Bootstrap Table API 中文版(完整翻译文档)

包丁雨
2023-12-01

表格参数Edit on GitHub

 


 

表格的参数定义在 jQuery.fn.bootstrapTable.defaults

       

 

名称

标签

类型

默认

描述

-data-toggleString'table'不用写 JavaScript 直接启用表格。
classesdata-classesString'table table-hover'表格的类名称。默认情况下,表格是有边框的,你可以添加 'table-no-bordered' 来删除表格的边框样式。
sortClassdata-sort-classStringundefined被排序的td元素的类名。
heightdata-heightNumberundefined定义表格的高度。
undefinedTextdata-undefined-textString'-'当数据为 undefined 时显示的字符。
stripeddata-stripedBooleanfalse设置为 true 会有隔行变色效果。
sortNamedata-sort-nameStringundefined定义排序列,通过url方式获取数据填写字段名,否则填写下标。
sortOrderdata-sort-orderString'asc'定义排序方式,'asc' 或者 'desc'。
sortStabledata-sort-stableBooleanfalse设置为 true 将获得稳定的排序,我们会添加\_position属性到 row 数据中。
iconsPrefixdata-icons-prefixString'glyphicon'定义字体库 ('Glyphicon' or 'fa' for FontAwesome),使用"fa"时需引用 FontAwesome,并且配合 icons 属性实现效果。
Glyphicon 集成于Bootstrap可免费使用,参考: http://glyphicons.com/
FontAwesome 参考: http://fortawesome.github.io/
iconsdata-iconsObject{
  paginationSwitchDown: 'glyphicon-collapse-down icon-chevron-down',
  paginationSwitchUp: 'glyphicon-collapse-up icon-chevron-up',
  refresh: 'glyphicon-refresh icon-refresh'
  toggle: 'glyphicon-list-alt icon-list-alt'
  columns: 'glyphicon-th icon-th'
  detailOpen: 'glyphicon-plus icon-plus'
  detailClose: 'glyphicon-minus icon-minus'
}
自定义图标
columns-Array[]列配置项,详情请查看 列参数 表格.
data-Array[]加载json格式的数据。
ajaxdata-ajaxFunctionundefined自定义 AJAX 方法,须实现 jQuery AJAX API。
methoddata-methodString'get'服务器数据的请求方式 'get' 或 'post'。
urldata-urlStringundefined服务器数据的加载地址。
cachedata-cacheBooleantrue设置为 false 禁用 AJAX 数据缓存。
contentTypedata-content-typeString'application/json'发送到服务器的数据编码类型。
dataTypedata-data-typeString'json'服务器返回的数据类型。
ajaxOptionsdata-ajax-optionsObject{}提交ajax请求时的附加参数,可用参数列请查看http://api.jquery.com/jQuery.ajax.
queryParamsdata-query-paramsFunctionfunction(params) {
return params;
}
请求服务器数据时,你可以通过重写参数的方式添加一些额外的参数,例如 toolbar 中的参数 如果 queryParamsType = 'limit' ,返回参数必须包含
limit, offset, search, sort, order 否则, 需要包含: 
pageSize, pageNumber, searchText, sortName, sortOrder. 
返回false将会终止请求。
queryParamsTypedata-query-params-typeString'limit'设置为 'limit' 则会发送符合 RESTFul 格式的参数。
responseHandlerdata-response-handlerFunctionfunction(res) {
return res;
}
加载服务器数据之前的处理程序,可以用来格式化数据。
参数:res为从服务器请求到的数据。
paginationdata-paginationBooleanfalse设置为 true 会在表格底部显示分页条。
paginationLoopdata-pagination-loopBooleantrue设置为 true 启用分页条无限循环的功能。
onlyInfoPaginationdata-only-info-paginationBooleanfalse设置为 true 只显示总数据数,而不显示分页按钮。需要设置 pagination='true'。
sidePaginationdata-side-paginationString'client'设置在哪里进行分页,可选值为 'client' 或者 'server'。设置 'server'时,必须设置服务器数据地址(url)或者重写ajax方法。
pageNumberdata-page-numberNumber1如果设置了分页,首页页码。
pageSizedata-page-sizeNumber10如果设置了分页,页面数据条数。
pageListdata-page-listArray[10, 25, 50, 100, All]如果设置了分页,设置可供选择的页面数据条数。设置为 All 或者 Unlimited,则显示所有记录。
selectItemNamedata-select-item-nameString'btSelectItem'radio 或者 checkbox 的字段 name 名。
smartDisplaydata-smart-displayBooleantrue设置为 true 是程序自动判断显示分页信息和 card 视图。
escapedata-escapeBooleanfalse转义HTML字符串,替换 &<>"\`, 和 ' 字符。
searchdata-searchBooleanfalse是否启用搜索框。
searchOnEnterKeydata-search-on-enter-keyBooleanfalse设置为 true时,按回车触发搜索方法,否则自动触发搜索方法。
strictSearchdata-strict-searchBooleanfalse设置为 true启用全匹配搜索,否则为模糊搜索。
searchTextdata-search-textString''初始化搜索文字。
searchTimeOutdata-search-time-outNumber500设置搜索超时时间。
trimOnSearchdata-trim-on-searchBooleantrue设置为 true 将自动去掉搜索字符的前后空格。
showHeaderdata-show-headerBooleantrue是否显示列头。
showFooterdata-show-footerBooleanfalse是否显示列脚。
showColumnsdata-show-columnsBooleanfalse是否显示内容列下拉框。
showRefreshdata-show-refreshBooleanfalse是否显示刷新按钮。
showToggledata-show-toggleBooleanfalse是否显示切换视图(table/card)按钮。
showPaginationSwitchdata-show-pagination-switchBooleanfalse是否显示切换分页按钮。
showFullscreendata-show-fullscreenBooleanfalse是否显示全屏按钮。
minimumCountColumnsdata-minimum-count-columnsNumber1最小隐藏列的数量。
idFielddata-id-fieldStringundefined指定主键列。
uniqueIddata-unique-idStringundefined对每一行指定唯一标识符。
cardViewdata-card-viewBooleanfalse设置为 true将显示card视图,适用于移动设备。否则为table试图,适用于pc端。
detailViewdata-detail-viewBooleanfalse设置为 true 可以显示详细页面模式。
detailFormatterdata-detail-formatterFunctionfunction(index, row) {
return '';
}
格式化详细页面模式的视图。
searchAligndata-search-alignString'right'指定 搜索框 水平方向的位置。'left' 或 'right'。
buttonsAligndata-buttons-alignString'right'指定 按钮栏 水平方向的位置。'left' 或 'right'。
toolbarAligndata-toolbar-alignString'left'指定 toolbar 水平方向的位置。'left' 或 'right'。
paginationVAligndata-pagination-v-alignString'bottom'指定 分页条 在垂直方向的位置。'top','bottom' 或 'both'。
paginationHAligndata-pagination-h-alignString'right'指定 分页条 在水平方向的位置。'left' 或 'right'。
paginationDetailHAligndata-pagination-detail-h-alignString'left'指定 分页详细信息 在水平方向的位置。'left' 或 'right'。
paginationPreTextdata-pagination-pre-textString'<'指定分页条中上一页按钮的图标或文字。
paginationNextTextdata-pagination-next-textString'>'指定分页条中下一页按钮的图标或文字。
clickToSelectdata-click-to-selectBooleanfalse设置 true 将在点击行时,自动选择 rediobox 和 checkbox。
ignoreClickToSelectOndata-ignore-click-to-select-onFunction{ return $.inArray(element.tagName, ['A', 'BUTTON']); }包含一个参数:
element: 点击的元素。
返回 true 是点击事件会被忽略,返回 false 将会自动选中。该选项只有在 clickToSelect 为 true 时才生效。
singleSelectdata-single-selectBooleanfalse设置 true 将禁止多选。
toolbardata-toolbarStringundefined一个jQuery 选择器,指明自定义的 toolbar。例如:
#toolbar, .toolbar.
buttonsToolbardata-buttons-toolbarString | Nodeundefined一个jQuery 选择器,指明自定义的 buttons toolbar。例如:
    #buttons-toolbar, .buttons-toolbar 或 DOM 节点。
