Bootstrap Bootstrap表格插件bootstrap-table配置与应用小结

程序员文章站 2022-08-11 14:56:25

Bootstrap表格插件bootstrap-table配置与应用小结 by:授客 QQ：1033553122 win7 JQuery-3.2.1.min.js 下载地址： https://gitee.com/ishouke/front_end_plugin/blob/master/jquery-3 ......

bootstrap表格插件bootstrap-table配置与应用小结

by:授客 qq：1033553122

1. 测试环境

win7

jquery-3.2.1.min.js

下载地址：

bootstrap-3.3.7-dist

下载地址：

bootstrap-table-develop-v1.12.1.zip

下载地址：

2. 配置与应用

效果展示

Bootstrap Bootstrap表格插件bootstrap-table配置与应用小结

html代码片段

head设置

<!doctype html>

<html lang="zh-cn">

<head>

<meta charset="utf-8">

<meta http-equiv="x-ua-compatible" content="ie=edge">

<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- 上述3个meta标签*必须*放在最前面，任何其他内容都*必须*跟随其后！ -->

{% load staticfiles %}

<!-- jquery (bootstrap 的所有 javascript 插件都依赖 jquery，所以必须放在前边) -->

<script type="text/javascript" src="{% static  'website/jquery-3.2.1.min.js' %}" defer></script>

<!-- bootstrap -->

<link rel="stylesheet" type="text/css" href="{% static 'website/bootstrap-3.3.7-dist/css/bootstrap.min.css' %}" />

<!-- 加载 bootstrap 的所有 javascript 插件。你也可以根据需要只加载单个插件。 -->

<script type="text/javascript" src="{% static  'website/bootstrap-3.3.7-dist/js/bootstrap.min.js' %}" defer></script>

<!-- html5 shim 和 respond.js 是为了让 ie8 支持 html5 元素和媒体查询（media queries）功能 -->

<!-- 警告：通过 file:// 协议（就是直接将 html 页面拖拽到浏览器中）访问页面时 respond.js 不起作用 -->

<!--[if lt ie 9]>

<script src="https://cdn.bootcss.com/html5shiv/3.7.3/html5shiv.min.js" defer></script>

<script src="https://cdn.bootcss.com/respond.js/1.4.2/respond.min.js" defer></script>

<![endif]-->

<!-- bootstrap-table -->

<link rel="stylesheet" type="text/css" href="{% static 'website/bootstrap-table-1.12.1-dist/bootstrap-table.min.css' %}" />

<script type="text/javascript" src="{% static  'website/bootstrap-table-1.12.1-dist/bootstrap-table.min.js' %}" defer></script>

<!-- 引入中文语言包，注意：locale files 必须放在bootstrap-table.js后面 -->

<script type="text/javascript" src="{% static  'website/bootstrap-table-1.12.1-dist/locale/bootstrap-table-zh-cn.min.js' %}" defer></script>

……略

</head>

table及toolbar工具条

<div class="container-fluid">

<div class="row">

<table id="roletable"></table>

<div id="toolbar">

<div class="btn-group">

<button class="btn btn-default" data-toggle="modal" data-target="#roledialog" id="addbtn">新增

<i class="glyphicon glyphicon-plus"></i>

</button>

<button class="btn btn-default" id="editbtn">修改

<i class="glyphicon glyphicon-edit"></i>

</button>

<button class="btn btn-default" id="deletebtn">删除

<i class="glyphicon glyphicon-remove"></i>

</button>

</div>

<form class="form-inline" id="queryform">

<div class="form-group">

<div class="input-group">

<div class="input-group-addon">角色名称</div>

<input  type="text" class="form-control" name="rolenameq" id="rolenameq" placeholder="请输入角色名称">

</div>

<div class="input-group date" id="starttimepicker">

<div class="input-group-addon">开始时间</div>

<input  type="text" class="form-control" name="starttime" id="starttime" >

<span class="input-group-addon">

<span class="glyphicon glyphicon-calendar"></span>

</span>

</div>

<div class="input-group date" id="endtimepicker">

<div class="input-group-addon">结束时间</div>

<input  type="text" class="form-control" name="endtime" id="endtime">

<span class="input-group-addon">

<span class="glyphicon glyphicon-calendar"></span>

</span>

</div>

</div>

