BootstrapTable 是基于 Bootstrap 和 jQuery 开发的前端表格组件,作为网页端表格展示利器,它自带分页排序搜索复选框固定列导出数据等常用功能,不需要从零手写大量原生表格代码,只需要引入对应的 css 和 js 文件,初始化配置项,就可以快速生成功能完善的数据表格,支持静态本地数据渲染,也支持异步请求后端接口获取 json 数据,适合后台管理系统数据列表页面,实例代码主要分为页面资源引入,html 容器标签,js 初始化配置三大部分,掌握这套实例代码之后,就可以快速复用改造,实现各类业务数据表格展示。
BootstrapTable 之所以成为后台系统常用表格展示组件,是因为原生 html table 只能展示静态行列,缺少分页筛选排序这些交互能力,手写这些交互代码工作量很大,BootstrapTable 把这些能力封装成配置参数,开发者只需要修改 columns 列配置 url 请求地址,分页开关,搜索框开关,就能完成表格定制,并且样式和 Bootstrap 风格统一,页面视觉效果协调,减少前端样式开发工作量。
基础实例代码准备依赖资源
使用实例代码之前,页面必须引入四类资源,jQuery 库,Bootstrap 核心 css,Bootstrap 核心 js,bootstrap-table 的 css 文件,bootstrap-table 的 js 文件,资源可以使用本地文件,也可以使用公共 CDN 地址,版本需要匹配,jQuery 版本过低或者 Bootstrap 版本不兼容,会导致表格初始化失败。
完整基础实例代码结构
html 部分,在页面 body 里面添加 table 标签,给 table 设置 id,比如 id 为 bootstrapTable
js 初始化代码,页面加载完成之后执行初始化
$(function () {
$('bootstrapTable').bootstrapTable({
url: '/api/dataList',
method: 'get',
pagination: true,
pageNumber: 1,
pageSize: 10,
pageList: [10, 20, 50],
search: true,
columns: [
{
field: 'id',
title: '编号',
sortable: true
},
{
field: 'name',
title: '名称'
},
{
field: 'createTime',
title: '创建时间'
}
]
});
});
如果是本地静态数据,不需要 url,直接增加 data 选项,写入 json 数组,不需要请求后端接口。
核心配置项说明
| 配置项 | 作用 |
|---|---|
| url | 后端数据接口地址 |
| method | 请求方式 get 或者 post |
| pagination | 是否开启分页 true 开启 false 关闭 |
| pageSize | 默认每页展示条数 |
| pageList | 可选每页条数下拉选项 |
| search | 是否开启顶部搜索框 |
| columns | 表格列配置,field 对应 json 字段名,title 是表头文字,sortable 代表该列支持排序 |
进阶扩展实例
可以增加操作列,在 columns 里面新增一列,使用 formatter 函数自定义渲染按钮,比如编辑删除按钮,还可以开启 showColumns 控制列显示隐藏,showRefresh 刷新按钮,fixedColumns 固定左侧列,响应式适配不同屏幕,支持行点击事件 onClickRow,点击某一行触发自定义业务逻辑。后端接口返回的数据格式需要符合组件规范,主数据放在 rows 字段,总条数放在 total 字段,格式不匹配会出现分页无效或者表格无数据。
BootstrapTable 实例代码复用性很强,项目里面多个列表页面,只需要修改 columns 列定义和接口地址,就可以快速生成新的数据表格,开发后台管理系统的时候可以大幅减少重复编码,重点注意版本兼容,接口返回格式,列 field 和后端 json 字段保持一致,这三点是实例代码可以正常运行的关键。
【常见问题】
问题 1 表格展示利器 BootstrapTable 实例代码初始化之后表格空白是什么原因
回答 1 表格展示利器 BootstrapTable 实例代码初始化空白,优先检查 jQuery 和 bootstrap-table 的 js 文件是否成功引入,后端接口返回的 json 是否包含 rows 和 total 字段,columns 里面 field 名称和返回数据字段是否匹配。
问题 2 表格展示利器 BootstrapTable 实例代码可以改成本地静态数据吗
回答 2 表格展示利器 BootstrapTable 实例代码可以改成本地静态数据,删除 url 配置项,增加 data 属性,直接写入 json 数组,不需要请求后端接口,适合演示和测试页面。
问题 3 表格展示利器 BootstrapTable 实例代码分页不生效是什么原因
回答 3 表格展示利器 BootstrapTable 实例代码分页不生效,是因为 pagination 参数没有设置为 true,同时后端返回数据必须携带 total 总数字段,缺少 total 会导致分页组件无法计算总页数。
【免责申明】
本文内容基于 BootstrapTable 开源组件通用用法编写,不同版本组件配置项和语法存在差异,实际项目请对照对应版本官方文档进行调整。


