设置ProTable组件默认只展示部分列，其余列通过setting设置

最新推荐文章于 2024-06-05 15:41:36 发布

丷与你初见丷

最新推荐文章于 2024-06-05 15:41:36 发布

阅读量795

点赞数

文章标签： typescript Ant Design Pro 前端框架

原文链接：https://blog.csdn.net/qq_38969618/article/details/129989845

版权

需求背景：某个表格有很多个字段，但是刚进入页面时，默认只展示部分列，其余列先隐藏，用户可以手动再勾选来显示。

通过ProTable组件的columnsState属性配置即可。注意：一旦配置持久化，组件内部会自动处理相关缓存&表格列显示，此时不需要再手动代码修改columnsState，否则会陷入死循环 !!! 。如果没有配置持久化，可使用：columnsState={{ value: columnsStateMap, onChange: setColumnsStateMap }}，其中columnsStateMap是对象类型（通过useState声明）。

// 定义列数组
const columns: any[] = [
  {
    title: '序号',
    dataIndex: 'index',
    fixed: 'left', // 左固定显示
    key: 'index',
    valueType: 'index',
  },
 {
    title: '用户名',
    dataIndex: 'userName', // dataIndex： 后台返回的字段名
    key: 'userName', // key: 前端传参名
    hideInSearch: true, // 在搜索框中不显示
    order: 1 // order：表单中的显示位置，越大越靠前显示（不会影响表格列展示顺序）
  },
  {
    title: '地区',
    hideInTable: true, // 在列表中不显示
    dataIndex: 'region',
    key: 'xxx'
    valueType: 'select', // 表单类型：下拉搜索框
    filters: true,
    onFilter: true,
    valueEnum: {
      london: {
        text: '伦敦',
      },
      'New York': {
        text: '纽约',
      },
    },
  },
  {
    title: '年龄',
    dataIndex: 'age',
    key: 'xxx',
  },
  {
    title: '地址',
    dataIndex: 'address',
    key: 'xxx',
  },
];
 
<ProTable
  columns={columns}
  request={(params) => getList(params)}
  options={{ reload: false, density: false }} // 表格右上侧不展示：重新加载 & 密度按钮
  search={{ collapsed: false, collapseRender: () => null }} // 不展示搜索框的展开&折叠按钮
  columnsState={{
    defaultValue: { // 配置初始值；如果配置了持久化，仅第一次生效（没有缓存的第一次），后续都按缓存处理。
        age: {
          show: false, // 该字段（年龄列）不显示在表格列中
        },
        address: {
          show: false,
        },
   },
   onChange: (mapObj: Record<string, ColumnsState>) => {
      /* 注意：如果设置持久化，不要在该函数中再额外设置columnsState的值，否则死循环 */
      console.log(mapObj) // {useName: { show: true },age: { show: false},…}
   },
   persistenceKey: 'infoTableSetting', // 持久化列的key，用于判断是否是同一个table,会存在缓存里去
   persistenceType: 'localStorage', // 持久化列的类型，localStorage 设置在关闭浏览器后也是存在的，sessionStorage 关闭浏览器后会丢失
}}
  pagination={{
    showSizeChanger: true,
    showQuickJumper: true,
    defaultPageSize: 5,
    current: 1,
    showTotal: (total) => `共${total}条` // 总条数的展示
    onChange: (page) => console.log(page),
  }}
  toolBarRender={() => [ // 表格右上侧：展示自定义的按钮
    <Button key="button" icon={<PlusOutlined />} onClick={handleAdd} type="primary">
      新建
    </Button>,
  ]}
/>;