0.1.2 • Published 4 months ago

@ibiz-template-package/vs-tree-ex v0.1.2

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

vs-tree2.0

极简树组件, 无任何依赖【麻雀虽小,五脏俱全】

浏览器支持

EdgeChromeFirefoxOperaSafari
Latest ✔Latest ✔Latest ✔Latest ✔Latest ✔

功能点

  • 基础树组件
  • 层级面包屑
  • 复选框
  • 单选框
  • 异步加载数据
  • 虚拟列表
  • 拖拽节点
  • 手风琴
  • 树内搜索
  • 自定义图标
  • 连接线
  • 最大可选
  • 节点右键事件
  • 自定义格式化数据
  • 支持Vue组件

DEMO

跳转到DEMO

安装

npm install vs-tree

yarn add vs-tree

use

<div id="tree"></div>
import vsTree from 'vs-tree'
import 'vs-tree/dist/vs-tree.css'

const tree = new vsTree('#tree', {
  data: {id: 1, name: 'tree1', children: []} // [{id, name}, {id, name, children}]
});

直接引入js

<link rel="stylesheet" href="../dist/vs-tree.css">
<div id="tree"></div>
<script src="../dist/vs-tree.js"></script>
const tree = new vsTree.default('#tree', {
  data: {id: 1, name: 'tree1', children: []} // [{id, name}, {id, name, children}]
});

支持浏览器模块

<script type="module">
import vsTree from '../dist/vs-tree.esm.browser.js'
const tree = new vsTree('#tree', {
  data: {id: 1, name: 'tree1', children: []} // [{id, name}, {id, name, children}]
});
</script>

Vue2.x use

// main.js
import { install } from 'vs-tree'
import 'vs-tree/dist/vs-tree.css'

Vue.use(install)
<template>
  <div id="app">
    <vs-tree :data="data"></vs-tree>
  </div>
</template>

<script>
var id = 1000
function add(parentId, name) {
  const list = []
  for (var i = 0; i < 10; i++) {
    list.push({ id: '100' + id++, name: name + i, parentId: parentId })
  }
  return list
}
const data = {
  id: '1', name: 'zhangsan', parentId: '-1', children: [
    { id: '100', name: 'wangwu', parentId: '1', children: add('100', 'wangwu') },
    { id: '101', name: 'zhaoliu', parentId: '1', children: add('101', 'zhaoliu') },
    { id: '102', name: 'huahua', parentId: '1' },
    { id: '103', name: 'oo-1', parentId: '1' },
    { id: '104', name: 'oo-2', parentId: '1' },
    { id: '105', name: 'oo-3', parentId: '1' },
    { id: '106', name: 'oo-4', parentId: '1' },
    { id: '107', name: 'oo-5', parentId: '1' },
    { id: '108', name: 'oo-6', parentId: '1' },
    { id: '109', name: 'oo-7', parentId: '1' },
    { id: '110', name: 'oo-8', parentId: '1' },
    { id: '111', name: 'oo-9', parentId: '1' },
  ]
}
export default {
  name: 'App',
  data () {
    return {
      data: data
    }
  },

}
</script>

Options

InputDescTypeDefault
el选择器, 或 HTMLElementstring 或 HTMLElement
data展示数据Object、 Array
async延时渲染Booleanfalse
hideRoot是否展示根节点Booleanfalse
showLine是否展示连接线Booleanfalse
showIcon是否显示图标Booleanfalse
onlyShowLeafIcon是否仅显示叶子节点图标Booleanfalse
showCheckbox是否显示复选框Booleanfalse
checkboxType父子节点关联关系ObjectcheckboxTypeOptions
checkInherit新加入节点时自动继承父节点选中状态Booleanfalse
showRadio是否显示单选框,会覆盖复选框Booleanfalse
radioType分组范围String'all'
disabledInherit新加入节点时自动继承父节点禁用状态Booleanfalse
highlightCurrent是否高亮选中当前项Booleanfalse
accordion手风琴模式Booleanfalse
animation开启动画Booleanfalse
draggable开启拖拽Booleanfalse
dropable允许放置Booleanfalse
nocheckParent禁止父节点选中Booleanfalse
sort对选中列表排序Booleanfalse
checkOnClickNode是否在点击节点的时候选中节点Booleanfalse
lazy异步加载节点Booleanfalse
strictLeaf严格依赖isLeaf,不提供时如无子节点则不渲染展开图标Booleanfalse
max最大可选数量Number0
checkFilterLeaf选中结果过滤掉叶子节点, 异步加载时需手需提供 isLeafBooleanfalse
rootName根节点名称,仅 data 为数组时有效,此时不会默认Stringnull
expandClass展开收起图标classStringvs-expand-icon
theme皮肤风格,仅支持 'element'Stringnull
breadcrumb面包屑功能,只展示一层节点Objectnull
disabledKeys禁止操作Arraynull
checkedKeys默认选中Arraynull
expandKeys默认展开Arraynull
expandLevel默认展开级数, 0 不展开 -1 全部展开Number1
indent缩进Number10
virtual虚拟列表配置信息ObjectvirtualOptions
maxHeight组件最大高度String、Number400px
minHeight组件最大高度String、Number0px

