TreeSelect 树选择

树型选择控件。

何时使用

类似 Select 的选择控件,可选择的数据结构是一个树形结构时,可以使用 TreeSelect,例如公司层级、学科系统、分类目录等等。

代码演示

基本

最简单的用法。

TreeSelect树选择 - 图1

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { TreeSelect } from 'choerodon-ui';
  4. const TreeNode = TreeSelect.TreeNode;
  5. class Demo extends React.Component {
  6. state = {
  7. value: undefined,
  8. };
  9. onChange = value => {
  10. this.setState({ value });
  11. };
  12. render() {
  13. return (
  14. <TreeSelect
  15. showSearch
  16. style={{ width: 300 }}
  17. value={this.state.value}
  18. dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  19. placeholder="Please select"
  20. allowClear
  21. treeDefaultExpandAll
  22. onChange={this.onChange}
  23. >
  24. <TreeNode value="parent 1" title="parent 1" key="0-1">
  25. <TreeNode value="parent 1-0" title="parent 1-0" key="0-1-1">

多选

多选的树选择。

TreeSelect树选择 - 图2

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { TreeSelect } from 'choerodon-ui';
  4. const TreeNode = TreeSelect.TreeNode;
  5. class Demo extends React.Component {
  6. state = {
  7. value: undefined,
  8. };
  9. onChange = value => {
  10. this.setState({ value });
  11. };
  12. render() {
  13. return (
  14. <TreeSelect
  15. showSearch
  16. style={{ width: 300 }}
  17. value={this.state.value}
  18. dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  19. placeholder="Please select"
  20. allowClear
  21. multiple
  22. treeDefaultExpandAll
  23. onChange={this.onChange}
  24. >
  25. <TreeNode value="parent 1" title="parent 1" key="0-1">

从数据直接生成

使用 treeData 把 JSON 数据直接生成树结构。

TreeSelect树选择 - 图3

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { TreeSelect } from 'choerodon-ui';
  4. const treeData = [
  5. {
  6. label: 'Node1',
  7. value: '0-0',
  8. key: '0-0',
  9. children: [
  10. {
  11. label: 'Child Node1',
  12. value: '0-0-1',
  13. key: '0-0-1',
  14. },
  15. {
  16. label: 'Child Node2',
  17. value: '0-0-2',
  18. key: '0-0-2',
  19. },
  20. ],
  21. },
  22. {
  23. label: 'Node2',
  24. value: '0-1',
  25. key: '0-1',
  26. },
  27. ];

可勾选

使用勾选框实现多选功能。

TreeSelect树选择 - 图4

  1. import React from 'react';
  2. import ReactDOM from 'react-dom';
  3. import { TreeSelect } from 'choerodon-ui';
  4. const SHOW_PARENT = TreeSelect.SHOW_PARENT;
  5. const treeData = [
  6. {
  7. label: 'Node1',
  8. value: '0-0',
  9. key: '0-0',
  10. children: [
  11. {
  12. label: 'Child Node1',
  13. value: '0-0-0',
  14. key: '0-0-0',
  15. },
  16. ],
  17. },
  18. {
  19. label: 'Node2',
  20. value: '0-1',
  21. key: '0-1',
  22. children: [
  23. {
  24. label: 'Child Node3',
  25. value: '0-1-0',
  26. key: '0-1-0',
  27. },

API

Tree props

参数说明类型默认值
allowClear显示清除按钮booleanfalse
defaultValue指定默认选中的条目string/string[]-
disabled是否禁用booleanfalse
dropdownClassName下拉菜单的 className 属性string-
dropdownMatchSelectWidth下拉菜单和选择器同宽booleantrue
dropdownStyle下拉菜单的样式object-
filterTreeNode是否根据输入项进行筛选,默认用 treeNodeFilterProp 的值作为要筛选的 TreeNode 的属性值boolean|Function(inputValue: string, treeNode: TreeNode) (函数需要返回 bool 值)Function
getPopupContainer菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例Function(triggerNode)() => document.body
labelInValue是否把每个选项的 label 包装到 value 中,会把 value 类型从 string 变为 {value: string, label: ReactNode, halfChecked(treeCheckStrictly 时有效): string[] } 的格式booleanfalse
loadData异步加载数据function(node)-
multiple支持多选(当设置 treeCheckable 时自动变为 true)booleanfalse
placeholder选择框默认文字string-
searchPlaceholder搜索框默认文字string-
showCheckedStrategy定义选中项回填的方式。TreeSelect.SHOW_ALL: 显示所有选中节点(包括父节点). TreeSelect.SHOW_PARENT: 只显示父节点(当父节点下所有子节点都选中时). 默认只显示子节点.enum{TreeSelect.SHOWALL, TreeSelect.SHOWPARENT, TreeSelect.SHOW_CHILD }TreeSelect.SHOW_CHILD
showSearch在下拉中显示搜索框(仅在单选模式下生效)booleanfalse
size选择框大小,可选 large smallstring‘default’
treeCheckable显示 checkboxbooleanfalse
treeCheckStrictlycheckable 状态下节点选择完全受控(父子节点选中状态不再关联),会使得 labelInValue 强制为 truebooleanfalse
treeDatatreeNodes 数据,如果设置则不需要手动构造 TreeNode 节点(value 在整个树范围内唯一)array<{value, label, children, [disabled, disableCheckbox, selectable]}>[]
treeDataSimpleMode使用简单格式的 treeData,具体设置参考可设置的类型 (此时 treeData 应变为这样的数据结构: [{id:1, pId:0, value:’1’, label:”test1”,…},…], pId 是父节点的 id)false|Array<{ id: string, pId: string, rootPId: null }>false
treeDefaultExpandAll默认展开所有树节点booleanfalse
treeDefaultExpandedKeys默认展开的树节点string[]-
treeNodeFilterProp输入项过滤对应的 treeNode 属性string‘value’
treeNodeLabelProp作为显示的 prop 设置string‘title’
value指定当前选中的条目string/string[]-
onChange选中树节点时调用此函数function(value, label, extra)-
onSearch文本框值变化时回调function(value: string)-
onSelect被选中时调用function(value, node, extra)-
searchValue搜索框的值,可以通过 onSearch 获取用户输入string-
autoClearSearchValue当多选模式下值被选择,自动清空搜索框booleantrue

Tree 方法

名称描述
blur()移除焦点
focus()获取焦点

TreeNode props

建议使用 treeData 来代替 TreeNode,免去手工构造麻烦

参数说明类型默认值
disableCheckbox禁掉 checkboxbooleanfalse
disabled是否禁用booleanfalse
isLeaf是否是叶子节点booleanfalse
key此项必须设置(其值在整个树范围内唯一)string-
title树节点显示的内容string|ReactNode‘—-‘
value默认根据此属性值进行筛选(其值在整个树范围内唯一)string-