jstree是一款非常实用的jQuery目录树插件。jsTree树插件易于扩展,可以配置主题,支持HTML和JSON格式的数据,还支持异步回调数据,支持多级树结构等。它的特点还有:
支持树节点的拖拽。
支持使用键盘导航。
支持在线编辑、创建和删除。
支持3状态的checkbox
支持模糊搜索。
可自定义节点类型。
使用方法
使用该目录树插件需要在页面中引入jquery、主题样式文件style.min.css和jstree.min.js文件。
通过HTML代码来生成树结构
- Root node
- Child node 1
- Child node 2
$(function() {
$('#container').jstree();
});
你可以通过data-jstree来为树节点添加选项:
Root node ...通过JSON来生成树结构
$(function() {
$('#container').jstree({
'core' : {
'data' : [
{ "text" : "Root node", "children" : [
{ "text" : "Child node 1" },
{ "text" : "Child node 2" }
]
}
]
}
});
});
在json数据中可用的选项有:
id:节点的ID,用于标识一个树节点。
icon:树节点的图标。它可以是某个图标文件或CSS class名称。
data:可以是任何数据,它对树的显示没有影响,只是附加在节点上的数据。
state:指定树节点状态的对象:
selected:初始化时该节点是否被选择。
opened:该节点是否打开。
disabled:是否禁用该节点。
checked:指定使用checkbox插件。指定节点是否被checked(仅当tie_selection为false时有效)。
undetermined:指定使用checkbox插件。节点在不确定状态时是否被渲染。
type:节点的类型。
li_attr:在生成的HTML树结构li元素上的属性对象。
a_attr:在生成的HTML树结构a元素上的属性对象。
下面是一个示例代码:
$(function() {
$('#container').jstree({
'core' : {
'data' : [
{
"text" : "Root node",
"state" : {"opened" : true },
"children" : [
{
"text" : "Child node 1",
"state" : { "selected" : true },
"icon" : "glyphicon glyphicon-flash"
},
{ "text" : "Child node 2", "state" : { "disabled" : true } }
]
}
]
}
});
});
通过AJAX来管理树结构
可以通过jaax请求来生成树结构:
$(function() {
$('#container').jstree({
'core' : {
'data' : {
"url" : "//www.jstree.com/fiddle/",
"dataType" : "json" // needed only if you do not supply JSON headers
}
}
});
});
服务器端的响应代码是:
[{
"id":1,"text":"Root node","children":[
{"id":2,"text":"Child node 1"},
{"id":3,"text":"Child node 2"}
]
}]
通过回调函数来管理树结构
$(function() {
$('#container').jstree({
'core' : {
'data' : function (node, cb) {
if(node.id === "#") {
cb([{"text" : "Root", "id" : "1", "children" : true}]);
}
else {
cb(["Child"]);
}
}
}
});
});
事件
jstree 提供了很多事件来管理树结构。最常使用的是changed事件,它在用户选择不同的树节点时触发:
$(function() {
$('#container').jstree({
'core' : {
'data' : [
{"id" : 1, "text" : "Node 1"},
{"id" : 2, "text" : "Node 2"},
]
}
});
$('#container').on("changed.jstree", function (e, data) {
console.log("The selected nodes are:");
console.log(data.selected);
});
});
所有的事件都在.jstree命名空间中触发。
方法
你可以通过调用方法的方式来操作树:
Select node 1
$(function() {
$('#container').jstree({
'core' : {
'data' : [
{"id" : 1, "text" : "Node 1"},
{"id" : 2, "text" : "Node 2"},
]
}
});
$('button').on("click", function () {
var instance = $('#container').jstree(true);
instance.deselect_all();
instance.select_node('1');
});
});
上面的例子展示了如何通过jstree示例来调用方法,你也可以通过下面的方式来调用方法:
$('#container').jstree("select_node", "1");
关于jstree更多的API和使用方法请参考官方主页:https://www.jstree.com/