vue组织树（树形组件vue3)

2024-02-16 11:53| 来源: 网络整理| 查看: 265

vue-power-tree 内容列表介绍安装使用相关仓库维护者介绍

本插件在element-plus树形组件基础上，进行了二次封装。适用于vue3项目，在具备了element-plus 的Tree组件的所有功能的基础上，又增加了组织树展示效果，并同时支持拖拽，及自定义组织树的展开收起样式

npm

安装 # use npm npm install vue-power-tree # use yarn yarn add vue-power-tree 使用 # vue全局引用 import { createApp } from "vue" import App from "./App.vue" import VuePowerTree from "vue-power-tree" import "vue-power-tree/dist/style.css" const app = createApp(App) app.use(VuePowerTree) # 局部引用 import VuePowerTree from "vue-power-tree" import "vue-power-tree/dist/style.css"

vue中使用示例

- + import VuePowerTree from "vue-power-tree" import "vue-power-tree/dist/style.css" interface Tree { label: string children?: Tree[] } const handleNodeClick = (data: Tree) => { } const data: Tree[] = [ { id: 0, label: '主活动', children: [ { id: 2, label: '子活动1', children: [ { id: 5, label: '客群规则1' }, { id: 6, label: '客群规则2' } ] }, { id: 3, label: '子活动2', children: [ { id: 7, label: '客群规则3' }, { id: 8, label: '客群规则4' } ] }, { id: 4, label: '子活动3' }, { id: 9, label: '子活动4' } ] } ] const defaultProps = { children: 'children', label: 'label', } .minus, .plus { border: 1px solid red; background: #fff; width: 20px; height: 20px; display: flex; align-items: center; justify-content: center; }

本插件支持所有的element-plus的Tree组件功能，可参照，同时扩展了 tree-type属性控制树形显示

1. 属性属性说明类型可选值默认值data展示数据array——tree-type树显示方式，普通树形（element树），组织树显示 tree-type=‘org’stringnormalempty-text内容为空的时候展示的文本string——node-key每个树节点用来作为唯一标识的属性，整棵树应该是唯一的string——props配置选项，具体看下表object——render-after-expand是否在第一次展开某个树节点后才渲染其子节点boolean—trueload加载子树数据的方法，仅当 lazy 属性为true 时生效function(node, resolve)，node为当前点击的节点，resolve为数据加载完成的回调(必须调用)——render-content树节点的内容区的渲染 FunctionFunction(h, { node, data, store })——highlight-current是否高亮当前选中节点，默认值是 false。boolean—falsedefault-expand-all是否默认展开所有节点boolean—falseexpand-on-click-node是否在点击节点的时候展开或者收缩节点，默认值为 true，如果为 false，则只有点箭头图标的时候才会展开或者收缩节点。boolean—truecheck-on-click-node是否在点击节点的时候选中节点，默认值为 false，即只有在点击复选框时才会选中节点。boolean—falseauto-expand-parent展开子节点的时候是否自动展开父节点boolean—truedefault-expanded-keys默认展开的节点的 key 的数组array——show-checkbox节点是否可被选择boolean—falsecheck-strictly在显示复选框的情况下，是否严格的遵循父子不互相关联的做法，默认为 falseboolean—falsedefault-checked-keys默认勾选的节点的 key 的数组array——current-node-key当前选中的节点string, number——filter-node-method对树节点进行筛选时执行的方法，返回 false 则表示这个节点会被隐藏Function(value, data, node)——accordion是否每次只打开一个同级树节点展开boolean—falseindent相邻级节点间的水平缩进，单位为像素number—16icon自定义图标组件string / Component--lazy是否懒加载子节点，需与 load 方法结合使用boolean—falsedraggable是否开启拖拽节点功能boolean—falseallow-drag判断节点能否被拖拽如果返回 false ，节点不能被拖动Function(node)——allow-drop拖拽时判定目标节点能否成为拖动目标位置。如果返回 false ，拖动节点不能被拖放到目标节点。 type 参数有三种情况：‘prev’、‘inner’ 和 ‘next’，分别表示放置在目标节点前、插入至目标节点和放置在目标节点后Function(draggingNode, dropNode, type)—— 2. Props Props说明类型可选值默认值label指定节点标签为节点对象的某个属性值string, function(data, node)——children指定子树为节点对象的某个属性值string——disabled指定节点选择框是否禁用为节点对象的某个属性值string, function(data, node)——isLeaf指定节点是否为叶子节点，仅在指定了 lazy 属性的情况下生效string, function(data, node)——class自定义节点类名string, function(data, node)—— 3. 方法

Tree 组件有以下方法，均返回当前选中的节点数组

方法描述参数filter过滤所有树节点，过滤后的节点将被隐藏接收一个参数并指定为 filter-node-method 属性的第一个参数updateKeyChildren为节点设置新数据，只有当设置 node-key 属性的时候才可用(key, data) 接收两个参数: 1. 节点的 key 2. 新数据getCheckedNodes如果节点可以被选中，(show-checkbox 为 true), 本方法将返回当前选中节点的数组(leafOnly, includeHalfChecked) 接收两个布尔类型参数: 1. 默认值为 false. 若参数为 true, 它将返回当前选中节点的子节点 2. 默认值为 false. 如果参数为 true, 返回值包含半选中节点数据setCheckedNodes设置目前勾选的节点，使用此方法必须提前设置 node-key 属性要选中的节点构成的数组getCheckedKeys若节点可用被选中 (show-checkbox 为 true), 它将返回当前选中节点 key 的数组(leafOnly) 接收一个布尔类型参数，默认为 false. 如果参数是 true, 它只返回当前选择的子节点数组。setCheckedKeys设置目前选中的节点，使用此方法必须设置 node-key 属性(keys, leafOnly) 接收两个参数: 1. 一个需要被选中的多节点 key 的数组 2. 一个布尔类型参数，默认为 false. 如果参数是 true, 它只返回当前选择的子节点数组。setChecked设置节点是否被选中, 使用此方法必须设置 node-key 属性(key/data, checked, deep) 接收三个参数: 1. 要选中的节点的 key 或者数据 2. 一个布尔类型参数表明是否选中. 3. 一个布尔类型参数表明是否递归选中子节点getHalfCheckedNodes如果节点可用被选中 (show-checkbox 为 true), 它将返回当前半选中的节点组成的数组-getHalfCheckedKeys若节点可被选中(show-checkbox 为 true)，则返回目前半选中的节点的 key 所组成的数组-getCurrentKey返回当前被选中节点的数据 (如果没有则返回 null)—getCurrentNode返回当前被选中节点的数据 (如果没有则返回 null)—setCurrentKey通过 key 设置某个节点的当前选中状态，使用此方法必须设置 node-key 属性(key, shouldAutoExpandParent=true) 1. 待被选节点的 key，如果为 null, 取消当前选中的节点 2. 是否自动展开父节点setCurrentNode设置节点为选中状态，使用此方法必须设置 node-key 属性(node, shouldAutoExpandParent=true) 1. 待被选中的节点 2. 是否展开父节点getNode根据 data 或者 key 拿到 Tree 组件中的 node(data) 节点的 data 或 keyremove删除 Tree 中的一个节点，使用此方法必须设置 node-key 属性(data) 要删除的节点的 data 或者 node 对象append为 Tree 中的一个节点追加一个子节点(data, parentNode) 1. 要追加的子节点的 data 2. 父节点的 data, key 或 nodeinsertBefore在 Tree 中给定节点前插入一个节点(data, refNode) 1. 要增加的节点的 data 2. 参考节点的 data, key 或 nodeinsertAfter在 Tree 中给定节点后插入一个节点(data, refNode) 1. 要增加的节点的 data 2. 参考节点的 data, key 或 node 4. 事件事件名说明回调参数node-click当节点被点击的时候触发三个参数：对应于节点点击的节点对象， TreeNode 节点属性，事件对象node-contextmenu当某一节点被鼠标右键点击时会触发该事件共四个参数，依次为：event、传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身。check-change当复选框被点击的时候触发共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点本身是否被选中、节点的子树中是否有被选中的节点check点击节点复选框之后触发共两个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、树目前的选中状态对象，包含 checkedNodes、checkedKeys、halfCheckedNodes、halfCheckedKeys 四个属性current-change当前选中节点变化时触发的事件共两个参数，依次为：当前节点的数据，当前节点的 Node 对象node-expand节点被展开时触发的事件共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身node-collapse节点被关闭时触发的事件共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身node-drag-start节点开始拖拽时触发的事件共两个参数，依次为：被拖拽节点对应的 Node、eventnode-drag-enter拖拽进入其他节点时触发的事件共三个参数，依次为：被拖拽节点对应的 Node、所进入节点对应的 Node、eventnode-drag-leave拖拽离开某个节点时触发的事件共三个参数，依次为：被拖拽节点对应的 Node、所离开节点对应的 Node、eventnode-drag-over在拖拽节点时触发的事件（类似浏览器的 mouseover 事件）共三个参数，依次为：被拖拽节点对应的 Node、当前进入节点对应的 Node、eventnode-drag-end拖拽结束时（可能未成功）触发的事件共四个参数，依次为：被拖拽节点对应的 Node、结束拖拽时最后进入的节点（可能为空）、被拖拽节点的放置位置（before、after、inner）、eventnode-drop拖拽成功完成时触发的事件共四个参数，依次为：被拖拽节点对应的 Node、结束拖拽时最后进入的节点、被拖拽节点的放置位置（before、after、inner）、event 5. 插槽插槽名说明—自定义树节点的内容，自定义树节点的内容，参数为 { node, data }icon-node组织树形态下，自定义展开收起样式，可参考上面 vue中使用示例相关仓库 element-plus-tree - 饿了么Tree组件vue-power-tree 维护者

@liuzepeng

其他

欢迎访问github，star一下也欢迎提出issue，作者会及时完善，感谢

【本文地址】

vue组织树（树形组件vue3)

vue组织树（树形组件vue3)

今日新闻

推荐新闻