Tree
Tree
Importimport { Tree } from 'antd'; |
Almost anything can be represented in a tree structure. Examples include directories, organization hierarchies, biological classifications, countries, etc. The Tree component is a way of representing the hierarchical relationship between these things. You can also expand, collapse, and select a treeNode within a Tree.
Common props ref：Common props
| Property | Description | Type | Default | Version | Global Config |
|---|---|---|---|---|---|
| allowDrop | Whether to allow dropping on the node | ({ dropNode, dropPosition }) => boolean | - | × | |
| autoExpandParent | Whether to automatically expand a parent treeNode | boolean | false | × | |
| blockNode | Whether treeNode fill remaining horizontal space | boolean | false | × | |
| checkable | Add a Checkbox before the treeNodes | boolean | false | × | |
| checkedKeys | (Controlled) Specifies the keys of the checked treeNodes (PS: When this specifies the key of a treeNode which is also a parent treeNode, all the children treeNodes of will be checked; and vice versa, when it specifies the key of a treeNode which is a child treeNode, its parent treeNode will also be checked. When checkable and checkStrictly is true, its object has checked and halfChecked property. Regardless of whether the child or parent treeNode is checked, they won't impact each other | string[] | {checked: string[], halfChecked: string[]} | [] | × | |
| checkStrictly | Check treeNode precisely; parent treeNode and children treeNodes are not associated | boolean | false | × | |
| classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 6.0.0 | |
| defaultCheckedKeys | Specifies the keys of the default checked treeNodes | string[] | [] | × | |
| defaultExpandAll | Whether to expand all treeNodes by default | boolean | false | × | |
| defaultExpandedKeys | Specify the keys of the default expanded treeNodes | string[] | [] | × | |
| defaultExpandParent | If auto expand parent treeNodes when init | boolean | true | × | |
| defaultSelectedKeys | Specifies the keys of the default selected treeNodes | string[] | [] | × | |
| disabled | Whether the tree is disabled | boolean | false | × | |
| draggable | Specifies whether this Tree or the node is draggable. Use icon: false to disable drag handler icon | boolean | ((node: DataNode) => boolean) | { icon?: React.ReactNode | false, nodeDraggable?: (node: DataNode) => boolean } | false | config: 4.17.0 | × |
| expandedKeys | (Controlled) Specifies the keys of the expanded treeNodes | string[] | [] | × | |
| fieldNames | Customize node title, key, children field name | object | { title: title, key: key, children: children } | 4.17.0 | × |
| filterTreeNode | Defines a function to filter (highlight) treeNodes. When the function returns true, the corresponding treeNode will be highlighted | function(node) | - | × | |
| height | Config virtual scroll height. Will not support horizontal scroll when enabled | number | - | × | |
| icon | Insert a custom icon before the title. Need to set showIcon to true | ReactNode | (props) => ReactNode | - | × | |
| loadData | Load data asynchronously | function(node) | - | × | |
| loadedKeys | (Controlled) Set loaded tree nodes. Need to work with loadData | string[] | [] | × | |
| motion | Custom motion config for the tree | CSSMotionProps | - | × | |
| multiple | Allows selecting multiple treeNodes | boolean | false | × | |
| rootStyle | Style on the root element | CSSProperties | - | 4.20.0 | × |
| selectable | Whether it can be selected | boolean | true | × | |
| selectedKeys | (Controlled) Specifies the keys of the selected treeNodes, multiple selection needs to set multiple to true | string[] | - | × | |
| showIcon | Controls whether to display the icon node (no default style) | boolean | false | × | |
| showLine | Shows a connecting line | boolean | {showLeafIcon: ReactNode | ((props: AntTreeNodeProps) => ReactNode)} | false | × | |
| styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 6.0.0 | |
| switcherIcon | Customize expand/collapse icons for tree nodes (Will not rotate automatically in showLine mode) | ReactNode | ((props: AntTreeNodeProps) => ReactNode) | - | renderProps: 4.20.0 | × |
| switcherLoadingIcon | Customize loading icons for tree nodes | ReactNode | - | 5.20.0 | × |
| titleRender | Customize tree node title render | (nodeData) => ReactNode | - | 4.5.0 | × |
| treeData | The treeNodes data Array, if set it then you need not to construct children TreeNode. (key should be unique across the whole array) | array<{ key, title, children, [disabled, selectable] }> | - | × | |
| virtual | Disable virtual scroll when set to false | boolean | true | 4.1.0 | × |
| onCheck | Callback function for when the onCheck event occurs | function(checkedKeys, e:{checked: boolean, checkedNodes, node, event, halfCheckedKeys}) | - | × | |
| onDoubleClick | Callback function for when the user double clicks a treeNode | function(event, node) | - | × | |
| onDragEnd | Callback function for when the onDragEnd event occurs | function({event, node}) | - | × | |
| onDragEnter | Callback function for when the onDragEnter event occurs | function({event, node, expandedKeys}) | - | × | |
| onDragLeave | Callback function for when the onDragLeave event occurs | function({event, node}) | - | × | |
| onDragOver | Callback function for when the onDragOver event occurs | function({event, node}) | - | × | |
| onDragStart | Callback function for when the onDragStart event occurs | function({event, node}) | - | × | |
| onDrop | Callback function for when the onDrop event occurs | function({event, node, dragNode, dragNodesKeys}) | - | × | |
| onExpand | Callback function for when a treeNode is expanded or collapsed | function(expandedKeys, {expanded: boolean, node}) | - | × | |
| onLoad | Callback function for when a treeNode is loaded | function(loadedKeys, {event, node}) | - | × | |
| onRightClick | Callback function for when the user right clicks a treeNode | function({event, node}) | - | × | |
| onSelect | Callback function for when the user clicks a treeNode | function(selectedKeys, e:{selected: boolean, selectedNodes, node, event}) | - | × |
| Property | Description | Type | Default | |
|---|---|---|---|---|
| checkable | When Tree is checkable, set TreeNode display Checkbox or not | boolean | - | |
| disableCheckbox | Disables the checkbox of the treeNode | boolean | false | |
| disabled | Disables the treeNode | boolean | false | |
| icon | Customize icon. When you pass component, whose render will receive full TreeNode props as component props | ReactNode | (props) => ReactNode | - | |
| isLeaf | Determines if this is a leaf node (effective when loadData is specified). false will force the TreeNode to be treated as a parent node | boolean | - | |
| key | Used with (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. P.S.: It must be unique in all of treeNodes of the tree | string | (internal calculated position of treeNode) | |
| selectable | Set whether the treeNode can be selected | boolean | true | |
| title | Title | ReactNode | --- |
| Property | Description | Type | Default |
|---|---|---|---|
| expandAction | Directory opening logic, options: false | click | doubleClick | string | boolean | click |
Before 3.4.0: The number of treeNodes can be very large, but when checkable=true, it will increase the compute time. So, we cache some calculations (e.g. this.treeNodesStates) to avoid double computing. But, this brings some restrictions. When you load treeNodes asynchronously, you should render tree like this:
{this.state.treeData.length ? (<Tree>{this.state.treeData.map((data) => (<TreeNode />))}</Tree>) : ('loading tree');}
| Name | Description |
|---|---|
| scrollTo({ key: string | number; align?: 'top' | 'bottom' | 'auto'; offset?: number }) | Scroll to key item in virtual scroll |
| Token Name | Description | Type | Default Value |
|---|---|---|---|
| directoryNodeSelectedBg | Background color of selected directory node | string | #1677ff |
| directoryNodeSelectedColor | Text color of selected directory node | string | #fff |
| 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) |
| 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 | |
| motionEaseInOut | Preset motion curve. | string | |
| motionEaseOutBack | Preset motion curve. | string | |
| paddingXS | Control the extra small padding of the element. | number | 8 |
default prefix props only work when initializing. So defaultExpandAll has already been executed when ajax loads data. You can control expandedKeys or render the Tree when data is loaded to realize expanding all nodes.
Virtual scroll only render items in visible region. Thus not support auto width (like long title with horizontal scroll).
disabled node work logic in the tree?Tree change its data by conduction. Includes checked or auto expanded, it will conduction state to parent / children node until current node is disabled. So if a controlled node is disabled, it will only modify self state and not affect other nodes. For example, a parent node contains 3 child nodes and one of them is disabled. When check the parent node, it will only check rest 2 child nodes. As the same, when check these 2 child node, parent will be checked whatever checked state the disabled one is.
This conduction logic prevents modifying disabled parent checked state by checking children nodes, and users cannot modify directly with click which avoids interactive conflicts. If you want to modify this conduction logic, you can customize it with the checkStrictly prop.