OpenManual
组件

Files 文件树

使用 Files 组件展示项目目录结构和文件树。

Files 组件用于以树形结构展示项目目录,清晰地呈现文件组织方式。

基本用法

使用 Files 包裹 FileFolder 组件:

<Files>
  <Folder name="src" defaultOpen>
    <File name="index.ts" />
    <File name="config.ts" />
    <Folder name="components">
      <File name="Button.tsx" />
    </Folder>
  </Folder>
  <File name="package.json" />
  <File name="tsconfig.json" />
</Files>
index.ts
config.ts
package.json
tsconfig.json

文件类型图标

File 组件会根据文件扩展名自动匹配图标:

app.tsx
styles.css
utils.ts
data.json
README.md
.env

属性

Files

Files 是一个容器组件,无额外属性。用于包裹 FileFolder 子组件。

Folder

属性类型必填默认值说明
namestring文件夹名称
defaultOpenbooleanfalse是否默认展开
childrenReactNode子文件/文件夹

File

属性类型必填说明
namestring文件名(含扩展名)

注意事项

  • Filename 属性应包含完整的文件名和扩展名
  • Folder 设置 defaultOpen 可以让该文件夹默认展开
  • 嵌套 Folder 可以展示多级目录结构
  • 文件图标根据扩展名自动匹配,支持常见的文件类型

On this page