# 文件树

- 页面: https://jiguang132.com/zh/resources/magic-ui/docs/file-tree
- 资源: Magic UI (https://jiguang132.com/zh/resources/magic-ui.md)
- 全部指南: https://jiguang132.com/zh/resources/magic-ui/docs.md

Magic UI 的独立组件，请不要替换为 JGuang UI/Base UI 的同名 API。

## 安装

```bash
npx shadcn@latest add https://jiguang132.com/r/magic-ui/file-tree.json
```

Registry 将复制可编辑源码和依赖到独立命名空间。检查主题变量与 Tailwind CSS v4 配置；不要覆盖已有的项目组件。

## 使用与验证

在左侧选择组件，在预览中操作它的状态；使用“查看代码”检查真实源码。安装后执行类型检查和构建，再验证键盘焦点、手机布局与深浅色主题。

## 来源

https://github.com/magicuidesign/magicui/tree/cdb348cb4c72a9b54b554d8617801e479fbc8714
MIT 许可证；不包括付费内容。下方提供上游英文参考内容，中文使用指南已适配；上游详细参考暂保留英文。

---


## 适用场景

展示本地可展开的文件/文件夹树。

## 示例使用的原生参数

从该组件全部本地示例的 JSX 提取，按导入模块及组件区分；包括复合示例中实际使用的其他 Magic UI 组件。不是全部属性清单，也不是宿主通用 variant API。展开对象需结合示例数据声明；完整类型与默认值见下方源码参考。

| 所属组件参数 | 说明 | 示例来源 |
| --- | --- | --- |
| `Tree.className` (file-tree) | 当前原生组件的样式类，需先配置 Tailwind 与所需 CSS。 | `examples/file-tree-demo.tsx` |
| `Tree.initialSelectedId` (file-tree) | Tree 初始选中的条目 id。 | `examples/file-tree-demo.tsx` |
| `Tree.initialExpandedItems` (file-tree) | Tree 初始展开的文件夹 id 列表。 | `examples/file-tree-demo.tsx` |
| `Tree.elements` (file-tree) | 包含 id、名称及可选 children 的原生树数据。 | `examples/file-tree-demo.tsx` |

## 交互与状态检查

- 文件树 · 默认示例 — `file-tree-demo`

这些名称是实际示例入口，不是新增组件属性或独立组件数量。选择对应示例后，检查指针/键盘行为、深浅色、手机尺寸和加载失败；纯装饰特效不应伪造禁用、错误或提交状态。完整示例安装包含其真实依赖闭包。

## 业务接入边界

elements 是具有唯一 id 的结构化数据；初始选中/展开只是初始值，不连接文件系统，也不提供上传能力。

## 宿主与动画配置

初始化 Tailwind CSS v4、语义 CSS 变量及 dark 变体；按本地 Registry 的独立命名空间导入。复用已有 next-themes Provider，不混入 JGuang UI/Base UI/HeroUI API。进入视口再挂载特效，离开后卸载；为 Canvas/WebGL 不可用、网络媒体失败提供静态替代。遵循 prefers-reduced-motion，并验证计时器、RAF、观察器和事件监听已清理；不能仅凭 CSS 停止就宣称引擎已停止。示例不提供后端、登录、支付或真实 AI 流。这里的实用指南为双语，上游详细参考和演示文本仍保留原文。


## 可用状态与示例

文件树 · 默认示例

组件中的状态与数据为演示用途，不包含后端接口。接入实际项目时请检查源码中的公开参数，再连接业务数据。



## Installation

<Tabs defaultValue="cli">

<TabsList>
  <TabsTrigger value="cli">CLI</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">

```bash
npx shadcn@latest add @magicui/file-tree
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Copy and paste the following code into your project.</Step>



<Step>Update the import paths to match your project setup.</Step>

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx showLineNumbers
import { Tree } from "@/components/ui/file-tree"
import type { TreeViewElement } from "@/components/ui/file-tree"
```

```tsx showLineNumbers
const elements: TreeViewElement[] = [
  {
    id: "src",
    type: "folder",
    name: "src",
    children: [
      { id: "components", type: "folder", name: "components" },
      { id: "app", type: "folder", name: "app" },
      { id: "page", name: "page.tsx" },
      { id: "layout", name: "layout.tsx" },
    ],
  },
]

<Tree elements={elements} />
```

When you pass `elements` and omit `children`, the tree is rendered from data and siblings are sorted automatically using a folders-first alphabetical order. Use `sort="none"` to preserve the input order, or pass a custom comparator.

## Props

### Tree

| Prop                   | Type                                        | Default     | Description                                                           |
| ---------------------- | ------------------------------------------- | ----------- | --------------------------------------------------------------------- |
| `initialSelectedId`    | `string`                                    | `-`         | The ID of the initially selected item.                                |
| `indicator`            | `boolean`                                   | `true`      | Whether to show the tree indicator line.                              |
| `elements`             | `TreeViewElement[]`                         | `-`         | An array of tree view elements to render when `children` are omitted. |
| `initialExpandedItems` | `string[]`                                  | `-`         | An array of IDs for items that should be initially expanded.          |
| `openIcon`             | `React.ReactNode`                           | `-`         | Custom icon for open folders.                                         |
| `closeIcon`            | `React.ReactNode`                           | `-`         | Custom icon for closed folders.                                       |
| `sort`                 | `"default" \| "none" \| ((a, b) => number)` | `"default"` | Sorting mode used for data-driven trees rendered from `elements`.     |
| `dir`                  | `"rtl" \| "ltr"`                            | `"ltr"`     | The text direction of the tree.                                       |

### TreeViewElement

| Prop           | Type                 | Default | Description                                           |
| -------------- | -------------------- | ------- | ----------------------------------------------------- |
| `id`           | `string`             | `-`     | A unique identifier for the node.                     |
| `name`         | `string`             | `-`     | The label rendered for the node in data-driven mode.  |
| `type`         | `"file" \| "folder"` | `-`     | Explicit node type. Use `"folder"` for empty folders. |
| `isSelectable` | `boolean`            | `true`  | Whether the node can be selected.                     |
| `children`     | `TreeViewElement[]`  | `-`     | Child nodes for folders.                              |

### Folder

| Prop           | Type      | Default | Description                               |
| -------------- | --------- | ------- | ----------------------------------------- |
| `element`      | `string`  | `-`     | The name of the folder.                   |
| `value`        | `string`  | `-`     | The unique identifier for the folder.     |
| `isSelectable` | `boolean` | `true`  | Whether the folder can be selected.       |
| `isSelect`     | `boolean` | `-`     | Whether the folder is currently selected. |

### File

| Prop           | Type              | Default | Description                             |
| -------------- | ----------------- | ------- | --------------------------------------- |
| `value`        | `string`          | `-`     | The unique identifier for the file.     |
| `isSelectable` | `boolean`         | `true`  | Whether the file can be selected.       |
| `isSelect`     | `boolean`         | `-`     | Whether the file is currently selected. |
| `fileIcon`     | `React.ReactNode` | `-`     | Custom icon for the file.               |

### CollapseButton

| Prop        | Type                | Default | Description                                |
| ----------- | ------------------- | ------- | ------------------------------------------ |
| `elements`  | `TreeViewElement[]` | `-`     | An array of tree view elements to control. |
| `expandAll` | `boolean`           | `false` | Whether to expand all elements initially.  |




## 完整示例安装

组件安装命令只安装组件；下列示例命令还包含该示例实际导入的其他组件、原生辅助 UI、工具和固定版本依赖。辅助源码不算独立组件。

### 文件树 · 默认示例

```bash
npx shadcn@latest add https://jiguang132.com/r/magic-ui/examples/file-tree/file-tree-demo.json
```

默认导入: `@/components/magicui/examples/file-tree-demo`

依赖: `@radix-ui/react-accordion@1.2.16`, `@radix-ui/react-scroll-area@1.2.14`, `@radix-ui/react-slot@1.3.0`, `class-variance-authority@0.7.1`, `clsx@2.1.1`, `lucide-react@1.24.0`, `tailwind-merge@3.6.0`

### 最小使用与主题

```tsx
import Demo from '@/components/magicui/examples/file-tree-demo';
import { ThemeProvider } from 'next-themes';
export default function Example() {
  return <ThemeProvider attribute="class" defaultTheme="system" enableSystem><Demo /></ThemeProvider>;
}

```

项目须先配置 Tailwind CSS v4、语义颜色变量和 dark 变体。已有 next-themes Provider 时复用它，不要重复嵌套。Next Link 示例需要 Next.js 环境；静态 Vite 项目可保留原生组件代码，并自行将示例的页面链接改为项目路由。部分演示图片、视频和推文依赖网络；示例不包含登录或后端服务。实用指南与示例标签已提供中文，上游详细英文参考及演示数据未宣称全文翻译。


## 源码参数参考

以下实现签名和类型从本地固定版本源码生成。保留可选属性、原生继承类型、联合分支和 never 限制；不会将其他设计系统的 API 混入。forwardRef 实现中的 ref 属于 React 引用，不是新增业务属性。此区域是原始类型参考，不是上游说明的全文翻译。


```ts
Tree({
      className,
      elements,
      initialSelectedId,
      initialExpandedItems,
      children,
      indicator = true,
      openIcon,
      closeIcon,
      sort = "default",
      dir,
      ...props
    }, ref)

Folder({
      className,
      element,
      value,
      isSelectable = true,
      isSelect,
      children,
      ...props
    }, ref)

File({
      value,
      className,
      handleSelect,
      onClick,
      isSelectable = true,
      isSelect,
      fileIcon,
      children,
      ...props
    }, ref)

CollapseButton({ className, elements, expandAll = false, children, ...props }, ref)
```



```ts
type TreeViewElement = {
  id: string
  name: string
  type?: "file" | "folder"
  isSelectable?: boolean
  children?: TreeViewElement[]
}

type TreeSortMode =
  "default" | "none" | ((a: TreeViewElement, b: TreeViewElement) => number)

type TreeViewProps = {
  initialSelectedId?: string
  indicator?: boolean
  elements?: TreeViewElement[]
  initialExpandedItems?: string[]
  openIcon?: React.ReactNode
  closeIcon?: React.ReactNode
  sort?: TreeSortMode
} & Omit<
  React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Root>,
  "defaultValue" | "onValueChange" | "type" | "value"
>

type FolderProps = {
  expandedItems?: string[]
  element: string
  isSelectable?: boolean
  isSelect?: boolean
} & React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Item>
```


### 源码中的解构默认值

只列出直接写在参数或 props 解构中的默认表达式。条件表达式、运行时主题和其他计算值请结合源码；这里不是全部行为的默认值清单。


```ts
// Tree
indicator = true

// Tree
sort = "default"

// Folder
isSelectable = true

// File
isSelectable = true

// CollapseButton
expandAll = false
```


### 原生与外部类型

以下外部类型仍由 React 或资源自身依赖定义，没有手工展开为虚构属性。实际可用类型以安装版本的 TypeScript 检查为准。


```ts
HTMLDivElement
React.ReactNode
Omit<
  React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Root>,
  "defaultValue" | "onValueChange" | "type" | "value"
>
React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Root>
React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Item>
React.HTMLAttributes<HTMLDivElement>
HTMLButtonElement
React.ButtonHTMLAttributes<HTMLButtonElement>
React.HTMLAttributes<HTMLButtonElement>
```

---

JGuang 全部资源索引: https://jiguang132.com/llms.txt