表格选项
Bootstrap Table 的表格选项 API。
表格选项在 jQuery.fn.bootstrapTable.defaults 中定义。
-
-
属性：
data-toggle -
类型：
String -
详情：
无需编写 JavaScript 即可激活 bootstrap 表格。
-
默认值：
'table' -
示例： 从 HTML
ajax
-
属性：
data-ajax -
类型：
Function -
详情：
替换 ajax 调用的方法。应实现与 jQuery ajax 方法相同的 API。
-
默认值：
undefined -
示例： 表格 AJAX
ajaxOptions
-
属性：
data-ajax-options -
类型：
Object -
详情：
提交 ajax 请求的其他选项。值列表：jQuery.ajax。
-
默认值：
{} -
示例： AJAX 选项
buttons
-
属性：
data-buttons -
类型：
Function -
详情：
此选项允许在”按钮栏”（表格右上角）创建/添加自定义按钮。 这些按钮可以使用表格选项 buttonsOrder 进行排序，应使用事件的键/名称！
自定义按钮高度可配置，存在以下选项：
text- 描述：此选项用于 showButtonText 表格选项。
- 类型：
String
icon- 描述：此选项用于 showButtonIcons 表格选项。
- 类型：
String- 仅需要图标类，例如fa-users
render- 描述：将此选项设置为
false以默认隐藏按钮，当添加数据属性data-show-button-name="true"时，按钮再次可见。
- 描述：将此选项设置为
attributes- 描述：此选项允许添加其他 HTML 属性，例如
title - 类型：
Object - 示例：
{title: '按钮标题'}
- 描述：此选项允许添加其他 HTML 属性，例如
html- 描述：如果不想自动生成 HTML，可以使用此选项插入自定义 HTML。
仅当自定义 HTML 包含
name="button-name"时，event选项才有效。 如果使用此选项，将忽略以下选项：texticonattributes
- 类型：
Function|String
- 描述：如果不想自动生成 HTML，可以使用此选项插入自定义 HTML。
仅当自定义 HTML 包含
event- 描述：如果要为按钮添加事件，则应使用此选项
- 类型：
Function|Object|String
The
eventoption can be configured in three ways. One event withclickevent:{ 'event': () => { } }One event with a self-defined event type:
{ 'event': { 'mouseenter': () => { } } }Multiple events with self-defined event types:
{ 'event': { 'click': () => { }, 'mouseenter': () => { }, 'mouseleave': () => { } } }提示： 除了内联函数，您还可以使用函数名。
A configured custom button could look like this:
{ btnRemoveEvenRows: { 'text': '删除偶数行', 'icon': 'fa-trash', 'event': () => { //删除偶数行的操作 }, 'attributes': { 'title': '删除所有具有偶数 ID 的行' } } } -
默认值：
{} -
示例： 按钮
buttonsAlign
-
属性：
data-buttons-align -
类型：
String -
详情：
指示如何对齐工具栏按钮。可以使用
'left'（左）、'right'（右）。 -
默认值：
'right' -
示例： 按钮对齐
buttonsAttributeTitle
-
属性：
data-buttons-attribute-title -
类型：
String -
详情：
自定义工具栏按钮的标题属性，主要用于自定义工具栏样式。
-
默认值：
'title' -
示例： 按钮属性标题
buttonsClass
-
属性：
data-buttons-class -
类型：
String -
详情：
定义表格按钮的类（添加在
'btn-'之后）。 -
默认值：
'secondary' -
示例： 按钮类
buttonsOrder
-
属性：
data-buttons-order -
类型：
Array -
详情：
指示如何自定义工具栏按钮的顺序。
-
默认值：
['paginationSwitch', 'refresh', 'toggle', 'fullscreen', 'columns'] -
示例： 按钮顺序
buttonsPrefix
-
属性：
data-buttons-prefix -
类型：
String -
详情：
定义表格按钮的前缀。
-
默认值：
'btn' -
示例： 按钮前缀
buttonsToolbar
-
属性：
data-buttons-toolbar -
类型：
String/Node -
详情：
指示自定义按钮工具栏的 jQuery 选择器，例如：
#buttons-toolbar、.buttons-toolbar或 DOM 节点。 -
默认值：
undefined -
示例： 按钮工具栏
cache
-
属性：
data-cache -
类型：
Boolean -
详情：
设置为
false以禁用 AJAX 请求的缓存。 -
默认值：
true -
示例： 表格缓存
cardView
-
属性：
data-card-view -
类型：
Boolean -
详情：
设置为
true以显示卡片视图表格，例如，移动视图。 -
默认值：
false -
示例： 卡片视图
checkboxHeader
-
属性：
data-checkbox-header -
类型：
Boolean -
详情：
设置
false以隐藏标题行中的全选复选框。 -
默认值：
true -
示例： 复选框标题
classes
-
属性：
data-classes -
类型：
String -
详情：
表格的类名。可以使用
'table'、'table-bordered'、'table-hover'、'table-striped'、'table-dark'、'table-sm'和'table-borderless'。默认情况下，表格是边框的。 -
默认值：
'table table-bordered table-hover' -
示例： 表格类
clickToSelect
-
属性：
data-click-to-select -
类型：
Boolean -
详情：
设置
true以选择复选框或单选框，当单击行时。 -
默认值：
false -
示例： 点击选择
columns
-
属性：
- -
类型：
Array -
详情：
表格列配置对象。有关更多详细信息，请参阅列属性。
-
默认值：
[] -
示例： 表格列
contentType
-
属性：
data-content-type -
类型：
String -
详情：
请求远程数据的内容类型，例如：
application/x-www-form-urlencoded。 -
默认值：
'application/json' -
示例： 内容类型
customSearch
-
属性：
data-custom-search -
类型：
Function -
详情：
自定义搜索函数，而不是内置搜索函数，接受三个参数：
data: 表格数据。text: 搜索文本。filter: 从filterBy方法返回的过滤对象。
示例用法：
function customSearch(data, text) {
return data.filter(function (row) {
return row.field.indexOf(text) > -1
})
}
-
默认值：
undefined -
示例： 自定义搜索
customSort
-
属性：
data-custom-sort -
类型：
Function -
详情：
自定义排序函数，而不是内置排序函数，接受三个参数：
sortName: 排序名称。sortOrder: 排序顺序。data: 行数据。
-
默认值：
undefined -
示例： 自定义顺序
data
-
属性：
data-data -
类型：
Array | Object -
详情：
要加载的数据。
如果数据中有
_<field>_rowspan或_<field>_colspan属性，则将自动合并单元格，例如：$table.bootstrapTable({ data: [ { id: 1, name: 'Item 1', _name_rowspan: 2, price: '$1' }, { id: 2, price: '$2' } ] })如果使用此功能，则需要确保数据格式正确。
-
默认值：
[] -
示例： 从数据
dataField
-
属性：
data-data-field -
类型：
String -
详情：
在传入的 JSON 中包含
'rows'数据列表的键。 -
默认值：
'rows' -
示例： 总计/数据字段
dataType
-
属性：
data-data-type -
类型：
String -
详情：
您期望从服务器返回的数据类型。
-
默认值：
'json' -
示例： 数据类型
detailFilter
-
属性：
data-detail-filter -
类型：
Function -
详情：
启用扩展每行，当
detailView设置为true时。返回 true，行将启用扩展，返回 false 并禁用行的扩展。默认函数返回 true 以允许扩展所有行。 -
默认值：
function(index, row) { return true } -
示例： 详细筛选
detailFormatter
-
属性：
data-detail-formatter -
类型：
Function -
详情：
当
detailView设置为true时，格式化您的详细视图。返回一个字符串，并将其附加到详细视图单元格中，可选地直接使用第三个参数渲染元素，该参数是目标单元格的 jQuery 元素。 -
默认值：
function(index, row, element) { return '' } -
示例： 详细视图
detailView
-
属性：
data-detail-view -
类型：
Boolean -
详情：
设置为
true以显示详细视图表。您可以设置uniqueId选项以保持详细视图状态，当刷新表格时。 -
默认值：
false -
示例： 详细视图唯一 ID
detailViewAlign
-
属性：
data-detail-view-align -
类型：
String -
详情：
指示如何对齐详细视图图标。可以使用
'left'、'right'。 -
默认值：
'left' -
示例： 详细视图对齐
detailViewByClick
-
属性：
data-detail-view-by-click -
类型：
Boolean -
详情：
设置为
true以在单击单元格时切换详细视图。 -
默认值：
false -
示例： 详细视图图标
detailViewIcon
-
属性：
data-detail-view-icon -
类型：
Boolean -
详情：
设置为
true以显示详细视图列（加号/减号图标）。 -
默认值：
true -
示例： 详细视图图标
escape
-
属性：
data-escape -
类型：
Boolean -
详情：
转义字符串以插入 HTML，替换 &、<、>、”、
和 ' 字符。 要禁用列标题检查escapeTitle` 选项。 -
默认值：
false -
示例： 表格转义
escapeTitle
-
属性：
data-escape-title -
类型：
Boolean -
详情：
切换是否应对列标题应用
escape选项。 -
默认值：
true -
示例： 表格转义标题
filterOptions
-
属性：
data-filter-options -
类型：
Boolean -
详情：
定义算法默认过滤选项，
filterAlgorithm: 'and'表示所有给定过滤器必须匹配，filterAlgorithm: 'or'表示一个给定过滤器必须匹配。 -
默认值：
{ filterAlgorithm: 'and' } -
示例： 过滤选项
fixedScroll
-
属性：
data-fixed-scroll -
类型：
Boolean -
详情：
设置为
true以启用表格固定滚动条位置，当加载数据时。 -
默认值：
false -
示例： 固定滚动
footerField
-
属性：
data-footer-field -
类型：
String -
详情：
定义从数据数组或服务器响应 JSON 中的页脚对象的键。 页脚对象可以用于设置/定义页脚 colspan 和/或页脚值。 仅在
data-pagination为true且data-side-pagination为server时触发。
{
"rows": [
{
"id": 0,
"name": "Item 0",
"price": "$0",
"amount": 3
}
],
"footer": {
"id": "footer id",
"_id_colspan": 2,
"name": "footer name"
}
}
-
默认值：
footerField -
示例： 页脚字段
footerStyle
-
属性：
data-footer-style -
类型：
Function -
详情：
页脚样式格式化函数，接受一个参数：
column: 列对象。
支持
classes或css。示例用法：
function footerStyle(column) {
return {
css: { 'font-weight': 'normal' },
classes: 'my-class'
}
}
-
默认值：
{} -
示例： 页脚样式
headerStyle
-
属性：
data-header-style -
类型：
Function -
详情：
标题样式格式化函数，接受一个参数：
column: 列对象。
支持
classes或css。示例用法：
function headerStyle(column) {
return {
css: { 'font-weight': 'normal' },
classes: 'my-class'
}
}
-
默认值：
{} -
示例： 标题样式
height
-
属性：
data-height -
类型：
Number -
详情：
表格的高度，启用表格的固定标题。
-
默认值：
undefined -
示例： 表格高度
icons
-
属性：
data-icons -
类型：
Object -
详情：
定义在工具栏、分页和详细视图中使用的图标。
-
默认值：
{
paginationSwitchDown: 'fa-caret-square-down',
paginationSwitchUp: 'fa-caret-square-up',
refresh: 'fa-sync',
toggleOff: 'fa-toggle-off',
toggleOn: 'fa-toggle-on',
columns: 'fa-th-list',
fullscreen: 'fa-arrows-alt',
detailOpen: 'fa-plus',
detailClose: 'fa-minus'
}
- 示例： 表格图标
iconSize
-
属性：
data-icon-size -
类型：
String -
详情：
定义图标大小，可以使用
undefined、'lg'、'sm'。 -
默认值：
undefined -
示例： 图标大小
iconsPrefix
-
属性：
data-icons-prefix -
类型：
String -
详情：
定义图标集名称。默认情况下，此选项是自动计算的。
{ bootstrap3: 'glyphicon', bootstrap4: 'fa', bootstrap5: 'bi', 'bootstrap-table': 'icon', bulma: 'fa', foundation: 'fa', materialize: 'material-icons', semantic: 'fa' } -
默认值：
undefined -
示例： 图标前缀
idField
-
属性：
data-id-field -
类型：
String -
详情：
指示将使用哪个字段作为复选框/单选框值，它是 selectItemName 的对应项。
-
默认值：
undefined -
示例： ID字段
ignoreClickToSelectOn
-
属性：
data-ignore-click-to-select-on -
类型：
Function -
详情：
设置忽略元素
clickToSelect的元素。接受一个参数：element: 单击的元素。
如果单击应被忽略，则返回 true，否则返回 false，以导致选择行。此选项仅在
clickToSelect为 true 时相关。 -
默认值：
{ return ['A', 'BUTTON'].includes(tagName) } -
示例： 忽略点击选择
loadingFontSize
-
属性：
data-loading-font-size -
类型：
String -
详情：
定义加载文本的字体大小，默认值为
'auto'，根据表格宽度自动计算，范围为 12px 到 32px。 -
默认值：
'auto' -
示例： 加载字体大小
loadingTemplate
-
属性：
data-loading-template -
类型：
Function -
详情：
自定义加载类型。参数对象包含：
- loadingMessage: 格式化加载消息的
formatLoadingMessage本地化。
- loadingMessage: 格式化加载消息的
- 默认值：
function (loadingMessage) { return '<span class="loading-wrap">' + '<span class="loading-text">' + loadingMessage + '</span>' + '<span class="animation-wrap"><span class="animation-dot"></span></span>' + '</span>' } - 示例： 加载模板
locale
-
属性：
data-locale -
类型：
String -
详情：
设置要使用的语言（例如
'zh-CN'）。必须预加载语言文件。 允许使用备用语言，如果加载，则按以下顺序：- 首先尝试指定的语言，
- 然后尝试将 ‘_’ 翻译为 ‘-‘ 并大写区域代码的语言，
- 然后尝试短语言代码（例如，
'zh'而不是'zh-CN'）， - 最后将使用最后加载的语言文件（或如果没有加载语言文件，则使用默认语言）。
如果未定义或空字符串，则使用最后加载的语言（或如果没有加载语言文件，则使用
'en-US'）。 -
默认值：
undefined -
示例： 表格语言
maintainMetaData
-
属性：
data-maintain-meta-data -
类型：
Boolean -
详情：
设置为
true以保持以下元数据在更改页面和搜索时：- 选定的行
- 隐藏的行
-
默认值：
false -
示例： 保持元数据
method
-
属性：
data-method -
类型：
String -
详情：
请求远程数据的方法类型。
-
默认值：
'get' -
示例： 表格方法
minimumCountColumns
-
属性：
data-minimum-count-columns -
类型：
Number -
详情：
隐藏列下拉列表中的最小列数。
-
默认值：
1 -
示例： 最小列数
multipleSelectRow
-
属性：
data-multiple-select-row -
类型：
Boolean -
详情：
设置为
true以启用多行选择。可以使用 ctrl+click 选择一行或 shift+click 选择范围行。 -
默认值：
false -
示例： 多行选择
pageList
-
属性：
data-page-list -
类型：
Array -
详情：
设置分页属性时，通过选择列表初始化页面大小。如果包括
'all'或'unlimited'选项，则所有记录将显示在您的表格中。提示：如果表格行少于选项（s），则将自动隐藏选项（s）。要禁用此功能，可以将 smartDisplay 设置为
false -
默认值：
[10, 25, 50, 100] -
示例： 页面列表
pageNumber
-
属性：
data-page-number -
类型：
Number -
详情：
设置分页属性时，初始化页面编号。
-
默认值：
1 -
示例： 页面编号
pageSize
-
属性：
data-page-size -
类型：
Number -
详情：
设置分页属性时，初始化页面大小。
-
默认值：
10 -
示例： 页面大小
pagination
-
属性：
data-pagination -
类型：
Boolean -
详情：
设置为
true以在表格底部显示分页工具栏。 -
默认值：
false -
示例： 表格分页
paginationDetailHAlign
-
属性：
data-pagination-detail-h-align -
类型：
String -
详情：
指示如何对齐分页详细信息。可以使用
'left'、'right'。 -
默认值：
'left' -
示例： 分页 H 对齐
paginationHAlign
-
属性：
data-pagination-h-align -
类型：
String -
详情：
指示如何对齐分页。可以使用
'left'、'right'。 -
默认值：
'right' -
示例： 分页 H 对齐
paginationLoadMore
-
属性：
data-pagination-load-more -
类型：
Boolean -
详情：
设置为
true以通过分页加载更多数据。它仅在客户端分页中使用。通常，要实现 “加载更多” 功能，通常需要将其与responseHandler结合使用以处理返回的数据。它主要用于在总页数未知的情况下使用。在这种情况下，不可能显示确切的页数或计算页数。相反，可以使用显示格式（例如 “100+”）来指示存在超出显示数量的项目。随着用户导航到最后一页，将加载更多数据，并更新分页信息。此过程将继续，直到所有数据加载完成。
-
默认值：
false -
示例： 分页加载更多
paginationLoop
-
属性：
data-pagination-loop -
类型：
Boolean -
详情：
设置为
true以启用分页连续循环模式。 -
默认值：
true -
示例： 分页循环
paginationNextText
-
属性：
data-pagination-next-text -
类型：
String -
详情：
指示在分页详细信息中显示图标或文本，下一按钮。
-
默认值：
'›' -
示例： 分页文本
paginationPagesBySide
-
属性：
data-pagination-pages-by-side -
类型：
Number -
详情：
当前页面每侧（右侧、左侧）的页面数。
-
默认值：
1 -
示例： 分页索引编号
paginationParts
-
属性：
data-pagination-parts -
类型：
Array -
详情：
这些选项定义哪些分页部分应可见。
pageInfo显示当前页面将显示的数据集（例如Showing 1 to 10 of 54 rows）。pageInfoShort类似于pageInfo，它仅显示表格有多少行（例如Showing 54 rows）。pageSize显示定义应显示多少行的下拉列表。pageList显示分页的主要部分（页码列表）。
-
默认值：
['pageInfo', 'pageSize', 'pageList'] -
示例： 分页部分
paginationPreText
-
属性：
data-pagination-pre-text -
类型：
String -
详情：
指示在分页详细信息中显示图标或文本，上一按钮。
-
默认值：
'‹' -
示例： 分页文本
paginationSuccessivelySize
-
属性：
data-pagination-successively-size -
类型：
Number -
详情：
一行中连续页数的最大数量。
-
默认值：
5 -
示例： 分页索引编号
paginationUseIntermediate
-
属性：
data-pagination-use-intermediate -
类型：
Boolean -
详情：
计算并显示中间页面以快速访问。
-
默认值：
false -
示例： 分页索引编号
paginationVAlign
-
属性：
data-pagination-v-align -
类型：
String -
详情：
指示如何垂直对齐分页。可以使用
'top'、'bottom'、'both'（将分页放在顶部和底部）。 -
默认值：
'bottom' -
示例： 分页 V 对齐
queryParams
-
属性：
data-query-params -
类型：
Function -
详情：
请求远程数据时，可以通过修改 queryParams 发送其他参数。
如果
queryParamsType = 'limit'，则 params 对象包含：limit、offset、search、sort、order。否则，它包含：
pageSize、pageNumber、searchText、sortName、sortOrder。返回
false以停止请求。 -
默认值：
function(params) { return params } -
示例： 查询参数
queryParamsType
-
属性：
data-query-params-type -
类型：
String -
详情：
设置为
'limit'以发送查询参数作为 RESTFul 类型。 -
默认值：
'limit' -
示例： 查询参数类型
regexSearch
-
属性：
data-regex-search -
类型：
Boolean -
详情：
设置为
true以启用正则搜索。 如果启用此选项，则可以使用正则表达式搜索，例如[47a]$用于所有以4、7或a结尾的项目。 正则表达式可以输入/[47a]$/gim或不带[47a]$标志。默认标志为gim。 -
默认值：
false -
示例： 正则搜索
rememberOrder
-
属性：
data-remember-order -
类型：
Boolean -
详情：
设置为
true以记住每个列的顺序。 -
默认值：
false -
示例： 记住顺序
responseHandler
-
属性：
data-response-handler -
类型：
Function -
详情：
在加载远程数据之前处理响应数据格式。参数对象包含：
res: 响应数据。jqXHR: jqXHR 对象，它是 XMLHTTPRequest 对象的超集。有关更多信息，请参阅 jqXHR 类型。
-
默认值：
function(res) { return res } -
示例： 响应处理程序
rowAttributes
-
属性：
data-row-attributes -
类型：
Function -
详情：
行属性格式化函数，接受两个参数：
row: 行记录数据。index: 行索引。
支持所有自定义属性。
-
默认值：
{} -
示例： 行属性
rowStyle
-
属性：
data-row-style -
类型：
Function -
详情：
行样式格式化函数，接受两个参数：
row: 行记录数据。index: 行索引。
支持类或 css。
-
默认值：
{} -
示例： 行样式
search
-
属性：
data-search -
类型：
Boolean -
详情：
启用搜索输入。
有三种搜索方式：
- 值包含搜索查询（默认）。 示例：Github 包含 git。
- 值必须与搜索查询完全相同。 示例：Github（值）和 Github（搜索查询）。
- 比较（<、>、<=、=<、>=、=>）。 示例：4 大于 3。
注意：
- 如果您想使用自定义搜索输入，请使用 searchSelector。
- 您还可以使用 regexSearch 选项通过正则表达式搜索。
- 如果您想向服务器端分页发送可搜索参数，请使用 searchable 选项。
-
默认值：
false -
示例： 表格搜索
searchable
searchAccentNeutralise
-
属性：
data-search-accent-neutralise -
类型：
Boolean -
详情：
设置为
true以使用重音消除功能。 -
默认值：
false -
示例： 搜索重音消除
searchAlign
-
属性：
data-search-align -
类型：
String -
详情：
指示如何对齐搜索输入。可以使用
'left'、'right'。 -
默认值：
'right' -
示例： 搜索对齐
searchHighlight
-
属性：
data-search-highlight -
类型：
Boolean -
详情：
设置为
true以突出显示搜索文本（使用<mark>HTML 标记）。 您还可以定义 自定义高亮格式化程序，例如，用于具有 HTML 或使用自定义高亮颜色的值。 -
默认值：
'false' -
示例： 搜索高亮
searchOnEnterKey
-
属性：
data-search-on-enter-key -
类型：
Boolean -
详情：
搜索方法将在按 Enter 键时执行。
-
默认值：
false -
示例： 搜索 Enter 键
searchSelector
-
属性：
data-search-selector -
类型：
Boolean|String -
详情：
如果此选项设置（必须是有效 dom 选择器，例如
#customSearch），则将找到的 dom 元素（aninput元素）用作表格搜索，而不是内置搜索输入。 -
默认值：
false -
示例： 搜索选择器
searchText
-
属性：
data-search-text -
类型：
String -
详情：
设置搜索属性时，初始化搜索文本。
-
默认值：
'' -
示例： 搜索文本
searchTimeOut
-
属性：
data-search-time-out -
类型：
Number -
详情：
设置搜索触发超时。
-
默认值：
500 -
示例： 搜索超时
selectItemName
-
属性：
data-select-item-name -
类型：
String -
详情：
复选框或单选框输入的名称。
-
默认值：
'btSelectItem' -
示例： ID字段
serverSort
-
属性：
data-server-sort -
类型：
Boolean -
详情：
设置为
false以在客户端对数据进行排序，仅在sidePagination为server时有效。 -
默认值：
true -
示例： 服务器排序
showButtonIcons
-
属性：
data-show-button-icons -
类型：
Boolean -
详情：
所有按钮都将显示图标。
-
默认值：
true -
示例： 显示按钮图标
showButtonText
-
属性：
data-show-button-text -
类型：
Boolean -
详情：
所有按钮都将显示文本。
-
默认值：
false -
示例： 显示按钮文本
showColumns
-
属性：
data-show-columns -
类型：
Boolean -
详情：
设置为
true以显示列下拉列表。我们可以将switchable列选项设置为false以隐藏下拉列表中的列项。可以使用 minimumCountColumns 表格选项控制最小选定列数。 -
默认值：
false
showColumnsSearch
-
属性：
data-show-columns-search -
类型：
Boolean -
详情：
设置为
true以显示列过滤器搜索。 -
默认值：
false -
示例： 列搜索
showColumnsToggleAll
-
属性：
data-show-columns-toggle-all -
类型：
Boolean -
详情：
设置为
true以显示列选项/下拉列表中的切换所有复选框。 -
默认值：
false -
示例： 列切换所有
showExtendedPagination
-
属性：
data-show-extended-pagination -
类型：
Boolean -
详情：
设置为
true以显示扩展版本的分页（包括所有行（不带过滤器）的计数）。 如果您使用服务器端分页，请使用totalNotFilteredField定义计数。 -
默认值：
false -
示例： 显示扩展分页
showFooter
-
属性：
data-show-footer -
类型：
Boolean -
详情：
设置为
true以显示摘要页脚行。 -
默认值：
false -
示例： 显示页脚
showFullscreen
-
属性：
data-show-fullscreen -
类型：
Boolean -
详情：
设置为
true以显示全屏按钮。 -
默认值：
false -
示例： 显示全屏
showHeader
-
属性：
data-show-header -
类型：
Boolean -
详情：
设置为
false以隐藏表格标题。 -
默认值：
true -
示例： 显示标题
showPaginationSwitch
-
属性：
data-show-pagination-switch -
类型：
Boolean -
详情：
设置为
true以显示分页切换按钮。 -
默认值：
false -
示例： 显示分页切换
showRefresh
-
属性：
data-show-refresh -
类型：
Boolean -
详情：
设置为
true以显示刷新按钮。 -
默认值：
false -
示例： 显示刷新
showSearchButton
-
属性：
data-show-search-button -
类型：
Boolean -
详情：
设置为
true以显示搜索按钮，以在搜索输入之后执行搜索（例如，防止流量或加载时间）。 -
默认值：
false -
示例： 显示搜索按钮
showSearchClearButton
-
属性：
data-show-search-clear-button -
类型：
Boolean -
详情：
设置为
true以显示清除按钮，以清除搜索输入（还清除过滤器控制（如果启用））。 -
默认值：
false -
示例： 显示搜索清除按钮
showToggle
-
属性：
data-show-toggle -
类型：
Boolean -
详情：
设置为
true以显示切换按钮以切换表格/卡片视图。 -
默认值：
false -
示例： 显示切换
sidePagination
-
属性：
data-side-pagination -
类型：
String -
详情：
定义表格的侧分页，只能为
'client'或'server'。 使用'server'侧需要设置'url'或'ajax'选项。注意，所需的响应格式取决于是否设置了
'sidePagination'选项。请参阅以下示例：URL 参数：
当
sidePagination设置为server时，bootstrap 表格将调用url并带有以下 URL 参数：offset带有 0 到total- 1 之间的值，表示要包含的第一条记录。limit带有表示每页行数的值。
实现服务器端分页时，您必须实现一个 JSON 视图，格式如下例所示。该视图必须获取 URL 参数值并返回从
offset索引开始的记录，并返回指示由limit表示的记录数。 例如，如果您想要记录 11-20，您的视图必须从 URL 字符串中获取offset=10和limit=10，并返回记录，如下例所示。 -
默认值：
'client'
silentSort
-
属性：
data-silent-sort -
类型：
Boolean -
详情：
设置为
false以使用加载消息对数据进行排序。此选项在sidePagination选项设置为'server'时有效。 -
默认值：
true -
示例： 静音排序
singleSelect
-
属性：
data-single-select -
类型：
Boolean -
详情：
设置为
true以允许选择一个复选框。 -
默认值：
false -
示例： 单选
smartDisplay
-
属性：
data-smart-display -
类型：
Boolean -
详情：
设置为
true以智能显示分页或卡片视图。 -
默认值：
true -
示例： 智能显示
sortable
-
属性：
data-sortable -
类型：
Boolean -
详情：
设置为
false以禁用所有列的可排序。 -
默认值：
true -
示例： 表格可排序
sortClass
-
属性：
data-sort-class -
类型：
String -
详情：
排序的
td元素的类名。 -
默认值：
undefined -
示例： 排序类
sortEmptyLast
-
属性：
data-sort-empty-last -
类型：
Boolean -
详情：
设置为
true以将<empty string>、undefined和null排序为最后一个值。 -
默认值：
false -
示例： 排序空最后一个
sortName
-
属性：
data-sort-name -
类型：
String -
详情：
定义将排序的列。
-
默认值：
undefined -
示例： 排序名称顺序
sortOrder
-
属性：
data-sort-order -
类型：
String -
详情：
定义列排序顺序，只能为
undefined、'asc'或'desc'。 -
默认值：
undefined -
示例： 排序名称顺序
sortReset
-
属性：
data-sort-reset -
类型：
Boolean -
详情：
设置为
true以在第三次单击时重置排序。 -
默认值：
false -
示例： 排序重置
sortResetPage
-
属性：
data-sort-reset-page -
类型：
Boolean -
详情：
设置为
true以在排序时重置页面编号。 -
默认值：
false -
示例： 排序重置页面
sortStable
-
属性：
data-sort-stable -
类型：
Boolean -
详情：
设置为
true以获取稳定排序。我们将为行添加'_position'属性。 -
默认值：
false -
示例： 稳定排序
strictSearch
-
属性：
data-strict-search -
类型：
Boolean -
详情：
启用严格搜索。 禁用比较检查。
-
默认值：
false -
示例： 严格搜索
theadClasses
-
属性：
data-thead-classes -
类型：
String -
详情：
表格 thead 的类名。Bootstrap v4，使用修饰类
.thead-light或.thead-dark以使thead显示浅色或深色灰色。 -
默认值：
'' -
示例： thead 类
toolbar
-
属性：
data-toolbar -
类型：
String/Node -
详情：
指示工具栏的 jQuery 选择器，例如：
#toolbar、.toolbar或 DOM 节点。 -
默认值：
undefined -
示例： 自定义工具栏
toolbarAlign
-
属性：
data-toolbar-align -
类型：
String -
详情：
指示如何对齐自定义工具栏。可以使用
'left'、'right'。 -
默认值：
'left' -
示例： 工具栏对齐
totalField
-
属性：
data-total-field -
类型：
String -
详情：
在传入的 JSON 中包含
'total'数据的键。 -
默认值：
'total' -
示例： 总计/数据字段
totalNotFiltered
-
属性：
data-total-not-filtered -
类型：
Number -
详情：
此属性主要通过分页服务器传递，使用起来很方便。
-
默认值：
0
totalNotFilteredField
-
属性：
data-total-not-filtered-field -
类型：
string -
详情：
从 JSON 响应中使用的 JSON 响应将用于
showExtendedPagination。 -
默认值：
totalNotFiltered -
示例： 总计未过滤字段
totalRows
-
属性：
data-total-rows -
类型：
Number -
详情：
此属性主要通过分页服务器传递，使用起来很方便。
-
默认值：
0
trimOnSearch
-
属性：
data-trim-on-search -
类型：
Boolean -
详情：
设置为
true以修剪搜索字段中的空格。 -
默认值：
true -
示例： 搜索修剪
undefinedText
-
属性：
data-undefined-text -
类型：
String -
详情：
定义默认的
undefined文本。 -
默认值：
'-' -
示例： 未定义文本
uniqueId
-
属性：
data-unique-id -
类型：
String -
详情：
指示每个行的唯一标识符。 唯一 ID 应始终安全，例如字母数字，不应包含可能破坏 HTML 的字符，例如
". -
默认值：
undefined -
示例： getRowByUniqueId
url
-
属性：
data-url -
类型：
String -
详情：
从远程站点请求数据的 URL。
注意，所需的响应格式取决于是否指定了
'sidePagination'选项。请参阅以下示例：URL 参数：
当
sidePagination设置为server时，bootstrap 表格将调用url并带有以下 URL 参数：offset带有 0 到total- 1 之间的值，表示要包含的第一条记录。limit带有表示每页行数的值。
实现服务器端分页时，您必须实现一个 JSON 视图，格式如下例所示。该视图必须获取 URL 参数值并返回从
offset索引开始的记录，并返回指示由limit表示的记录数。 例如，如果您想要记录 11-20，您的视图必须从 URL 字符串中获取offset=10和limit=10，并返回记录，如下例所示。 -
默认值：
undefined -
示例： 从 URL
-
错误处理
要获取加载错误，请使用 onLoadError
virtualScroll
-
属性：
data-virtual-scroll -
类型：
Boolean -
详情：
设置为
true以启用虚拟滚动以显示虚拟的 “无限” 列表。注意： 目前，实现假设每行具有相同的高度。如果各行的高度不同，可能会出现不可预测的错误。请确保每行的高度一致，或者应用样式
td { white-space: nowrap; }以解决此问题。 -
默认值：
false -
示例： 大数据
virtualScrollItemHeight
-
属性：
data-virtual-scroll-item-height -
类型：
Number -
详情：
如果未定义此选项，我们将使用第一个项目的高度。
如果虚拟项目高度显著大于默认高度，则此尺寸用于帮助确定在初始化时应创建多少单元格，并帮助计算可滚动区域的宽度。此高度值只能使用
px单位。 -
默认值：
undefined
visibleSearch
-
属性：
data-visible-search -
类型：
Boolean -
详情：
设置为
true以仅在可见列/数据上搜索。如果数据包含未显示的其他值，它们将忽略搜索。 -
默认值：
false -
示例： 可见搜索