TreeSelect树选择

树型选择控件。

何时使用

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

代码演示

TreeSelect 树选择 - 图1

基本

最简单的用法。

  1. import { TreeSelect } from 'choerodon-ui';
  2. const TreeNode = TreeSelect.TreeNode;
  3. class Demo extends React.Component {
  4. state = {
  5. value: undefined,
  6. };
  7. onChange = value => {
  8. this.setState({ value });
  9. };
  10. render() {
  11. return (
  12. <TreeSelect
  13. showSearch
  14. style={{ width: 300 }}
  15. value={this.state.value}
  16. dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  17. placeholder="Please select"
  18. allowClear
  19. treeDefaultExpandAll
  20. onChange={this.onChange}
  21. >
  22. <TreeNode value="parent 1" title="parent 1" key="0-1">
  23. <TreeNode value="parent 1-0" title="parent 1-0" key="0-1-1">
  24. <TreeNode value="leaf1" title="my leaf" key="random" />
  25. <TreeNode value="leaf2" title="your leaf" key="random1" />
  26. </TreeNode>
  27. <TreeNode value="parent 1-1" title="parent 1-1" key="random2">
  28. <TreeNode value="sss" title={<b style={{ color: '#08c' }}>sss</b>} key="random3" />
  29. </TreeNode>
  30. </TreeNode>
  31. </TreeSelect>
  32. );
  33. }
  34. }
  35. ReactDOM.render(<Demo />, mountNode);

TreeSelect 树选择 - 图2

从数据直接生成

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

  1. import { TreeSelect } from 'choerodon-ui';
  2. const treeData = [
  3. {
  4. label: 'Node1',
  5. value: '0-0',
  6. key: '0-0',
  7. children: [
  8. {
  9. label: 'Child Node1',
  10. value: '0-0-1',
  11. key: '0-0-1',
  12. },
  13. {
  14. label: 'Child Node2',
  15. value: '0-0-2',
  16. key: '0-0-2',
  17. },
  18. ],
  19. },
  20. {
  21. label: 'Node2',
  22. value: '0-1',
  23. key: '0-1',
  24. },
  25. ];
  26. class Demo extends React.Component {
  27. state = {
  28. value: undefined,
  29. };
  30. onChange = value => {
  31. this.setState({ value });
  32. };
  33. render() {
  34. return (
  35. <TreeSelect
  36. style={{ width: 300 }}
  37. value={this.state.value}
  38. dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  39. treeData={treeData}
  40. placeholder="Please select"
  41. treeDefaultExpandAll
  42. onChange={this.onChange}
  43. />
  44. );
  45. }
  46. }
  47. ReactDOM.render(<Demo />, mountNode);

TreeSelect 树选择 - 图3

多选

多选的树选择。

  1. import { TreeSelect } from 'choerodon-ui';
  2. const TreeNode = TreeSelect.TreeNode;
  3. class Demo extends React.Component {
  4. state = {
  5. value: undefined,
  6. };
  7. onChange = value => {
  8. this.setState({ value });
  9. };
  10. render() {
  11. return (
  12. <TreeSelect
  13. showSearch
  14. style={{ width: 300 }}
  15. value={this.state.value}
  16. dropdownStyle={{ maxHeight: 400, overflow: 'auto' }}
  17. placeholder="Please select"
  18. allowClear
  19. multiple
  20. treeDefaultExpandAll
  21. onChange={this.onChange}
  22. >
  23. <TreeNode value="parent 1" title="parent 1" key="0-1">
  24. <TreeNode value="parent 1-0" title="parent 1-0" key="0-1-1">
  25. <TreeNode value="leaf1" title="my leaf" key="random" />
  26. <TreeNode value="leaf2" title="your leaf" key="random1" />
  27. </TreeNode>
  28. <TreeNode value="parent 1-1" title="parent 1-1" key="random2">
  29. <TreeNode value="sss" title={<b style={{ color: '#08c' }}>sss</b>} key="random3" />
  30. </TreeNode>
  31. </TreeNode>
  32. </TreeSelect>
  33. );
  34. }
  35. }
  36. ReactDOM.render(<Demo />, mountNode);

TreeSelect 树选择 - 图4

可勾选

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

  1. import { TreeSelect } from 'choerodon-ui';
  2. const SHOW_PARENT = TreeSelect.SHOW_PARENT;
  3. const treeData = [
  4. {
  5. label: 'Node1',
  6. value: '0-0',
  7. key: '0-0',
  8. children: [
  9. {
  10. label: 'Child Node1',
  11. value: '0-0-0',
  12. key: '0-0-0',
  13. },
  14. ],
  15. },
  16. {
  17. label: 'Node2',
  18. value: '0-1',
  19. key: '0-1',
  20. children: [
  21. {
  22. label: 'Child Node3',
  23. value: '0-1-0',
  24. key: '0-1-0',
  25. },
  26. {
  27. label: 'Child Node4',
  28. value: '0-1-1',
  29. key: '0-1-1',
  30. },
  31. {
  32. label: 'Child Node5',
  33. value: '0-1-2',
  34. key: '0-1-2',
  35. },
  36. ],
  37. },
  38. ];
  39. class Demo extends React.Component {
  40. state = {
  41. value: ['0-0-0'],
  42. };
  43. onChange = value => {
  44. console.log('onChange ', value);
  45. this.setState({ value });
  46. };
  47. render() {
  48. const tProps = {
  49. treeData,
  50. value: this.state.value,
  51. onChange: this.onChange,
  52. treeCheckable: true,
  53. showCheckedStrategy: SHOW_PARENT,
  54. searchPlaceholder: 'Please select',
  55. style: {
  56. width: 300,
  57. },
  58. };
  59. return <TreeSelect {...tProps} />;
  60. }
  61. }
  62. ReactDOM.render(<Demo />, mountNode);

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.SHOW_ALL, TreeSelect.SHOW_PARENT, 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)-

Tree 方法

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

TreeNode props

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

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