@git-diff-view/react

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

@git-diff-view/react

原始使用文档
文档目录12 节
  1. Features
  2. Installation
  3. Quick Start
  4. Basic Usage
  5. Advanced Usage with DiffFile
  6. Styling
  7. API Reference
  8. Props
  9. DiffData Type
  10. Examples
  11. Live Demo
  12. License

@git-diff-view/react

A high-performance React diff view component with GitHub-style UI

npm version npm downloads

Features

  • ✅ Split & Unified views
  • ✅ Syntax highlighting with full context
  • ✅ Light & Dark themes
  • ✅ SSR & RSC support
  • ✅ Widget & extend data system
  • ✅ High performance with Web Worker support

Installation

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

Quick Start

Basic Usage

import { DiffView, DiffModeEnum } from "@git-diff-view/react";
import "@git-diff-view/react/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
    />
  );
}

Advanced Usage with DiffFile

File Comparison Mode

import { DiffView } from "@git-diff-view/react";
import { DiffFile, generateDiffFile } from "@git-diff-view/file";
import "@git-diff-view/react/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 Mode

import { DiffView } from "@git-diff-view/react";
import { DiffFile } from "@git-diff-view/core";
import "@git-diff-view/react/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} />

Styling

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

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

API Reference

Props

PropTypeDescription
dataDiffDataDiff data with oldFile, newFile, and hunks
diffFileDiffFilePre-processed diff file instance
diffViewModeSplit | UnifiedView mode (default: Split)
diffViewThemelight | darkTheme (default: light)
diffViewHighlightbooleanEnable syntax highlighting
diffViewWrapbooleanEnable line wrapping
diffViewFontSizenumberFont size in pixels
diffViewAddWidgetbooleanEnable widget button
renderWidgetLine(props) => ReactNodeCustom widget renderer
renderExtendLine(props) => ReactNodeCustom extend data renderer
extendDataExtendDataAdditional data per line
onAddWidgetClick(props) => voidWidget button click handler

DiffData Type

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

Examples

Live Demo

Try it online: https://mrwangjusttodo.github.io/git-diff-view

License

MIT © MrWangJustToDo

版本与发布记录

@git-diff-view/react 共发布 50 个版本,首次发布于 2024/01/30;过去 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 个月前

其他发布通道:beta → 0.0.1-beta.2。

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

@git-diff-view/react 是什么?

@git-diff-view/react

如何安装 @git-diff-view/react?

在项目目录运行 npm install @git-diff-view/react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0)、react-dom(^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@git-diff-view/react 支持 TypeScript 吗?

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

@git-diff-view/react 支持 ESM 还是 CommonJS?

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

@git-diff-view/react 可以商用吗?

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

@git-diff-view/react 的下载量有多少?

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

@git-diff-view/react 还在维护吗?

最新版本 0.1.8 发布于 2026/10/15(1 个月前);至今共发布 50 个版本,其中过去 12 个月发布了 14 个;首次发布于 2024/01/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。