File Diff
通过对齐行号与可展开上下文检查新增及删除内容。
适用场景
- 当界面需要以下行为时使用 File Diff:通过对齐行号与可展开上下文检查新增及删除内容。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/file-diff.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
packages/vue/src/agents/file-diff/demo.vue
<script setup lang="ts">
import { onBeforeUnmount, onMounted, ref } from "vue";
import { RotateCcw } from "lucide-vue-next";
import { FileDiff, type FileDiffLine } from "@/components/orvui/agents/file-diff";
const lines: FileDiffLine[] = [
{
id: "1",
oldLine: 18,
newLine: 18,
content: "export async function runTask() {",
},
{ id: "2", type: "removed", oldLine: 19, content: " return execute(task);" },
{
id: "3",
type: "added",
newLine: 19,
content: " const result = await execute(task);",
},
{
id: "4",
type: "added",
newLine: 20,
content: " return normalize(result);",
},
{ id: "5", oldLine: 20, newLine: 21, content: "}" },
];
const visible = ref(0),
complete = ref(false),
run = ref(0);
let epoch = 0;
const scheduledTasks = new Set<ReturnType<typeof setTimeout>>();
function cancel() {
epoch++;
scheduledTasks.forEach(clearTimeout);
scheduledTasks.clear();
}
function later(milliseconds: number, task: () => void) {
const version = epoch;
const handle = setTimeout(() => {
scheduledTasks.delete(handle);
if (version === epoch) task();
}, milliseconds);
scheduledTasks.add(handle);
}
onBeforeUnmount(cancel);
function replay() {
cancel();
run.value++;
visible.value = 0;
complete.value = false;
lines.forEach((_, index) =>
later(180 + 360 * index, () => {
visible.value = index + 1;
}),
);
later(lines.length * 360 + 480, () => {
complete.value = true;
});
}
onMounted(replay);
</script>
<template>
<div class="relative h-[300px] w-full max-w-lg">
<FileDiff
:key="run"
file="src/runner.ts"
:lines="lines.slice(0, visible)"
:status="complete ? 'complete' : 'streaming'"
:copy-text="lines.map((line) => line.content).join('\n')"
:max-height="150"
/><button
type="button"
@click="replay"
class="absolute bottom-0 left-0 inline-flex items-center gap-1.5 rounded-md px-2 py-1 text-xs font-medium text-muted-foreground outline-none transition-colors hover:bg-muted hover:text-foreground focus-visible:ring-2 focus-visible:ring-ring"
>
<RotateCcw class="size-3" />Replay
</button>
</div>
</template>
packages/vue/src/agents/file-diff/src/FileDiff.vue
组合结构
使用公开部件 FileDiff 组合 File Diff,并从该组件的公开入口导入。
ToolResult
└── ToolResultOutput
└── FileDiff说明: Code Block 呈现带高亮的代码,并支持行控件、文件标签与复制操作。 Tool Result 在同一表面呈现工具调用状态、摘要与可展开结果。 Agent Activity 将持续变化的助手活动组织为可展开步骤与完成摘要。
工作方式
通过对齐行号与可展开上下文检查新增及删除内容。
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
FileDiff | v-model:openboolean | update:open |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
fileContent—linesFileDiffLine[]—status?"streaming" | "complete""streaming"open?booleanundefineddefaultOpen?booleantruecollapseOnComplete?booleantruemaxHeight?number220language?"text" | "bash" | "diff" | "json" | "tsx" | "typescript" | "javascript" | "vue" | "css" | "html""typescript"copyText?string""onCopy?() => void | Promise<void>—事件
update:open[open: boolean]@update:openopenChange[open: boolean]@openChange无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 File Diff?
- 通过 file、lines、status、open、defaultOpen、collapseOnComplete、maxHeight、language、copyText、onCopy 配置 File Diff;API 表列出其类型与默认值。
- 如何连接到应用状态?
- 监听 update:open、openChange,将组件连接到应用状态。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
更新于
来源与许可 ↗MIT · 0.1.1