layui的table checkbox 默认选中设置

原创已于 2022-02-23 14:38:35 修改 · 6.1k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#layui #前端 #javascript

于 2022-02-22 17:48:57 首次发布

这篇博客总结了在layui框架中实现表格数据默认选中的四种方法：1) 后台数据设置checked属性；2) 设置LAY_CHECKED属性；3) 使用done回调模拟选中；4) 更改DOM模拟选中状态。强调了处理数据格式和利用layui库特性的关键点。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

最近工作遇到一个需求，需要给带checkbox的表格数据设置默认选中。我在网上看到许多种解答方法，比较杂乱，也不是全都好使，所以记录一下。

第一种：在后台的data数据中设置好checked值

1.返回数据格式如下：

{
	"code": 0,
	"msg": "",
	"count": 2,
	"data": [{
		"rolename": "系统管理员",
		"roleid": "1",
		"checked": true //重点
	}, {
		"rolename": "普通员工",
		"roleid": "21",
		"checked": false //重点
	}]
}

2.需要在table.render（）上面添加：
table = $.extend(table, {config: {checkName: ‘checked’}});

layui.use('table', function(){
	var $ = layui.$;
	var table = layui.table;
	
	//使用table前加上下面这句
	table =  $.extend(table, {config: {checkName: 'checked'}});
	table.render({
	    ...
	});
});

注意：后台反馈回来的checked包装格式不要将true或false包装成字符串哦，layui处理会有问题。

第二种：在后台的data数据中设置好LAY_CHECKED值

返回数据格式如下：

{
	"code": 0,
	"msg": "",
	"count": 2,
	"data": [{
		"LAY_CHECKED": true,
		"rolename": "系统管理员",
		"roleid": "1"
	}, {
		"LAY_CHECKED": true,
		"rolename": "普通员工",
		"roleid": "21"
	}]
}

第三种：done回调函数设置checked模拟选中（一），后台数据不做任何处理

layui.use('table', function(){
	var $ = layui.$;
	var table = layui.table;
	
	//使用table前加上下面这句
	table =  $.extend(table, {config: {checkName: 'checked'}});
	table.render({
	    id     : 'roleList'
	    ,...
	    ,done : function(res, curr, count){
			if( pUserRoleArray != undefined ){
			    var roleArray = pUserRoleArray.split(',');
			     //遍历集合
			 	layui.each(res.data, function(index,item){
			 		//将获取的选中行数据进行遍历
			 		//array.indexOf 此方法判断数组中是否存在某个值，如果存在，则返回数组元素的下标，否则返回-1
				 	if( roleArray.indexOf(''+item.roleid+'')>-1 ){ 
					     //点击去属性 lay-id='表格id'； index：要回显的行数下标，从0开始
					     $("div[lay-id='roleList'] td .layui-form-checkbox").eq(index).click();
			          } 
				 });
			}
		}
	});
});

第四种：done回调函数设置checked模拟选中（二），后台数据不做任何处理

layui.use('table', function(){
	var $ = layui.$;
	var table = layui.table;
	
	//使用table前加上下面这句
	table =  $.extend(table, {config: {checkName: 'checked'}});
	table.render({
	    id     : 'roleList'
	    ,...
	    ,done : function(res, curr, count){
			if( pUserRoleArray != undefined ){
			    var roleArray = pUserRoleArray.split(',');
			     //遍历集合
			 	layui.each(res.data, function(index,item){
			 		//将获取的选中行数据进行遍历
			 		//array.indexOf 此方法判断数组中是否存在某个值，如果存在，则返回数组元素的下标，否则返回-1
				 	if( roleArray.indexOf(''+item.roleid+'')>-1 ){ 
					    //第一步：设置LAY_CHECKED （若不设置此操作，在获取选中值时将取到空）
						roleTableData[index]["LAY_CHECKED"]='true';
						//第二步：获取属性 lay-id='table'==表格id；设置checked 并 添加class属性(以下两步是为了实现选中效果)
						 $("div[lay-id='roleList'] tr[data-index=" + index + "] input[type='checkbox']").prop('checked', true);
					 	 $("div[lay-id='roleList'] tr[data-index=" + index + "] input[type='checkbox']").next().addClass('layui-form-checked');
			          } 
				 });
			}
		}
	});
});