ThTreeV2虚拟化树形控件

在数据量过大时使用,虚拟树都能毫无压力地处理(支持万行数据)

依赖说明

element-ui vue-virtual-scroll-list

效果预览

基本使用

<template>
  <div>
    <th-tree-v2
        ref="refTree"
        height="200px"
        :data="treeData"
        show-checkbox
        node-key="id"
        :keeps="20"
    />
  </div>
</template>

<script>
export default {
  data () {
    return {
      treeData: [
        {
          id: '1',
          label: 'label的1',
          children: [
            {
              id: '1-1',
              label: 'label的1-1',
              children: [
                {
                  id: '1-1-1',
                  label: 'label的1-1-1',
                  disabled: true
                },
                {
                  id: '1-1-2',
                  label: 'label的1-1-2'
                },
                {
                  id: '1-1-3',
                  label: 'label的1-1-3'
                },
                {
                  id: '1-1-4',
                  label: 'label的1-1-4'
                }
              ]
            },
            {
              id: '1-2',
              label: 'label的1-2',
              children: [
                {
                  id: '1-2-1',
                  label: 'label的1-2-1'
                },
                {
                  id: '1-2-2',
                  label: 'label的1-2-2'
                }
              ]
            }
          ]
        },
        {
          id: '2-1',
          label: 'label的2-1',
          children: [
            {
              id: '2-1-1',
              label: 'label的2-1-1'
            },
            {
              id: '2-1-2',
              label: 'label的2-1-2'
            },
            {
              id: '2-1-3',
              label: 'label的2-1-3'
            }
          ]
        }
      ]
    }
  },
  methods: {
    filterNode (value, data) {
      if (!value) return true
      return data.label.indexOf(value) !== -1
    },
    getTreeData () {
      console.log(this.$refs.refTree.getCheckedNodes())
    }
  }
}
</script>

Attributes

参数	说明	类型	可选值	默认值
keeps	实际渲染数量,根据设置的高度合理设置	number	--	20
height	树形控件的高度	string	--	100%
data	树形数据	array	--	[]
node-key	每个树节点用来作为唯一标识的属性，整棵树应该是唯一的	string	--	''
props	配置选项,属性参考下面#Props	object	--	--
render-after-expand	是否在第一次展开某个树节点后才渲染其子节点	boolean	--	true
render-content	树节点的内容区的渲染 Function	Function(h, { node, data, store }	--	--
highlight-current	是否高亮当前选中节点，默认值是 false	boolean	--	false
default-expand-all	是否默认展开所有节点	boolean	--	false
expand-on-click-node	是否在点击节点的时候展开或者收缩节点， 默认值为 true，如果为 false，则只有点箭头图标的时候才会展开或者收缩节点	boolean	--	true
check-on-click-node	是否在点击节点的时候选中节点，默认值为 false，即只有在点击复选框时才会选中节点	boolean	--	false
auto-expand-parent	展开子节点的时候是否自动展开父节点	boolean	--	true
default-expanded-keys	默认展开的节点的 key 的数组	array	--	--
show-checkbox	节点是否可被选择	boolean	--	false
check-strictly	在显示复选框的情况下，是否严格的遵循父子不互相关联的做法，默认为 false	boolean	--	false
default-checked-keys	默认勾选的节点的 key 的数组	array	--	--
current-node-key	当前选中的节点	string/number	--	--
filter-node-method	对树节点进行筛选时执行的方法，返回 true 表示这个节点可以显示，返回 false 则表示这个节点会被隐藏	Function(value, data, node)	--	--
accordion	是否每次只打开一个同级树节点展开	boolean	--	false
indent	相邻级节点间的水平缩进，单位为像素	number	--	16
icon-class	自定义树节点的图标	string	--	--

Props

参数	说明	类型
label	显示字段	string, function(data, node)
disabled	是否禁用	boolean, function(data, node)
children	树节点	array

方法

方法名	说明	参数
filter	对树节点进行筛选操作	接收一个任意类型的参数，该参数会在 filter-node-method 中作为第一个参数
updateKeyChildren	通过 keys 设置节点子元素，使用此方法必须设置 node-key 属性	(key, data) 接收两个参数，1. 节点 key 2. 节点数据的数组
getCheckedNodes	若节点可被选择（即 show-checkbox 为 true），则返回目前被选中的节点所组成的数组	(leafOnly, includeHalfChecked) 接收两个 boolean 类型的参数，1. 是否只是叶子节点，默认值为 false 2. 是否包含半选节点，默认值为 false
setCheckedNodes	设置目前勾选的节点，使用此方法必须设置 node-key 属性	(nodes) 接收勾选节点数据的数组
getCheckedKeys	若节点可被选择（即 show-checkbox 为 true），则返回目前被选中的节点的 key 所组成的数组	(leafOnly) 接收一个 boolean 类型的参数，若为 true 则仅返回被选中的叶子节点的 keys，默认值为 false
setCheckedKeys	通过 keys 设置目前勾选的节点，使用此方法必须设置 node-key 属性	(keys, leafOnly) 接收两个参数，1. 勾选节点的 key 的数组 2. boolean 类型的参数，若为 true 则仅设置叶子节点的选中状态，默认值为 false
setChecked	通过 key / data 设置某个节点的勾选状态，使用此方法必须设置 node-key 属性	(key/data, checked, deep) 接收三个参数，1. 勾选节点的 key 或者 data 2. boolean 类型，节点是否选中 3. boolean 类型，是否设置子节点 ，默认为 false
getHalfCheckedNodes	若节点可被选择（即 show-checkbox 为 true），则返回目前半选中的节点所组成的数组	--
getHalfCheckedKeys	若节点可被选择（即 show-checkbox 为 true），则返回目前半选中的节点的 key 所组成的数组	--
getCurrentKey	获取当前被选中节点的 key，使用此方法必须设置 node-key 属性，若没有节点被选中则返回 null	--
getCurrentNode	获取当前被选中节点的 data，若没有节点被选中则返回 null	--
setCurrentKey	通过 key 设置某个节点的当前选中状态，使用此方法必须设置 node-key 属性	(key) 待被选节点的 key，若为 null 则取消当前高亮的节点
setCurrentNode	通过 node 设置某个节点的当前选中状态，使用此方法必须设置 node-key 属性	(node) 待被选节点的 node
getNode	根据 data 或者 key 拿到 Tree 组件中的 node	(data) 要获得 node 的 key 或者 data
remove	删除 Tree 中的一个节点，使用此方法必须设置 node-key 属性	(data) 要删除的节点的 data 或者 node
append	为 Tree 中的一个节点追加一个子节点	(data, parentNode) 接收两个参数，1. 要追加的子节点的 data 2. 子节点的 parent 的 data、key 或者 node
insertBefore	为 Tree 的一个节点的前面增加一个节点	(data, refNode) 接收两个参数，1. 要增加的节点的 data 2. 要增加的节点的后一个节点的 data、key 或者 node
insertAfter	为 Tree 的一个节点的后面增加一个节点	(data, refNode) 接收两个参数，1. 要增加的节点的 data 2. 要增加的节点的前一个节点的 data、key 或者 node

Events

事件名称	说明	回调参数
node-click	节点被点击时的回调	共三个参数，依次为：传递给 data 属性的数组中该节点所对应的对象、节点对应的 Node、节点组件本身
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、节点组件本身

Default Slot

事件名称	说明
default	自定义树节点的内容，参数为 { node, data }