<button type="button" id="querybtn" class="btn btn-primary querybutton">查询</button>

</form>

</div>

</div>

</div>

js代码片段

数据表初始化配置

/**

* 获取角色表数据

function loadtabledata () {

$('#' + roletableid).bootstraptable({

url: roletabledataurl, // 服务器数据的加载地址。

method:'get', // 服务器数据的请求方式 'get' 或 'post'。

pagination:true,// 在表格底部显示分页信息(显示第 x 到第 x 条记录，总共 x 条记录)，翻页条 // 注意：数据页页数超过1页会才展示翻页条

paginationvalign:'bottom', // 指定分页条在垂直方向的位置。'top'，'bottom' 或 'both'。

sidepagination:'server', // 设置在哪里进行分页，可选值为 'client' 或者 'server'。注意：设置 'server'时，必须设置服务器数据地址（url）或者重写ajax方法。

responsehandler:responsehandler, // 加载服务器数据之前的处理程序，可以用来格式化数据。

pagesize:10, // 如果启用分页，设置初始化界面时，默认的每页显示数据条数

pagelist:[10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 'all'], // 如果设置了分页，设置可供选择的页面记录数。设置为 all 或者 unlimited，则显示所有记录

smartdisplay:false, // 设置为 true 是程序自动判断显示分页信息和 card 视图。这会导致自定义的 pagelist不起作用

silentsort:true, // 设置为true将在点击分页按钮时，自动记住排序项。仅在 sidepagination设置为 server时生效

showcolumns:true, // 展示内容列下拉框，方便设置展示那些列

showrefresh:true, // 显示刷新按钮

idfield:'id', // 指定主键列

//datafield: "data", //返回的json数组记录(表格数据)的key.默认是"rows", 数据格式： {"total": 0, "rows": []}

checkboxheader:true, // 如果设置 false，将在列头隐藏全选复选框，反之则显示，设置为ture时，必须设置singleselect=false 才有效

clicktoselect:true, // 如果设置 true，则在点击行时，自动选中 rediobox 、 checkbox。

singleselect:false, //如果设置为true - 禁止多选，否则不禁止多选

striped:true, // 设置为 true 会有隔行变色效果

toolbar:'#toolbar', // 一个jquery 选择器，形如#toolbar, .toolbar，指明自定义的 toolbar

toolbaralign:'left', // 指定 toolbar 水平方向的位置。'left' 或 'right'。

columns: [{

field: 'checkbox',

align: 'center', // 设置数据对齐方式可选项： 'left', 'right', 'center'

halign: 'center', // 设置表头标题对齐方式可选项： 'left', 'right', 'center'

valign: 'middle', // 设置单元格数据的垂直方向上的对齐方式，有：top（靠上）、middle（居中）、bottom（靠下）针对checkbox似乎不起作用

checkbox:true, // 显示为复选框

width: '1%',// 设置列宽度

},{

field: 'id',

title: '角色id',

align: 'center',

halign: 'center',

valign:'middle',

sortable:true, // 允许排序列

order:'desc', // 默认排序方式升序-asc 降序-desc

width: '2%',

}, {

field: 'name',

title: '角色名称',

align: 'center',

valign: 'middle',

halign: 'center',

width: '14%'

}, {

field: 'remark',

title: '角色描述',

valign: 'middle',

align: 'center',

halign: 'center',

width: '20%'

}, {

field: 'is_enable',

title: '是否启用',

valign: 'middle',

align: 'center',

halign: 'center',

width:'4%'

}, {

field: 'creater',

title: '创建人',

valign: 'middle',

align: 'center',

halign: 'center',

width:'7%'

}, {

field: 'create_time',

title: '创建时间',

valign: 'middle',

align: 'center',

halign: 'center',

width:'11%'

}, {

field: 'modifier',

title: '修改人',

valign: 'middle',

align: 'center',

halign: 'center',

width:'7%'

},{

field: 'modify_time',

title: '修改时间',

valign: 'middle',

align: 'center',

halign: 'center',

width:'11%'

},{

field:'operate',

title:'操作',

algin:'left',

halgin:'center',

width:'23%',

events: operateevents,

formatter:operateformatter

} ]

});

}

// 加载表格数据

loadtabledata();

加载服务器数据之前的数据处理(responsehandler)

/**

 * 加载服务器数据之前的处理程序，可以用来格式化数据。

 * 参数：result为从服务器请求到的数据

 * @param result

*/

