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 导入项目样式入口。
示例
预览
packages/vue/src/blocks/project-folder/demo.vue
<script setup lang="ts">
import { h } from "vue";
import { ProjectFolder } from "@/components/orvui/blocks/project-folder";
const sheets = [
["emerald", "#a7f3d0"],
["orange", "#fed7aa"],
["sky", "#bae6fd"],
["violet", "#ddd6fe"],
["amber", "#fef3c7"],
];
const previews = sheets.map(([id, background], index) => ({
id,
content: h(
"span",
{ class: "relative block h-full w-full", style: { background } },
[
h("span", {
class: "absolute left-3 top-3 h-2 w-8 rounded-full bg-black/15",
}),
...["top-8", "top-11"].map((top) =>
h("span", { class: `absolute inset-x-3 ${top} h-px bg-black/10` }),
),
h(
"span",
{
class: "absolute bottom-3 right-3 text-sm font-medium text-black/50",
},
String.fromCharCode(65 + index),
),
],
),
}));
</script>
<template>
<div class="flex min-h-80 w-full items-center justify-center px-6 py-10">
<ProjectFolder
title="Brand direction"
description="Updated recently"
:count="5"
:previews="previews"
/>
</div>
</template>
packages/vue/src/blocks/project-folder/src/ProjectFolder.vue
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
ProjectFolder | v-model:openboolean | update:open |
ProjectFolder | v-model:expandedboolean | update:expanded |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
titlestring—description?string"Updated recently"previews?ProjectFolderPreview[]() => []count?numberprops.previews.lengthitemLabel?string"file"open?booleanundefineddefaultOpen?booleanfalseexpanded?booleanundefineddefaultExpanded?booleanfalsedisabled?booleanfalseariaLabel?string—事件
update:open[open: boolean]@update:openopenChange[open: boolean]@openChangeupdate:expanded[expanded: boolean]@update:expandedexpandedChange[expanded: boolean]@expandedChangeclick[]@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。
更新于
来源与许可 ↗MIT · 0.1.1