JS树形插件"jsTree"使用小记

最近在开发中遇到要在页面展示无限层级分类的需求,作为后端出身的我,要在jsp模板里面写原生的树形结构还是有些吃力的,于是网上找了一圈,发现jsTree这个插件的口碑不错,但在实际使用过程中还是遇到了一些小困难,记录下来以便日后检索

博客原文连接:http://onee.top/2017/03/jstree/
Github:https://github.com/VOREVER
个人主页:https://wangyu.space/

基本使用

使用插件当然要先引入插件,此插件也是依赖与jQuery的,所以一定要先导入jQuery,版本要求1.9.0以上,我这里偷个懒,直接使用CDN来导入(也建议用CDN来导入,因为线上环境CDN的加载速度比加载服务器文件要快。。)

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.2.1/themes/default/style.min.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.12.1/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.2.1/jstree.min.js"></script>

生成树的方式有好几种,可以直接写ul套li标签,插件会帮你生成好看的树形样式,还有一种就是通过JSON数据来生成,我这里用的就是通过AJAX请求数据来生成树的,首先在HTML中建立一个空的节点,取一个唯一的id,举例如下:

<div id="treeDemo"></div>

之后就可以通过js来生成树啦,先用jQuery获取DOM对象,接着调用jsTree的API来生成树,如下所示:

$('#treeDemo').jstree({
    'core': {
        'data': {
            'id' : 'node_1',
            'text' : 'Node'
        }
    }
});

最后生成的效果就是普普通通的文件树,类似于文件夹目录结构,懒得截图就不截了,自行脑补,这里要说一下的就是data这个参数都有哪些属性可以来设置,官网的API介绍的不全,我在浏览器检查其里获取了一下data对象,列入data参数的所有属性

a_attr: Object // 生成一个a标签节点的属性
li_attr: Object // 生成一个li标签节点的属性
children: Array // 所有子节点数组
data: Object // 此节点的数据(没传过。。)
icon: String // 此节点的图标(没传过。。)
id: String // 节点唯一的id,如果不传会默认生成
original: Object // 后台传过来的这个节点的所有数据
parent: String // 父节点的id
parents: Object // 所有的父节点数组
state: Object // 节点状态,这里面有五个固定属性,可以传默认值
// 分别是“checked”、“disabled”、“loaded”、“opened”、“selected”,均为布尔值
text: String // 节点显示的文本
type: String // 节点的类型,我只用过默认“default”

当然生成树除了data参数,还有很多别的参数可以设置,以下写一些我用过的,更详细请查阅官方API文档

$('#treeDemo').jstree({
    // 引入插件
    'plugins': ['checkbox','types','themes','contextmenu'],
    'types': {
        'default': {
            'icon': false  // 删除默认图标
        },
    },
    'checkbox': {  // 去除checkbox插件的默认效果
        'tie_selection': false,
        'keep_selected_style': false,
        'whole_node': false
    },
    'core': {
        'multiple' : true,  // 可否多选
        'data' : nodeData,  // 生成节点的数据,nodeData是后台返回的JSON数据
        'dblclick_toggle': true   //允许tree的双击展开
    },
    'contextmenu': {    // 右键菜单
        'items': {
            'edit': {
                'label': '编辑',
                'action': function (data) {}
            },
            'delete': {
                'label': '删除'
                'action': function (data) {}
            }
        }
    }
});

遇到的坑

基本的用法就在这里,用起来基本上还是比较顺利的,下面来说说不太顺利的,比如如何去刷新一个树,或者说换个数据,如何重新生成,API里面有刷新的函数用法如下:

$('#treeDemo').jstree(true).refresh();

如果用了你就会发现,除了把页面上所有节点的选中状态都去掉了,其他的并没有用,就算更换了数据源,也并不会生成一棵新的树,达不到我想要的效果,解决办法就是...不要去刷新它,直接销毁掉,然后再重新生成,办法比较土,但我目前没找到更好的办法,销毁树的方法如下:

$('#treeDemo').jstree("destroy");

接下来再说另一个坑,通过右键菜单,我想实现删除某个节点的功能,通过实现右键的监听事件,在API文档中找到了删除节点的函数delete_node (obj),返回一个布尔值,按理说传一个节点对象进去就可以了,可是不管是传对象还是传节点id,打死就是不对,一直返回false,获取节点对象的方法如下:

var inst = jQuery.jstree.reference(data.reference)
var node = inst.get_node(data.reference);

看到文档中说可以传个节点id的数组来批量删除节点,那好那就来试试吧

$('#treeDemo').jstree(true).delete_node([node.id]);

成功了😂,什么鬼,我明明只要删一个节点,非要让我传个数组。。。那接下来又有问题啦,函数返回删除成功了,可页面上的节点还在啊,这个问题着实困扰了我一天都没有解决,于是在一个加班的页面,无意中在官网首页的一个子标签里看到一句话,大意是,你要要编辑删除节点的话,要设置core.check_callback的值为true,这么重要的东西为什么藏着这么隐蔽。。为什么不写在API文档里。。。于是添加了这个属性就好了,如下所示:

$('#treeDemo').jstree({
    'core': {
        'check_callback': true;
    }
});

总结

jsTree这个插件还是很好用的,遇到的问题先写这么多,之后有的话再往里面补充,就这样。。。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容