AI Sidebar

在可搜索树中组织助手资源,支持选择与移动操作。

适用场景

  • 当界面需要以下行为时使用 AI Sidebar:在可搜索树中组织助手资源,支持选择与移动操作。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/ai-sidebar.json https://orvui.efu.me/r/animated-sidebar.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

Workspace

Agent workspace

Draft

Selected resource

Review resource sidebar interaction details

Keep the resource tree predictable while files move between projects, labels overflow, and folders expand around the current selection.

Interaction notes

  • Folders only reveal their contents.
  • Files can be selected, moved, or renamed.
  • Rejected moves return to their previous location.

组合结构

使用公开部件 AISidebar 组合 AI Sidebar,并从该组件的公开入口导入。

AnimatedSidebarProvider
├── AnimatedSidebar
│   ├── AnimatedSidebarContent
│   │   └── AISidebar
│   │       ├── Folder or project
│   │       └── File or bookmark
│   └── AnimatedSidebarRail
└── AnimatedSidebarInset

说明: Message Scroller 在新消息加入时跟随内容,同时允许读者离开并返回最新位置。 Prompt Input 通过自适应高度文本框、附件与键盘操作编写并提交提示词。

工作方式

在可搜索树中组织助手资源,支持选择与移动操作。

状态与事件

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

组件状态绑定
组件Vue 绑定更新事件
AISidebarv-model:itemsSidebarResource[]update:items
AISidebarv-model:activeIdnull | stringupdate:activeId

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

API 参考

items?
SidebarResource[]
props.defaultItems
defaultItems?
SidebarResource[]
() => []
activeId?
null | string
props.defaultActiveId
defaultActiveId?
null | string
null
defaultExpandedIds?
string[]
() => []
ariaLabel?
string
"Resources"
className?
string
—
onMove?
(move: SidebarResourceMove) => void | Promise<void>
—
onRename?
(item: SidebarResource, label: string) => void | Promise<void>
—
renderIcon?
(item: SidebarResource) => VNodeChild
—
renderMenu?
(item: SidebarResource, controls: SidebarResourceMenuControls) => VNodeChild
—

事件

update:items
[items: SidebarResource[]]
@update:items
itemsChange
[items: SidebarResource[]]
@itemsChange
update:activeId
[id: string | null]
@update:activeId
activeChange
[id: string]
@activeChange
moveError
[error: unknown, move: SidebarResourceMove]
@moveError
renameError
[error: unknown, item: SidebarResource]
@renameError

插槽

icon
—

作用域参数: v-bind

#icon
menu
—

作用域参数: v-bind

#menu

无障碍

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

常见问题

如何配置 AI Sidebar?
通过 items、defaultItems、activeId、defaultActiveId、defaultExpandedIds、ariaLabel、className、onMove、onRename、renderIcon、renderMenu 配置 AI Sidebar;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:items、itemsChange、update:activeId、activeChange、moveError、renameError,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于