ant-design/components/tree/index.zh-CN.md

62 lines
3.7 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
type: Data Display
2016-07-21 10:15:00 +08:00
title: Tree
subtitle: 树形控件
2016-03-31 14:17:09 +08:00
---
2015-08-01 14:08:04 +08:00
2015-08-05 21:18:34 +08:00
## 何时使用
2015-08-06 14:11:02 +08:00
文件夹、组织架构、生物分类、国家地区等等,世间万物的大多数结构都是树形结构。使用`树控件`可以完整展现其中的层级关系,并具有展开收起选择等交互功能。
2015-08-06 09:17:40 +08:00
## API
2015-08-15 23:45:25 +08:00
### Tree props
| 参数 | 说明 | 类型 | 默认值 |
|-----------|------------------------------------------|------------|--------|
2016-11-04 11:55:20 +08:00
|multiple | 支持点选多个节点(节点本身) | bool | false |
|checkable | 节点前添加 Checkbox 复选框 | bool | false |
2016-01-07 19:05:55 +08:00
|defaultExpandAll | 默认展开所有树节点 | bool | false |
2015-12-30 17:54:07 +08:00
|defaultExpandedKeys | 默认展开指定的树节点 | String[] | [] |
2016-01-07 19:05:55 +08:00
|expandedKeys | (受控)展开指定的树节点 | String[] | [] |
|autoExpandParent | 是否自动展开父节点 | bool | true |
2015-08-19 12:18:10 +08:00
|defaultCheckedKeys | 默认选中复选框的树节点 | String[] | [] |
2016-06-29 18:01:52 +08:00
|checkedKeys | 受控选中复选框的树节点注意父子节点有关联如果传入父节点key则子节点自动选中相应当子节点key都传入父节点也自动选中。当设置`checkable`和`checkStrictly`,它是一个有`checked`和`halfChecked`属性的对象,并且父子节点的选中与否不再关联 | String[]/{checked:Array<String>,halfChecked:Array<String>} | [] |
2016-04-07 18:16:49 +08:00
|checkStrictly| checkable状态下节点选择完全受控父子节点选中状态不再关联| bool | false |
2015-08-19 12:18:10 +08:00
|defaultSelectedKeys | 默认选中的树节点 | String[] | [] |
2016-04-07 18:16:49 +08:00
|selectedKeys | (受控)设置选中的树节点 | String[] | - |
|onExpand | 展开/收起节点时触发 | function(expandedKeys, {expanded: bool, node}) | - |
2016-01-29 11:31:10 +08:00
|onCheck | 点击复选框触发 | function(checkedKeys, e:{checked: bool, checkedNodes, node, event}) | - |
|onSelect | 点击树节点触发 | function(selectedKeys, e:{selected: bool, selectedNodes, node, event}) | - |
|filterTreeNode | 按需筛选树节点高亮返回true | function(node) | - |
2016-01-07 19:05:55 +08:00
|loadData | 异步加载数据 | function(node)| - |
2016-01-28 15:13:17 +08:00
|onRightClick | 响应右键点击 | function({event,node}) | - |
2016-01-07 19:05:55 +08:00
|draggable | 设置节点可拖拽IE>8 | bool | false |
|onDragStart | 开始拖拽时调用 | function({event,node}) | - |
|onDragEnter | dragenter 触发时调用 | function({event,node,expandedKeys}) | - |
|onDragOver | dragover 触发时调用 | function({event,node}) | - |
|onDragLeave | dragleave 触发时调用 | function({event,node}) | - |
|onDragEnd | dragend 触发时调用 | function({event,node}) | - |
|onDrop | drop 触发时调用 | function({event, node, dragNode, dragNodesKeys}) | - |
2015-08-15 23:45:25 +08:00
### TreeNode props
| 参数 | 说明 | 类型 | 默认值 |
2015-08-06 09:17:40 +08:00
|-----------|------------------------------------------|------------|--------|
2015-08-15 23:45:25 +08:00
|disabled | 禁掉响应 | bool | false |
2016-01-07 19:05:55 +08:00
|disableCheckbox | 禁掉 checkbox | bool | false |
2016-04-10 16:26:31 +08:00
|title | 标题 | String/element | '---' |
2016-01-07 19:05:55 +08:00
|key | 被树的 (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys 属性所用。注意:整个树范围内的所有节点的 key 值不能重复! | String | 内部计算出的节点位置 |
|isLeaf | 设置为叶子节点 | bool | false |
2016-07-25 12:15:59 +08:00
## 注意
2017-01-06 10:46:25 +08:00
树节点可以有很多,但在设置`checkable`时,将会花费更多的计算时间,因此我们缓存了一些计算结果(`this.treeNodesStates`)来复用,避免多次重复计算,以此提高性能。但这也带来了一些限制,当你异步加载树节点时,你需要这样渲染树:
```jsx
{this.state.treeData.length
? <Tree>{this.state.treeData.map(data => <TreeNode />)}</Tree>
: 'loading tree'}
```