checkboxTypeOptions

optionsDesc默认
Y勾选后情况'ps'
N取消勾选情况'ps'

p 表示操作影响父节点 s 表示操作影响子节点

radioType

all 表示全局范围内分组 level 表示每级节点内分组

virtualOptions

optionsDesc默认
showCount视图内展示多少条数据20
itemHeight每条的高度26

breadcrumb

optionsDesc默认
elSelector, HtmlElement内部创建根节点
iconstring, ELement, Functionnull
linkstring, ELement, Functionnull
separatorstring, ELement, Functionnull
changeEventdom, node[], current

方法

Tree 内部使用了 Node 类型的对象来包装用户传入的数据,用来保存目前节点的状态。 Tree 拥有如下方法:

Methods说明参数
getCheckedNodes获取选中节点-
getNodeById根据 ID 获取 Node 节点id
setMaxValue设置最大可选number
scrollToIndex滚动到索引位置number
clearCheckedNodes清除选中节点-
filter过滤节点keyword, onlySearchLeaf

onlySearchLeaf 只过滤叶子节点

Node 方法

Node 拥有如下方法:

Methods说明参数
setChecked设置是否选中true,false
setDisabled设置禁止操作true,false
remove删除当前节点-
append追加节点data

Events

事件名称说明回调参数返回值
click节点点击事件event, nodevoid
beforeCheck节点选择前触发nodetrue,false
check复选框被点击时触发event, nodevoid
change复选框改变时触发 node void
limitAlert超过 max 配置时触发-void
renderContent自定义节点内容h,nodeh() 或 Dom
loadlazy=true 时有效node, resolvevoid
checkFilter过滤掉的节点不计入统计nodetrue, false
format格式化数据data{name,children,isLeaf,icon}
contextmenu鼠标右键事件event, nodevoid
searchFilter搜索过滤keyword, node, datanode[]
searchRender搜索渲染node, cloneNodeElement
onDragstart开始拖拽e, nodevoid
onDragenter进入放置目标e, node, dragPosvoid
onDrop放置目标e, node, dragPosvoid

searchRender 返回的 Element 不会影响原有dom

renderContent

h: 生成简单 dom 节点,当前仅支持以下配置

renderContent: function (h, node) {
  return h("div", {
    className: "tree-action",
    children: [
      h("a", {
        text: 'append',
        click: function (e, node) {
          node.append({
            id: id++,
            name: 'append'
          })
        }
      }),
      h("a", {
        text: 'remove',
        click: function (e, node) {
          node.remove()
        }
      })
    ]
  })
}

renderContent: function(h, node) {
  const append = document.createElement('a')
  append.innerText = 'append'
  dom.appendChild(append)
  append.onclick = () => {
    node.append({
      id: id++,
      name: 'append'
    })
  }
  return append
}

load

resolve 异步加载完成后回调

lazy: true,
load: function (node, resolve) {
  setTimeout(() => {
    resolve([{
      id: id++,
      name: '新叶子节点' + id,
      isLeaf: true
    }])
  }, 1000)
}

format

目前仅支持,id, name、children、isLeaf、icon、extra

format: function(data) {
  return {
    name: data.title,
    children: data.child,
    isLeaf: !data.child,
    icon: 'custom-icon' || document.createElement
  }
}

Tips

  1. maxHeight 高度变大后 showCount 也要相应变大,不然滑动到底部后数据展示不全,会出现空白.
  2. minHeight 可以配置最小高度,当 minHeight 和 maxHeight 配置相同的高度时,可以固定高度
  3. 如果发现vs-tree组件不显示数据渲染结果为空,则在vs-tree组件上加v-if="list.length > 0" 判断下等数据加载完毕后进行渲染
  4. itemHeight 是用于内部计算,dom元素真是高度需要用css指定
  5. lazy为true时需手动添加isLeaf标识

License

MIT License.

QQ交流群(860150548)

0.1.2

4 months ago

0.1.1

6 months ago