checkboxHeaderdata-checkbox-headerBooleantrue设置 false 将在列头隐藏全选复选框。
maintainSelecteddata-maintain-selectedBooleanfalse设置为 true 在点击分页按钮或搜索按钮时,将记住checkbox的选择项。
sortabledata-sortableBooleantrue设置为false 将禁止所有列的排序。
silentSortdata-silent-sortBooleantrue设置为 false 将在点击分页按钮时,自动记住排序项。仅在 sidePagination设置为 server时生效。
rowStyledata-row-styleFunctionfunction(row,index) {
return class;
}
自定义行样式 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css
rowAttributesdata-row-attributesFunctionfunction(row,index) {
return attributes;
}
自定义行属性 参数为:
row: 行数据
index: 行下标
返回值可以为class或者css 支持所有自定义属性
customSearchdata-custom-searchFunction$.noop自定义搜索方法来替代内置的搜索功能,它包含一个参数:
        text:搜索文字。
用法示例:
        function customSearch(text) {
            //Search logic here.
            //You must use `this.data` array in order to filter the data. NO use `this.options.data`.
        }
        
customSortdata-custom-sortFunction$.noop自定义排序方法来替代内置的搜索功能,它包含一个参数:
sortName: 排序名。
sortOrder: 排序顺序。
用法示例:
        function customSort(sortName, sortOrder) {
            //Sort logic here.
            //You must use `this.data` array in order to sort the data. NO use `this.options.data`.
        }
        

