EmuReady项目中的列可见性功能详解

2025-06-07 19:25:23作者：蔡丛锟

概述

在现代Web应用中，数据表格是展示信息的重要组件。EmuReady项目提供了一个强大的列可见性(Column Visibility)功能，允许用户根据需求自定义显示或隐藏表格中的特定列。这种功能在数据密集型应用中尤为重要，它能够帮助用户专注于当前最关心的数据维度。

核心组件解析

useColumnVisibility自定义Hook

这个Hook是整个列可见性功能的核心，它提供了以下关键能力：

状态管理：维护当前所有列的可见性状态
持久化存储：通过localStorage实现用户偏好的持久化
操作API：提供丰富的操作方法控制列显示状态

使用方法示例

const columns: ColumnDefinition[] = [
  { key: 'id', label: 'ID', defaultVisible: true },
  { key: 'username', label: '用户名', defaultVisible: true },
  { key: 'status', label: '状态', defaultVisible: false },
  { key: 'actions', label: '操作', alwaysVisible: true }
];

const columnVisibility = useColumnVisibility(columns, {
  storageKey: 'user-management-columns'
});

列定义属性详解

key: 列的唯一标识符，用于在代码中引用该列
label: 显示给用户的列名称
defaultVisible: 控制列初始是否可见（默认为true）
alwaysVisible: 设置为true的列将无法被隐藏（常用于操作列）

ColumnVisibilityControl组件

这是一个即插即用的UI控件，为用户提供可视化的列可见性控制界面。它包含以下特点：

下拉菜单式设计，节省空间
清晰的视觉反馈，显示当前可见列状态
支持键盘导航，符合无障碍访问标准

完整实现示例

下面是一个在表格中集成列可见性功能的完整示例：

function UserTable() {
  // 定义列配置
  const COLUMNS = [
    { key: 'id', label: 'ID', defaultVisible: true },
    { key: 'name', label: '姓名', defaultVisible: true },
    { key: 'email', label: '邮箱', defaultVisible: true },
    { key: 'department', label: '部门', defaultVisible: false },
    { key: 'actions', label: '操作', alwaysVisible: true }
  ];

  // 初始化列可见性Hook
  const columnVisibility = useColumnVisibility(COLUMNS, {
    storageKey: 'user-table-columns'
  });

  return (
    <div className="p-4">
      <div className="flex justify-between items-center mb-4">
        <h2 className="text-xl font-semibold">用户列表</h2>
        <ColumnVisibilityControl
          columns={COLUMNS}
          columnVisibility={columnVisibility}
        />
      </div>

      <table className="w-full border-collapse">
        <thead>
          <tr className="bg-gray-100">
            {columnVisibility.isColumnVisible('id') && (
              <th className="p-3 text-left">ID</th>
            )}
            {columnVisibility.isColumnVisible('name') && (
              <th className="p-3 text-left">姓名</th>
            )}
            {columnVisibility.isColumnVisible('email') && (
              <th className="p-3 text-left">邮箱</th>
            )}
            {columnVisibility.isColumnVisible('department') && (
              <th className="p-3 text-left">部门</th>
            )}
            {columnVisibility.isColumnVisible('actions') && (
              <th className="p-3 text-left">操作</th>
            )}
          </tr>
        </thead>
        <tbody>
          {users.map(user => (
            <tr key={user.id} className="border-b">
              {columnVisibility.isColumnVisible('id') && (
                <td className="p-3">{user.id}</td>
              )}
              {columnVisibility.isColumnVisible('name') && (
                <td className="p-3">{user.name}</td>
              )}
              {columnVisibility.isColumnVisible('email') && (
                <td className="p-3">{user.email}</td>
              )}
              {columnVisibility.isColumnVisible('department') && (
                <td className="p-3">{user.department}</td>
              )}
              {columnVisibility.isColumnVisible('actions') && (
                <td className="p-3 space-x-2">
                  <button className="text-blue-600">编辑</button>
                  <button className="text-red-600">删除</button>
                </td>
              )}
            </tr>
          ))}
        </tbody>
      </table>
    </div>
  );
}