为React Ant-Design Table增加字段设置

为React Ant-Design Table增加字段设置
最近做的几个项目经常遇到这样的需求,要在表格上增加一个自定义表格字段设置的功能。就是用户可以自己控制那些列需要展示。在几个项目里都实现了一遍,每个项目的需求又都有点儿不一样,迭代了很多版,所以抽时间把这个功能封装了个组件:@silverage/table-custom,将这些差别都集成了进去,方便今后使用和维护。同时也方便需要这个功能的人来使用。下面介绍下安装和使用

最近做的几个项目经常遇到这样的需求,要在表格上增加一个自定义表格字段设置的功能。就是用户可以自己控制那些列需要展示。

在几个项目里都实现了一遍,每个项目的需求又都有点儿不一样,迭代了很多版,所以抽时间把这个功能封装了个组件:@silverage/table-custom,将这些差别都集成了进去,方便今后使用和维护。同时也方便需要这个功能的人来使用。

下面介绍下安装和使用

安装

npm i @silverage/table-custom --save
 add @silverage/table-custom
pnpm add @silverage/table-custom

组件在ant-design基础上,所以你也要安装antd持久化使用的use-local-storage-state,也是要安装的。另外,react也是peer dependency。

使用

组件使用非常简单,只需要将你原先antd的

换成即可。兼容所有antd table的属性。

为React Ant-Design Table增加字段设置

悬浮在表格时,表格右上角就会出现齿轮 图标。点击之后就可进入设置界面。通过勾选就可以隐藏/展示列。

为React Ant-Design Table增加字段设置

支持单行表头,同时也支持双层合并表头。

为React Ant-Design Table增加字段设置

你可能注意到上面截图中,ID列是灰色的,这是因为在使用时,希望某些列是固定展示不可隐藏的。这时可以通过对column设置disableCustom: true来实现。

const columns = [
    {
        title: `ID`,
        dataIndex: `id`,
        key: `id`,
        width: 100,
        fixed: 'left',
        disableCustom: true // here
    }
]

另外,修改后的列想要保存,这里有两个方式:一种是通过localstorage做持久化,一种是通过后端提供接口。不同的项目选择不同方式实现,最近的几个项目两种都用了。

localstorage的方式很简单,只需要提供组件storageKey属性即可。

接口方式,可通过savedColumnsonChecklistChange配合实现。

过了一段时间使用后,在某些项目中,“极个别同志(no one but you)”认为,这个齿轮的图标太不明显了,想在表格上面放个按钮来控制,所以加了如下属性,让用户自己控制。因为原有表格上方可能有其他按钮。

又过了一段时间,为了今后必然出现的字段排序需求,又增加了排序功能,只需要设置sortable字段。

为React Ant-Design Table增加字段设置

鼠标拖拽字段后的icon就可以,同样支持单层和双层表头!

也可以自定义icon样式:


查看完成文档:https://github.com/yuhongda/table-custom

Enjoy

作者:零售于弘达

来源:社区 自猿其说 转载请注明来源

给TA打赏
共{{data.count}}人
人已打赏
前端

记录--alova组件使用方法(区别axios)

2023-11-18 14:07:12

运维笔记

如何避免程序员的中年危机?

2023-10-10 17:50:51

0 条回复 A文章作者 M管理员
    暂无讨论,说说你的看法吧
个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索