列参数Edit on GitHub

 


 

The column options is defined in jQuery.fn.bootstrapTable.columnDefaults.

 

Name

Attribute

Type

Default

Description

radiodata-radioBooleanfalseTrue to show a radio. The radio column has fixed width.
checkboxdata-checkboxBooleanfalseTrue to show a checkbox. The checkbox column has fixed width.
fielddata-fieldStringundefinedThe column field name.
titledata-titleStringundefinedThe column title text.
titleTooltipdata-title-tooltipStringundefinedThe column title tooltip text. This option also support the title HTML attribute
classclass / data-classStringundefinedThe column class name.
rowspanrowspan / data-rowspanNumberundefinedIndicate how many rows a cell should take up.
colspancolspan / data-colspanNumberundefinedIndicate how many columns a cell should take up.
aligndata-alignStringundefinedIndicate how to align the column data. 'left', 'right', 'center' can be used.
haligndata-halignStringundefinedIndicate how to align the table header. 'left', 'right', 'center' can be used.
faligndata-falignStringundefinedIndicate how to align the table footer. 'left', 'right', 'center' can be used.
valigndata-valignStringundefinedIndicate how to align the cell data. 'top', 'middle', 'bottom' can be used.
widthdata-widthNumber {Pixels or Percentage}undefinedThe width of column. If not defined, the width will auto expand to fit its contents. Also you can add '%' to your number and the bootstrapTable will use the percentage unit, otherwise, you can add or no the 'px' to your number and then the bootstrapTable will use the pixels
sortabledata-sortableBooleanfalseTrue to allow the column can be sorted.
orderdata-orderString'asc'The default sort order, can only be 'asc' or 'desc'.
visibledata-visibleBooleantrueFalse to hide the columns item.
cardVisibledata-card-visibleBooleantrueFalse to hide the columns item in card view state.
switchabledata-switchableBooleantrueFalse to disable the switchable of columns item.
clickToSelectdata-click-to-selectBooleantrueTrue to select checkbox or radiobox when the column is clicked.
formatterdata-formatterFunctionundefinedThe context (this) is the column Object. 
The cell formatter function, take three parameters: 
value: the field value. 
row: the row record data.
index: the row index.
footerFormatterdata-footer-formatterFunctionundefinedThe context (this) is the column Object. 
The function, take one parameter: 
data: Array of all the data rows. 
the function should return a string with the text to show in the footer cell.
eventsdata-eventsObjectundefinedThe cell events listener when you use formatter function, take three parameters: 
event: the jQuery event. 
value: the field value. 
row: the row record data.
index: the row index.
sorterdata-sorterFunctionundefinedThe custom field sort function that used to do local sorting, take two parameters: 
a: the first field value.
b: the second field value.
rowA: the first row.
rowB: the second row.
sortNamedata-sort-nameStringundefinedProvide a customizable sort-name, not the default sort-name in the header, or the field name of the column. For example, a column might display the value of fieldName of "html" such as "<b><span style="color:red">abc</span></b>", but a fieldName to sort is "content" with the value of "abc".
cellStyledata-cell-styleFunctionundefinedThe cell style formatter function, take three parameters: 
value: the field value.
row: the row record data.
index: the row index.
field: the row field.
Support classes or css.
searchabledata-searchableBooleantrueTrue to search data for this column.
searchFormatterdata-search-formatterBooleantrueTrue to search use formated data.
escapedata-escapeBooleanfalseEscapes a string for insertion into HTML, replacing &, <, >, ", \`, and ' characters.
showSelectTitledata-show-select-titleBooleanfalseTrue to show the title of column with 'radio' or 'singleSelect' 'checkbox' option.

事件Edit on GitHub

 


 

 

Option 事件

jQuery 事件

参数

描述

