---
category: Components
type: 数据展示
title: Tree
subtitle: 树形控件
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Ag9_Q6ArswEAAAAAAAAAAAAADrJ8AQ/original
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*1GeUQJPTGUYAAAAAAAAAAAAADrJ8AQ/original
---

多层次的结构列表。

## 何时使用

文件夹、组织架构、生物分类、国家地区等等，世间万物的大多数结构都是树形结构。使用`树控件`可以完整展现其中的层级关系，并具有展开收起选择等交互功能。

## API

### Tree props

| 参数                  | 说明                                                                                                                                                                                                                                                | 类型                                                                                                                                             | 默认值                                           | 版本  |     |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | ----- | --- |
| allowDrop             | 是否允许拖拽时放置在该节点                                                                                                                                                                                                                          | ({ dropNode, dropPosition }) => boolean                                                                                                          | -                                                |       |
| autoExpandParent      | 是否自动展开父节点                                                                                                                                                                                                                                  | boolean                                                                                                                                          | false                                            |       |     |
| blockNode             | 是否节点占据一行                                                                                                                                                                                                                                    | boolean                                                                                                                                          | false                                            |       |     |
| checkable             | 节点前添加 Checkbox 复选框                                                                                                                                                                                                                          | boolean                                                                                                                                          | false                                            |       |     |
| checkedKeys(v-model)  | （受控）选中复选框的树节点（注意：父子节点有关联，如果传入父节点 key，则子节点自动选中；相应当子节点 key 都传入，父节点也自动选中。当设置`checkable`和`checkStrictly`，它是一个有`checked`和`halfChecked`属性的对象，并且父子节点的选中与否不再关联 | string\[] \| number\[] \| {checked: string\[] \| number\[], halfChecked: string\[] \| number\[]}                                                 | \[]                                              |       |     |
| checkStrictly         | checkable 状态下节点选择完全受控（父子节点选中状态不再关联）                                                                                                                                                                                        | boolean                                                                                                                                          | false                                            |       |     |
| defaultExpandAll      | 默认展开所有树节点, 如果是异步数据，需要在数据返回后再实例化，建议用 v-if="data.length"；当有 expandedKeys 时，defaultExpandAll 将失效                                                                                                              | boolean                                                                                                                                          | false                                            |       |     |
| disabled              | 将树禁用                                                                                                                                                                                                                                            | bool                                                                                                                                             | false                                            |       |     |
| draggable             | 设置节点可拖拽                                                                                                                                                                                                                                      | boolean                                                                                                                                          | false                                            |       |     |
| expandedKeys(v-model) | （受控）展开指定的树节点                                                                                                                                                                                                                            | string\[] \| number\[]                                                                                                                           | \[]                                              |       |     |
| fieldNames            | 替换 treeNode 中 title,key,children 字段为 treeData 中对应的字段                                                                                                                                                                                    | object                                                                                                                                           | {children:'children', title:'title', key:'key' } | 3.0.0 |     |
| filterTreeNode        | 按需筛选树节点（高亮），返回 true                                                                                                                                                                                                                   | function(node)                                                                                                                                   | -                                                |       |     |
| height                | 设置虚拟滚动容器高度，设置后内部节点不再支持横向滚动                                                                                                                                                                                                | number                                                                                                                                           | -                                                |       |
| loadData              | 异步加载数据                                                                                                                                                                                                                                        | function(node)                                                                                                                                   | -                                                |       |     |
| loadedKeys            | （受控）已经加载的节点，需要配合 `loadData` 使用                                                                                                                                                                                                    | string\[] \| number\[]                                                                                                                           | \[]                                              |       |     |
| multiple              | 支持点选多个节点（节点本身）                                                                                                                                                                                                                        | boolean                                                                                                                                          | false                                            |       |     |
| selectable            | 是否可选中                                                                                                                                                                                                                                          | boolean                                                                                                                                          | true                                             |       |     |
| selectedKeys(v-model) | （受控）设置选中的树节点                                                                                                                                                                                                                            | string\[] \| number\[]                                                                                                                           | -                                                |       |     |
| showIcon              | 是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式                                                                                                                                                             | boolean                                                                                                                                          | false                                            |       |     |
| showLine              | 是否展示连接线                                                                                                                                                                                                                                      | boolean \| {showLeafIcon: boolean}(3.0+)                                                                                                         | false                                            |       |     |
| switcherIcon          | 自定义树节点的展开/折叠图标                                                                                                                                                                                                                         | v-slot:switcherIcon="{active, checked, expanded, loading, selected, halfChecked, title, key, children, dataRef, data, defaultIcon, switcherCls}" | -                                                |       |     |
| title                 | 自定义标题                                                                                                                                                                                                                                          | slot                                                                                                                                             |                                                  | 2.0.0 |     |
| treeData              | treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（key 在整个树范围内唯一）                                                                                                                                                                    | [TreeNode\[\]](#treenode)                                                                                                                        | --                                               |       |     |
| virtual               | 设置 false 时关闭虚拟滚动                                                                                                                                                                                                                           | boolean                                                                                                                                          | true                                             | 3.0   |     |

### 事件

| 事件名称   | 说明                 | 回调参数                                                               |
| ---------- | -------------------- | ---------------------------------------------------------------------- |
| check      | 点击复选框触发       | function(checkedKeys, e:{checked: bool, checkedNodes, node, event})    |
| dragend    | dragend 触发时调用   | function({event, node})                                                |
| dragenter  | dragenter 触发时调用 | function({event, node, expandedKeys})                                  |
| dragleave  | dragleave 触发时调用 | function({event, node})                                                |
| dragover   | dragover 触发时调用  | function({event, node})                                                |
| dragstart  | 开始拖拽时调用       | function({event, node})                                                |
| drop       | drop 触发时调用      | function({event, node, dragNode, dragNodesKeys})                       |
| expand     | 展开/收起节点时触发  | function(expandedKeys, {expanded: bool, node})                         |
| load       | 节点加载完毕时触发   | function(loadedKeys, {event, node})                                    |
| rightClick | 响应右键点击         | function({event, node})                                                |
| select     | 点击树节点触发       | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) |

