TreeSelect 树选择

大约 4 分钟

TreeSelect 树选择

树型选择控件。

何时使用

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

基础树选择:

可多选树选择:

线性样式树选择:

可搜索树选择:

API

Tree props

参数说明类型默认值版本
allowClear显示清除按钮booleanfalse
defaultValue指定默认选中的条目string | string[]-
disabled是否禁用booleanfalse
dropdownClassName下拉菜单的 className 属性string-
dropdownMatchSelectWidth下拉菜单和选择器同宽。默认将设置 min-width,当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动boolean | numbertrue
dropdownStyle下拉菜单的样式object-
fieldNames替换 treeNode 中 label,value,children 字段为 treeData 中对应的字段object{children:'children', label:'title', value: 'value' }3.0.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: VNode, halfChecked(treeCheckStrictly 时有效): string[] } 的格式booleanfalse
listHeight设置弹窗滚动高度number256
loadData异步加载数据function(node)-
maxTagCount最多显示多少个 tagnumber-
maxTagPlaceholder隐藏 tag 时显示的内容slot | function(omittedValues)-
multiple支持多选(当设置 treeCheckable 时自动变为 true)booleanfalse
notFoundContent当下拉列表为空时显示的内容slotNot Found
placeholder选择框默认文字string | slot-
replaceFields替换 treeNode 中 label,value,key,children 字段为 treeData 中对应的字段object{children:'children', label:'title', key:'key', value: 'value'}1.6.1 (3.0.0 废弃)
searchPlaceholder搜索框默认文字string | slot-
searchValue(v-model)搜索框的值,可以通过 search 事件获取用户输入string-
showCheckedStrategy定义选中项回填的方式。TreeSelect.SHOW_ALL: 显示所有选中节点(包括父节点). TreeSelect.SHOW_PARENT: 只显示父节点(当父节点下所有子节点都选中时). 默认只显示子节点.enum{TreeSelect.SHOW_ALL, TreeSelect.SHOW_PARENT, TreeSelect.SHOW_CHILD }TreeSelect.SHOW_CHILD
showSearch(*)在下拉中显示搜索框(仅在单选模式下生效)booleanfalse
showArrow(*)在下拉中显示下拉箭头(当为multiple时自动变为false)booleantrue
size选择框大小,可选 large smallstring'default'
suffixIcon自定义的选择框后缀图标VNode | slot-
tagRender自定义 tag 内容,多选时生效slot-3.0
title自定义标题slot3.0.0
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[] | number[]-
treeExpandedKeys(v-model)设置展开的树节点string[] | number[]-
treeIcon是否展示 TreeNode title 前的图标,没有默认样式,如设置为 true,需要自行定义图标相关样式booleanfalse
treeLine是否展示线条样式,请参考 Tree - showLineboolean | objectfalse3.0
treeNodeFilterProp输入项过滤对应的 treeNode 属性string'value'
treeNodeLabelProp作为显示的 prop 设置string'title'
value(v-model)指定当前选中的条目string | string[]-
virtual设置 false 时关闭虚拟滚动booleantrue3.0

注意

  • showSearch 存在bug,不仅仅是在单选模式下生效
  • showArrow 存在bug, 比如showArrow默认为true,但在model为multiple时不生效,需要显示设置showArrow

事件

事件名称说明回调参数版本
change选中树节点时调用此函数function(value, label, extra)
dropdownVisibleChange展开下拉菜单的回调function(open)3.0
search文本框值变化时回调function(value: string)
select被选中时调用function(value, node, extra)
treeExpand展开节点时调用function(expandedKeys)

Tree 方法

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

TreeNode props

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

参数说明类型默认值版本
checkable当树为 checkable 时,设置独立节点是否展示 Checkboxboolean-
disableCheckbox禁掉 checkboxbooleanfalse
disabled是否禁用booleanfalse
isLeaf是否是叶子节点booleanfalse
key此项必须设置(其值在整个树范围内唯一)`stringnumber`-
selectable是否可选booleantrue
title树节点显示的内容`stringslot`'---'
value默认根据此属性值进行筛选(其值在整个树范围内唯一)string-
上次编辑于:
贡献者: jiapeng.duan,Noah.Su