# @git-diff-view/solid 中文文档

规范地址：https://npmcn.com/package/%40git-diff-view/solid/

版本：0\.1\.8
npm 元数据更新时间：2026-10-15T06:51:39.001Z
中文译文更新时间：2026-11-16T10:21:22.813Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40git-diff-view/solid
原文对照：https://npmcn.com/package/%40git-diff-view/solid/?lang=original
项目主页：https://mrwangjusttodo.github.io/git-diff-view
源码仓库：https://github.com/MrWangJustToDo/git-diff-view

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.3 MB，61 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- peer 依赖：solid-js ^1\.9\.0
- 首次发布：2025-07-06T17:47:18.175Z
- 最新版本发布：2026-10-15T06:51:38.597Z
- 近 30 天下载量：3641（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 14 个）

## 中文简介

@git-diff-view/ s固态

## 安装

```sh
npm install @git-diff-view/solid
```

也可以使用：`pnpm add @git-diff-view/solid`、`yarn add @git-diff-view/solid`、`bun add @git-diff-view/solid`

## README

# @git-diff-view/ s固态

> 具有 GitHub 风格 UI 的高性能 Solid diff 视图组件

[![npm version](https://img.shields.io/npm/v/@git-diff-view/solid)](https://www.npmjs.com/package/@git-diff-view/solid) [![npm downloads](https://img.shields.io/npm/dm/@git-diff-view/solid)](https://www.npmjs.com/package/@git-diff-view/solid)

## 特征

-   分割和统一视图
-   QQ 有完整背景的语法突出显示
-   & 黑暗主题
-   固体的精致反应
-   & 扩展数据系统
-   在Web Worker的支持下,高性能

## 安装

```bash
npm install @git-diff-view/solid
# or
pnpm add @git-diff-view/solid
# or
yarn add @git-diff-view/solid
```

## 快速启动

### 基本用途

```tsx
import { DiffView, DiffModeEnum } from "@git-diff-view/solid";
import "@git-diff-view/solid/styles/diff-view.css";

function MyDiffView() {
  return (
    <DiffView
      data={{
        oldFile: { fileName: "old.ts", content: "..." },
        newFile: { fileName: "new.ts", content: "..." },
        hunks: ["..."]
      }}
      diffViewMode={DiffModeEnum.Split}
      diffViewTheme="dark"
      diffViewHighlight
    />
  );
}
```

### 用 DiffFile 高级使用

**文件比较模式**

```tsx
import { DiffView } from "@git-diff-view/solid";
import { DiffFile, generateDiffFile } from "@git-diff-view/file";
import "@git-diff-view/solid/styles/diff-view.css";

const file = generateDiffFile(
  "old.ts", oldContent,
  "new.ts", newContent,
  "typescript", "typescript"
);
file.initTheme('dark');
file.init();
file.buildSplitDiffLines();

<DiffView diffFile={file} />
```

**Git Diff 模式**

```tsx
import { DiffView } from "@git-diff-view/solid";
import { DiffFile } from "@git-diff-view/core";
import "@git-diff-view/solid/styles/diff-view.css";

const file = new DiffFile(
  oldFileName,
  oldContent,
  newFileName,
  newContent,
  hunks,
  oldFileLang,
  newFileLang
);
file.initTheme('dark');
file.init();
file.buildSplitDiffLines();

<DiffView diffFile={file} />
```

## 样式

```tsx
// Default styles with Tailwind (next release will be pure CSS)
import "@git-diff-view/solid/styles/diff-view.css";

// Pure CSS (no Tailwind conflicts)
import "@git-diff-view/solid/styles/diff-view-pure.css";
```

## API 参考

### 道具

| Prop | 类型 | 说明 |
| --- | --- | --- |
| `data` | `DiffData` | 向导数据 `oldFile`, (中文(简体) ), `newFile`,以及 `hunks` |
| `diffFile` | `DiffFile` | 预处理的 diff 文件实例 |
| `diffViewMode` | `Split | Unified` | 查看模式( 默认 ): `Split`(中文(简体) ) |
| `diffViewTheme` | `light | dark` | 主题( 默认 ): `light`(中文(简体) ) |
| `diffViewHighlight` | `boolean` | 启用语法加亮 |
| `diffViewWrap` | `boolean` | 启用行包 |
| `diffViewFontSize` | `number` | 字体大小( 像素) |
| `diffViewAddWidget` | `boolean` | 启用部件按钮 |
| `renderWidgetLine` | `(props) => JSXElement` | 自定义部件渲染器 |
| `renderExtendLine` | `(props) => JSXElement` | 自定义扩展数据渲染器 |
| `extendData` | `ExtendData` | 每行增加数据 |
| `onAddWidgetClick` | `(props) => void` | 部件按钮点击处理器 |

### 数据类型

```typescript
type DiffData = {
  oldFile?: {
    fileName?: string | null;
    fileLang?: string | null;
    content?: string | null;
  };
  newFile?: {
    fileName?: string | null;
    fileLang?: string | null;
    content?: string | null;
  };
  hunks: string[];
};
```

## 实例

-   [固态示例](https://github.com/MrWangJustToDo/git-diff-view/tree/main/ui/solid-example)

## 现场直播

尝试在线: [https://mrwangjusttodo.github.io/git-diff-view 页面存档备份,存于互联网档案馆](https://mrwangjusttodo.github.io/git-diff-view)

## 许可证

麻省理工学院 [万正东先生](https://github.com/MrWangJustToDo)

## 常见问题

### @git-diff-view/solid 是什么？

@git-diff-view/ s固态

### 如何安装 @git-diff-view/solid？

在项目目录运行 npm install @git-diff-view/solid，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：solid-js（^1\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @git-diff-view/solid 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @git-diff-view/solid 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @git-diff-view/solid 可以商用吗？

@git-diff-view/solid 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @git-diff-view/solid 的下载量有多少？

根据 npm 官方下载统计，@git-diff-view/solid 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,641 次，日均约 121 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @git-diff-view/solid 还在维护吗？

最新版本 0\.1\.8 发布于 2026/10/15（1 个月前）；至今共发布 22 个版本，其中过去 12 个月发布了 14 个；首次发布于 2025/07/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

