# 表格 - 页面: https://jiguang132.com/zh/resources/ant-design/docs/table - 资源: Ant Design (https://jiguang132.com/zh/resources/ant-design.md) - 全部指南: https://jiguang132.com/zh/resources/ant-design/docs.md 展示行列数据。 ## 何时使用 {#when-to-use} - 当有大量结构化的数据需要展现时； - 当需要对数据进行排序、搜索、分页、自定义操作等复杂行为时。 ## 如何使用 {#how-to-use} 指定表格的数据源 `dataSource` 为一个数组。 ```jsx const dataSource = [ { key: '1', name: '胡彦斌', age: 32, address: '西湖区湖底公园1号', }, { key: '2', name: '胡彦祖', age: 42, address: '西湖区湖底公园1号', }, ]; const columns = [ { title: '姓名', dataIndex: 'name', key: 'name', }, { title: '年龄', dataIndex: 'age', key: 'age', }, { title: '住址', dataIndex: 'address', key: 'address', }, ]; ; ``` ## 相关推荐 {#promotion} - [Kitchen Sketch 插件 💎](https://kitchen.alipay.com/)：设计师神器，两步自动生成 Ant Design 表格组件。 - [ProTable](https://procomponents.ant.design/components/table) 高级表格：在 `antd` Table 之上扩展了更多便捷易用的功能，内置搜索、筛选、刷新等常用表格行为，并为多种类型数据展示提供了内置格式化。 - [S2](https://s2.antv.vision/zh) 多维交叉分析表格：[AntV S2 和 Antd Table 有什么区别？](https://zhuanlan.zhihu.com/p/494995642) ## 代码演示 {#examples} - 基本用法 · `basic` - JSX 风格的 API · `jsx` - 可选择 · `row-selection` - 选择和操作 · `row-selection-and-operation` - 自定义选择项 · `row-selection-custom` - 筛选和排序 · `head` - 树型筛选菜单 · `filter-in-tree` - 自定义筛选的搜索 · `filter-search` - 多列排序 · `multiple-sorter` - 可控的筛选和排序 · `reset-filter` - 自定义筛选菜单 · `custom-filter-panel` - 远程加载数据 · `ajax` - 紧凑型 · `size` - 带边框 · `bordered` - 可展开 · `expand` - 特殊列排序 · `order-column` - 表格行/列合并 · `colspan-rowspan` - 树形数据展示 · `tree-data` - 固定表头 · `fixed-header` - 自动高度 · `auto-height` - 固定列 · `fixed-columns` - 堆叠固定列 · `fixed-gapped-columns` - 固定头和列 · `fixed-columns-header` - 隐藏列 · `hidden-columns` - 表头分组 · `grouping-columns` - 可编辑单元格 · `edit-cell` - 可编辑行 · `edit-row` - 嵌套子表格 · `nested-table` - 拖拽排序 · `drag-sorting` - 列拖拽排序 · `drag-column-sorting` - 拖拽手柄列 · `drag-sorting-handler` - 单元格自动省略 · `ellipsis` - 统一列配置 · `column-defaults` - 自定义单元格省略提示 · `ellipsis-custom-tooltip` - 自定义空状态 · `custom-empty` - 总结栏 · `summary` - 虚拟列表 · `virtual-list` - 响应式 · `responsive` - 分页设置 · `pagination` - 随页面滚动的固定表头和滚动条 · `sticky` - 动态控制表格属性 · `dynamic-settings` - 自定义语义结构的样式和类 · `style-class` ## API 通用属性参考：[通用属性](#jguang-common-props) ### Table | 参数 | 说明 | 类型 | 默认值 | 版本 | [全局配置](/components/config-provider#component-config) | | --- | --- | --- | --- | --- | --- | | bordered | 是否展示外边框和列边框 | boolean | false | | × | | classNames | 用于自定义组件内部各语义化结构的 class，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), string> \| (info: { props })=> Record<[SemanticDOM](#semantic-dom), string> | - | | 6.0.1 | | column | 统一列配置，仅在单列未声明同名属性时生效 | Partial<[ColumnType](#column)> | - | 6.4.0 | × | | columns | 表格列的配置描述，具体项见下表 | [ColumnsType](#column)\[] | - | | × | | components | 覆盖默认的 table 元素 | [TableComponents](https://github.com/react-component/table/blob/75ee0064e54a4b3215694505870c9d6c817e9e4a/src/interface.ts#L129) | - | | × | | dataSource | 数据数组 | object\[] | - | | × | | expandable | 配置展开属性 | [expandable](#expandable) | - | | `expandable.expandIcon`: 5.14.0 | | footer | 表格尾部 | function(currentPageData) | - | | × | | getPopupContainer | 设置表格内各类浮层的渲染节点，如筛选菜单 | (triggerNode) => HTMLElement | () => TableHtmlElement | | × | | loading | 页面是否加载中 | boolean \| [Spin Props](/components/spin#api) | false | | × | | locale | 默认文案设置，目前包括排序、过滤、空数据文案 | object | [默认值](https://github.com/ant-design/ant-design/blob/6dae4a7e18ad1ba193aedd5ab6867e1d823e2aa4/components/locale/zh_CN.tsx#L20-L37) | | × | | pagination | 分页器，参考[配置项](#pagination)或 [pagination](/components/pagination) 文档，设为 false 时不展示和进行分页 | object \| `false` | - | | × | | rowClassName | 表格行的类名 | function(record, index): string | - | | × | | rowKey | 表格行 key 的取值，可以是字符串或一个函数 | string \| function(record): string | `key` | | `string`: 6.0.0，`function`: 6.1.0 | | rowSelection | 表格行是否可选择，[配置项](#rowselection) | object | - | | × | | rowHoverable | 表格行是否开启 hover 交互 | boolean | true | 5.16.0 | × | | scroll | 表格是否可滚动，也可以指定滚动区域的宽、高，[配置项](#scroll) | object | - | | 6.3.0 | | showHeader | 是否显示表头 | boolean | true | | × | | showSorterTooltip | 表头是否显示下一次排序的 tooltip 提示。当参数类型为对象时，将被设置为 Tooltip 的属性 | boolean \| [Tooltip props](/components/tooltip) & `{target?: 'full-header' \| 'sorter-icon' }` | { target: 'full-header' } | 5.16.0 | × | | size | 表格大小 | `large` \| `medium` \| `small` | `large` | | × | | sortDirections | 支持的排序方式，取值为 `ascend` `descend` | Array | \[`ascend`, `descend`] | | × | | sticky | 设置粘性头部和滚动条 | boolean \| `{offsetHeader?: number, offsetScroll?: number, getContainer?: () => HTMLElement}` | - | 4.6.0 (getContainer: 4.7.0) | × | | styles | 用于自定义组件内部各语义化结构的行内 style，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), CSSProperties> \| (info: { props })=> Record<[SemanticDOM](#semantic-dom), CSSProperties> | - | | 6.0.1 | | summary | 总结栏 | (currentData) => ReactNode | - | | × | | tableLayout | 表格元素的 [table-layout](https://developer.mozilla.org/zh-CN/docs/Web/CSS/table-layout) 属性，设为 `fixed` 表示内容不会影响列的布局 | - \| `auto` \| `fixed` | 无
固定表头/列或使用了 `column.ellipsis` 时，默认值为 `fixed` | | × | | title | 表格标题 | function(currentPageData) | - | | × | | virtual | 支持虚拟列表 | boolean | - | 5.9.0 | × | | onChange | 分页、排序、筛选变化时触发 | function(pagination, filters, sorter, extra: { currentDataSource: \[], action: `paginate` \| `sort` \| `filter` }) | - | | × | | onHeaderRow | 设置头部行属性 | function(columns, index) | - | | × | | onRow | 设置行属性 | function(record, index) | - | | × | | onScroll | 表单内容滚动时触发（虚拟滚动下只有垂直滚动会触发事件） | function(event) | - | 5.16.0 | × | ### Table ref | 参数 | 说明 | 类型 | 版本 | | --- | --- | --- | --- | | nativeElement | 最外层 div 元素 | HTMLDivElement | 5.11.0 | | scrollTo | 滚动到目标位置（设置 `key` 时为 Record 对应的 `rowKey`）。当指定 `offset` 时，表格会滚动至目标行顶部对齐并应用指定的偏移量。`offset` 对 `top` 无效。可选 `align` 参数控制对齐方式：`start` 顶部对齐、`center` 中间对齐、`end` 底部对齐、`nearest` 智能对齐（默认）。虚拟滚动模式下不支持 `center` 对齐 | (config: { index?: number, key?: React.Key, top?: number, offset?: number, align?: 'start' \| 'center' \| 'end' \| 'nearest' }) => void | 5.11.0 | #### onRow 用法 {#onrow-usage} 适用于 `onRow` `onHeaderRow` `onCell` `onHeaderCell`。 ```jsx
{ return { onClick: (event) => {}, // 点击行 onDoubleClick: (event) => {}, onContextMenu: (event) => {}, onMouseEnter: (event) => {}, // 鼠标移入行 onMouseLeave: (event) => {}, }; }} onHeaderRow={(columns, index) => { return { onClick: () => {}, // 点击表头行 }; }} /> ``` ### Column 列描述数据对象，是 columns 中的一项，Column 使用相同的 API。 | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | align | 设置列的对齐方式 | `left` \| `right` \| `center` | `left` | | | className | 列样式类名 | string | - | | | colSpan | 表头列合并，设置为 0 时，不渲染 | number | - | | | dataIndex | 列数据在数据项中对应的路径，支持通过数组查询嵌套路径 | string \| string\[] | - | | | defaultFilteredValue | 默认筛选值 | string\[] | - | | | filterResetToDefaultFilteredValue | 点击重置按钮的时候，是否恢复默认筛选值 | boolean | false | | | defaultSortOrder | 默认排序顺序 | `ascend` \| `descend` | - | | | ellipsis | 超过宽度将自动省略，暂不支持和排序筛选一起使用。
设置为 `true` 或 `{ showTitle?: boolean }` 时，表格布局将变成 `tableLayout="fixed"`。 | boolean \| { showTitle?: boolean } | false | showTitle: 4.3.0 | | filterDropdown | 可以自定义筛选菜单，此函数只负责渲染图层，需要自行编写各种交互 | ReactNode \| (props: [FilterDropdownProps](https://github.com/ant-design/ant-design/blob/ecc54dda839619e921c0ace530408871f0281c2a/components/table/interface.tsx#L79)) => ReactNode | - | | | filtered | 标识数据是否经过过滤，筛选图标会高亮 | boolean | false | | | filteredValue | 筛选的受控属性，外界可用此控制列的筛选状态，值为已筛选的 value 数组 | string\[] | - | | | filterIcon | 自定义 filter 图标。 | ReactNode \| (filtered: boolean) => ReactNode | - | | | filterOnClose | 是否在筛选菜单关闭时触发筛选 | boolean | true | 5.15.0 | | filterMultiple | 是否多选 | boolean | true | | | filterMode | 指定筛选菜单的用户界面 | 'menu' \| 'tree' | 'menu' | 4.17.0 | | filterSearch | 筛选菜单项是否可搜索 | boolean \| function(input, record):boolean | false | boolean:4.17.0 function:4.19.0 | | filters | 表头的筛选菜单项 | object\[] | - | | | filterDropdownProps | 自定义下拉属性，在 `<5.22.0` 之前可用 `filterDropdownOpen` 和 `onFilterDropdownOpenChange` | [DropdownProps](/components/dropdown#api) | - | 5.22.0 | | fixed | （IE 下无效）列是否固定，可选 `true` (等效于 `'start'`) `'start'` `'end'` | boolean \| string | false | | | key | React 需要的 key，如果已经设置了唯一的 `dataIndex`，可以忽略这个属性 | string | - | | | render | 生成复杂数据的渲染函数，参数分别为当前单元格的值，当前行数据，行索引 | (value: V, record: T, index: number): ReactNode | - | | | responsive | 响应式 breakpoint 配置列表。未设置则始终可见。 | [Breakpoint](https://github.com/ant-design/ant-design/blob/015109b42b85c63146371b4e32b883cf97b088e8/components/_util/responsiveObserve.ts#L1)\[] | - | 4.2.0 | | rowScope | 设置列范围 | `row` \| `rowgroup` | - | 5.1.0 | | shouldCellUpdate | 自定义单元格渲染时机 | (record, prevRecord) => boolean | - | 4.3.0 | | showSorterTooltip | 表头显示下一次排序的 tooltip 提示, 覆盖 table 中 `showSorterTooltip` | boolean \| [Tooltip props](/components/tooltip/#api) & `{target?: 'full-header' \| 'sorter-icon' }` | { target: 'full-header' } | 5.16.0 | | sortDirections | 支持的排序方式，覆盖 `Table` 中 `sortDirections`， 取值为 `ascend` `descend` | Array | \[`ascend`, `descend`] | | | sorter | 排序函数，本地排序使用一个函数(参考 [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 的 compareFunction)。需要服务端排序可设为 `true`（单列排序） 或 `{ multiple: number }`（多列排序） | function \| boolean \| { compare: function, multiple: number } | - | | | sortOrder | 排序的受控属性，外界可用此控制列的排序，可设置为 `ascend` `descend` `null` | `ascend` \| `descend` \| null | - | | | sortIcon | 自定义 sort 图标 | (props: { sortOrder }) => ReactNode | - | 5.6.0 | | title | 列头显示文字（函数用法 `3.10.0` 后支持） | ReactNode \| ({ sortColumns, filters }) => ReactNode | - | | | width | 列宽度（[指定了也不生效？](https://github.com/ant-design/ant-design/issues/13825#issuecomment-449889241)） | string \| number | - | | | minWidth | 最小列宽度，只在 `tableLayout="auto"` 时有效 | number | - | 5.21.0 | | hidden | 隐藏列 | boolean | false | 5.13.0 | | onCell | 设置单元格属性 | function(record, rowIndex) | - | | | onFilter | 本地模式下，确定筛选的运行函数 | function | - | | | onHeaderCell | 设置头部单元格属性 | function(column) | - | | ### ColumnGroup | 参数 | 说明 | 类型 | 默认值 | | ----- | ------------ | --------- | ------ | | title | 列头显示文字 | ReactNode | - | ### pagination 分页的配置项。 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | placement | 指定分页显示的位置， 取值为`topStart` \| `topCenter` \| `topEnd` \|`bottomStart` \| `bottomCenter` \| `bottomEnd`\| `none` | Array | \[`bottomEnd`] | | ~~position~~ | 指定分页显示的位置， 取值为`topLeft` \| `topCenter` \| `topRight` \|`bottomLeft` \| `bottomCenter` \| `bottomRight` \| `none`，请使用 `placement` 替换 | Array | \[`bottomRight`] | 更多配置项，请查看 [`Pagination`](/components/pagination)。 ### expandable 展开功能的配置。 | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | childrenColumnName | 指定树形结构的列名 | string | children | | | columnTitle | 自定义展开列表头 | ReactNode | - | 4.23.0 | | columnWidth | 自定义展开列宽度 | string \| number | - | | | defaultExpandAllRows | 初始时，是否展开所有行 | boolean | false | | | defaultExpandedRowKeys | 默认展开的行 | string\[] | - | | | expandedRowClassName | 展开行的 className | string \| (record, index, indent) => string | - | string: 5.22.0 | | expandedRowKeys | 展开的行，控制属性 | string\[] | - | | | expandedRowRender | 额外的展开行 | function(record, index, indent, expanded): ReactNode | - | | | expandIcon | 自定义展开图标，参考[示例](https://codesandbox.io/s/fervent-bird-nuzpr) | function(props): ReactNode | - | | | expandRowByClick | 通过点击行来展开子行 | boolean | false | | | fixed | 控制展开图标是否固定，可选 `true` `'left'` `'right'` | boolean \| string | false | 4.16.0 | | forceRender | 在展开前强制渲染展开行内容。虚拟模式下，仅强制渲染虚拟列表当前挂载的行；屏幕外的行仍可能被卸载 | boolean | false | 6.6.0 | | indentSize | 展示树形数据时，每层缩进的宽度，以 px 为单位 | number | 15 | | | rowExpandable | 设置是否允许行展开（`dataSource` 若存在 `children` 字段将不生效） | (record) => boolean | - | | | showExpandColumn | 是否显示展开图标列 | boolean | true | 4.18.0 | | onExpand | 点击展开图标时触发 | function(expanded, record) | - | | | onExpandedRowsChange | 展开的行变化时触发 | function(expandedRows) | - | | | ~~expandedRowOffset~~ | 废弃：展开行的偏移列数，设置后会强制将其前面的列设为固定列。请改用 `Table.EXPAND_COLUMN` 并通过列顺序控制位置 | number | - | 5.26.0 | ### rowSelection 选择功能的配置。 | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | align | 设置选择列的对齐方式 | `left` \| `right` \| `center` | `left` | 5.25.0 | | checkStrictly | checkable 状态下节点选择完全受控（父子数据选中状态不再关联） | boolean | true | 4.4.0 | | columnTitle | 自定义列表选择框标题 | ReactNode \| (originalNode: ReactNode) => ReactNode | - | | | columnWidth | 自定义列表选择框宽度 | string \| number | `32px` | | | fixed | 把选择框列固定在左边 | boolean | - | | | getCheckboxProps | 选择框的默认属性配置 | function(record) | - | | | getTitleCheckboxProps | 标题选择框的默认属性配置 | function() | - | | | hideSelectAll | 隐藏全选勾选框与自定义选择项 | boolean | false | 4.3.0 | | preserveSelectedRowKeys | 当数据被删除时仍然保留选项的 `key` | boolean | - | 4.4.0 | | renderCell | 渲染勾选框，用法与 Column 的 `render` 相同 | (checked: boolean, record: T, index: number, originNode: ReactNode): ReactNode | - | 4.1.0 | | selectedRowKeys | 指定选中项的 key 数组，需要和 onChange 进行配合 | string\[] \| number\[] | \[] | | | defaultSelectedRowKeys | 默认选中项的 key 数组 | string\[] \| number\[] | \[] | | | selections | 自定义选择项 [配置项](#selection), 设为 `true` 时使用默认选择项 | object\[] \| boolean | - | | | type | 多选/单选 | `checkbox` \| `radio` | `checkbox` | | | onCell | 设置单元格属性，用法与 Column 的 `onCell` 相同 | function(record, rowIndex) | - | 5.5.0 | | onChange | 选中项发生变化时的回调 | function(selectedRowKeys, selectedRows, info: { type }) | - | `info.type`: 4.21.0 | | onSelect | 用户手动选择/取消选择某行的回调 | function(record, selected, selectedRows, nativeEvent) | - | | ### scroll | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | scrollToFirstRowOnChange | 当分页、排序、筛选变化后是否滚动到表格顶部 | boolean | - | | x | 设置横向滚动，也可用于指定滚动区域的宽，可以设置为像素值，百分比，`true` 和 ['max-content'](https://developer.mozilla.org/zh-CN/docs/Web/CSS/width#max-content) | string \| number \| true | - | | y | 设置纵向滚动，也可用于指定滚动区域的高，可以设置为像素值 | string \| number | - | ### selection | 参数 | 说明 | 类型 | 默认值 | | -------- | -------------------------- | --------------------------- | ------ | | key | React 需要的 key，建议设置 | string | - | | text | 选择项显示的文字 | ReactNode | - | | onSelect | 选择项点击回调 | function(changeableRowKeys) | - | ## 在 TypeScript 中使用 {#using-in-typescript} ```tsx import React from 'react'; import { Table } from 'antd'; import type { TableColumnsType } from 'antd'; interface User { key: number; name: string; } const columns: TableColumnsType = [ { key: 'name', title: 'Name', dataIndex: 'name', }, ]; const data: User[] = [ { key: 0, name: 'Jack', }, ]; const Demo: React.FC = () => ( <> columns={columns} dataSource={data} /> {/* 使用 JSX 风格的 API */} dataSource={data}> key="name" title="Name" dataIndex="name" />
); export default Demo; ``` TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/serene-platform-0jo5t)。 ## Semantic DOM | 语义节点 | 原生说明 | 版本 | | --- | --- | --- | | `root` | 根元素，包含字体大小、背景色、圆角、滚动条颜色等表格容器的基础样式 | — | | `title` | 标题元素，包含表格标题的样式和布局 | — | | `content` | 内容元素，包含表格内容区域的样式和布局 | — | | `header.wrapper` | 头部容器元素，包含表头的布局和容器样式 | — | | `header.row` | 头部行元素，包含表头行的布局和样式 | — | | `header.cell` | 头部单元格元素，包含相对定位、内边距、文字换行、背景色、文字颜色、字体权重等表头单元格样式 | — | | `section` | 容器元素，包含清除浮动、最大宽度、滚动条背景等表格包装容器样式 | — | | `body.wrapper` | 主体容器元素，包含表格主体的布局和容器样式 | — | | `body.row` | 主体行元素，包含数据行的悬浮效果、选中状态、展开状态等交互样式 | — | | `body.cell` | 主体单元格元素，包含相对定位、内边距、文字换行等数据单元格的基础样式 | — | | `footer` | 底部元素，包含表格底部的背景色、文字颜色等样式 | — | | `pagination.root` | 分页根元素，包含分页组件的基础样式和布局 | — | | `pagination.item` | 分页单项元素，包含分页项的样式和交互效果 | — | 语义说明来源: `vendor/components/table/demo/_semantic.tsx` ## 主题变量（Design Token）{#design-token} 类型、继承关系和原生令牌声明保持固定源码原文；默认值由原生主题计算，并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。 | 令牌 | 类型 | 原生说明 | | --- | --- | --- | | `headerBg` | `string` | 表头背景 | | `headerColor` | `string` | 表头文字颜色 | | `headerSortActiveBg` | `string` | 表头排序激活态背景色 | | `headerSortHoverBg` | `string` | 表头排序激活态悬浮背景色 | | `bodySortBg` | `string` | 表格排序列背景色 | | `rowHoverBg` | `string` | 表格行悬浮背景色 | | `rowSelectedBg` | `string` | 表格行选中背景色 | | `rowSelectedHoverBg` | `string` | 表格行选中悬浮背景色 | | `rowExpandedBg` | `string` | 表格行展开背景色 | | `cellPaddingBlock` | `number` | 单元格纵向内间距 | | `cellPaddingInline` | `number` | 单元格横向内间距（默认大尺寸） | | `cellPaddingBlockMD` | `number` | 单元格纵向内间距（中等尺寸） | | `cellPaddingInlineMD` | `number` | 单元格横向内间距（中等尺寸） | | `cellPaddingBlockSM` | `number` | 单元格纵向内间距（小尺寸） | | `cellPaddingInlineSM` | `number` | 单元格横向内间距（小尺寸） | | `borderColor` | `string` | 表格边框/分割线颜色 | | `headerBorderRadius` | `number` | 表头圆角 | | `footerBg` | `string` | 表格底部背景色 | | `footerColor` | `string` | 表格底部文字颜色 | | `cellFontSize` | `number` | 单元格文字大小（默认大尺寸） | | `cellFontSizeMD` | `number` | 单元格文字大小（中等尺寸） | | `cellFontSizeSM` | `number` | 单元格文字大小（小尺寸） | | `headerSplitColor` | `string` | 表头分割线颜色 | | `fixedHeaderSortActiveBg` | `string` | 固定表头排序激活态背景色 | | `headerFilterHoverBg` | `string` | 表头过滤按钮悬浮背景色 | | `filterDropdownMenuBg` | `string` | 过滤下拉菜单选项背景 | | `filterDropdownBg` | `string` | 过滤下拉菜单颜色 | | `expandIconBg` | `string` | 展开按钮背景色 | | `selectionColumnWidth` | `number \| string` | 选择列宽度 | | `stickyScrollBarBg` | `string` | Sticky 模式下滚动条背景色 | | `stickyScrollBarBorderRadius` | `number` | Sticky 模式下滚动条圆角 | | `expandIconMarginTop` | `number` | 见原生声明及继承类型 | | `expandIconHalfInner` | `number` | 见原生声明及继承类型 | | `expandIconSize` | `number` | 见原生声明及继承类型 | | `expandIconScale` | `number` | 见原生声明及继承类型 | | `headerIconColor` | `string` | 见原生声明及继承类型 | | `headerIconHoverColor` | `string` | 见原生声明及继承类型 | 声明来源: `vendor/components/table/style/index.ts` ```ts import { unit } from '@ant-design/cssinjs'; import type { CSSObject } from '@ant-design/cssinjs'; import { FastColor } from '@ant-design/fast-color'; import { clearFix, resetComponent } from '../../style'; import type { FullToken, GenerateStyle, GetDefaultToken } from '../../theme/internal'; import { genStyleHooks, mergeToken } from '../../theme/internal'; import genBorderedStyle from './bordered'; import genEllipsisStyle from './ellipsis'; import genEmptyStyle from './empty'; import genExpandStyle from './expand'; import genFilterStyle from './filter'; import genFixedStyle from './fixed'; import genPaginationStyle from './pagination'; import genRadiusStyle from './radius'; import genRtlStyle from './rtl'; import genSelectionStyle from './selection'; import genSizeStyle from './size'; import genSorterStyle from './sorter'; import genStickyStyle from './sticky'; import genSummaryStyle from './summary'; import genVirtualStyle from './virtual'; export interface ComponentToken { /** * @desc 表头背景 * @descEN Background of table header */ headerBg: string; /** * @desc 表头文字颜色 * @descEN Color of table header text */ headerColor: string; /** * @desc 表头排序激活态背景色 * @descEN Background color of table header when sorted */ headerSortActiveBg: string; /** * @desc 表头排序激活态悬浮背景色 * @descEN Background color of table header when sorted and hovered */ headerSortHoverBg: string; /** * @desc 表格排序列背景色 * @descEN Background color of table sorted column */ bodySortBg: string; /** * @desc 表格行悬浮背景色 * @descEN Background color of table hovered row */ rowHoverBg: string; /** * @desc 表格行选中背景色 * @descEN Background color of table selected row */ rowSelectedBg: string; /** * @desc 表格行选中悬浮背景色 * @descEN Background color of table selected row when hovered */ rowSelectedHoverBg: string; /** * @desc 表格行展开背景色 * @descEN Background color of table expanded row */ rowExpandedBg: string; /** * @desc 单元格纵向内间距 * @descEN Vertical padding of table cell */ cellPaddingBlock: number; /** * @desc 单元格横向内间距（默认大尺寸） * @descEN Horizontal padding of table cell (large size by default) */ cellPaddingInline: number; /** * @desc 单元格纵向内间距（中等尺寸） * @descEN Vertical padding of table cell (middle size) */ cellPaddingBlockMD: number; /** * @desc 单元格横向内间距（中等尺寸） * @descEN Horizontal padding of table cell (middle size) */ cellPaddingInlineMD: number; /** * @desc 单元格纵向内间距（小尺寸） * @descEN Vertical padding of table cell (small size) */ cellPaddingBlockSM: number; /** * @desc 单元格横向内间距（小尺寸） * @descEN Horizontal padding of table cell (small size) */ cellPaddingInlineSM: number; /** * @desc 表格边框/分割线颜色 * @descEN Border color of table */ borderColor: string; /** * @desc 表头圆角 * @descEN Border radius of table header */ headerBorderRadius: number; /** * @desc 表格底部背景色 * @descEN Background of footer */ footerBg: string; /** * @desc 表格底部文字颜色 * @descEN Color of footer text */ footerColor: string; /** * @desc 单元格文字大小（默认大尺寸） * @descEN Font size of table cell (large size by default) */ cellFontSize: number; /** * @desc 单元格文字大小（中等尺寸） * @descEN Font size of table cell (middle size) */ cellFontSizeMD: number; /** * @desc 单元格文字大小（小尺寸） * @descEN Font size of table cell (small size) */ cellFontSizeSM: number; /** * @desc 表头分割线颜色 * @descEN Split border color of table header */ headerSplitColor: string; /** * @desc 固定表头排序激活态背景色 * @descEN Background color of fixed table header when sorted */ fixedHeaderSortActiveBg: string; /** * @desc 表头过滤按钮悬浮背景色 * @descEN Background color of table header filter button when hovered */ headerFilterHoverBg: string; /** * @desc 过滤下拉菜单选项背景 * @descEN Background of filter dropdown menu item */ filterDropdownMenuBg: string; /** * @desc 过滤下拉菜单颜色 * @descEN Color of filter dropdown */ filterDropdownBg: string; /** * @desc 展开按钮背景色 * @descEN Background of expand button */ expandIconBg: string; /** * @desc 选择列宽度 * @descEN Width of selection column */ selectionColumnWidth: number | string; /** * @desc Sticky 模式下滚动条背景色 * @descEN Background of sticky scrollbar */ stickyScrollBarBg: string; /** * @desc Sticky 模式下滚动条圆角 * @descEN Border radius of sticky scrollbar */ stickyScrollBarBorderRadius: number; /** @internal */ expandIconMarginTop: number; /** @internal */ expandIconHalfInner: number; /** @internal */ expandIconSize: number; /** @internal */ expandIconScale: number; /** @internal */ headerIconColor: string; /** @internal */ headerIconHoverColor: string; } export interface TableToken extends FullToken<'Table'> { tableFontSize: number; tableBg: string; tableRadius: number; tablePaddingHorizontal: number; tablePaddingVertical: number; tablePaddingHorizontalMiddle: number; tablePaddingVerticalMiddle: number; tablePaddingHorizontalSmall: number; tablePaddingVerticalSmall: number; tableBorderColor: string; tableHeaderTextColor: string; tableHeaderBg: string; tableFooterTextColor: string; tableFooterBg: string; tableHeaderCellSplitColor: string; tableHeaderSortBg: string; tableHeaderSortHoverBg: string; tableBodySortBg: string; tableFixedHeaderSortActiveBg: string; tableHeaderFilterActiveBg: string; tableFilterDropdownBg: string; tableFilterDropdownHeight: number | string; tableRowHoverBg: string; tableSelectedRowBg: string; tableSelectedRowHoverBg: string; tableFontSizeMiddle: number; tableFontSizeSmall: number; tableSelectionColumnWidth: number | string; tableExpandIconBg: string; tableExpandColumnWidth: number | string; tableExpandedRowBg: string; tableFilterDropdownWidth: number; tableFilterDropdownSearchWidth: number; // Z-Index zIndexTableFixed: number; // Virtual Scroll Bar tableScrollThumbSize: number; tableScrollThumbBg: string; tableScrollThumbBgHover: string; tableScrollBg: string; } ``` ## 注意 {#note} 按照 [React 的规范](https://zh-hans.react.dev/learn/rendering-lists#keeping-list-items-in-order-with-key)，所有的列表必须绑定 `key`。在 Table 中，`dataSource` 和 `columns` 里的数据值都需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。 ![控制台警告](https://os.alipayobjects.com/rmsportal/luLdLvhPOiRpyss.png) 如果 `dataSource[i].key` 没有提供，你应该使用 `rowKey` 来指定 `dataSource` 的主键，如下所示。若没有指定，控制台会出现以上的提示，表格组件也会出现各类奇怪的错误。 ```jsx // 比如你的数据主键是 uid return ; // 或 return
record.uid} />; ``` ## FAQ ### 如何在没有数据或只有一页数据时隐藏分页栏 {#faq-hide-pagination} 你可以设置 `pagination` 的 `hideOnSinglePage` 属性为 `true`。 ### 表格过滤时会回到第一页？ {#faq-filter-to-first-page} 前端过滤时通常条目总数会减少，从而导致总页数小于筛选前的当前页数，为了防止当前页面没有数据，我们默认会返回第一页。 如果你在使用远程分页，很可能需要保持当前页面，你可以参照这个 [受控例子](https://codesandbox.io/s/yuanchengjiazaishuju-ant-design-demo-7y2uf) 控制当前页面不变。 ### 表格分页为何会出现 size 切换器？ {#faq-size-changer} 自 `4.1.0` 起，Pagination 在 `total` 大于 50 条时会默认显示 size 切换器以提升用户交互体验。如果你不需要该功能，可以通过设置 `showSizeChanger` 为 `false` 来关闭。 ### 为什么 更新 state 会导致全表渲染？ {#faq-state-update-rerender} 由于 `columns` 支持 `render` 方法，因而 Table 无法知道哪些单元会受到影响。你可以通过 `column.shouldCellUpdate` 来控制单元格的渲染。 ### 如何排查 Table 性能问题？ {#faq-table-performance} React DevTools 在分析复杂表格时可能带来额外开销，尤其是行列数量较多的场景。若你遇到明显卡顿，建议先关闭 React DevTools，或在干净的浏览器环境中重新测试。如果在正常运行环境下仍能稳定复现性能问题，欢迎提供最小复现以便我们继续排查。 ### 固定列穿透到最上层该怎么办？ {#faq-fixed-column-zindex} 固定列通过 `z-index` 属性将其悬浮于非固定列之上，这使得有时候你会发现在 Table 上放置遮罩层时固定列会被透过的情况。为遮罩层设置更高的 `z-index` 覆盖住固定列即可。 ### 如何自定义渲染可选列的勾选框（比如增加 Tooltip）？ {#faq-custom-checkbox-render} 自 `4.1.0` 起，可以通过 [rowSelection](https://ant.design/components/table-cn/#rowselection) 的 `renderCell` 属性控制，可以参考此处 [Demo](https://codesandbox.io/s/table-row-tooltip-v79j2v) 实现展示 Tooltip 需求或其他自定义的需求。 ### 为什么 components.body.wrapper 或 components.body.row 在 virtual 开启时会报错？ {#faq-virtual-wrapper-ref} 因为虚拟表格需要获取其 ref 做一些计算，所以你需要使用 `React.forwardRef` 包裹并传递 ref 到 dom。如以下代码： ```tsx const EditableRow = React.forwardRef( ({ index, ...props }, ref) => { const [form] = Form.useForm(); return (
); }, ); ``` 对于固定行高纵向滚动的场景，可以使用以下方法： ```tsx
``` ## 原生通用属性 {#jguang-common-props} > Tips: 以下通用属性适用于 antd 大部分组件，不支持的组件会单独说明。 | 参数 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | style | 自定义样式 | CSSProperties | - | | className | 自定义类名 | string | - | | rootClassName | 添加在组件最外层的 className | string | - | | autoFocus | 自动获取焦点，仅对表单类、链接、交互容器等可聚焦元素生效 | boolean | false | ## 安装并复现示例 ```bash npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23 ``` 使用 ConfigProvider 和原生 App，并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示，不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。 ## 原生类型参考 源码查看器包含未修改的原生实现和以下声明文件，继承类型仍位于原生包中。代码中的英文注释保留为源码参考。 - `vendor/components/table/Column.ts` - `vendor/components/table/ColumnGroup.ts` - `vendor/components/table/ExpandIcon.tsx` - `vendor/components/table/InternalTable.tsx` - `vendor/components/table/hooks/useFilter/FilterDropdown.tsx` - `vendor/components/table/hooks/useFilter/FilterSearch.tsx` - `vendor/components/table/hooks/useFilter/FilterWrapper.tsx` - `vendor/components/table/hooks/useFilter/index.tsx` - `vendor/components/table/hooks/useLazyKVMap.ts` - `vendor/components/table/hooks/useSelection.tsx` - `vendor/components/table/hooks/useSorter.tsx` - `vendor/components/table/interface.ts` - `vendor/components/table/style/index.ts` ## 来源与许可 https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd 保留原生中英文正文与可执行示例；官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可，另列依赖的许可证也需保留。上传预览禁止向外发起请求，不提供后端服务。 --- JGuang 全部资源索引: https://jiguang132.com/llms.txt