function responsehandler(result){

if (result.success == 'false') {

alert('获取角色信息失败');

return;

// 返回数据，渲染表格

return {

total: result.data.total, //总页数, key名称固定为"total"

rows: result.data.rows    //行数据，key名称必须和bootstraptable函数中datafield的值保持一致，默认为rows.

};

};

格式化操作列

/**

 *  操作列格式化函数

*/

function operateformatter(value, row, index) {

if (row.is_enable == '是') {

return  ''+

'<div class="btn-group">' +

'<button class="btn btn-default asign-resource">分配资源&nbsp;<i class="glyphicon glyphicon-plus"></i></button>' +

'<button class="btn btn-default edit" >修改&nbsp;<i class="glyphicon glyphicon-edit"></i></button>' +

'<button class="btn btn-default delete">删除&nbsp;<i class="glyphicon glyphicon-remove"></i></button>' +

'<button class="btn btn-default switch" >禁用&nbsp;<i class="glyphicon glyphicon-cog"></i></button>' +

'</div>';

    } else {

return  ''+

'<div class="btn-group">' +

'<button class="btn btn-default asign-resource">分配资源&nbsp;<i class="glyphicon glyphicon-plus"></i></button>' +

'<button class="btn btn-default edit" >修改&nbsp;<i class="glyphicon glyphicon-edit"></i></button>' +

'<button class="btn btn-default delete">删除&nbsp;<i class="glyphicon glyphicon-remove"></i></button>' +

'<button class="btn btn-default switch" >启用&nbsp;<i class="glyphicon glyphicon-cog"></i></button>' +

'</div>';

给操作列按钮注册点击事件

// 给操作按钮注册点击事件

window.operateevents = {

'click .asign-resource': function (event, value, row, index) { // 注意click和.class之间必须有空格

……略

'click .edit': function (event, value, row, index) {

……略

'click .delete': function (event, value, row, index) {

……略

'click .switch': function (event, value, row, index) {

……略

}

};

函数参数说明：

event：jquery事件（参考events）。

value：字段名（实践发现，该参数获取到的值为undefined

row：json串格式表示的行数据

index：所点击行的index

给toolbar工具条按钮添加点击事件

// 给查询按钮增加点击事件

$('#' + querybtnid).click(function () {

//刷新处理，指定query 的参数，注：此地方指定的参数，仅在当次刷新时使用

var dataarray = $('#' + queryformid).serializearray();

var querycontent = {}

$.each(dataarray, function () {

querycontent[this.name] = this.value;

});

// 刷新如果不指定参数刷新：$(tableselector).bootstraptable('refresh');

$('#' + roletableid).bootstraptable('refresh', {

query: querycontent

});

});

// 给表格上方的修改按钮绑定点击事件

$('#' + editbtnid).click(function() {

editrole('bytopeditbtn');

});

// 给表格上方的删除按钮绑定点击事件

$('#' + deletebtnid).click(function() {

deleterole('bytopdeletebtn');

});

提交新增、修改表单

/**

* 提交新增、修改角色表单

$(document).ready(function() {

$('#' + roleformid).submit(function() {

var dataarray = $('#' + roleformid).serializearray();

var data = {};

$.each(dataarray, function () {

data[this.name] = this.value;

});

var csrftoken = getcookie('csrftoken');

if (csrftoken == '') {

alert('获取cookie失败');

return false;

}

if (optype == 'add') { // 新增

$.ajax({

type: "post",

url: addroleurl,

async: false,

data: data,

beforesend: function (xhr, settings) {

if (!csrfsafemethod(settings.type) && !this.crossdomain) {

xhr.setrequestheader("x_csrftoken", csrftoken);

}

success: function (result) {

if (result.success == 'true') {

alert(result.msg);

// 顶部插入一条记录

$('#' + roletableid).bootstraptable('insertrow', {index: 0, row: result.data});

$('#' + roletableid).bootstraptable('refresh');

// 隐藏模态对话框，并重置数据

$('#' + roledialogid).modal('hide');

} else {

alert(result.msg + "，" + result.reason);

}

error: function(xmlhttprequest, textstatus, errorthrown) {

alert('新增角色请求失败' + xmlhttprequest.responsetext);

}

});

} else if (optype == 'update') { // 修改

data['id'] = currentrole.id;

$.ajax({

type: "post",

url: updateroleurl,

async: false,

data: data,

beforesend: function (xhr, settings) {

if (!csrfsafemethod(settings.type) && !this.crossdomain) {

xhr.setrequestheader("x_csrftoken", csrftoken);

}

success: function (result) {

if (result.success == 'true') {

alert(result.msg);

// 在页面上更新角色信息

delete data['csrfmiddlewaretoken'];

// 更新行记录

$('#' + roletableid).bootstraptable('updaterow', {index: parseint(rowindex), row:result.data});

// 隐藏模态对话框，并重置数据

$('#' + roledialogid).modal('hide');

} else {

alert(result.msg + "，" + result.reason);

// 需要手动关闭模态对话框，所以也会自动重置数据

}

error: function(xmlhttprequest, textstatus, errorthrown) {

alert('修改角色请求失败' + xmlhttprequest.responsetext);

// 需要手动关闭模态对话框，所以也会自动重置数据

}

});

}

return false; // 避免跳转到django的返回结果数据页

});

插入行

$('#tableid').bootstraptable('insertrow', {index: 0, row: result.data});

参数说明：

index 新增行的索引

row 新增行的数据，json串表示

更新行

$('#tableid').bootstraptable('updaterow', {index: parseint(rowindex), row:result.data});

参数说明

index 要更新行的索引

row 要更新行的数据据，json串表示

修改记录

/**

* 修改角色

function editrole(flag) {

optype = 'update';

if (flag == 'bytopeditbtn') { // 通过点击表格上方的修改按钮进入

var rowarray = $('#' + roletableid).bootstraptable('getselections');

if (rowarray.length <1) {

alert('请先选择要修改的角色');

return;

} else if (rowarray.length >1) {

alert('每次修改，只能选择一个角色');

return;

}

// 获取选中行索引

rowindex = $('#' + roletableid).find('tbody>tr.selected').first().attr('data-index');

currentrole = rowarray[0]; // 记录当前被修改的角色信息

data = [{'name': 'rolename', 'value':rowarray[0].name}, {'name':'roledesc', 'value':rowarray[0].remark}]

} else if (flag == 'byroweditbtn') { // 通过点击行右侧的修改按钮进入

data = [{'name': 'rolename', 'value':currentrole.name}, {'name':'roledesc', 'value':currentrole.remark}]

}

// 用所选记录信息，填充即将弹出对话框中表单组件值

$.each(data, function () {

$('#' + this.name).val(this.value);

});

$('#' + roledialogid).modal('show'); // 打开修改模态对话框

}

获取选中行索引

rowindex = $('#' + roletableid).find('tbody>tr.selected').first().attr('data-index');

这里为啥要获取，为啥可以这么获取？原因是这样的，通过选择表记录行，然后点击表格上方的修改按钮修改对应记录，这种情况下，无法直接获取对应行记录的索引，导致没法更新对应记录行，所以需要获取索引，没找到对应，至于为啥这么获取，是由table 表结构决定的，如下图：

删除记录

/**

* 删除角色

function deleterole(flag) {

var idarray = [];

if (flag == 'bytopdeletebtn') { // 通过点击表格上方的删除按钮进入

rowarray = $('#' + roletableid).bootstraptable('getselections');

if (rowarray.length <1) {

alert('请先选择要删除的角色');

return;

}

} else if (flag == 'byrowdeletebtn') { // 通过点击行右侧的删除按钮进入

idarray.push(currentrole.id);

}

var mark = true; // 标记是否删除成功

if (confirm('是否删除选中记录?')) {

$.each(rowarray, function() {

idarray.push(this.id);

});

$.ajax({

type: "post",

url: deleteroleurl,

async: false,

data: {'idarray':"" + idarray + ""},

success: function (result) {

if (result.success == 'true') {

alert(result.msg);

// 批量删除对应记录行

$('#' + roletableid).bootstraptable('remove',{ field: 'id', values: idarray});

//$('#' + roletableid).bootstraptable('refresh');

} else {

alert(result.msg + "，" + result.reason);

}

error: function(xmlhttprequest, textstatus, errorthrown) {

alert('删除角色请求失败' + xmlhttprequest.responsetext);

}

});

}

删除记录

$('#tableid').bootstraptable('remove',{ field: 'id', values: idarray});

field: 需要删除的行的 field 名称，

values: 需要删除的行的值，类型为数组。

获取选中行

$('#tableid').bootstraptable('getselections');

getselections 返回所选的行，当没有选择任何行的时候返回一个空数组

后台代码片段

查询表数据

def role_tabe_data(request):

'''

获取角色表数据

:param request:

'''

if request.method == 'get':

rows = [] # 用于存储记录行

table_data = {"total": 0, "rows": []}

try:

params = request.get

# search = params.get('search') # 通过表格插件自带的搜索框搜索的内容 # 如果要实现，需要确认按哪些列搜索

page_size = int(params.get('limit')) # 每页记录数

offset = int(params.get('offset'))

page_index = offset // page_size + 1 # 第几页数据

sort = params.get('sort') # 排序字段 // 初始化页面时，无排序获取值为none

order = params.get('order') # 排序方式

role_name = params.get('rolenameq') # 角色名称

start_time = params.get('starttime') # 开始时间

end_time = params.get('endtime') # 结束时间

sql_ddl = 'select id, name, remark, is_enable, creater, create_time, modifier, modify_time from website_role '

if role_name:

sql_ddl = sql_ddl + "where name like '%s%s' " % (role_name, '%%')

temp_mark = 1

else:

temp_mark = 0

if start_time:

if temp_mark:

sql_ddl = sql_ddl + "and create_time>='%s' " % start_time

else:

sql_ddl = sql_ddl + "where create_time>='%s' " % start_time

temp_mark = 1

else:

temp_mark = 0

if end_time:

if temp_mark:

sql_ddl = sql_ddl + "and create_time<='%s' " % end_time

else:

sql_ddl = sql_ddl + "where create_time<='%s' " % start_time

if order and sort:

sql_ddl = sql_ddl + 'order by %s %s' % (sort, order)

else:

sql_ddl = sql_ddl + 'order by id desc' # 最新创建的排在最前面

records = role.objects.raw(sql_ddl)

records = json.loads(serializers.serialize('json', records), encoding='utf-8')

table_data["total"] = len(records)

paginator = paginator(records, page_size) # 设置每页展示的数据

try:

page = paginator.page(page_index)

except pagenotaninteger as e: # 如果请求的页面编号不存在，返回第一页数据

logger.warn('%s' % e)

page = paginator.page(1)

except emptypage as e: # 如果请求页面，超出页面范围，返回最后一页数据

logger.warn('%s' % e)

page = paginator.page(paginator.num_pages)

records = page.object_list

for record in records:

row = {}

row['id'] = record['pk']

row.update(record['fields'])

if row['is_enable']:

row['is_enable'] = '是'

else:

row['is_enable'] = '否'

rows.append(row)

table_data["rows"] = rows

content = {'data':table_data, 'msg':'获取角色信息成功', 'success':'true', 'reason': ''}

except exception as e:

logger.error('getting roles info data failed: %s' % e)

content = {'data':[], 'msg':'获取角色信息失败', 'success':'false', 'reason': '%s' % e}

else:

logger.error('only get method allowed for getting roles data')

content = {'data':[], 'msg':'获取角色信息失败', 'success':'false', 'reason': 'only get method allowed for getting roles data'}

return jsonresponse(content)

说明：

bootstarp-table默认只支持按单列排序，默认打开页面，请求表数据时，会附加提供以下参数：

order=asc&offset=0&limit=pagesize

或者如下(添加了搜索框的情况下)

search=&order=asc&offset=0&limit=pagesize

search：前端输入的搜索内容

order:排序方式,asc - 升序 desc - 降序

sort：需要排序的列

offset：偏移

limit：限制查询返回记录数，即每页记录数

如下，我们可以通过limit和offset获取要查询要查询页面的索引(索引从1开始)

page_size = int(params.get('limit')) # 每页记录数

offset = int(params.get('offset'))

page_index = offset // page_size + 1 # 第几页数据

新增记录

def add_role(request):

'''

新增角色

'''

if request.method == 'post':

try:

params = request.post

creater = str(request.user)

role_name = params.get('rolename') # 资源名称

role_desc = params.get('roledesc') # 资源描述

create_time = datetime.now().strftime('%y-%m-%d %h:%m:%s')

# 验证数据合法性

if not role_name:

content = {'msg':'新增角色失败', 'success':'false', 'reason': '角色名称不能为空'}

return jsonresponse(content)

role_obj = role(name=role_name,

remark=role_desc,

is_enable=1,

creater = creater,

create_time=create_time)

role_obj.save()

data = {'id':role_obj.id, 'name':role_name, 'remark':role_desc, 'is_enable':'是', 'creater':str(creater), 'create_time':create_time, 'modifier':'-', 'modify_time':'-' }

content = {'data':data, 'msg':'新增角色成功', 'success':'true', 'reason':''}

except exception as e:

logger.error('adding role failed: %s' % e)

content = {'data':{}, 'msg':'新增角色失败', 'success':'false', 'reason': '%s' % e}

else:

logger.error('only post method allowed for adding role data')

content = {'data':{}, 'msg':'新增角色失败', 'success':'false', 'reason': 'only get method allowed for adding role data'}

return jsonresponse(content)

修改记录

def update_role(request):

'''

修改角色

'''

if request.method == 'post':

try:

params = request.post

modifier = str(request.user)

id = params['id']

role_name = params['rolename'] # 资源名称

role_desc = params['roledesc'] # 资源描述

modify_time = datetime.now().strftime('%y-%m-%d %h:%m:%s')

# 数据合法性验证

if not role.objects.exclude(id=id).exists():

return jsonresponse({'msg':'修改失败', 'success':'false', 'reason': '角色不存在'})

# 更新数据

obj = role.objects.get(id=id)

obj.name = role_name

obj.remark = role_desc

obj.modify_time = modify_time

obj.modifier = modifier

obj.save()

data = { 'name':role_name, 'remark':role_desc, 'modify_time':modify_time, 'modifier':modifier} # 返回需要更新的数据，以便页面更新对应行信息

content = {'msg':'修改成功', 'data':data, 'success':'true', 'reason':''}

except exception as e:

logger.error('updating role failed: %s' % e)

content = {'msg':'修改失败', 'data':{}, 'success':'false', 'reason': '%s' % e}

else:

logger.error('only post method allowed for updating role')

content = {'msg':'修改失败', 'data':{}, 'success':'false', 'reason': 'only post method allowed for updating role'}

return jsonresponse(content)

删除记录

def delete_role(request):

'''

删除角色

'''

if request.method == 'post':

try:

            params = request.post

            id_list = eval(params.get('idarray') + ",") # 如果不加逗号，前端只传递一个参数时，这里获取到的id_list为单个整数值

mark = true

reason = ''

try:

with transaction.atomic():

for id in id_list:

                        role = role.objects.filter(id=id)

if role.exists():

                            role.delete()

except exception as e:

                reason = 'deleting role failed: %s' % e

                logger.error(reason)

                mark = false

            if mark:

return jsonresponse({'msg':'删除成功', 'success':'true',  'reason': ''})

else:

return jsonresponse({'msg':'删除失败', 'success':'false',  'reason': '%s' % reason})

except exception as e:

            logger.error('deleting role failed: %s' % e)

            content = {'msg':'删除失败', 'success':'false', 'reason': '%s' % e}

else:

        logger.error('only post method allowed for deleting role')

        content = {'msg':'删除失败', 'success':'false', 'reason': 'only post method allowed for deleting role'}

return jsonresponse(content)

3. 参考链接

上一篇： iOS Accessibility指南

下一篇： Yii框架的增删改查总结分析

Bootstrap Bootstrap表格插件bootstrap-table配置与应用小结

效果展示

html代码片段

head设置

table及toolbar工具条

js代码片段

数据表初始化配置

加载服务器数据之前的数据处理(responsehandler)

格式化操作列

给操作列按钮注册点击事件

给toolbar工具条按钮添加点击事件

提交新增、修改表单

修改记录

删除记录

后台代码片段

查询表数据

新增记录

修改记录

删除记录

结合bootstrap fileinput插件和Bootstrap-table表格插件，实现文件上传、预览、提交的导入Excel数据操作流程

JQuery Ztree 树插件配置与应用小结