JS表格組件神器bootstrap table詳解（基礎(chǔ)版）

更新時(shí)間：2015年12月08日 10:55:19 作者：懶得安分

這篇文章主要介紹了JS表格組件神器bootstrap table，bootstrap table界面采用扁平化的風(fēng)格，用戶體驗(yàn)比較好，更好兼容各種客戶端，需要了解更多bootstrap table的朋友可以參考下

一、Bootstrap Table的引入

關(guān)于Bootstrap Table的引入，一般來說還是兩種方法：

1、直接下載源碼，添加到項(xiàng)目里面來。
由于Bootstrap Table是Bootstrap的一個(gè)組件，所以它是依賴Bootstrap的，我們首先需要添加Bootstrap的引用。

2、使用我們神奇的Nuget
打開Nuget，搜索這兩個(gè)包

Bootstrap已經(jīng)是最新的3.3.5了，我們直接安裝即可。

而Bootstrap Table的版本竟然是0.4，這也太坑爹了。所以博主建議Bootstrap Table的包就直接在源碼里面去下載吧。Bootstrap Table最新的版本好像是1.9.0。

二、代碼詳解
當(dāng)然，組件引用進(jìn)來了，使用就簡(jiǎn)單了，只不過這里面涉及很多細(xì)節(jié)需要我們處理，具體我們待會(huì)再說，先來看看使用方法。
1、在cshtml頁面引用相關(guān)組件，并定義好一個(gè)空的表格。

@{
 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">狀態(tài)</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>

引入需要的文件之后，我們最重要的就是定義一個(gè)空的table，如上的 <table id="tb_departments"></table> 。當(dāng)然Bootstrap table還提供了一種簡(jiǎn)介的用法，直接在table標(biāo)簽里面定義類似“data-...”等相關(guān)屬性，就不用再js里面注冊(cè)了，但博主覺得這種用法雖然簡(jiǎn)單，但不太靈活，遇到父子表等這些高級(jí)用法的時(shí)候就不太好處理了，所以咱們還是統(tǒng)一使用在js里面初始化的方式來使用table組件。
2、Js初始化

$(function () {

 //1.初始化Table
 var oTable = new TableInit();
 oTable.Init();

 //2.初始化Button的點(diǎn)擊事件
 var oButtonInit = new ButtonInit();
 oButtonInit.Init();

});


var TableInit = function () {
 var oTableInit = new Object();
 //初始化Table
 oTableInit.Init = function () {
 $('#tb_departments').bootstrapTable({
 url: '/Home/GetDepartment', //請(qǐng)求后臺(tái)的URL（*）
 method: 'get', //請(qǐng)求方式（*）
 toolbar: '#toolbar', //工具按鈕用哪個(gè)容器
 striped: true, //是否顯示行間隔色
 cache: false, //是否使用緩存，默認(rèn)為true，所以一般情況下需要設(shè)置一下這個(gè)屬性（*）
 pagination: true, //是否顯示分頁（*）
 sortable: false, //是否啟用排序
 sortOrder: "asc", //排序方式
 queryParams: oTableInit.queryParams,//傳遞參數(shù)（*）
 sidePagination: "server", //分頁方式：client客戶端分頁，server服務(wù)端分頁（*）
 pageNumber:1, //初始化加載第一頁，默認(rèn)第一頁
 pageSize: 10, //每頁的記錄行數(shù)（*）
 pageList: [10, 25, 50, 100], //可供選擇的每頁的行數(shù)（*）
 search: true, //是否顯示表格搜索，此搜索是客戶端搜索，不會(huì)進(jìn)服務(wù)端，所以，個(gè)人感覺意義不大
 strictSearch: true,
 showColumns: true, //是否顯示所有的列
 showRefresh: true, //是否顯示刷新按鈕
 minimumCountColumns: 2, //最少允許的列數(shù)
 clickToSelect: true, //是否啟用點(diǎn)擊選中行
 height: 500, //行高，如果沒有設(shè)置height屬性，表格自動(dòng)根據(jù)記錄條數(shù)覺得表格高度
 uniqueId: "ID", //每一行的唯一標(biāo)識(shí)，一般為主鍵列
 showToggle:true, //是否顯示詳細(xì)視圖和列表視圖的切換按鈕
 cardView: false, //是否顯示詳細(xì)視圖
 detailView: false, //是否顯示父子表
 columns: [{
 checkbox: true
 }, {
 field: 'Name',
 title: '部門名稱'
 }, {
 field: 'ParentName',
 title: '上級(jí)部門'
 }, {
 field: 'Level',
 title: '部門級(jí)別'
 }, {
 field: 'Desc',
 title: '描述'
 }, ]
 });
 };

 //得到查詢的參數(shù)
 oTableInit.queryParams = function (params) {
 var temp = { //這里的鍵的名字和控制器的變量名必須一直，這邊改動(dòng)，控制器也需要改成一樣的
 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;
};

表格的初始化也很簡(jiǎn)單，定義相關(guān)的參數(shù)即可。上面一些博主覺得重要的參數(shù)都加了注釋，并且初始化Table必須的幾個(gè)參數(shù)博主也用（*）做了標(biāo)記，如果你的表格也有太多的頁面需求，直接用必須的參數(shù)就能解決。同樣，在columns參數(shù)里面其實(shí)也有很多的參數(shù)需要設(shè)置，比如列的排序，對(duì)齊，寬度等等。這些博主覺得比較簡(jiǎn)單，不會(huì)涉及表格的功能，看看API就能搞定。
3、在Controller里面對(duì)應(yīng)的方法

 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);
 }

這里有一點(diǎn)需要注意：如果是服務(wù)端分頁，返回的結(jié)果必須包含total、rows兩個(gè)參數(shù)。漏寫或錯(cuò)寫都會(huì)導(dǎo)致表格無法顯示數(shù)據(jù)。相反，如果是客戶端分頁，這里要返回一個(gè)集合對(duì)象到前端。

4、效果及說明

還是貼幾張效果圖出來：

三、問題小結(jié)

由于是從零開始開發(fā)的以上功能，博主遇到一個(gè)問題可以和園友們分享一下，這應(yīng)該也是今天這篇想表達(dá)的重點(diǎn)。

1、上面說過，如果在js里面初始化的參數(shù)sidePagination: "server" 設(shè)置為在服務(wù)端分頁，那么我們的返回值必須告訴前端總記錄的條數(shù)和當(dāng)前頁的記錄數(shù)，然后前端才知道如何分頁。并且最重要的一點(diǎn)，這兩個(gè)參數(shù)的名字必須為total和rows。最開始也不知道這個(gè)，寫成了total和row，結(jié)果是請(qǐng)求可以進(jìn)到后臺(tái)的GetDepartment方法，返回值total和row也都有值，可是前端就是顯示如下：

找了好半天原因。原來是row寫錯(cuò)了，應(yīng)該寫成rows?？赡苓@也是前天園友遇到的問題的原因。

2、第二個(gè)問題就是關(guān)于bootstrap頁面樣式的問題，我們使用過bootstrap的朋友應(yīng)該知道，它里面所有的圖標(biāo)都是通過class = "glyphicon glyphicon-plus"這種方式去寫的。按要求這樣做了，可是新增、修改、刪除前面的圖標(biāo)怎么都出不來。如下：

怎么回事呢？然后各種百度，最后發(fā)現(xiàn)原來是fonts文件夾的問題。我們?cè)谛陆ㄒ粋€(gè)MVC項(xiàng)目的時(shí)候，會(huì)自動(dòng)創(chuàng)建一個(gè)fonts文件夾，里面內(nèi)容如下：

而我們的bootstrap.css是放在Content文件夾里面的，這樣就導(dǎo)致找不到這些樣式文件。最終通過谷歌瀏覽器查看控制臺(tái)

原來它自動(dòng)去Content里面找fonts文件夾了。這下就好辦了，把我們的fonts文件夾拷貝到Content下不就行了嗎。呵呵，原來真是這樣，問題順利解決。

3、關(guān)于中文。剛開始，沒有引用 <script src="~/Content/bootstrap-table/locale/bootstrap-table-zh-CN.js"></script> 這個(gè)包，所以界面找不到記錄是顯示的是英文，如下：

后來也是查資料了解到，bootstrap table里面原來還有一個(gè)中文包，把它添加進(jìn)來就好了。

4、第四點(diǎn)要說說表格自帶的搜索功能，有上可知，在初始化表格的時(shí)候，通過設(shè)置search: true可以設(shè)置表格的搜索框出現(xiàn)并且可以進(jìn)行模糊搜索。但是這個(gè)時(shí)候問題來了，我們采用的是服務(wù)端分頁，每次返回到前臺(tái)的只有本頁的數(shù)據(jù)，這個(gè)時(shí)候我們?cè)偎阉鞯臅r(shí)候發(fā)現(xiàn)：搜索不了。這是什么原因呢？博主在谷歌里面調(diào)試bootstrap-table.js這個(gè)js發(fā)現(xiàn)里面有這樣一段邏輯：

 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方法里面，它有一個(gè)判斷：if (this.options.sidePagination !== 'server') {......}也就是說，如果不是服務(wù)端分頁，才進(jìn)入檢索，重寫加載表格，否則壓根就不會(huì)進(jìn)入檢索，這也就是為什么服務(wù)分頁的時(shí)候，搜索會(huì)不起作用。博主試了下，換成客戶端分頁，確實(shí)可以搜索。呵呵，原來如此。其實(shí)這也很好里面，過濾本頁的數(shù)據(jù)，意義不大。
5、關(guān)于Bootstrap Table的排序，由于一般這種BS系統(tǒng)肯定會(huì)采用服務(wù)端分頁，我們?nèi)绻麅H僅在js里面設(shè)置sortable和sortOrder等屬性信息，表格是不會(huì)有效排序的。原因很簡(jiǎn)單，服務(wù)端分頁的方式，排序本頁數(shù)據(jù)意義不大。所以，一般的排序需要將排序方式和排序字段發(fā)送到后臺(tái)，在后臺(tái)排序比較合適。比如我們這里可以再參數(shù)里面增加兩個(gè)：

oTableInit.queryParams = function (params) {
 var temp = { //這里的鍵的名字和控制器的變量名必須一直，這邊改動(dòng)，控制器也需要改成一樣的
 limit: params.limit, //頁面大小
 offset: params.offset, //頁碼
 order: params.order,
 ordername: params.sort,
 departmentname: $("#txt_search_departmentname").val(),
 statu: $("#txt_search_statu").val()
 };
 return temp;
 };

五、總結(jié)
在開發(fā)經(jīng)歷中，也使用Jqgrid、EasyUI等表格組件。相比而言，bootstrap Table有自己的優(yōu)勢(shì)：

1、界面采用扁平化的風(fēng)格，用戶體驗(yàn)比較好，更好兼容各種客戶端。這點(diǎn)也是最重要的。

2、開源、免費(fèi)。國(guó)人最喜歡的就是免費(fèi)了。呵呵。

3、相對(duì)Jqgrid、easyUI而言，比較輕量級(jí)。功能不能說最全面，但基本夠用。

如果大家還想深入學(xué)習(xí)，可以點(diǎn)擊這里進(jìn)行學(xué)習(xí)，再為大家附兩個(gè)精彩的專題：Bootstrap學(xué)習(xí)教程 Bootstrap實(shí)戰(zhàn)教程 Bootstrap Table使用教程

最近新補(bǔ)充的一系列bootstrap基礎(chǔ)教程，歡迎大家學(xué)習(xí)。

以上就是本文的全部?jī)?nèi)容，希望能夠幫助大家更好的學(xué)習(xí)JS表格組件神器bootstrap table。

您可能感興趣的文章: