bootstrap treeview基本运用
程序员文章站
2022-06-08 10:49:10
...
虽然现在有了很多新的前端框架，但是有的时候我们做一个不需要任何其他js编译环境就可以运行的项目，那还是的使用一些老式技术，接下来就来回顾一些bootstrap treeview + jquery的使用
bootstrap-treeview是一款效果非常酷的基于bootstrap的jQuery多级列表树插件，该jQuery插件基于Twitter Bootstrap。
插件官网：https://jquery-plugins.net/bootstrap-tree-view
一、依赖下载
Bootstrap v3.3.4 (>= 3.0.0)
jQuery v2.1.3 (>= 1.9.0)
这个相配匹配的不怎么好找，有需要的朋友可以自己到我云盘下载网盘地址https://pan.baidu.com/s/1OxxqD9MTjTx5XYvZs4EQpg 提取码 ：fihe
引入
<link href="libs/bootstrap-3.3.7-dist/css/bootstrap.css" rel="stylesheet" type="text/css" />
<link href="libs/bootstrap-treeview.min.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="libs/bootstrap-3.3.7-dist/jquery-3.2.1.min.js"></script>
<script type="text/javascript" src="libs/bootstrap-3.3.7-dist/js/bootstrap.js"></script>
<script type="text/javascript" src="libs/bootstrap-treeview.min.js"></script>
html中添加
<div id="tree"></div>
二、使用实例
$(function() {
$('#ftree').treeview({
data:getTree(),
showCheckbox:true,
hierarchicalCheck:true
})
})
function getTree() {
//节点上的数据遵循如下的格式：
var tree = [{
text: "Node 1", //节点显示的文本值 string
icon: "glyphicon glyphicon-play-circle", //节点上显示的图标，支持bootstrap的图标 string
selectedIcon: "glyphicon glyphicon-ok", //节点被选中时显示的图标 string
color: "#ff0000", //节点的前景色 string
backColor: "#1606ec", //节点的背景色 string
href: "#http://www.baidu.com", //节点上的超链接
selectable: true, //标记节点是否可以选择。false表示节点应该作为扩展标题，不会触发选择事件。 string
state: { //描述节点的初始状态 Object
checked: true, //是否选中节点
/*disabled: true,*/ //是否禁用节点
expanded: true, //是否展开节点
selected: true //是否选中节点
},
tags: ['标签信息1', '标签信息2'], //向节点的右侧添加附加信息（类似与boostrap的徽章） Array of Strings
nodes: [{
text: "Child 1",
nodes: [{
text: "Grandchild 1"
}, {
text: "Grandchild 2"
}]
}, {
text: "Child 2"
}]
}, {
text: "Parent 2",
nodes: [{
text: "Child 2",
nodes: [{
text: "Grandchild 3"
}, {
text: "Grandchild 4"
}]
}, {
text: "Child 2"
}]
}, {
text: "Parent 3"
}, {
text: "Parent 4"
}, {
text: "Parent 5"
}];
return tree;
}
三、参数详解
var options = {
data: data, //data属性是必须的，是一个对象数组 Array of Objects.
color: "", //所有节点使用的默认前景色，这个颜色会被节点数据上的backColor属性覆盖. String
backColor: "#000000", //所有节点使用的默认背景色，这个颜色会被节点数据上的backColor属性覆盖. String
borderColor: "#000000", //边框颜色。如果不想要可见的边框，则可以设置showBorder为false。 String
nodeIcon: "glyphicon glyphicon-stop", //所有节点的默认图标
checkedIcon: "glyphicon glyphicon-check", //节点被选中时显示的图标 String
collapseIcon: "glyphicon glyphicon-minus", //节点被折叠时显示的图标 String
expandIcon: "glyphicon glyphicon-plus", //节点展开时显示的图标 String
emptyIcon: "glyphicon", //当节点没有子节点的时候显示的图标 String
enableLinks: false, //是否将节点文本呈现为超链接。前提是在每个节点基础上，必须在数据结构中提供href值。 Boolean
highlightSearchResults: true, //是否高亮显示被选中的节点 Boolean
levels: 2, //设置整棵树的层级数 Integer
multiSelect: false, //是否可以同时选择多个节点 Boolean
onhoverColor: "#F5F5F5", //光标停在节点上**的默认背景色 String
selectedIcon: "glyphicon glyphicon-stop", //节点被选中时显示的图标 String
searchResultBackColor: "", //当节点被选中时的背景色
searchResultColor: "", //当节点被选中时的前景色
selectedBackColor: "", //当节点被选中时的背景色
selectedColor: "#FFFFFF", //当节点被选中时的前景色
showBorder: true, //是否在节点周围显示边框
showCheckbox: false, //是否在节点上显示复选框
showIcon: true, //是否显示节点图标
showTags: false, //是否显示每个节点右侧的标记。前提是这个标记必须在每个节点基础上提供数据结构中的值。
uncheckedIcon: "glyphicon glyphicon-unchecked", //未选中的复选框时显示的图标，可以与showCheckbox一起使用
}
四、方法详解
1. checkAll(options);//选中所有树节点
2. checkNode(node | nodeId, options); //选中一个给定nodeId的树节点
3. clearSearch();//清除查询结果
4. collapseAll(options);//折叠所有树节点
5. collapseNode(node | nodeId, options);//折叠一个给定nodeId的树节点和它的子节点
6. disableAll(options);//禁用所有树节点
7. disableNode(node | nodeId, options);//禁用一个给定nodeId的树节点
8. enableAll(options);//**所有树节点
9. enableNode(node | nodeId, options);//**给定nodeId的树节点
10. expandAll(options);//展开所有节点
11. expandNode(node | nodeId, options);//展开给定nodeId的树节点
12. getCollapsed();//返回被折叠的树节点数组
13. getDisabled();//返回被禁用的树节点数组
14. getEnabled();//返回被**的树节点数组
15. getExpanded();//返回被展开的树节点数组
16. getNode(nodeId);//返回与给定节点id相匹配的单个节点对象。
17. getParent(node | nodeId);//返回给定节点id的父节点
18. getSelected();//返回被选定节点的数组。
19. getSiblings(node | nodeId);//返回给定节点的兄弟节点数组
20. getUnselected();//返回未选择节点的数组
21. remove();//删除the tree view component.删除绑定的事件，内部附加的对象，并添加HTML元素。
22. revealNode(node | nodeId, options);//显示给定的树节点，将树从节点扩展到根。
23. search(pattern, options);//在树视图中搜索匹配给定字符串的节点，并在树中突出显示它们。返回匹配节点的数组。
24. selectNode(node | nodeId, options);//选择一个给定的树节点
25. toggleNodeChecked(node | nodeId, options);//Toggles a nodes checked state; checking if unchecked, unchecking if checked.
26. toggleNodeDisabled(node | nodeId, options);//切换节点的禁用状态;
27. toggleNodeExpanded(node | nodeId, options);//切换节点的展开与折叠状态
28. toggleNodeSelected(node | nodeId, options);//切换节点的选择状态
29. uncheckAll(options);//不选所有节点
30. uncheckNode(node | nodeId, options);//不选给定nodeId的节点
31. unselectNode(node | nodeId, options);//不选给定nodeId的节点
// 说明：可以通过两种方式来调用方法：
// 1、插件包装器：插件的包装器可以作为访问底层方法的代理。
$('#tree').treeview('methodName', args);
// 其中，多个参数必须使用数组对象来传入。
// 2、直接使用treeview：你可以通过下面两种方法中的一种来获取treeview对象实例：
//该方法返回一个treeview的对象实例
$('#tree').treeview(true).methodName(args);
//对象实例也保存在DOM元素的data中， 可以使用'treeview'的id来访问它。
$('#tree').data('treeview').methodName(args);
五、事件详解
1. nodeChecked (event, node) - 一个节点被checked.
2. nodeUnchecked (event, node) - 一个节点被unchecked.
3. nodeCollapsed (event, node) - 一个节点被折叠.
4. nodeDisabled (event, node) - 一个节点被禁用.
5. nodeEnabled (event, node) - 一个节点被启用.
6. nodeExpanded (event, node) - 一个节点被展开.
7. nodeSelected (event, node) - 一个节点被选择.
8. nodeUnselected (event, node) - 取消选择一个节点.
9. searchComplete (event, results) - 搜索完成之后触发.
10. searchCleared (event, results) - 搜索结果被清除之后触发.
//说明：事件的调用有两种方式：
//第 1 种：在参数中使用回调函数来绑定任何事件：
$('#tree').treeview({
//命名约定：以on为前缀，并将事件名的第一个字母转为大写，例如： nodeSelected -> onNodeSelected
onNodeSelected:function(event, data) {
// 事件代码...
}
});
//第 2 种：使用标准的jQuery .on()方法来绑定事件:
$('#tree').on('nodeSelected',function(event, data) {
// 事件代码...
});
六、实现多级联动
官方说的使用 hierarchicalCheck: true, 属性设置级联，但经测试无效，最后改用手动方式（递归联动）
//选中全部父节点
function checkAllParent(node,nodeIds){
let parentNode = $('#tree').treeview('getParent',node.nodeId);
if(!("nodeId" in parentNode)){
return nodeIds;
}else {
nodeIds.push(parentNode.nodeId);
checkAllParent(parentNode,nodeIds);
}
}
//取消全部父节点
function uncheckAllParent(node,nodeIds){
let siblings = $('#tree').treeview('getSiblings', node.nodeId);
let parentNode = $('#tree').treeview('getParent',node.nodeId);
if(!("nodeId" in parentNode)) {
return nodeIds;
}
let isAllUnchecked = true; //是否全部没选中
for(let i in siblings){
if(siblings[i].state.checked){
isAllUnchecked=false;
break;
}
}
if(isAllUnchecked){
nodeIds.push(parentNode.nodeId);
}
uncheckAllParent(parentNode,nodeIds);
}
//级联选中所有子节点
function getAllSons(node,nodeIds){
nodeIds.push(node.nodeId);
if(node.nodes!=null&&node.nodes.length>0){
for(let i in node.nodes){
getAllSons(node.nodes[i],nodeIds);
}
}
}
调用
$('#tree').on('nodeChecked',function (event,node) {
// dosomething ...
// 定义数组记录所有待选中节点nodeID
let chekableNodeIds=[];
checkAllParent(node,chekableNodeIds);
getAllSons(node,chekableNodeIds);
$('#tree').treeview('checkNode',[chekableNodeIds,{silent:true}])
});
$('#tree').on('nodeUnchecked',function (event,node) {
// dosomething ...
// 定义数组记录所有待取消节点nodeID
let chekableNodeIds=[];
uncheckAllParent(node,chekableNodeIds);
getAllSons(node,chekableNodeIds);
$('#tree').treeview('uncheckNode',[chekableNodeIds,{silent:true}])
})
七、运行测试
如图
上一篇： Git 基础 - 打标签 tag
下一篇： TinyMce 中文手册