树选择 TreeSelect

何时使用

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

代码演示

API

通用属性参考：通用属性

Tree props

参数	说明	类型	默认值	版本
allowClear	自定义清除按钮	boolean \| { clearIcon?: ReactNode }	false	5.8.0: 支持对象形式
autoClearSearchValue	当多选模式下值被选择，自动清空搜索框	boolean	true
defaultValue	指定默认选中的条目	string \| string[]	-
disabled	是否禁用	boolean	false
popupClassName	下拉菜单的 className 属性	string	-	4.23.0
popupMatchSelectWidth	下拉菜单和选择器同宽。默认将设置 `min-width`，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动	boolean \| number	true	5.5.0
dropdownRender	自定义下拉框内容	(originNode: ReactNode, props) => ReactNode	-
dropdownStyle	下拉菜单的样式	object	-
fieldNames	自定义节点 label、value、children 的字段	object	{ label: `label`, value: `value`, children: `children` }	4.17.0
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[] } 的格式	boolean	false
listHeight	设置弹窗滚动高度	number	256
loadData	异步加载数据。在过滤时不会调用以防止网络堵塞，可参考 FAQ 获得更多内容	function(node)	-
maxTagCount	最多显示多少个 tag，响应式模式会对性能产生损耗	number \| `responsive`	-	responsive: 4.10
maxTagPlaceholder	隐藏 tag 时显示的内容	ReactNode \| function(omittedValues)	-
maxTagTextLength	最大显示的 tag 文本长度	number	-
multiple	支持多选（当设置 treeCheckable 时自动变为 true）	boolean	false
notFoundContent	当下拉列表为空时显示的内容	ReactNode	`Not Found`
placeholder	选择框默认文字	string	-
placement	选择框弹出的位置	`bottomLeft` `bottomRight` `topLeft` `topRight`	bottomLeft
prefix	自定义前缀	ReactNode	-	5.22.0
searchValue	搜索框的值，可以通过 `onSearch` 获取用户输入	string	-
showCheckedStrategy	配置 `treeCheckable` 时，定义选中项回填的方式。`TreeSelect.SHOW_ALL`: 显示所有选中节点(包括父节点)。`TreeSelect.SHOW_PARENT`: 只显示父节点(当父节点下所有子节点都选中时)。默认只显示子节点	`TreeSelect.SHOW_ALL` \| `TreeSelect.SHOW_PARENT` \| `TreeSelect.SHOW_CHILD`	`TreeSelect.SHOW_CHILD`
showSearch	是否支持搜索框	boolean	单选：false \| 多选：true
size	选择框大小	`large` \| `middle` \| `small`	-
status	设置校验状态	'error' \| 'warning'	-	4.19.0
suffixIcon	自定义的选择框后缀图标	ReactNode	`<DownOutlined />`
switcherIcon	自定义树节点的展开/折叠图标	ReactNode \| ((props: AntTreeNodeProps) => ReactNode)	-	renderProps: 4.20.0
tagRender	自定义 tag 内容，多选时生效	(props) => ReactNode	-
treeCheckable	显示 Checkbox	boolean	false
treeCheckStrictly	`checkable` 状态下节点选择完全受控（父子节点选中状态不再关联），会使得 `labelInValue` 强制为 true	boolean	false
treeData	treeNodes 数据，如果设置则不需要手动构造 TreeNode 节点（value 在整个树范围内唯一）	array<{value, title, children, [disabled, disableCheckbox, selectable, checkable]}>	[]
treeDataSimpleMode	使用简单格式的 treeData，具体设置参考可设置的类型 (此时 treeData 应变为这样的数据结构: [{id:1, pId:0, value:'1', title:"test1",...},...]， `pId` 是父节点的 id)	boolean \| object<{ id: string, pId: string, rootPId: string }>	false
treeTitleRender	自定义渲染节点	(nodeData) => ReactNode	-	5.12.0
treeDefaultExpandAll	默认展开所有树节点	boolean	false
treeDefaultExpandedKeys	默认展开的树节点	string[]	-
treeExpandAction	点击节点 title 时的展开逻辑，可选：false \| `click` \| `doubleClick`	string \| boolean	false	4.21.0
treeExpandedKeys	设置展开的树节点	string[]	-
treeIcon	是否展示 TreeNode title 前的图标，没有默认样式，如设置为 true，需要自行定义图标相关样式	boolean	false
treeLine	是否展示线条样式，请参考 Tree - showLine	boolean \| object	false	4.17.0
treeLoadedKeys	（受控）已经加载的节点，需要配合 `loadData` 使用	string[]	[]
treeNodeFilterProp	输入项过滤对应的 treeNode 属性	string	`value`
treeNodeLabelProp	作为显示的 prop 设置	string	`title`
value	指定当前选中的条目	string \| string[]	-
variant	形态变体	`outlined` \| `borderless` \| `filled`	`outlined`	5.13.0
virtual	设置 false 时关闭虚拟滚动	boolean	true	4.1.0
onChange	选中树节点时调用此函数	function(value, label, extra)	-
onDropdownVisibleChange	展开下拉菜单的回调	function(open)	-
onSearch	文本框值变化时的回调	function(value: string)	-
onSelect	被选中时调用	function(value, node, extra)	-
onTreeExpand	展示节点时调用	function(expandedKeys)	-
onPopupScroll	下拉列表滚动时的回调	(event: UIEvent) => void	-	5.17.0

Tree 方法

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

TreeNode props

建议使用 treeData 来代替 TreeNode，免去手动构造的麻烦

参数	说明	类型	默认值
checkable	当树为 Checkbox 时，设置独立节点是否展示 Checkbox	boolean	-
disableCheckbox	禁掉 Checkbox	boolean	false
disabled	是否禁用	boolean	false
isLeaf	是否是叶子节点	boolean	false
key	此项必须设置（其值在整个树范围内唯一）	string	-
selectable	是否可选	boolean	true
title	树节点显示的内容	ReactNode	`---`
value	默认根据此属性值进行筛选（其值在整个树范围内唯一）	string	-

主题变量（Design Token）

Token 名称	描述	类型	默认值
indentSize	缩进宽度	number	24
nodeHoverBg	节点悬浮态背景色	string	rgba(0, 0, 0, 0.04)
nodeHoverColor	节点悬浮态态文字颜色	string	rgba(0, 0, 0, 0.88)
nodeSelectedBg	节点选中态背景色	string	#e6f4ff
nodeSelectedColor	节点选中态文字颜色	string	rgba(0, 0, 0, 0.88)
titleHeight	节点标题高度	number	24

FAQ

onChange 时如何获得父节点信息？

从性能角度考虑，我们默认不透出父节点信息。你可以这样获得：https://codesandbox.io/s/get-parent-node-in-onchange-eb1608

自定义 Option 样式导致滚动异常怎么办？

请参考 Select 的 FAQ。

为何在搜索时 `loadData` 不会触发展开？

在 v4 alpha 版本中，默认在搜索时亦会进行搜索。但是经反馈，在输入时会快速阻塞网络。因而改为搜索不触发 loadData。但是你仍然可以通过 filterTreeNode 处理异步加载逻辑：

<TreeSelect
  filterTreeNode={(input, treeNode) => {
    const match = YOUR_LOGIC_HERE;

    if (match && !treeNode.isLeaf && !treeNode.children) {
      // Do some loading logic
    }

    return match;
  }}
/>

为何弹出框不能横向滚动？

关闭虚拟滚动即可，因为开启虚拟滚动时无法准确的测量完整列表的 scrollWidth。

Ant Design

TreeSelect
树选择

何时使用

代码演示

API

Tree props

Tree 方法

TreeNode props

主题变量（Design Token）

组件 Token如何定制？

全局 Token如何定制？

FAQ

onChange 时如何获得父节点信息？

自定义 Option 样式导致滚动异常怎么办？

为何在搜索时 `loadData` 不会触发展开？

为何弹出框不能横向滚动？

TreeSelect树选择

何时使用

代码演示

API

Tree props

Tree 方法

TreeNode props

主题变量（Design Token）

组件 Token如何定制？

全局 Token如何定制？

FAQ

onChange 时如何获得父节点信息？

自定义 Option 样式导致滚动异常怎么办？

为何在搜索时 loadData 不会触发展开？

为何弹出框不能横向滚动？

TreeSelect
树选择

为何在搜索时 `loadData` 不会触发展开？