树1 3Tree

展示树

可选树

单选树

子父级单独作为选项都可选择

仅末级可选

在树结构中有多个插槽,插入状态和操作

多选树

multiple 为 true 开启多选

多选树有两种点击交互逻辑,可通过 detachCheckAction 字段来设置是否将 check 事件同文字点击事件分离出来,默认为 false 不分离

若子父级都单独作为一个选项存在

若仅末级节点可选中,父级本身不承载内容仅作为分类存在

若子父级联动,即勾选子级父级为半选状态

分段hover样式

虚拟树

virtual 为 true 启用虚拟 tree

节点点击前回调

节点懒加载

API

属性

名称类型可选值/示例默认值说明
dataArray[]树结构数据
v-modelArray[]已选中选中节点信息
propsObject例如:{label:"name",children:"list",class:"mytree-node"}{}可配置节点信息,如节点显示的 label 对应字段、children 对应字段,以及节点 class 名配置
nodeKeyStringid节点唯一标识
multipleBooleantrue / falsefalse是否开启多选
defaultExpandAllBooleantrue / falsefalse是否默认全部展开
notNullBooleantrue/ falsetrue是否返回半选状态的数据
checkStrictlyBooleantrue/ falsefalse在多选的情况下是否严格的遵循父子不互相关联的做法
returnParentNodeBooleantrue/ falsefalse在多选的情况下change事件中是否返回父节点已勾选数据,与checkStrictly冲突
lastStageBooleantrue/ falsefalse是否仅末级可选
virtualBooleantrue/ falsefalse是否启用虚拟列表
filterNodeMethodFunction树筛选过滤函数
filterValueString树筛选关键字
detachCheckActionBooleantrue/ falsefalse多选状态下是否将 check 动作与行点击事件分离
readonlyBooleantrue/ falsefalse是否只读,该树只做展示
heightNumber0默认高度 100%
itemHeightNumber40节点默认高度,虚拟列表渲染时计算使用
indentNumber14水平缩进长度
detachHoverActionBooleantrue/ falsefalse是否将hover动作分离
widthAutoBooleantrue/ falsefalse树宽度是否自适应
selectedExpandBooleantrue/ falsetrue选中项是否展开,默认展开
multipleHighlightBooleantrue/ falsefalse多选情况下行是否高亮
highlightDisabledBooleantrue/ falsetrue多选情况下禁用节点是否可以高亮
highlightItemString''手动定义当前高亮元素的id或者自定义nodeKey 默认是空串
checkHighlightBooleantrue/ falsetrue多选情况下勾选节点是否高亮当前行
searchAsTreeBooleantrue/ falsefalse搜索面板是否以树型展示结果
dataAutoSelectBooleantrue/ falsetrue特殊场景适用,为false时树data节点checked状态由数据控制且不会触发自动计算关联节点勾选状态
beforeClickFunction节点点击事件前钩子函数,会返回当前点击节点,上一个点击节点,和放行函数,若放行函数不执行则该次点击无效
lazyBooleantrue/ falsefalse懒加载节点,需配合load属性使用,可懒加载节点通过children对应字段标记
loadFunction(node,done)=>done([])lazy为true时生效,节点展开前触发,函数形参为当前节点和回调函数,回调函数中需返回数据为当前节点的子节点数据

事件

名称参数说明
change(ids:TreeNode[],selectNode:TreeNode,currentNode:TreeNode)选中回调,ids 为已选中节点 id 数组,selectNode 为当前选中的节点信息,currentNode 为当前操作的节点信息,如为空则该change事件非交互产生
nodeClick(currentNode:TreeNode)节点点击回调,currentNode 为当前操作的节点信息
nodeEnter(e:Event,currentNode:TreeNode)节点鼠标移入回调,currentNode 为当前的节点信息
nodeLeave(e:Event,currentNode:TreeNode)节点鼠标移出回调,currentNode 为当前的节点信息
nodeExpand(currentNode:TreeNode)节点展开事件,currentNode 为当前的节点信息
nodeCollapse(currentNode:TreeNode)节点收起事件,currentNode 为当前的节点信息

方法

名称参数说明
checkAll(status:Boolean)多选情况下的可选节点的全选/全不选
changeExpand(status:Boolean)展开/收起 整颗树

Slot

名称说明
nodePrefix节点前缀
nodeSuffix节点后缀
rowSuffix节点行后缀
nodeSlot节点插槽,用于自定义渲染节点
searchSlot搜索面板插槽,用于自定义搜索结果面板

节点属性

名称说明
id节点默认唯一标识 可通过配置修改字段
name节点默认label 可通过配置修改字段
children节点子集
uncheckable节点是否不可选
disabled节点是否禁用

最近更新于: