TreeSelect
TreeSelect
Importimport { TreeSelect } from 'antd'; |
TreeSelect is similar to Select, but the values are provided in a tree like structure. Any data whose entries are defined in a hierarchical manner is fit to use this control. Examples of such case may include a corporate hierarchy, a directory structure, and so on.
Common props ref：Common props
| Property | Description | Type | Default | Version | Global Config |
|---|---|---|---|---|---|
| allowClear | Customize clear icon | boolean | { clearIcon?: ReactNode } | false | 5.8.0: Support object type | × |
| If auto clear search input value when multiple select is selected/deselected | boolean | true | × | ||
Whether has border style, please use variant instead | boolean | true | - | × | |
| classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 5.25.0 | |
| defaultOpen | Initial open state of dropdown | boolean | - | × | |
| defaultValue | To set the initial selected treeNode(s) | string | string[] | - | × | |
| disabled | Disabled or not | boolean | false | × | |
The className of dropdown menu, please use classNames.popup.root instead | string | - | - | × | |
Determine whether the popup menu and the select input are the same width, please use popupMatchSelectWidth instead | boolean | number | true | - | × | |
The className of dropdown menu, use classNames.popup.root instead | string | - | 4.23.0 | × | |
| popupMatchSelectWidth | Determine whether the popup menu and the select input are the same width. Default set min-width same as input. Will ignore when value less than select width. false will disable virtual scroll | boolean | number | true | 5.5.0 | × |
Customize dropdown content, use popupRender instead | (originNode: ReactNode, props) => ReactNode | - | × | ||
| popupRender | Customize dropdown content | (originNode: ReactNode, props) => ReactNode | - | × | |
To set the style of the dropdown menu, use styles.popup.root instead | CSSProperties | - | × | ||
| fieldNames | Customize node label, value, children field name | object | { label: label, value: value, children: children } | 4.17.0 | × |
Whether to filter treeNodes by input value. The value of treeNodeFilterProp is used for filtering by default | boolean | function(inputValue: string, treeNode: TreeNode) (should return boolean) | function | × | ||
| getPopupContainer | To set the container of the dropdown menu. The default is to create a div element in body, you can reset it to the scrolling area and make a relative reposition. example | function(triggerNode) | () => document.body | × | |
| labelInValue | Whether to embed label in value, turn the format of value from string to {value: string, label: ReactNode, halfChecked: boolean (Is the option list in a semi selected state and not displayed in the values)} | boolean | false | × | |
| listHeight | Config popup height | number | 256 | × | |
| loadData | Load data asynchronously. Will not load when filtering. Check FAQ for more info | function(node) | - | × | |
| maxCount | The maximum number of items that can be selected. Only takes effect when multiple=true. If (showCheckedStrategy = 'SHOW_ALL' and treeCheckStrictly is disabled) or showCheckedStrategy = 'SHOW_PARENT' is used, maxCount will not take effect. | number | - | 5.23.0 | × |
| maxTagCount | Max tag count to show. responsive will cost render performance | number | responsive | - | responsive: 4.10 | × |
| maxTagPlaceholder | Placeholder for not showing tags | ReactNode | function(omittedValues) | - | × | |
| maxTagTextLength | Max tag text length to show | number | - | × | |
| multiple | Support multiple or not, will be true when enable treeCheckable | boolean | false | × | |
| notFoundContent | Specify content to show when no result matches | ReactNode | Not Found | × | |
| open | Controlled open state of dropdown | boolean | - | × | |
| placeholder | Placeholder of the select input | string | - | × | |
| placement | The position where the selection box pops up | bottomLeft bottomRight topLeft topRight | bottomLeft | × | |
| prefix | The custom prefix | ReactNode | - | 5.22.0 | × |
Work with onSearch to make search value controlled | string | - | × | ||
Whether to show the arrow icon, please use suffixIcon={null} instead | boolean | true | - | × | |
| showCheckedStrategy | The way show selected item in box when treeCheckable set. Default: just show child nodes. TreeSelect.SHOW_ALL: show all checked treeNodes (include parent treeNode). TreeSelect.SHOW_PARENT: show checked treeNodes (just show parent treeNode) | TreeSelect.SHOW_ALL | TreeSelect.SHOW_PARENT | TreeSelect.SHOW_CHILD | TreeSelect.SHOW_CHILD | × | |
| showSearch | Support search or not | boolean | Object | single: false | multiple: true | × | |
| size | To set the size of the select input | large | medium | small | - | × | |
| status | Set validation status | 'error' | 'warning' | - | 4.19.0 | × |
| styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 5.25.0 | |
| suffixIcon | The custom suffix icon | ReactNode | <DownOutlined /> | × | |
| switcherIcon | Customize collapse/expand icon of tree node | ReactNode | ((props: AntTreeNodeProps) => ReactNode) | - | renderProps: 4.20.0 | 5.28.0 |
| tagRender | Customize tag render when multiple | (props) => ReactNode | - | × | |
| treeCheckable | Whether to show checkbox on the treeNodes | boolean | false | × | |
| treeCheckStrictly | Whether to check nodes precisely (in the checkable mode), means parent and child nodes are not associated, and it will make labelInValue be true | boolean | false | × | |
| treeData | Data of the treeNodes, manual construction work is no longer needed if this property has been set(ensure the Uniqueness of each value) | array<{ value, title, children, [disabled, disableCheckbox, selectable, checkable] }> | [] | × | |
| treeDataSimpleMode | Enable simple mode of treeData. Changes the treeData schema to: [{id:1, pId:0, value:'1', title:"test1",...},...] where pId is parent node's id). It is possible to replace the default id and pId keys by providing object to treeDataSimpleMode | boolean | object<{ id: string, pId: string, rootPId: string }> | false | × | |
| treeDefaultExpandAll | Whether to expand all treeNodes by default | boolean | false | × | |
| treeDefaultExpandedKeys | Default expanded treeNodes | string[] | - | × | |
| treeExpandAction | Tree title open logic when click, optional: false | click | doubleClick | string | boolean | false | 4.21.0 | × |
| treeExpandedKeys | Set expanded keys | string[] | - | × | |
| treeIcon | Shows the icon before a TreeNode's title. There is no default style; you must set a custom style for it if set to true | boolean | false | × | |
| treeLine | Show the line. Ref Tree - showLine | boolean | object | false | 4.17.0 | × |
| treeLoadedKeys | (Controlled) Set loaded tree nodes, work with loadData only | string[] | [] | × | |
Will be used for filtering if filterTreeNode returns true | string | value | × | ||
| treeNodeLabelProp | Will render as content of select | string | title | × | |
| treeTitleRender | Customize tree node title render | (nodeData) => ReactNode | - | 5.12.0 | × |
| value | To set the current selected treeNode(s) | string | string[] | - | × | |
| variant | Variants of selector | outlined | borderless | filled | underlined | outlined | 5.13.0 | underlined: 5.24.0 | 5.19.0 |
| virtual | Disable virtual scroll when set to false | boolean | true | 4.1.0 | × |
| onChange | A callback function, can be executed when selected treeNodes or input value change | function(value, label, extra) | - | × | |
| onClear | Called when clear | () => void | - | - | × |
Called when dropdown open, use onOpenChange instead | function(open) | - | × | ||
| onOpenChange | Called when dropdown open | (open: boolean) => void | - | × | |
| onPopupScroll | Called when dropdown scrolls | (event: UIEvent) => void | - | 5.17.0 | × |
| A callback function, can be executed when the search input changes | function(value: string) | - | × | ||
| onSelect | A callback function, can be executed when you select a treeNode | function(value, node, extra) | - | × | |
| onTreeExpand | A callback function, can be executed when treeNode expanded | function(expandedKeys) | - | × |
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| autoClearSearchValue | If auto clear search input value when multiple select is selected/deselected | boolean | true | |
| filterTreeNode | Whether to filter treeNodes by input value. The value of treeNodeFilterProp is used for filtering by default | boolean | function(inputValue: string, treeNode: TreeNode) (should return boolean) | function | |
| searchValue | Work with onSearch to make search value controlled | string | - | |
| treeNodeFilterProp | Will be used for filtering if filterTreeNode returns true | string | value | |
| onSearch | A callback function, can be executed when the search input changes | function(value: string) | - |
| Name | Description | Version |
|---|---|---|
| blur() | Remove focus | |
| focus() | Get focus |
We recommend you to use
treeDatarather thanTreeNode, to avoid the trouble of manual construction.
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| checkable | When Tree is checkable, set TreeNode display Checkbox or not | boolean | - | |
| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | |
| disabled | Disabled or not | boolean | false | |
| isLeaf | Leaf node or not | boolean | false | |
| key | Required property (unless using treeDataSimpleMode), should be unique in the tree | string | - | |
| selectable | Whether can be selected | boolean | true | |
| title | Content showed on the treeNodes | ReactNode | --- | |
| value | Will be treated as treeNodeFilterProp by default, should be unique in the tree | string | - |
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| indentSize | Indent width of tree | number | 24 |
| nodeHoverBg | Background color of hovered node | string | rgba(0,0,0,0.04) |
| nodeHoverColor | Text color of hovered node | string | rgba(0,0,0,0.88) |
| nodeSelectedBg | Background color of selected node | string | #e6f4ff |
| nodeSelectedColor | Text color of selected node | string | rgba(0,0,0,0.88) |
| switcherSize | Switcher width of tree | number | 24 |
| titleHeight | Node title height | number | 24 |
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| colorBgContainer | Container background color, e.g: default button, input box, etc. Be sure not to confuse this with `colorBgElevated`. | string | #ffffff |
| colorBgContainerDisabled | Control the background color of container in disabled state. | string | rgba(0,0,0,0.04) |
| colorBgElevated | Container background color of the popup layer, in dark mode the color value of this token will be a little brighter than `colorBgContainer`. E.g: modal, pop-up, menu, etc. | string | #ffffff |
| colorBgTextHover | Control the background color of text in hover state. | string | rgba(0,0,0,0.06) |
| colorBorder | Default border color, used to separate different elements, such as: form separator, card separator, etc. | string | #d9d9d9 |
| colorPrimary | Brand color is one of the most direct visual elements to reflect the characteristics and communication of the product. After you have selected the brand color, we will automatically generate a complete color palette and assign it effective design semantics. | string | #1677ff |
| colorPrimaryBorder | The stroke color under the main color gradient, used on the stroke of components such as Slider. | string | #91caff |
| colorPrimaryHover | Hover state under the main color gradient. | string | #4096ff |
| colorSplit | Used as the color of separator, this color is the same as colorBorderSecondary but with transparency. | string | rgba(5,5,5,0.06) |
| colorText | Default text color which comply with W3C standards, and this color is also the darkest neutral color. | string | rgba(0,0,0,0.88) |
| colorTextDisabled | Control the color of text in disabled state. | string | rgba(0,0,0,0.25) |
| colorTextQuaternary | The fourth level of text color is the lightest text color, such as form input prompt text, disabled color text, etc. | string | rgba(0,0,0,0.25) |
| colorWhite | Pure white color don't changed by theme | string | #fff |
| borderRadius | Border radius of base components | number | 6 |
| borderRadiusSM | SM size border radius, used in small size components, such as Button, Input, Select and other input components in small size | number | 4 |
| controlInteractiveSize | Control the interactive size of control component. | number | 16 |
| controlItemBgActiveDisabled | Control the background color of control component item when active and disabled. | string | rgba(0,0,0,0.15) |
| controlItemBgHover | Control the background color of control component item when hovering. | string | rgba(0,0,0,0.04) |
| fontFamily | The font family of Ant Design prioritizes the default interface font of the system, and provides a set of alternative font libraries that are suitable for screen display to maintain the readability and readability of the font under different platforms and browsers, reflecting the friendly, stable and professional characteristics. | string | -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji' |
| fontSize | The most widely used font size in the design system, from which the text gradient will be derived. | number | 14 |
| fontSizeLG | Large font size | number | 16 |
| fontWeightStrong | Control the font weight of heading components (such as h1, h2, h3) or selected item. | number | 600 |
| lineHeight | Line height of text. | number | 1.5714285714285714 |
| lineType | Border style of base components | string | solid |
| lineWidth | Border width of base components | number | 1 |
| lineWidthBold | The default line width of the outline class components, such as Button, Input, Select, etc. | number | 2 |
| lineWidthFocus | Control the width of the line when the component is in focus state. | number | 3 |
| marginXS | Control the margin of an element, with a small size. | number | 8 |
| motionDurationFast | Motion speed, fast speed. Used for small element animation interaction. | string | 0.1s |
| motionDurationMid | Motion speed, medium speed. Used for medium element animation interaction. | string | 0.2s |
| motionDurationSlow | Motion speed, slow speed. Used for large element animation interaction. | string | 0.3s |
| motionEaseInBack | Preset motion curve. | string | |
| motionEaseOutBack | Preset motion curve. | string | |
| paddingXS | Control the extra small padding of the element. | number | 8 |
We don't provide this since performance consideration. You can get by this way: https://codesandbox.io/s/get-parent-node-in-onchange-eb1608
You can ref Select FAQ.
loadData not trigger when searching?In earlier version, loadData will be triggered when searching. But we got feedback that it will block network when inputting. So we change it to not trigger loadData when searching. But you can still handle async logic by filterTreeNode:
<TreeSelectfilterTreeNode={(input, treeNode) => {const match = YOUR_LOGIC_HERE;if (match && !treeNode.isLeaf && !treeNode.children) {// Do some loading logic}return match;}}/>
Just turn off virtual scrolling, because the scrollWidth of the complete list cannot be accurately measured when virtual scrolling is turned on.