layui表格怎么实现列的显示与隐藏记忆功能

冬晨小哥_7698

冬晨小哥_7698

2026-11-19

576人浏览

原创

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

layui表格怎么实现列的显示与隐藏记忆功能

为什么直接用 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', ...) 或延时执行。

深蓝色网站后台管理系统layui框架模板-AdminPro
深蓝色网站后台管理系统layui框架模板-AdminPro

一款深蓝色网站后台管理系统layui框架模板

下载
  • 右键菜单 DOM 结构固定:.layui-table-patch .layui-table-menu .layui-table-menu-body 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 时也要带上,否则可能跳回第一页——但这和列记忆无关,只是连带易错点。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

layui表格 layui

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3103

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

6803

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

7610

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

7578

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

1083

5

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2395

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3962

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1316

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4619

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
ThinkPHP配置开发与CMS后台实战
ThinkPHP配置开发与CMS后台实战

共87课时 | 13.3万人学习

第二十三期_综合实战
第二十三期_综合实战

共89课时 | 11.6万人学习

Layui 快速入门精讲
Layui 快速入门精讲

共5课时 | 1.6万人学习