Table 表格

何时使用

当有大量结构化的数据需要展现时；
当需要对数据进行排序、搜索、分页、自定义操作等复杂行为时。

如何使用

代码演示

基本用法

JSX 风格的 API

可选择

选择和操作

自定义选择项

筛选和排序

树型筛选菜单

自定义筛选的搜索

多列排序

可控的筛选和排序

自定义筛选菜单

远程加载数据

紧凑型

带边框

可展开

特殊列排序

表格行/列合并

树形数据展示

固定表头

固定列

堆叠固定列

固定头和列

隐藏列

表头分组

测试debug

API

Table

参数	说明	类型	默认值	版本
bordered	是否展示外边框和列边框	boolean	false
classNames	用于自定义组件内部各语义化结构的 class，支持对象或函数	Record<[SemanticDOM], string> \| (info: { props })=> Record<[SemanticDOM], string>	-
columns	表格列的配置描述，具体项见下表	ColumnsType[]	-
components	覆盖默认的 table 元素	TableComponents	-
dataSource	数据数组	object[]	-
expandable	配置展开属性	expandable	-
footer	表格尾部	function(currentPageData)	-
getPopupContainer	设置表格内各类浮层的渲染节点，如筛选菜单	(triggerNode) => HTMLElement	() => TableHtmlElement
loading	页面是否加载中	boolean \| Spin Props	false
locale	默认文案设置，目前包括排序、过滤、空数据文案	object	默认值
pagination	分页器，参考配置项或 pagination 文档，设为 false 时不展示和进行分页	object \| `false`	-
rowClassName	表格行的类名	function(record, index): string	-
rowKey	表格行 key 的取值，可以是字符串或一个函数	string \| function(record): string	`key`
rowSelection	表格行是否可选择，配置项	object	-
rowHoverable	表格行是否开启 hover 交互	boolean	true	5.16.0
scroll	表格是否可滚动，也可以指定滚动区域的宽、高，配置项	object	-
showHeader	是否显示表头	boolean	true
showSorterTooltip	表头是否显示下一次排序的 tooltip 提示。当参数类型为对象时，将被设置为 Tooltip 的属性	boolean \| Tooltip props & `{target?: 'full-header' \| 'sorter-icon' }`	`{ target: 'full-header' }`	5.16.0
size	表格大小	`large` \| `middle` \| `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], CSSProperties> \| (info: { props })=> Record<[SemanticDOM], CSSProperties>	-
summary	总结栏	(currentData) => VNode	-
tableLayout	表格元素的 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` 无效	`(config: { index?: number, key?: VueKey, top?: number, offset?: number }) => void`	5.11.0

onRow 用法

适用于 onRow onHeaderRow onCell onHeaderCell。

jsx

<Table
  onRow={(record) => {
    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	可以自定义筛选菜单，此函数只负责渲染图层，需要自行编写各种交互	VNode \| (props: FilterDropdownProps) => VNode	-
filtered	标识数据是否经过过滤，筛选图标会高亮	boolean	false
filteredValue	筛选的受控属性，外界可用此控制列的筛选状态，值为已筛选的 value 数组	string[]	-
filterIcon	自定义 filter 图标。	VNode \| (filtered: boolean) => VNode	false
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	-	5.22.0
fixed	（IE 下无效）列是否固定，可选 `true` (等效于 `'start'`) `'start'` `'end'`	boolean \| string	false
key	需要的 key，如果已经设置了唯一的 `dataIndex`，可以忽略这个属性	string	-
render	生成复杂数据的渲染函数，参数分别为当前单元格的值，当前行数据，行索引	(value: V, record: T, index: number): VNode	-
responsive	响应式 breakpoint 配置列表。未设置则始终可见。	Breakpoint[]	-	4.2.0
rowScope	设置列范围	`row` \| `rowgroup`	-	5.1.0
shouldCellUpdate	自定义单元格渲染时机	(record, prevRecord) => boolean	-	4.3.0
showSorterTooltip	表头显示下一次排序的 tooltip 提示, 覆盖 table 中 `showSorterTooltip`	boolean \| Tooltip props & `{target?: 'full-header' \| 'sorter-icon' }`	`{ target: 'full-header' }`	5.16.0
sortDirections	支持的排序方式，覆盖 `Table` 中 `sortDirections`，取值为 `ascend` `descend`	Array	[`ascend`, `descend`]
sorter	排序函数，本地排序使用一个函数(参考 Array.sort 的 compareFunction)。需要服务端排序可设为 `true`（单列排序）或 `{ multiple: number }`（多列排序）	function \| boolean \| `{ compare: function, multiple: number }`	-
sortOrder	排序的受控属性，外界可用此控制列的排序，可设置为 `ascend` `descend` `null`	`ascend` \| `descend` \| null	-
sortIcon	自定义 sort 图标	(props: { sortOrder }) => VNode	-	5.6.0
title	列头显示文字（函数用法 `3.10.0` 后支持）	VNode \| ({ sortColumns, filters }) => VNode	-
width	列宽度（指定了也不生效？）	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	列头显示文字	VNode	-

pagination

分页的配置项。

参数	说明	类型	默认值
placement	指定分页显示的位置，取值为`topStart` \| `topCenter` \| `topEnd` \|`bottomStart` \| `bottomCenter` \| `bottomEnd`\| `none`	Array	[`bottomEnd`]
~~position~~	指定分页显示的位置，取值为`topLeft` \| `topCenter` \| `topRight` \|`bottomLeft` \| `bottomCenter` \| `bottomRight` \| `none`，请使用 `placement` 替换	Array	[`bottomRight`]

更多配置项，请查看 Pagination。

expandable

展开功能的配置。

参数	说明	类型	默认值	版本
childrenColumnName	指定树形结构的列名	string	children
columnTitle	自定义展开列表头	VNode	-	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): VNode	-
expandIcon	自定义展开图标，参考示例	function(props): VNode	-
expandRowByClick	通过点击行来展开子行	boolean	false
fixed	控制展开图标是否固定，可选 `true` `'left'` `'right'`	boolean \| string	false	4.16.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	自定义列表选择框标题	VNode \| (originalNode: VNode) => VNode	-
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: VNode): VNode	-	4.1.0
selectedRowKeys	指定选中项的 key 数组，需要和 onChange 进行配合	string[] \| number[]	[]
defaultSelectedRowKeys	默认选中项的 key 数组	string[] \| number[]	[]
selections	自定义选择项配置项, 设为 `true` 时使用默认选择项	object[] \| boolean	true
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'	string \| number \| true	-
y	设置纵向滚动，也可用于指定滚动区域的高，可以设置为像素值	string \| number	-

selection

参数	说明	类型	默认值
key	需要的 key，建议设置	string	-
text	选择项显示的文字	VNode	-
onSelect	选择项点击回调	function(changeableRowKeys)	-

Table 表格 ​

何时使用 ​

如何使用 ​

代码演示 ​

基本用法 ​

JSX 风格的 API ​

可选择 ​

选择和操作 ​

自定义选择项 ​

筛选和排序 ​

树型筛选菜单 ​

自定义筛选的搜索 ​

多列排序 ​

可控的筛选和排序 ​

自定义筛选菜单 ​

远程加载数据 ​

紧凑型 ​

带边框 ​

可展开 ​

特殊列排序 ​

表格行/列合并 ​

树形数据展示 ​

固定表头 ​

固定列 ​

堆叠固定列 ​

固定头和列 ​

隐藏列 ​

表头分组 ​

测试debug ​

API ​

Table ​

Table ref ​

onRow 用法 ​

Column ​

ColumnGroup ​

pagination ​

expandable ​

rowSelection ​

scroll ​

selection ​

Table 表格

何时使用

如何使用

代码演示

基本用法

JSX 风格的 API

可选择

选择和操作

自定义选择项

筛选和排序

树型筛选菜单

自定义筛选的搜索

多列排序

可控的筛选和排序

自定义筛选菜单

远程加载数据

紧凑型

带边框

可展开

特殊列排序

表格行/列合并

树形数据展示

固定表头

固定列

堆叠固定列

固定头和列

隐藏列

表头分组

测试debug

API

Table

Table ref

onRow 用法

Column

ColumnGroup

pagination

expandable

rowSelection

scroll

selection