onAllall.bs.tablename, args所有的事件都会触发该事件,参数包括:
name:事件名,
args:事件的参数。
onClickRowclick-row.bs.tablerow, $element当用户点击某一行的时候触发,参数包括:
row:点击行的数据,
$element:tr 元素,
field:点击列的 field 名称。
onDblClickRowdbl-click-row.bs.tablerow, $element当用户双击某一行的时候触发,参数包括:
row:点击行的数据,
$element:tr 元素,
field:点击列的 field 名称。
onClickCellclick-cell.bs.tablefield, value, row, $element当用户点击某一列的时候触发,参数包括:
field:点击列的 field 名称,
value:点击列的 value 值,
row:点击列的整行数据,
$element:td 元素。
onDblClickCelldbl-click-cell.bs.tablefield, value, row, $element当用户双击某一列的时候触发,参数包括:
field:点击列的 field 名称,
value:点击列的 value 值,
row:点击列的整行数据,
$element:td 元素。
onSortsort.bs.tablename, order当用户对某列进行排序时触发,参数包括:
name:排序列的 filed 名称,
order:排序顺序。
onCheckcheck.bs.tablerow当用户选择某一行时触发,参数包含:
        row:与点击行对应的记录,
        $element:选择的DOM元素。
onUncheckuncheck.bs.tablerow当用户反选某一行时触发,参数包含:
row:与点击行对应的记录,
        $element:选择的DOM元素。
onCheckAllcheck-all.bs.tablerows当用户全选所有的行时触发,参数包含:
rows:最新选择的所有行的数组。
onUncheckAlluncheck-all.bs.tablerows当用户反选所有的行时触发,参数包含:
rows:最新选择的所有行的数组。
onCheckSomecheck-some.bs.tablerows当用户选择某些行时触发,参数包含:
rows:相对于之前选择的行的数组。
onUncheckSomeuncheck-some.bs.tablerows当用户反选某些行时触发,参数包含:
rows:相对于之前选择的行的数组。
onLoadSuccessload-success.bs.tabledata远程数据加载成功时触发成功。
onLoadErrorload-error.bs.tablestatus远程数据加载失败时触发成功。
onColumnSwitchcolumn-switch.bs.tablefield, checked当切换列的时候触发。
onColumnSearchcolumn-search.bs.tablefield, text当搜索列时触发。
onPageChangepage-change.bs.tablenumber, size当页面更改页码或页面大小时触发。
onSearchsearch.bs.tabletext当搜索表格时触发。
onToggletoggle.bs.tablecardView切换表格视图时触发。
onPreBodypre-body.bs.tabledata在表格 body 渲染之前触发。
onPostBodypost-body.bs.tablenone在表格 body 渲染完成后触发。
onPostHeaderpost-header.bs.tablenone在表格 header 渲染完成后触发。
onExpandRowexpand-row.bs.tableindex, row, $detail当点击详细图标展开详细页面的时候触发。
onCollapseRowcollapse-row.bs.tableindex, row当点击详细图片收起详细页面的时候触发。
onRefreshOptionsrefresh-options.bs.tableoptions刷新选项之后并在销毁和初始化表之前触发。
onRefreshrefresh.bs.tableparams点击刷新按钮后触发。
onScrollBodyscroll-body.bs.table 表格 body 滚动时触发。

方法Edit on GitHub

 


 

使用方法的语法:$('#table').bootstrapTable('method', parameter);

 

名称

参数

描述

例子

getOptionsnone返回表格的 Options。 
getSelectionsnone返回所选的行,当没有选择任何行的时候返回一个空数组。 
getAllSelectionsnone返回所有选择的行,包括搜索过滤前的,当没有选择任何行的时候返回一个空数组。 
getDatauseCurrentPage或者当前加载的数据。假如设置 useCurrentPage 为 true,则返回当前页的数据。 
getRowByUniqueIdid根据 uniqueId 获取行数据。 
loaddata加载数据到表格中,旧数据会被替换。 
showAllColumnsnone显示所有列。 
hideAllColumnsnone隐藏所有列。 
appenddata添加数据到表格在现有数据之后。 
prependdata插入数据到表格在现有数据之前。 
removeparams从表格中删除数据,包括两个参数: field: 需要删除的行的 field 名称,
values: 需要删除的行的值,类型为数组。
 
removeAll-删除表格所有数据。 
removeByUniqueIdid根据 uniqueId 删除指定的行。 
insertRowparams插入新行,参数包括:
index: 要插入的行的 index,
row: 行的数据,Object 对象。
 
