Project Folder

扇形展开文档预览,并将选中文件夹展开为聚焦表面。

适用场景

  • 当界面需要以下行为时使用 Project Folder:扇形展开文档预览,并将选中文件夹展开为聚焦表面。

安装

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

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/project-folder.json

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

示例

预览

状态与事件

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

组件状态绑定
组件Vue 绑定更新事件
ProjectFolderv-model:openbooleanupdate:open
ProjectFolderv-model:expandedbooleanupdate:expanded

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

API 参考

title
string
—
description?
string
"Updated recently"
previews?
ProjectFolderPreview[]
() => []
count?
number
props.previews.length
itemLabel?
string
"file"
open?
boolean
undefined
defaultOpen?
boolean
false
expanded?
boolean
undefined
defaultExpanded?
boolean
false
disabled?
boolean
false
ariaLabel?
string
—

事件

update:open
[open: boolean]
@update:open
openChange
[open: boolean]
@openChange
update:expanded
[expanded: boolean]
@update:expanded
expandedChange
[expanded: boolean]
@expandedChange
click
[]
@click

插槽

preview
—

作用域参数: preview

#preview

无障碍

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

常见问题

如何配置 Project Folder?
通过 title、description、previews、count、itemLabel、open、defaultOpen、expanded、defaultExpanded、disabled、ariaLabel 配置 Project Folder;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:open、openChange、update:expanded、expandedChange、click,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

请留意

部分组件参考了开源作品,相关署名与独立许可请参阅 NOTICE。

更新于