JS组件系列——自己动手封装bootstrap-treegrid组件

蔚落 2022-06-17 14:15 231阅读 0赞

# 一、开源的treegrid #

[回到顶部][Link 1]

## 1、组件效果预览 ##

最原始的效果

![459756-20170427200832584-538330588.png][]

bootstrap样式的效果

![459756-20170427200855694-147617581.png][]

![459756-20170427200905928-734283407.png][]

这个是组件最原始的效果，后面会告诉大家博主做了哪些封装以及加了哪些功能。

在此还是给出一个封装过的效果吧！

![459756-20170427210638053-1519646105.png][]

[回到顶部][Link 1]

## 2、组件开源地址 ##

最后还是给出github上面一个开源的treegrid组件。

github开源地址：[https://github.com/maxazan/jquery-treegrid][https_github.com_maxazan_jquery-treegrid]

文档示例地址：[http://maxazan.github.io/jquery-treegrid/][http_maxazan.github.io_jquery-treegrid]

bootstrap样式的demo以及使用：[http://maxazan.github.io/jquery-treegrid/examples/example-bootstrap-3.html][http_maxazan.github.io_jquery-treegrid_examples_example-bootstrap-3.html]

[回到顶部][Link 1]

# 二、封装treegrid #

[回到顶部][Link 1]

## 1、组件封装的必要性 ##

（1）纵观组件的所有的demo和文档，基本都是说的我们直接写死的table标签，然后通过样式去确定父子关系，最后初始化得到效果，但大部分情况下，我们的表格数据都不是写死的，而是通过后台获取数据，然后将数据渲染到前端，最终得到我们想要的效果，如果根据组件目前的使用方式，我们得到一个集合数据之后，需要自己去拼接tr、td这些东西，这都是小事，最麻烦的是组件是有父子关系的，我们需要根据我们数据之间的关系转化为组件的父子关系，并且由于支持无限级，还涉及到数据的递归运算。这个复杂的过程是我们不想经常去做的，怎么办呢？最好的思路就是封装了，封装的时候麻烦一次，以后使用就简单了，可以说这是一件一劳永逸的事情。

（2）一般来说，既然是treegrid，肯定会有表头，而这个表头是根据数据来动态显示的。组件自带的效果可以自己写死表头，但还是那句话，使用的灵活性太差。

由于以上两点，于是才有了今天的这篇文章。

[回到顶部][Link 1]

## 2、组件封装代码示例 ##

首先我们将treegrid组件下载并引用到我们的项目里面，然后向其目录里面加一个extension的文件夹，里面添加一个jquery.treegrid.extension.js的文件。

![459756-20170427204320647-1305518790.png][]

然后就是最重要的jquery.treegrid.extension.js文件的内容：

![复制代码][copycode.gif]

![复制代码][copycode.gif]

代码说明

1、为了避免和源组件的初始化冲突，我们自定义的组件取了一个别名，叫 treegridData 。我们使用组件的时候就通过treegridData来进行初始化，如果你觉得这个名称不顺眼，可以自行修改。

2、代码的封装思路基本是参考博主之前介绍组件的封装 [http://www.cnblogs.com/landeanfen/p/5124542.html][http_www.cnblogs.com_landeanfen_p_5124542.html]这一篇里面的内容来的。

3、defaults里面就是初始化组件的时候可以传递的参数，上述注释基本上写得比较清楚。id和parentId两个参数主要是用来描述数据之间的父子级关系，后面我们介绍组件时候的时候你一看就能明白。

4、博主加了几个自认为很有用的属性和方法，应该能减少一些使用的麻烦。比如初始化组件的时候是否展开所有的子节点、添加title、表格行的渐变色和表格边框等。

5、上述封装里面递归查找子节点的时候，每一次都需要遍历所有的数据去找子节点，效率偏低，如果你使用了类似linq to js之类的组件去操作js的集合，可以优化那部分代码，适当提高递归的效率。当然，如果你的结果集本身数据量不太大，这么写影响也不太大。

[回到顶部][Link 1]

## 3、封装后的组件使用 ##

我们在界面上面引用需要的css和js文件

![复制代码][copycode.gif]

![复制代码][copycode.gif]

然后定义一个空的table标签

最后就是js初始化了

![复制代码][copycode.gif]

$(document).ready(function () {
                $('#tb').treegridData({
                    id: 'Id',
                    parentColumn: 'ParentId',
                    type: "GET", //请求数据的ajax类型
                    url: '/TestMVC/GetData',   //请求数据的ajax的url
                    ajaxParams: {}, //请求数据的ajax的data属性
                    expandColumn: null,//在哪一列上面显示展开按钮
                    striped: true,   //是否各行渐变色
                    bordered: true,  //是否显示边框
                    //expandAll: false,  //是否全部展开
                    columns: [
                        {
                            title: '机构名称',
                            field: 'Name'
                        },
                        {
                            title: '机构描述',
                            field: 'Desc'
                        }
                    ]
                });
            });

![复制代码][copycode.gif]

当然啦，还得配上后台的取数据的方法

![复制代码][copycode.gif]

public class TestMVCController : Controller
        {
        public JsonResult GetData()
            {
                var result = new List<object>();
                result.Add(new { Id = 1, Name = "百度科技", Desc = "搜索巨头"});
                result.Add(new { Id = 2, Name = "百度事业部", Desc = "搜索巨头",ParentId=1 });
                result.Add(new { Id = 3, Name = "百度人事部", Desc = "搜索巨头", ParentId = 1 });
                result.Add(new { Id = 11, Name = "百度HH部", Desc = "搜索巨头", ParentId = 2 });
                result.Add(new { Id = 4, Name = "百度行政", Desc = "搜索巨头", ParentId = 1 });
                result.Add(new { Id = 5, Name = "百度YY部", Desc = "搜索巨头", ParentId = 1 });
                result.Add(new { Id = 12, Name = "百度BB部", Desc = "搜索巨头", ParentId = 2 });
                result.Add(new { Id = 6, Name = "搜狐科技", Desc = "IT" });
                result.Add(new { Id = 7, Name = "搜狐信息部", Desc = "IT", ParentId = 6 });
                result.Add(new { Id = 8, Name = "搜狐人事", Desc = "IT", ParentId = 6 });
                result.Add(new { Id = 9, Name = "搜狐事业部", Desc = "IT", ParentId = 6 });
                result.Add(new { Id = 10, Name = "搜狐事业子部", Desc = "IT", ParentId = 9 });
                return Json(result, JsonRequestBehavior.AllowGet);
            }
        }

![复制代码][copycode.gif]

这里一看应该就能明白组件defaults里面的id和parentColumn的作用了吧。记得jqgrid里面使用treeview的时候用到了一个level用来判断是哪一级别的节点，博主觉得这样硬性要求返回数据里面加一个level属性有点不妥，所以我们约定如果当前记录的parentId为null或者空字符串的时候，这个节点就是根节点，然后根据根节点去递归找子节点。

使用后的各种效果示例如下。

初始化的时候配置expandAll: false得到的效果

![459756-20170427210829912-2091224638.png][]

增加隔行变色striped: true

![459756-20170427210933490-1415573245.png][]

增加表格边框bordered: true

![459756-20170427211029178-385948100.png][]

综合效果

![459756-20170427211218084-1274640674.png][]

[Link 1]: http://www.cnblogs.com/landeanfen/p/6776152.html#_labelTop
[459756-20170427200832584-538330588.png]: /images/20220617/7ec34344ad3d4a918b99cdca89450e55.png
[459756-20170427200855694-147617581.png]: /images/20220617/62a4ac43cc61423188e58e104c8941a1.png
[459756-20170427200905928-734283407.png]: /images/20220617/a61eaf4e30c345698afcb7409a790973.png
[459756-20170427210638053-1519646105.png]: /images/20220617/2e1a516d4b5f4b12ae16e0c59715fb93.png
[https_github.com_maxazan_jquery-treegrid]: https://github.com/maxazan/jquery-treegrid
[http_maxazan.github.io_jquery-treegrid]: http://maxazan.github.io/jquery-treegrid/
[http_maxazan.github.io_jquery-treegrid_examples_example-bootstrap-3.html]: http://maxazan.github.io/jquery-treegrid/examples/example-bootstrap-3.html
[459756-20170427204320647-1305518790.png]: /images/20220617/392d7b3bfe244f74af45c25c324b3fe6.png
[copycode.gif]: /images/20220617/cdaba74c7824416c8503cd8ab4f60c24.png
[http_www.cnblogs.com_landeanfen_p_5124542.html]: http://www.cnblogs.com/landeanfen/p/5124542.html
[459756-20170427210829912-2091224638.png]: /images/20220617/3bd51cd519634b69992a3abc85840b45.png
[459756-20170427210933490-1415573245.png]: /images/20220617/0b94cd9252cc49e0a6de05c9071feaf7.png
[459756-20170427211029178-385948100.png]: /images/20220617/7b9b8a3d9ed84944a2513eaca57a3f57.png
[459756-20170427211218084-1274640674.png]: /images/20220617/b4af328458f346f58b7062af87daf092.png