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

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

通过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>,
  ]}
/>;
业务页面截图:默认不展示“订单编号”列
  • 2
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 2
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值