### Tree 方法

| 名称                                                                                      | 说明                            |
| ----------------------------------------------------------------------------------------- | ------------------------------- |
| scrollTo({ key: string \| number; align?: 'top' \| 'bottom' \| 'auto'; offset?: number }) | 虚拟滚动下，滚动到指定 key 条目 |

### TreeNode

| 参数            | 说明                                                                                                                                  | 类型             | 默认值               | 版本 |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -------------------- | ---- |
| checkable       | 当树为 checkable 时，设置独立节点是否展示 Checkbox                                                                                    | boolean          | -                    |      |
| class           | 节点的 class                                                                                                                          | string           | -                    |      |
| disableCheckbox | 禁掉 checkbox                                                                                                                         | boolean          | false                |      |
| disabled        | 禁掉响应                                                                                                                              | boolean          | false                |      |
| icon            | 自定义图标。可接收组件，props 为当前节点 props                                                                                        | slot\|slot-scope | -                    |      |
| isLeaf          | 设置为叶子节点(设置了`loadData`时有效)                                                                                                | boolean          | -                    |      |
| key             | 被树的 (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys 属性所用。注意：整个树范围内的所有节点的 key 值不能重复！ | string \| number | 内部计算出的节点位置 |      |
| selectable      | 设置节点是否可被选中                                                                                                                  | boolean          | true                 |      |
| style           | 节点的 style                                                                                                                          | string\|object   | -                    |      |
| title           | 标题                                                                                                                                  | string           | '---'                |      |

### DirectoryTree props

| 参数         | 说明                                              | 类型   | 默认值 |
| ------------ | ------------------------------------------------- | ------ | ------ |
| expandAction | 目录展开逻辑，可选 `false` `'click'` `'dblclick'` | string | click  |

## FAQ

### 在 showLine 时，如何隐藏子节点图标？

文件图标通过 switcherIcon 来实现，如果不需要你可以覆盖对应的样式
