1.9.9 • Published 4 years ago

vue-search-tree v1.9.9

Weekly downloads
31
License
ISC
Repository
-
Last release
4 years ago

安装

npm i vue-search-tree

Demo演示

https://100px.net/vue-search-tree/

使用

方式1: 通过 script 标签引入 (适用于前后不分离项目)

在dist目录下找到一个css和一个js文件, 然后在页面上假如如下两行代码

其中js文件记得要放在引入vue的script后面

<link rel="stylesheet" href="./dist/search-tree@2.2.3.css">
...
<script src="./dist/search-tree@2.2.3.min.js"></script>

方式2: 通过 import 方式引入

先找到main.js引入插件并use

import SearchTree from 'vue-search-tree'

Vue.use(SearchTree)

使用示例请参照Demo演示

属性 (Attributes)

参数说明类型默认值
data源数据Array必填项
node-key节点的唯一标识String'id'
theme-color主题色String'#409eff'
search模糊搜索的关键词String''
hide-misses是否隐藏模糊搜索不匹配的节点Booleantrue
expand-misses是否展开模糊搜索不匹配的节点Booleanfalse
search-debounce模糊搜索防抖 (毫秒)Number300
empty-text内容为空时展示的文本String''
show-checkbox是否显示checkboxBooleanfalse
default-expand-all是否默认展开所有节点Booleanfalse
expand-on-click-node点击节点时是否展开或折叠Booleantrue
check-on-click-node点击节点时是否选中节点Booleanfalse
default-expanded-keys默认展开节点的keysArray[]
default-checked-keys默认选中节点的keysArray[]
filter-node过滤显示的节点 (该方法得到的是引用节点)Function-
props配置选项,请看下表Object

props (配置项)

参数说明类型
name节点名称String
children节点的子集String
disabled该节点是否禁用String

事件 (Event)

事件名说明参数
node-click节点被点击时触发参数1: 事件参数event, 参数2: 当前node节点
node-checked节点的选中状态改变时触发参数1: 事件参数event, 参数2: 当前node节点
node-expand节点展开或折叠时触发参数1: 事件参数event, 参数2: 当前node节点

方法 (Methods)

方法名说明参数参数类型返回值
getNodeByKey通过key获取对应节点参数1: 唯一标识keyString / Number成功返回对应的节点, 失败返回null
resetChecked取消所有节点的选中状态---
setCheckedByKeys通过keys批量设置节点的选中状态参数1: 唯一标识keys, 参数2: 状态参数1: Array, 参数2: Boolean-
getCheckedKeys获取选中节点的keys参数1: 指定表示(默认为nodeKey)String所有选中节点的唯一标识keys
getCheckedNodes获取选中的节点nodes--所有选中的节点nodes
remove通过key删除一个节点参数1: 唯一标识key或当前节点String / Number成功返回true, 失败返回false
append通过key添加一个子节点参数1: 唯一标识key或当前节点, 参数2: node节点String / Number成功返回true, 失败返回false
insertBefore通过key在前添加一个兄弟节点参数1: 唯一标识key或当前节点, 参数2: node节点String / Number成功返回true, 失败返回false
insertAfter通过key在后添加一个兄弟节点参数1: 唯一标识key或当前节点, 参数2: node节点String / Number成功返回true, 失败返回false
getTotalOfNodes获取所有满足条件的节点数量-Function所有满足条件的节点数量
  • getTotalOfNodes 使用示例:

    • 获取所有名称包含'北京'的节点: getTotalOfNodes(node => node.name.indexOf('北京') > -1)
1.9.9

4 years ago

2.2.4

4 years ago

2.2.3

4 years ago

2.2.2

4 years ago

2.2.1

4 years ago

2.2.0

4 years ago

2.1.9

4 years ago

2.1.8

4 years ago

2.1.7

4 years ago

2.1.6

4 years ago

2.1.5

4 years ago

2.1.4

4 years ago

2.1.3

4 years ago

2.1.1

4 years ago

2.1.0

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.9

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

0.0.1

4 years ago