为 React Ant-Design Table 增加字段设置 | 京东云技术团队

2023-11-16
北京
本文字数：1425 字
阅读完需：约 5 分钟

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

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

下面介绍下安装和使用

安装

npm i @silverage/table-custom --saveyarn add @silverage/table-custompnpm add @silverage/table-custom

复制代码

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

使用

组件使用非常简单，只需要将你原先 antd 的<Table />换成<TableCustom />即可。兼容所有 antd table 的属性。

import { TableCustom } from '@silverage/table-custom'
<TableCustom columns={columns} dataSource={dataSource} />

复制代码

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

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

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

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

复制代码

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

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

<TableCustom    storageKey="myKey"    columns={columns}    dataSource={dataSource}/>

复制代码

接口方式，可通过savedColumns和onChecklistChange配合实现。

const [savedColumns, setSavedColumns] = useState([])
<TableCustom    columns={columns}    dataSource={dataSource}    savedColumns={savedColumns ?? []}    onChecklistChange={async checkedList => {        const res = await api.request()        setSavedColumns(res?.data)    }}/>

复制代码

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

const [visible, setVisible] = useState(false)<Button onClick={() => setVisible(true)}>Open</Button><TableCustom    columns={columns}    dataSource={dataSource}    openCustomModal={visible} // here    onCustomModalClose={() => setVisible(false)} // and here/>

复制代码

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

<TableCustom    columns={columns}    dataSource={dataSource}    sortable/>

复制代码

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

也可以自定义 icon 样式：

<TableCustom    columns={columns}    dataSource={dataSource}    sortable    sortHandler={<span>::</span>}/>

复制代码

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

Enjoy

作者：京东零售于弘达
来源：京东云开发者社区自猿其说 Tech 转载请注明来源

发布于: 刚刚阅读数: 6

原文链接:【http://xie.infoq.cn/article/be20f3d7862e3a03b72d42600】。文章转载请联系作者。

京东科技开发者

关注

拥抱技术，与开发者携手创造未来！ 2018-11-20 加入

我们将持续为人工智能、大数据、云计算、物联网等相关领域的开发者，提供技术干货、行业技术内容、技术落地实践等文章内容。京东云开发者社区官方网站【https://developer.jdcloud.com/】，欢迎大家来玩

发布

暂无评论

创作场景

为 React Ant-Design Table 增加字段设置 | 京东云技术团队

安装

使用

Enjoy

京东科技开发者

评论