Bootstrap-table使用笔记

最近写了一些前端代码，使用bootstrap-table这个组件。觉得很好用，记录一下使用的方法。

1.准备工作

首先要引入bootstrap的引用，然后引入bootstrap-table的引用，如下

<link rel="stylesheet" href="bootstrap.min.css">
<script src="jquery.min.js"></script>
<script src="bootstrap.min.js"></script>

<link rel="stylesheet" href="bootstrap-table.css">

<script src="bootstrap-table.js"></script>
<--汉化文件，放在 bootstrap-table.js 后面-->
<script src="bootstrap-table-zh-CN.js"></script>

如果我们采用JS代码方式来初始化表格插件，那么只需要在HTML上声明一个表格对象即可，如下代码。

 <table id="table"></table>

表格内容的初始化使用下面的方法：

 $('#table').bootstrapTable({
     url: 'data1.json',
     columns: [{
         field: 'id',
         title: 'Item ID'
     }, {
         field: 'name',
         title: 'Item Name'
     }, {
         field: 'price',
         title: 'Item Price'
     }, ]
 });

 2.bootstrap-table使用的介绍

初始化table的方法

$("#table").bootstrapTable({
    url: queryUrl,                      //请求后台的URL（*）
    method: 'GET',                      //请求方式（*）
    //toolbar: '#toolbar',              //工具按钮用哪个容器
    striped: true,                      //是否显示行间隔色
    cache: false,                       //是否使用缓存，默认为true，所以一般情况下需要设置一下这个属性（*）
    pagination: true,                   //是否显示分页（*）
    sortable: true,                     //是否启用排序
    sortOrder: "asc",                   //排序方式
    sidePagination: "server",           //分页方式：client客户端分页，server服务端分页（*）
    pageNumber: 1,                      //初始化加载第一页，默认第一页,并记录
    pageSize: 15,                     //每页的记录行数（*）
    pageList: [10, 25, 50, 100],        //可供选择的每页的行数（*）
    search: false,                      //是否显示表格搜索
    strictSearch: true,
    showColumns: true,                  //是否显示所有的列（选择显示的列）
    showRefresh: true,                  //是否显示刷新按钮
    minimumCountColumns: 2,             //最少允许的列数
    clickToSelect: true,                //是否启用点击选中行
    //height: 500,                      //行高，如果没有设置height属性，表格自动根据记录条数觉得表格高度
    uniqueId: "ID",                     //每一行的唯一标识，一般为主键列
    showToggle: true,                   //是否显示详细视图和列表视图的切换按钮
    cardView: false,                    //是否显示详细视图
    detailView: false,                  //是否显示父子表
    //得到查询的参数
    queryParams : function (params) {
        //这里的键的名字和控制器的变量名必须一致，这边改动，控制器也需要改成一样的
        var temp = {   
            rows: params.limit,                         //页面大小
            page: (params.offset / params.limit) + 1,   //页码
            sort: params.sort,      //排序列名  
            sortOrder: params.order //排位命令（desc，asc） 
        };
        return temp;
    },
    columns: [{
                checkbox: true,  
                visible: true                  //是否显示复选框  
              }, {
                 field: 'Name',
                 title: '姓名',
                 sortable: true
              }, {
                  field: 'Mobile',
                  title: '手机',
                  sortable: true
              }, {
                  field: 'Email',
                  title: '邮箱',
                  sortable: true,
                  formatter: emailFormatter
              }, {
                  field: 'Homepage',
                  title: '主页',
                  formatter: linkFormatter
              }, {
                  field: 'Hobby',
                  title: '兴趣爱好'
              }, {
                  field: 'Gender',
                  title: '性别',
                  sortable: true
              }, {
                  field: 'Age',
                  title: '年龄'
              }, {
                  field: 'BirthDate',
                  title: '出生日期',
                  formatter: dateFormatter
              }, {
                  field: 'Height',
                  title: '身高'
              }, {
                  field: 'Note',
                  title: '备注'
              }, {
                  field:'ID',
                  title: '操作',
                  width: 120,
                  align: 'center',
                  valign: 'middle',
                  formatter: actionFormatter
              }, ],
              onLoadSuccess: function () {
              },
              onLoadError: function () {
                  showTips("数据加载失败！");
              },
              onDblClickRow: function (row, $element) {
                  var id = row.ID;
                  EditViewById(id, 'view');
              },
      });
});

上面的代码是一个实例化bootstrap-table使用的属性，可以根据需要添加不必每次都写全。

2.1分页查询

这个组件我最喜欢的功能就是分页查询和排序，下面看一下如何使用

 queryParams : function (params) {
        //这里的键的名字和控制器的变量名必须一致，这边改动，控制器也需要改成一样的
        var temp = {   
            rows: params.limit,     //页面大小
            page: params.offset,    //页码
            sort: params.sort,      //排序列名  
            sortOrder: params.order //排位命令（desc，asc） 
        };
        return temp;
    }

 上面的queryParams是向后台传递的参数，可以扩展，传入任何的key值参数，但是必须保持前后台（controller中和页面中）量名相同。然后来说分页的事情，controller层只要返回一个类似{total:22,rows:[{},{},{}]}这样的json字符串即可，rows中存放的是一个JsonArray数组，这样前台就会解析出正确的表格，并且当我们改变页码，每页显示的条数params.limit，params.offset都会自动将正确的数字发送到后台。

排序操作同样很方便当我们在属性中加入sortable: true时，然后在需要排序的一列上写入sortable: true那么该列的表头上就会出现排序的小箭头，然后我们点击的时候params.sort，params.order这两个参数又会将列名，如：field: 'Name',（那么发送到后台的就会是Name）和升降序发送到后台，只要我们按照这个去查询就可以了。

2.3格式化输出函数及其他

如上面写道的格式化函数可以这样定义：

             }, {
                  field: 'Email',
                  title: '邮箱',
                  sortable: true,
                  formatter: emailFormatter
             }, {

 格式化的数据转义函数如下，主要就是根据内容进行格式化输出的JS函数，好像是需要放在一个文件内。

        //Email字段格式化
        function emailFormatter(value, row, index) {
            return "<a href='mailto:" + value + "' title='单击打开连接'>" + value + "</a>";
        }

   如果我们需要双击弹出编辑界面的层，我们可以处理表格的双击事件，如下代码所示。

onDblClickRow: function (row, $element) {

}

 对于表格记录的获取，我们可以通过下面的代码进行获取：$table.bootstrapTable('getSelections')

//单条记录
var rows = $table.bootstrapTable('getSelections');
//多条记录
var ids = "";
var rows = $table.bootstrapTable('getSelections');
for (var i = 0; i < rows.length; i++) {
    ids += rows[i].ID + ',';
}

如果要刷新表格数据可以使用下面的方法

function refreshTable(){
    $("#table").bootstrapTable("refresh",{url:"http://XXXXXXXX"})
}

这里只介绍了一些常用的方法 ，如有不足请移步官方文档。总之，bootstrap-table这个组件是一个很友好的前端组件，特此记录。