Diff
示例代码Go · 可复制
这是上方组件库展示案例的完整源码。examples/components/diff.go
在脚手架项目中复用组件构造和 Render 写法;示例的 registerSection 与共享辅助函数由组件库提供。
package main
import (
"fmt"
"github.com/dyike/keel/ui/core"
"github.com/dyike/keel/ui/el"
"github.com/dyike/keel/ui/kit"
"strings"
)
func init() {
registerSection("diff", "data", func() core.Widget {
enableHighlight()
context := strings.Repeat("// unchanged context\n", 16)
initial := kit.DiffValue{Before: "package main\n\nfunc greeting() string {\n\treturn \"Hello\"\n}\n\n" + context + "// old note\n", After: "package main\n\nfunc greeting() string {\n\treturn \"Hello, Keel\"\n}\n\n" + context + "// reviewed note\n"}
patch := kit.Diff(initial.Before, initial.After).Patch("main.go", "main.go")
d := kit.Diff(initial.Before, initial.After).Language("go").Name(demoText("Review changes", "审阅更改"))
lineStatus := demoText("Click a line number to locate its source.", "点击行号查看对应源位置。")
d.OnLineNumberPress(func(line kit.DiffLine) {
side := demoText("After", "更改后")
if line.Side == kit.DiffSideBefore {
side = demoText("Before", "更改前")
}
lineStatus = fmt.Sprintf("%s · %d", side, line.Line+1)
})
d.HunkActions(func(h kit.DiffHunk) []kit.DiffAction {
return []kit.DiffAction{
{Label: demoText("Inspect region", "查看区域"), OnSelect: func(current kit.DiffHunk) {
lineStatus = fmt.Sprintf("%s %d · -%d,%d +%d,%d", demoText("Region", "区域"), current.Index+1, current.BeforeStart+1, current.BeforeEnd-current.BeforeStart, current.AfterStart+1, current.AfterEnd-current.AfterStart)
}},
{Label: demoText("Restore region", "还原区域"), Disabled: h.PatchOnly, OnSelect: func(current kit.DiffHunk) { d.RevertAt(current.Index) }},
}
})
modes := kit.Select(demoText("Presentation", "展示方式"), "Auto", "Unified", "Split").OnChange(func(s string) {
switch s {
case "Unified":
d.Mode(kit.DiffModeUnified)
case "Split":
d.Mode(kit.DiffModeSplit)
default:
d.Mode(kit.DiffModeAuto)
}
})
modes.SetValue("Auto")
return el.Root(el.ViewFunc(func(cx *el.Context) el.Element {
return el.Div().ScrollY().P(16).Gap(12).Child(modes.Render(cx), el.Text(lineStatus), kit.Button(demoText("Inspect patch", "查看补丁"), func() { _ = d.SetPatch(patch) }).Render(cx), kit.Button(demoText("Reset comparison", "重置比较"), func() { d.SetValue(initial) }).Render(cx), d.Render(cx))
}))
})
}
比较两份文本,定位差异区域,逐项保留或还原,并导出统一补丁。视图复用只读 CodeEditor,支持文本选择、复制与可见区域渲染。
review := kit.Diff(before, after).Name("审阅更改").Height(360).
OnChange(func(value kit.DiffValue) { /* 保存 value.Before / value.After */ })
patch := review.Patch("file.go", "file.go")
Value() 返回 DiffValue{Before, After},SetValue 静默替换两份文本。Changes() 返回差异区域数,Current() 为从零开始的当前区域,无差异时为 -1。SetCurrent(index) 定位有效区域,不触发回调。Keep() 将当前区域的修改写入 Before,Revert() 从 Before 还原当前 After 区域;两者返回是否执行,并各触发一次 OnChange。SetDisabled 禁止审阅操作,程序仍可设置文本和当前区域;祖先禁用同样使控件不可操作。
Mode(DiffModeAuto) 在视口宽度低于随字体缩放调整的 720dp 时使用统一补丁视图,宽屏并排显示原始 Before/After。DiffModeUnified 和 DiffModeSplit 强制指定视图。Height(dp) 设置每个编辑器的视口高度,外层可放入纵向滚动容器。切换视图保留文本和当前区域。并排面板按行映射同步纵向滚动:未改变的行精确对应,替换区域内部插值,删除区域对应另一侧边界。差异导航同时定位两侧源位置,横向滚动保持独立。统一视图显示每处差异前后各三行上下文;相同文本直接显示原文。
工具栏自动换行,控件高度为 44dp。Tab 聚焦控件,Enter/空格激活按钮;编辑器支持通常的选择、复制、导航与搜索快捷键,但拒绝编辑。复制按钮复制完整补丁;编辑器选择复制的是显示内容,统一视图包含补丁标记。容器语义为 group,编辑器及按钮使用本地化名称,没有新增自动化角色。
行标记保留 CRLF 和末尾换行差异。唯一行锚点与有计算预算的 LCS 避免无界二次计算;较大的重复区域可能呈现为整块替换,并不保证最小差异。Patch(oldName, newName) 使用带引号的 a/、b/ 路径、三行上下文和缺少末尾换行标记。相同文本返回空补丁。文件名仅描述文本文件,不建模重命名、文件权限和二进制补丁。
验证:go test ./ui/kit -run TestDiff、go test ./ui/window -run TestDiff、go run ./examples/components -section diff。测试覆盖精确重建;安装 Git 时还验证补丁实际应用结果。修改区域内按位置配对的行还会高亮增删字素簇,保留组合重音及 emoji 序列的完整性。整行新增/删除保留行级高亮,所有行内比较共享计算预算。可通过 HunkActions 配置自定义逐块操作;完整视觉和设备一致性尚未验收。参考组件库演示并未要求可编辑合并面板。
Stats() 返回新增/删除源行数和差异区域数,不计入未改变的上下文,审阅操作后自动更新。Expanded(true) 在两种文本视图中显示所有上下文,Expanded(false) 恢复三行上下文;两种视图工具栏都提供这些操作。展开/折叠仅改变显示,保留当前差异,不影响 Patch() 或触发 OnChange。并排面板通过保留源文本的编辑器折叠隐藏未改变的间隙,留下三行上下文及一个源行折叠锚点;展开恢复所有行,导航确保差异区域可见。选择和复制仍使用完整原文。Language(name) 通过已有的可选高亮提供者设置两侧源编辑器的语言,统一补丁继续使用差异装饰。
SetPatch(text) 原子切换为单个文本 unified patch 的查看模式,错误时保留当前内容。支持 Git diff/index 及新建/删除文件的模式头,拒绝多文件和二进制补丁;校验差异块行数、顺序、数值溢出及末尾换行标记。空字符串是有效空补丁。PatchInput() 返回原始输入及模式标志。此模式下缺失的源文本未知,Value() 返回空文本对;Patch(...) 忽略传入文件名,原样返回输入。SetValue 恢复文本比较。保留/还原不可用且不触发回调,展开操作不会编造缺失上下文。并排查看在正文内显示差异块头和源行号,与编辑器的显示行号分开;大行号间隙不分配空白行。示例的“查看补丁”按钮演示此模式。
OnLineNumberPress(func(DiffLine)) 返回从 0 开始的原始源行号及 DiffSideBefore 或 DiffSideAfter。并排折叠保留源行身份;统一视图中的上下文属于 After,删除行属于 Before,新增行属于 After。导入补丁返回原始稀疏行号,而非片段的显示行。文件头、差异块头和无末尾换行标记不触发回调。点击行号仍选择该行,折叠箭头只执行折叠;组件或祖先禁用时不触发指针回调。
Hunk(index) 返回 (DiffHunk, bool):包含从 0 开始的索引、左闭右开的 BeforeStart/BeforeEnd 和 AfterStart/AfterEnd 源行范围、精确的 Before/After 文本及 PatchOnly 标记。空范围表示插入或删除。文本比较返回不含上下文的修改区域;补丁查看返回含已知上下文的原始差异块,保留稀疏源行范围和末尾换行状态,不补造省略文本。快照不会随后续编辑变化。
KeepAt(index) / RevertAt(index) 直接操作指定的当前差异块并通知一次,无需先改变当前选择。索引无效、组件禁用或仅查看补丁时返回 false,不修改状态。差异块数量减少时,原当前索引被限制到有效范围。文本更新可能改变索引;使用保存的索引前应重新获取快照。这些接口也为嵌入式差异块操作提供源位置身份。
HunkActions(func(DiffHunk) []DiffAction) 在统一编辑器或 After 面板的每个差异块前插入操作行;Before 预留相同空间保持对齐。DiffAction 包含 Label、Disabled 和 OnSelect func(DiffHunk),回调为 nil 时禁用。操作收到最新快照,可显式调用 KeepAt 或 RevertAt。补丁查看允许应用自定义动作,但仍拒绝接受/撤销。过期操作行不能作用于替换后的比较内容。
工厂函数仅在操作或比较/展示重建时执行,不逐帧调用;不要在工厂中修改 Diff。返回切片会被复制。外部计算的标签或可用状态变化时,应重新设置 HunkActions。返回空操作可省略某块的操作行,传 nil 删除全部操作行。标签宜简短。操作行按文字比例预留空间,按钮至少高 44dp;窄屏支持横向滚动,并随源码纵向滚动,折叠隐藏的行不绘制。复制、行号、光标/选择及文本键盘导航均不包含控件。按钮支持常规指针和键盘激活,并遵循祖先禁用状态;仅布局可见操作行。