Jamdesk Documentation logo

树形结构

以可交互的展开/折叠方式展示文件与文件夹层级,支持键盘导航。适用于项目结构文档。

Tree 以展开/折叠和键盘导航的方式展示文件与文件夹层级。可用于记录项目结构、目录布局,或说明代码库中文件的存放位置。

在以下场景使用 Tree:

  • 展示项目结构,用于入门指南
  • 说明文件组织方式,用于教程
  • 记录 CLI 输出中的目录树
  • 说明应在何处添加文件,用于配置指南

用法

<Tree>
  <TreeFolder name="src" defaultOpen>
    <TreeFile name="index.ts" />
  </TreeFolder>
</Tree>

基础 Tree

package.json
<Tree>
  <TreeFolder name="src" defaultOpen>
    <TreeFile name="index.ts" />
    <TreeFile name="config.ts" />
  </TreeFolder>
  <TreeFile name="package.json" />
</Tree>

项目结构示例

向读者展示完成设置后项目的样子:

Tree 与代码块

特性Tree代码块
可交互是(展开/折叠)否
键盘导航是否
视觉层级图标 + 缩进仅文本
最适合文档快速内联参考

主要的结构文档请使用 Tree;如"创建 src/index.ts"这类快速内联参考则使用代码块。

键盘导航

使用以下按键在树中移动:

按键操作
Arrow Down移动到下一项
Arrow Up移动到上一项
Arrow Right展开文件夹或移动到第一个子项
Arrow Left折叠文件夹或移动到父级
Home跳到第一项
End跳到最后一个可见项
Enter / Space切换文件夹的展开/折叠状态
输入字符跳到匹配的项

属性

TreeFolder

stringrequired

树中显示的文件夹名称。

booleandefault: false

初始为展开状态。

booleandefault: true

文件夹是否可以切换展开/折叠。

TreeFile

stringrequired

树中显示的文件名称。

下一步

组件概览

浏览所有可用组件

MDX 基础

了解如何在 MDX 中使用组件