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 导入项目样式入口。

示例

预览

File changes

组合结构

使用公开部件 FileDiff 组合 File Diff,并从该组件的公开入口导入。

ToolResult
└── ToolResultOutput
    └── FileDiff

说明: Code Block 呈现带高亮的代码,并支持行控件、文件标签与复制操作。 Tool Result 在同一表面呈现工具调用状态、摘要与可展开结果。 Agent Activity 将持续变化的助手活动组织为可展开步骤与完成摘要。

工作方式

通过对齐行号与可展开上下文检查新增及删除内容。

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
FileDiffv-model:openbooleanupdate:open

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

file
Content
—
lines
FileDiffLine[]
—
status?
"streaming" | "complete"
"streaming"
open?
boolean
undefined
defaultOpen?
boolean
true
collapseOnComplete?
boolean
true
maxHeight?
number
220
language?
"text" | "bash" | "diff" | "json" | "tsx" | "typescript" | "javascript" | "vue" | "css" | "html"
"typescript"
copyText?
string
""
onCopy?
() => void | Promise<void>
—

事件

update:open
[open: boolean]
@update:open
openChange
[open: boolean]
@openChange

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 File Diff?
通过 file、lines、status、open、defaultOpen、collapseOnComplete、maxHeight、language、copyText、onCopy 配置 File Diff;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:open、openChange,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于