简介
Vue Sidebar Group Tree 是一款基于 Vue.js 的侧边栏树组件,提供直观的展示方式以及多种交互方式。它可以用于快速构建现代化的前端 Web 应用,让用户拥有更好的体验。
在使用之前,需要注意:
该组件基于 Vue.js 进行开发,需要在项目中安装 Vue.js
该组件依赖于如下的其他 npm 包:
- lodash
- vue-click-outside
安装
使用 npm 进行安装:
npm install vue-sidebar-group-tree --save
使用方式
引入组件
在需要使用组件的页面中,先引入组件:
import VueSidebarGroupTree from 'vue-sidebar-group-tree'
使用组件
在 Vue 的 template 中,可以通过如下方式使用组件:
-- -------------------- ---- ------- ---------- ----------------------- ------------------------------------------ ----------- -------- ------ ------------------- ---- ------------------------ ------ ------- - ----- ----------- ----------- - ------------------- -- ------ - ------ - --------- - - --- -- ------ ------ --------- - - --- -- ------ ------- -- -- - --- -- ------ ------- -- -- - --- -- ------ ------- --- --------- - - --- -- ------ ------- - --- -- -- - --- -- ------ ------- - --- -- - - - - -- - --- -- ------ ----- - - - - - ---------
组件参数
Vue Sidebar Group Tree 提供了一系列的参数配置,可以满足多样化的需求。
data
- 类型:Array(required)
- 说明:用于设置侧边树的数据。
title
- 类型:String
- 默认值:''
- 说明:设置侧边栏的标题。
hasSearch
- 类型:Boolean
- 默认值:false
- 说明:设置是否显示搜索框。
hasCollapse
- 类型:Boolean
- 默认值:false
- 说明:设置是否支持折叠/展开操作。
hasIcon
- 类型:Boolean
- 默认值:false
- 说明:设置是否显示图标。
hasActive
- 类型:Boolean
- 默认值:false
- 说明:表示是否高亮选中项。
activeKey
- 类型:Number/String
- 默认值:0
- 说明:设置默认选中项的 key 值。
defaultOpenKeys
- 类型:Array
- 默认值:[]
- 说明:设置默认展开的节点。
width
- 类型:Number/String
- 默认值:240
- 说明:设置侧边栏的宽度。
height
- 类型:Number/String
- 默认值:'100vh'
- 说明:设置侧边栏的高度。
okText
- 类型:String
- 默认值:'确认'
- 说明:设置搜索框的确认按钮文字。
cancelText
- 类型:String
- 默认值:'取消'
- 说明:设置搜索框的取消按钮文字。
searchPlaceholder
- 类型:String
- 默认值:'请输入搜索内容...'
- 说明:设置搜索框的占位符文本。
iconConfig
- 类型:Object
- 默认值:{}
- 说明:设置图标样式。
事件
Vue Sidebar Group Tree 提供了一些事件,方便开发者进行定制化开发。
item-click
参数:
- data:被点击的节点数据
说明:节点单击事件。
item-dblclick
参数:
- data:被点击的节点数据
说明:节点双击事件。
item-contextmenu
参数:
- data:被点击的节点数据
说明:节点右键菜单事件。
toggle-expand
参数:
data:被展开/折叠的节点数据
keys:被展开/折叠的节点 key 值
expanded:当前状态是否展开
说明:节点展开/折叠事件。
search
参数:
- value:当前搜索框输入的值
说明:搜索框输入事件。
search-ok
参数:
- value:当前搜索框输入的值
说明:搜索框确认事件。
search-cancel
参数:无
说明:搜索框取消事件。
示例代码
基本使用
-- -------------------- ---- ------- ---------- ----------------------- ------------------------------------------ ----------- -------- ------ ------------------- ---- ------------------------ ------ ------- - ----- ------------ ----------- - ------------------- -- ------ - ------ - --------- - - --- -- ------ ------ --------- - - --- -- ------ ------- -- -- - --- -- ------ ------- -- -- - --- -- ------ ------- --- --------- - - --- -- ------ ------- - --- -- -- - --- -- ------ ------- - --- -- - - - - -- - --- -- ------ ----- - - - - - ---------
支持搜索
-- -------------------- ---- ------- ---------- ----------------------- ---------------- -------------------------------------------- ----------- -------- ------ ------------------- ---- ------------------------ ------ ------- - ----- ------------- ----------- - ------------------- -- ------ - ------ - --------- - - --- -- ------ ------ --------- - - --- -- ------ ------- -- -- - --- -- ------ ------- -- -- - --- -- ------ ------- --- --------- - - --- -- ------ ------- - --- -- -- - --- -- ------ ------- - --- -- - - - - -- - --- -- ------ ----- - - - - - ---------
支持折叠和图标
-- -------------------- ---- ------- ---------- ----------------------- ---------------- -------------------- ------------------------------------------ ----------- -------- ------ ------------------- ---- ------------------------ ------ ------- - ----- --------------- ----------- - ------------------- -- ------ - ------ - --------- - - --- -- ------ ------ --------- - - --- -- ------ ------- -- -- - --- -- ------ ------- -- -- - --- -- ------ ------- --- --------- - - --- -- ------ ------- - --- -- -- - --- -- ------ ------- - --- -- - - - - -- - --- -- ------ ----- - - - - - ---------
支持高亮选中项和事件
-- -------------------- ---- ------- ---------- ----------------------- ---------------- ------------------ ----------------------------- ----------------------------------------- ----------------------------------- -------------------------- ----------- -------- ------ ------------------- ---- ------------------------ ------ ------- - ----- ------------ ----------- - ------------------- -- ------ - ------ - --------- - - --- -- ------ ------ --------- - - --- -- ------ ------- -- -- - --- -- ------ ------- -- -- - --- -- ------ ------- --- --------- - - --- -- ------ ------- - --- -- -- - --- -- ------ ------- - --- -- - - - - -- - --- -- ------ ----- - - - -- -------- - --------------------- - ------------------------ -- ----- -- --------------------------- - ------------------------------ -- ----- -- ------------------------ ----- --------- - --------------------------- -- ----- ----- --------- - - - ---------
总结
Vue Sidebar Group Tree 是一款优秀的侧边栏树组件,它提供了多种参数配置以及丰富的事件。它可以满足多种形式的需求,开发者可以根据自身需求,快速构建出现代化的前端 Web 应用。如果你正在寻找一款侧边栏树组件,Vue Sidebar Group Tree 是一个值得一试的选择。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005727081e8991b448e8a69