Skip to content

Commit 7b84ac4

Browse files
chore: update readme
1 parent fe7b9f3 commit 7b84ac4

5 files changed

Lines changed: 86 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on Keep a Changelog, and this project follows Semantic Versioning.
66

7+
## [Unreleased]
8+
9+
### Docs
10+
11+
- Reorganized root README files for clearer scanning (quick overview + positioning block), clarified the purpose of `docs/positioning.md`, and aligned `packages/react/README.md` so npm package docs reflect the same positioning updates.
12+
13+
714
## [0.1.5] - 2026-04-08
815

916
### Added

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# react-virtualized-diff
22

3+
Built for large files: a virtualized React diff component.
4+
5+
## At a Glance
6+
7+
-**Focus:** fast diff rendering for very large files (10k+ lines).
8+
- 🧩 **Best for:** embedded PR/MR review pages, long-list diff UIs, and internal review tools.
9+
- 🧭 **Positioning details:** [docs/positioning.md](./docs/positioning.md).
10+
11+
## Positioning
12+
13+
Target scenarios: very large files, long-list scrolling experiences, and embedded code review pages (PR/MR diff views) where stable first paint and smooth scrolling are critical.
14+
15+
| Option | Performance (large files) | Bundle size | Customizability | React ecosystem integration cost |
16+
| --- | --- | --- | --- | --- |
17+
| `react-virtualized-diff` | High (virtualized rendering for 10k+ lines) | Small-to-medium (focused diff capability) | High (style slots, render hooks, interaction callbacks) | Low (native React API, TypeScript-friendly) |
18+
| Traditional non-virtualized diff components | Medium-to-low (often degrades on big files) | Medium | Medium (limited extension points) | Low (quick to adopt, but needs extra optimization for large files) |
19+
| In-house diff + virtualization | Depends on implementation (can be high) | Uncertain (often grows with business logic) | High (fully controllable) | High (build + maintenance overhead) |
20+
321
High-performance React code/text diff viewer for **large text/code files** with virtualized rendering.
422

523
- 📦 npm: [`react-virtualized-diff`](https://www.npmjs.com/package/react-virtualized-diff)
624
- 🌐 Live Demo: https://www.zhangjiahang.com/react-virtualized-diff
725
- 📊 Benchmark report: [benchmark-results/results.md](./benchmark-results/results.md)
826
- 🇨🇳 中文文档: [README.zh-CN.md](./README.zh-CN.md)
27+
- 🧭 Positioning doc: [docs/positioning.md](./docs/positioning.md)
928

1029
## Quick Demo View
1130
![20260408-024125](https://github.com/user-attachments/assets/5345cbe4-04b1-4cfd-bcba-a68fcd7e82aa)

README.zh-CN.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# react-virtualized-diff
22

3+
为大文件而生的 React 虚拟化 diff 组件。
4+
5+
## 快速了解
6+
7+
-**核心目标:** 面向 `10k+` 行大文件,保持渲染与滚动流畅。
8+
- 🧩 **典型场景:** PR/MR 代码审查页嵌入、长列表 diff 页面、内部审查系统。
9+
- 🧭 **定位细节:** [docs/positioning.md](./docs/positioning.md)
10+
11+
## 产品定位
12+
13+
目标场景:超大文件(如 10k+ 行)、长列表滚动场景,以及代码审查页面(PR/MR Diff)嵌入,重点解决首屏渲染与滚动流畅度问题。
14+
15+
| 方案 | 性能(大文件) | 包体积 | 可定制性 | React 生态集成成本 |
16+
| --- | --- | --- | --- | --- |
17+
| `react-virtualized-diff` | 高(虚拟化渲染,适合 10k+ 行) | 中等偏小(聚焦 diff 核心能力) | 高(样式槽位、渲染器、交互回调) | 低(原生 React 组件 + TypeScript 友好) |
18+
| 传统非虚拟化 diff 组件 | 中-低(大文件容易卡顿) | 中等 | 中(扩展点有限) | 低(接入快,但大文件需额外优化) |
19+
| 自研 diff + 列表虚拟化方案 | 取决于实现(理论可高) | 不确定(常随业务膨胀) | 高(完全可控) | 高(开发与维护成本高) |
20+
321
面向**大体量文本/代码文件**的高性能 React Diff 组件(虚拟滚动渲染)。
422

523
- 📦 npm:[`react-virtualized-diff`](https://www.npmjs.com/package/react-virtualized-diff)
624
- 🌐 在线 Demo:https://www.zhangjiahang.com/react-virtualized-diff
725
- 📊 Benchmark 报告:[benchmark-results/results.md](./benchmark-results/results.md)
826
- 🇬🇧 English README:[README.md](./README.md)
27+
- 🧭 定位文档:[docs/positioning.md](./docs/positioning.md)
928

1029
## 示例
1130
![20260408-024125](https://github.com/user-attachments/assets/5345cbe4-04b1-4cfd-bcba-a68fcd7e82aa)

docs/positioning.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Positioning
2+
3+
`docs/positioning.md` 是项目的“定位说明文档”,用于统一回答“这个库是给谁用的、适合放在哪些业务场景、与同类方案如何区分”。
4+
5+
## 标准宣传语
6+
7+
为大文件而生的 React 虚拟化 diff 组件。
8+
9+
## 目标用户画像
10+
11+
### 1) 代码托管平台(Code Hosting Platform)
12+
13+
- 典型形态:Git 服务、Merge Request / Pull Request 审查页面。
14+
- 核心诉求:在超大变更集下保持流畅滚动、快速跳转与可读性。
15+
- 集成关注点:与现有评论系统、行号交互、权限体系和主题系统兼容。
16+
17+
### 2) 内部审查系统(Internal Review System)
18+
19+
- 典型形态:企业内部代码审查、配置变更审计、文本比对后台。
20+
- 核心诉求:稳定性优先、可定制 UI、可嵌入业务流程(审批、留痕、追踪)。
21+
- 集成关注点:与组织内 React 技术栈、设计系统、埋点与监控对齐。
22+
23+
### 3) IDE 插件前端(IDE Plugin Frontend)
24+
25+
- 典型形态:WebView / 内嵌面板中的文件 diff 预览。
26+
- 核心诉求:受限容器中仍能维持性能,支持暗色主题与紧凑布局。
27+
- 集成关注点:轻量依赖、可控渲染开销、便于与编辑器事件联动。

packages/react/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
High-performance React diff viewer with virtualization for large text/code files.
44

5+
## At a glance
6+
7+
- Built for large files (`10k+` lines) and long diff lists.
8+
- Designed for embedded code review UIs (PR/MR pages), internal review systems, and IDE plugin frontends.
9+
- Positioning & personas: https://github.com/Zhang-JiahangH/react-virtualized-diff/blob/main/docs/positioning.md
10+
11+
## Positioning
12+
13+
| Option | Performance (large files) | Bundle size | Customizability | React integration cost |
14+
| --- | --- | --- | --- | --- |
15+
| `react-virtualized-diff` | High (virtualized rendering) | Small-to-medium | High | Low |
16+
| Traditional non-virtualized diff components | Medium-to-low | Medium | Medium | Low |
17+
| In-house diff + virtualization | Depends on implementation | Uncertain | High | High |
18+
519
- Demo: https://www.zhangjiahang.com/react-virtualized-diff
620
- Changelog: https://github.com/Zhang-JiahangH/react-virtualized-diff/blob/main/CHANGELOG.md
721
- Benchmark: https://github.com/Zhang-JiahangH/react-virtualized-diff/blob/main/benchmark-results/results.md

0 commit comments

Comments
 (0)