因为layui.table不自动维护列显隐状态,必须手动用localStorage存储字段hide状态,并在每次render/reload前动态注入cols配置中。

为什么直接用 layui.table 的 initSort 或 defaultToolbar 无法记住列显隐状态
因为 layui 官方表格(layui.table)本身不维护列的显示/隐藏状态,每次重载(table.reload())、切换页、甚至刷新页面后,所有列都会按初始化时的 cols 配置恢复原状。所谓“记忆”,必须由你主动存取、并在重新渲染前干预列配置。
关键点在于:不是靠某个开关参数自动生效,而是要在 cols 构建阶段,把用户上次操作的结果注入进去。
-
table.render()时的cols是静态数组,不会响应式更新 - 列显隐操作(如点击表头右键菜单)触发的是
table.setColsWidth()或手动 DOM 切换,但不改变原始cols配置 - 必须在每次 render / reload 前,先读取本地存储的列状态,再动态生成带
hide: true的cols
如何用 localStorage 存储并还原每列的 hide 状态
核心逻辑是给每列加唯一标识(推荐用 field),存一个对象映射:{'username': false, 'email': true, 'status': false}。注意不能只存“隐藏的字段名列表”,否则新增列或字段名变更时会出错。
示例代码片段(放在 table.render() 之前):
// 从 localStorage 读取列状态,fallback 为默认值
const colStateKey = 'user_table_col_state';
let colState = {};
try {
const saved = localStorage.getItem(colStateKey);
colState = saved ? JSON.parse(saved) : {};
} catch (e) {
console.warn('解析列状态失败', e);
}
// 初始化 cols,并注入 hide 状态
const initCols = [[
{type: 'checkbox'},
{field: 'username', title: '用户名', hide: colState.username === true},
{field: 'email', title: '邮箱', hide: colState.email === true},
{field: 'status', title: '状态', hide: colState.status === true}
]];
// 渲染时传入 initCols
table.render({
elem: '#userTable',
cols: initCols,
// ...其他配置
});
怎么监听列显隐操作并实时更新 localStorage
layui 没有内置“列显隐事件”,但你可以劫持右键菜单中的“显示/隐藏列”行为,或者监听表头 DOM 的点击(更可靠)。实际中推荐监听右键菜单的 click,因为它是用户唯一标准入口。
注意:必须等 table 渲染完成、右键菜单绑定好后再监听,建议用 table.on('renderDone', ...) 或延时执行。
- 右键菜单 DOM 结构固定:
.layui-table-patch .layui-table-menu .layui-table-menu-body li - 每个
<li>的data-field属性就是对应列的field - 点击后需同步更新
colState并写入localStorage,同时调用table.resize()触发重绘
简化的监听逻辑:
// 在 table.render() 后执行
setTimeout(() => {
const $menu = $('.layui-table-patch .layui-table-menu');
$menu.on('click', 'li', function() {
const field = $(this).data('field');
if (field == null) return;
// 切换状态
colState[field] = !colState[field];
// 写入 localStorage
try {
localStorage.setItem(colStateKey, JSON.stringify(colState));
} catch (e) {
console.warn('保存列状态失败', e);
}
});
}, 300);
reload 时忘记重置 cols 就会失效
这是最常踩的坑:表格 reload 后,如果没重新走一遍“读取 localStorage → 构建 cols → 传入 reload()”流程,列状态就回到初始值。
正确做法是把列配置逻辑抽成函数,在 render 和 reload 时都调用:
function getTableCols() {
const saved = localStorage.getItem(colStateKey);
const state = saved ? JSON.parse(saved) : {};
return [[
{type: 'checkbox'},
{field: 'username', title: '用户名', hide: state.username === true},
{field: 'email', title: '邮箱', hide: state.email === true},
{field: 'status', title: '状态', hide: state.status === true}
]];
}
// render 时
table.render({
elem: '#userTable',
cols: getTableCols(),
// ...
});
// reload 时
table.reload('userTable', {
cols: getTableCols(), // 必须显式传入!
// ...
});
如果你用了服务端分页,还要注意:page: {curr: 1} 这类参数 reload 时也要带上,否则可能跳回第一页——但这和列记忆无关,只是连带易错点。


















