@git-diff-view/solid

中文文档
0.1.8发布于 2026/10/15MITTypeScriptESM + CJS近 30 天下载 3641

@git-diff-view/ s固态

中文使用文档
文档目录12 节
  1. 特征
  2. 安装
  3. 快速启动
  4. 基本用途
  5. 用 DiffFile 高级使用
  6. 样式
  7. API 参考
  8. 道具
  9. 数据类型
  10. 实例
  11. 现场直播
  12. 许可证

@git-diff-view/ s固态

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

npm version npm downloads

特征

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

安装

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

快速启动

基本用途

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 高级使用

文件比较模式

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 模式

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} />

样式

// 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类型说明
dataDiffData向导数据 oldFile, (中文(简体) ), newFile,以及 hunks
diffFileDiffFile预处理的 diff 文件实例
diffViewModeSplit | Unified查看模式( 默认 ): Split(中文(简体) )
diffViewThemelight | dark主题( 默认 ): light(中文(简体) )
diffViewHighlightboolean启用语法加亮
diffViewWrapboolean启用行包
diffViewFontSizenumber字体大小( 像素)
diffViewAddWidgetboolean启用部件按钮
renderWidgetLine(props) => JSXElement自定义部件渲染器
renderExtendLine(props) => JSXElement自定义扩展数据渲染器
extendDataExtendData每行增加数据
onAddWidgetClick(props) => void部件按钮点击处理器

数据类型

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://mrwangjusttodo.github.io/git-diff-view 页面存档备份,存于互联网档案馆

许可证

麻省理工学院 万正东先生

版本与发布记录

@git-diff-view/solid 共发布 22 个版本,首次发布于 2025/07/07;过去 12 个月发布了 14 个版本。

版本发布日期距今
0.1.8latest2026/10/151 个月前
0.1.72026/07/134 个月前
0.1.62026/06/214 个月前
0.1.52026/05/265 个月前
0.1.42026/05/185 个月前
0.1.32026/03/207 个月前

关于 @git-diff-view/solid 的常见问题

@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 和提交记录判断。