@git-diff-view/ s固态
具有 GitHub 风格 UI 的高性能 Solid diff 视图组件
特征
- 分割和统一视图
- 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 | 类型 | 说明 |
|---|---|---|
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 | 部件按钮点击处理器 |
数据类型
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 页面存档备份,存于互联网档案馆
许可证
麻省理工学院 万正东先生