Tree 树形控件
uni-appH5微信小程序App
uni-app 跨端树形控件。展示层级数据,支持展开/收起、单选高亮、级联勾选(父级勾选/取消所有子孙,子级部分勾选时父级半选)。内部将树扁平化为可见行渲染,不依赖递归组件,兼容小程序与 uni-app X。
何时使用
展示和操作层级数据:目录、组织架构、多级分类。
何时不使用
只是让用户选一条层级路径时,用 Cascader 更省空间。
本文档为 uni-app 端组件契约;Web 端同名组件 API 可能略有差异,请以对应包文档为准。下方手机预览实时运行 uni-app H5 演示。
Props
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
nodes | Array<TreeNode> | [] | 树数据,项为 { label: string; value: string | number; children?: 同构; disabled?: boolean } |
expandAll | boolean | false | 默认展开全部有子节点的节点 |
checkable | boolean | false | 是否显示复选框;勾选父级级联勾选/取消所有子孙,子级部分勾选时父级显示半选 |
checkedKeys | Array<string | number> | [] | 勾选的 key 列表,配合 v-model:checkedKeys 使用 |
selectedKey | string | number | null | null | 单选高亮的 key,配合 v-model:selectedKey 使用;点击节点即更新 |
expandedKeys | Array<string | number> | "undefined(内部维护展开态)" | 展开的 key 列表,配合 v-model:expandedKeys 受控使用;不传时由组件内部维护 |
indent | number | 16 | 每层缩进(px) |
Events
| 名称 | 载荷 | 说明 |
|---|---|---|
update:checkedKeys | Array<string | number> | 勾选变化时触发,用于 v-model:checkedKeys |
update:selectedKey | string | number | null | 点击节点时触发,用于 v-model:selectedKey |
update:expandedKeys | Array<string | number> | 展开/收起节点时触发,用于 v-model:expandedKeys |
node-click | TreeNode | 点击节点时触发;disabled 节点不触发 |
示例
基础用法
vue
<Tree :nodes="deptTree" expand-all />可勾选
vue
<Tree :nodes="deptTree" checkable expand-all v-model:checked-keys="s" />默认选中
vue
<Tree :nodes="deptTree" expand-all selected-key="fe" />