updateRowparams更新指定的行,参数包括:
index: 要更新的行的 index,
row: 行的数据,Object 对象。
 
showRowparams显示指定的行,参数包括:
index: 要更新的行的 index 或者 uniqueId,
isIdField: 指定 index 是否为 uniqueid。
 
hideRowparams显示指定的行,参数包括:
index: 要更新的行的 index,
uniqueId: 或者要更新的行的 uniqueid。
 
getHiddenRowsshow获取所有隐藏的行,如果show参数为true,行将再次显示,否则,只返回隐藏的行。
mergeCellsoptions将某些单元格合并到一个单元格,选项包含以下属性: 
index: 行索引,
field: 字段名称,
rowspan: 要合并的rowspan数量,
colspan: 要合并的colspan数量。
updateCellparams更新一个单元格,params包含以下属性:
index: 行索引。
field: 字段名称。
value: 新字段值。
refreshparams刷新远程服务器数据,可以设置{silent: true}以静默方式刷新数据,并设置{url: newUrl}更改URL。 要提供特定于此请求的查询参数,请设置{query: {foo: 'bar'}}
refreshOptionsoptions刷新选项。
resetSearchtext设置搜索文本。
showLoadingnone显示加载状态。
hideLoadingnone隐藏加载状态。
checkAllnone选中当前页面所有行。
uncheckAllnone取消选中当前页面所有行。
checkindex选中某一行,行索引从0开始。
uncheckindex取消选中某一行,行索引从0开始。
checkByparams按值或数组选中某行,参数包含:
field: 用于查找记录的字段的名称,
values: 要检查的行的值数组。
例子: 
$("#table").bootstrapTable("checkBy", {field:"field_name", values:["value1","value2","value3"]})
uncheckByparams按值数组取消选中某行,参数包含:
field: 用于查找记录的字段的名称,
values: 要检查的行的值数组。
例子: 
$("#table").bootstrapTable("uncheckBy", {field:"field_name", values:["value1","value2","value3"]})
resetViewparams重置引导表视图,例如重置表高度。
resetWidthnone调整页眉和页脚的大小以适合当前列宽度。
destroynone销毁表。
showColumnfield显示指定的列。
hideColumnfield隐藏指定的列。
getHiddenColumns-获取隐藏的列。
getVisibleColumns-获取可见列。
scrollTovalue滚动到指定位置,单位为 px,设置 'bottom' 表示跳到最后。
getScrollPositionnone获取当前滚动条的位置,单位为 px。
filterByparams(只能用于 client 端)过滤表格数据, 你可以通过过滤{age: 10}来显示 age 等于 10 的数据。
selectPagepage跳到指定的页。
prevPagenone跳到上一页。
nextPagenone跳到下一页。
togglePaginationnone切换分页选项。
toggleViewnone切换 card/table 视图
expandRowindex如果详细视图选项设置为True,可展开索引为 index 的行。
collapseRowindex如果详细视图选项设置为True,可收起索引为 index 的行。.
expandAllRowsnone如果详细视图选项设置为True,可展开所有行。
collapseAllRowsnone如果详细视图选项设置为True,可收起开所有行。

多语言Edit on GitHub

 


 

 

Name

Parameter

Default

formatLoadingMessage-'Loading, please wait…'
formatRecordsPerPagepageNumber'%s records per page'
formatShowingRowspageFrom, pageTo, totalRows'Showing %s to %s of %s rows'
formatDetailPaginationtotalRows'Showing %s rows'
formatSearch-'Search'
formatNoMatches-'No matching records found'
formatRefresh-'Refresh'
formatToggle-'Toggle'
formatColumns-'Columns'
formatAllRows-'All'
formatFullscreen-'Fullscreen'

 


 

PS:

We can import all locale files what you need:

Copy

<script src="bootstrap-table-en-US.js"></script>
<script src="bootstrap-table-zh-CN.js"></script>
...

And then use JavaScript to switch locale:

Copy

$.extend($.fn.bootstrapTable.defaults, $.fn.bootstrapTable.locales['en-US']);
// $.extend($.fn.bootstrapTable.defaults, $.fn.bootstrapTable.locales['zh-CN']);
// ...

Back to top假如您喜欢 Bootstrap Table: 

  •  
  •  
  •  

 问题/帮助: 

该文档由 @wenzhixin 设计和建设。

由 @wenzhixin 开发维护,以及其他 贡献者帮忙维护。

代码许可:MIT,文档许可:CC BY 3.0

 
 类似资料: