關於 Bootstrap Table 的引入,一般有兩種方法:
1、直接下載源碼,添加到項目裡。由於 Bootstrap Table 是 Bootstrap 的一個組件,依賴於 Bootstrap,所以首先需要添加 Bootstrap 的引用。
2、使用方便的 NuGet。打開 NuGet,搜索相關套件:

Bootstrap 已經是 3.3.5 了,直接安裝即可。

而 NuGet 上的 Bootstrap Table 版本竟然是 0.4,太老了。所以建議 Bootstrap Table 直接到源碼那邊下載,最新版本約為 1.9.0。
組件引用進來後,使用就簡單了,只是裡面有很多細節需要處理。
1、在 cshtml 頁面引用相關組件,並定義一個空的表格。
@{ Layout = null; } <!DOCTYPE html> <html> <head> <meta name="viewport" content="width=device-width" /> <title>BootStrap Table使用</title> @*1、Jquery組件引用*@ <script src="~/Scripts/jquery-1.10.2.js"></script> @*2、bootstrap組件引用*@ <script src="~/Content/bootstrap/bootstrap.js"></script> <link href="~/Content/bootstrap/bootstrap.css" rel="stylesheet" /> @*3、bootstrap table組件以及中文包的引用*@ <script src="~/Content/bootstrap-table/bootstrap-table.js"></script> <link href="~/Content/bootstrap-table/bootstrap-table.css" rel="stylesheet" /> <script src="~/Content/bootstrap-table/locale/bootstrap-table-zh-CN.js"></script> @*4、頁面Js文件的引用*@ <script src="~/Scripts/Home/Index.js"></script> </head> <body> <div class="panel-body" style="padding-bottom:0px;"> <div class="panel panel-default"> <div class="panel-heading">查詢條件</div> <div class="panel-body"> <form id="formSearch" class="form-horizontal"> <div class="form-group" style="margin-top:15px"> <label class="control-label col-sm-1" for="txt_search_departmentname">部門名稱</label> <div class="col-sm-3"> <input type="text" class="form-control" id="txt_search_departmentname"> </div> <label class="control-label col-sm-1" for="txt_search_statu">狀態</label> <div class="col-sm-3"> <input type="text" class="form-control" id="txt_search_statu"> </div> <div class="col-sm-4" style="text-align:left;"> <button type="button" style="margin-left:50px" id="btn_query" class="btn btn-primary">查詢</button> </div> </div> </form> </div> </div> <div id="toolbar" class="btn-group"> <button id="btn_add" type="button" class="btn btn-default"> <span class="glyphicon glyphicon-plus" aria-hidden="true"></span>新增 </button> <button id="btn_edit" type="button" class="btn btn-default"> <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span>修改 </button> <button id="btn_delete" type="button" class="btn btn-default"> <span class="glyphicon glyphicon-remove" aria-hidden="true"></span>刪除 </button> </div> <table id="tb_departments"></table> </div> </body> </html>
引入需要的檔案後,最重要的就是定義一個空的 table,如 <table id="tb_departments"></table>。Bootstrap table 也提供了一種直接在 table 標籤裡定義 data-* 屬性的簡便用法,但這種方式雖簡單卻不夠靈活,遇到父子表等高級用法時不好處理,所以統一使用在 js 裡初始化的方式。
2、Js 初始化
$(function () { //1.初始化Table var oTable = new TableInit(); oTable.Init(); //2.初始化Button的點擊事件 var oButtonInit = new ButtonInit(); oButtonInit.Init(); }); var TableInit = function () { var oTableInit = new Object(); //初始化Table oTableInit.Init = function () { $('#tb_departments').bootstrapTable({ url: '/Home/GetDepartment', //請求後台的URL(*) method: 'get', //請求方式(*) toolbar: '#toolbar', //工具按鈕用哪個容器 striped: true, //是否顯示行間隔色 cache: false, //是否使用緩存,默認為true,所以一般情況下需要設置一下這個屬性(*) pagination: true, //是否顯示分頁(*) sortable: false, //是否啟用排序 sortOrder: "asc", //排序方式 queryParams: oTableInit.queryParams,//傳遞參數(*) sidePagination: "server", //分頁方式:client客戶端分頁,server服務端分頁(*) pageNumber:1, //初始化加載第一頁,默認第一頁 pageSize: 10, //每頁的記錄行數(*) pageList: [10, 25, 50, 100], //可供選擇的每頁的行數(*) search: true, //是否顯示表格搜索,此搜索是客戶端搜索,不會進服務端,所以,個人感覺意義不大 strictSearch: true, showColumns: true, //是否顯示所有的列 showRefresh: true, //是否顯示刷新按鈕 minimumCountColumns: 2, //最少允許的列數 clickToSelect: true, //是否啟用點擊選中行 height: 500, //行高,如果沒有設置height屬性,表格自動根據記錄條數覺得表格高度 uniqueId: "ID", //每一行的唯一標識,一般為主鍵列 showToggle:true, //是否顯示詳細視圖和列表視圖的切換按鈕 cardView: false, //是否顯示詳細視圖 detailView: false, //是否顯示父子表 columns: [{ checkbox: true }, { field: 'Name', title: '部門名稱' }, { field: 'ParentName', title: '上級部門' }, { field: 'Level', title: '部門級別' }, { field: 'Desc', title: '描述' }, ] }); }; //得到查詢的參數 oTableInit.queryParams = function (params) { var temp = { //這裡的鍵的名字和控制器的變量名必須一直,這邊改動,控制器也需要改成一樣的 limit: params.limit, //頁面大小 offset: params.offset, //頁碼 departmentname: $("#txt_search_departmentname").val(), statu: $("#txt_search_statu").val() }; return temp; }; return oTableInit; }; var ButtonInit = function () { var oInit = new Object(); var postdata = {}; oInit.Init = function () { //初始化頁面上面的按鈕事件 }; return oInit; };
表格的初始化很簡單,定義相關參數即可。上面重要的參數都加了註解,初始化 Table 必須的幾個參數也用(*)做了標記。同樣,columns 參數裡也有許多可設置項,比如列的排序、對齊、寬度等。
3、在 Controller 裡面對應的方法
public JsonResult GetDepartment(int limit, int offset, string departmentname, string statu) { var lstRes = new List<Department>(); for (var i = 0; i < 50; i++) { var oModel = new Department(); oModel.ID = Guid.NewGuid().ToString(); oModel.Name = "銷售部" + i ; oModel.Level = i.ToString(); oModel.Desc = "暫無描述信息"; lstRes.Add(oModel); } var total = lstRes.Count; var rows = lstRes.Skip(offset).Take(limit).ToList(); return Json(new { total = total, rows = rows }, JsonRequestBehavior.AllowGet); }
這裡有一點要特別注意:如果是服務端分頁,返回的結果必須包含 total、rows 兩個參數,漏寫或錯寫都會導致表格無法顯示資料;如果是客戶端分頁,則要返回一個集合物件到前端。





1、若在 js 裡設置 sidePagination: "server"(服務端分頁),返回值必須告訴前端總記錄條數和當前頁記錄數,且這兩個參數名必須為 total 和 rows。最開始寫成了 total 和 row,結果前端就是不顯示資料,找了好半天才發現是 row 寫錯了,應改成 rows。

2、關於 bootstrap 頁面樣式,圖標都是透過 class = "glyphicon glyphicon-plus" 這種方式寫的,但新增、修改、刪除前面的圖標怎麼都出不來。最後發現是 fonts 文件夾的問題——新建 MVC 項目時會自動創建一個 fonts 文件夾,而 bootstrap.css 放在 Content 裡,導致找不到這些樣式檔。


透過 Google 瀏覽器查看控制台,發現它自動去 Content 裡找 fonts 文件夾了。把 fonts 文件夾拷貝到 Content 下,問題就順利解決了。

3、關於中文。剛開始沒引用 bootstrap-table-zh-CN.js 這個包,所以界面顯示的是英文。查資料後了解到 bootstrap table 裡有一個中文包,把它添加進來就好了。

4、關於表格自帶的搜索功能,透過 search: true 可設置搜索框並進行模糊搜索。但採用服務端分頁時,每次返回前台的只有本頁資料,此時搜索就會失效。原因是 bootstrap-table.js 的 initSearch 方法裡有一個判斷:
BootstrapTable.prototype.onSearch = function (event) { var text = $.trim($(event.currentTarget).val()); // trim search input if (this.options.trimOnSearch && $(event.currentTarget).val() !== text) { $(event.currentTarget).val(text); } if (text === this.searchText) { return; } this.searchText = text; this.options.pageNumber = 1; this.initSearch(); this.updatePagination(); this.trigger('search', text); }; BootstrapTable.prototype.initSearch = function () { var that = this; if (this.options.sidePagination !== 'server') { var s = this.searchText && this.searchText.toLowerCase(); var f = $.isEmptyObject(this.filterColumns) ? null : this.filterColumns; // Check filter this.data = f ? $.grep(this.options.data, function (item, i) { for (var key in f) { if (item[key] !== f[key]) { return false; } } return true; }) : this.options.data; this.data = s ? $.grep(this.data, function (item, i) { for (var key in item) { key = $.isNumeric(key) ? parseInt(key, 10) : key; var value = item[key], column = that.columns[getFieldIndex(that.columns, key)], j = $.inArray(key, that.header.fields); // Fix #142: search use formated data if (column && column.searchFormatter) { value = calculateObjectValue(column, that.header.formatters[j], [value, item, i], value); } var index = $.inArray(key, that.header.fields); if (index !== -1 && that.header.searchables[index] && (typeof value === 'string' || typeof value === 'number')) { if (that.options.strictSearch) { if ((value + '').toLowerCase() === s) { return true; } } else { if ((value + '').toLowerCase().indexOf(s) !== -1) { return true; } } } } return false; }) : this.data; } };
在 initSearch 方法裡,它有個判斷 if (this.options.sidePagination !== 'server'),也就是說只有非服務端分頁才會進入檢索,這就是服務端分頁時搜索失效的原因。改成客戶端分頁確實可以搜索,但只過濾本頁資料,意義不大。
5、關於排序,由於 BS 系統通常採用服務端分頁,僅在 js 裡設置 sortable 和 sortOrder 是不會有效排序的,因為對本頁資料排序意義不大。一般需要把排序方式和排序欄位發送到後台,在後台排序。例如在參數裡增加兩個:
oTableInit.queryParams = function (params) { var temp = { //這裡的鍵的名字和控制器的變量名必須一直,這邊改動,控制器也需要改成一樣的 limit: params.limit, //頁面大小 offset: params.offset, //頁碼 order: params.order, ordername: params.sort, departmentname: $("#txt_search_departmentname").val(), statu: $("#txt_search_statu").val() }; return temp; };
在使用過 Jqgrid、EasyUI 等表格組件後,相比而言 Bootstrap Table 有自己的優勢:
1、界面採用扁平化風格,用戶體驗較好,更好相容各種客戶端,這點最重要。
2、開源、免費。
3、相對 Jqgrid、EasyUI 而言比較輕量級,功能雖非最全面,但基本夠用。
以上就是本文的全部內容,希望能幫助大家更好地學習 JS 表格組件神器 Bootstrap Table。