--- category: Components cols: 1 type: Data Display title: Table subtitle: 表格 --- 展示行列数据。 ## 何时使用 - 当有大量结构化的数据需要展现时; - 当需要对数据进行排序、搜索、分页、自定义操作等复杂行为时。 ## 如何使用 指定表格的数据源 `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', }]; ``` ## API ### Table | 参数 | 说明 | 类型 | 默认值 | |---------------|--------------------------|-----------------|---------| | rowSelection | 列表项是否可选择,[配置项](#rowSelection) | object | null | | pagination | 分页器,配置项参考 [pagination](/components/pagination/),设为 false 时不展示和进行分页 | object | | | size | 正常或迷你类型,`default` or `small` | string | default | | dataSource | 数据数组 | any[] | | | columns | 表格列的配置描述,具体项见下表 | [ColumnProps](https://git.io/vMMXC)[] | - | | rowKey | 表格行 key 的取值,可以是字符串或一个函数 | string\|Function(record):string | 'key' | | rowClassName | 表格行的类名 | Function(record, index):string | - | | expandedRowRender | 额外的展开行 | Function(record):ReactNode | - | | defaultExpandedRowKeys | 默认展开的行 | string[] | - | | expandedRowKeys | 展开的行,控制属性 | string[] | - | | defaultExpandAllRows | 初始时,是否展开所有行 | boolean | false | | onExpandedRowsChange | 展开的行变化时触发 | Function(expandedRows) | | | onExpand | 点击展开图标时触发 | Function(expanded, record) | | | onChange | 分页、排序、筛选变化时触发 | Function(pagination, filters, sorter) | | | loading | 页面是否加载中 | boolean\|[object](https://ant.design/components/spin-cn/#API) ([更多](https://github.com/ant-design/ant-design/issues/4544#issuecomment-271533135)) | false | | locale | 默认文案设置,目前包括排序、过滤、空数据文案 | object | filterConfirm: '确定'
filterReset: '重置'
emptyText: '暂无数据'
[默认值](https://github.com/ant-design/ant-design/issues/575#issuecomment-159169511) | | indentSize | 展示树形数据时,每层缩进的宽度,以 px 为单位 | number | 15 | | onRowClick | 点击行时触发 | Function(record, index, event) | - | | onRowDoubleClick| 双击行时触发 | Function(record, index, event) | - | | onRowMouseEnter | 鼠标移入行时触发 | Function(record, index, event) | - | | onRowMouseLeave | 鼠标移出行时触发 | Function(record, index, event) | - | | bordered | 是否展示外边框和列边框 | boolean | false | | showHeader | 是否显示表头 | boolean | true | | footer | 表格尾部 | Function(currentPageData) | | | title | 表格标题 | Function(currentPageData) | | | scroll | 横向或纵向支持滚动,也可用于指定滚动区域的宽高度:`{{ x: true, y: 300 }}` | object | - | ### Column 列描述数据对象,是 columns 中的一项,Column 使用相同的 API。 | 参数 | 说明 | 类型 | 默认值 | |-----------|----------------------------|-----------------|---------| | title | 列头显示文字 | string\|ReactNode | - | | key | React 需要的 key,如果已经设置了唯一的 `dataIndex`,可以忽略这个属性 | string | - | | dataIndex | 列数据在数据项中对应的 key,支持 `a.b.c` 的嵌套写法 | string | - | | render | 生成复杂数据的渲染函数,参数分别为当前行的值,当前行数据,行索引,@return里面可以设置表格[行/列合并](#components-table-demo-colspan-rowspan) | Function(text, record, index) {} | - | | filters | 表头的筛选菜单项 | object[] | - | | onFilter | 本地模式下,确定筛选的运行函数 | Function | - | | filterMultiple | 是否多选 | boolean | true | | filterDropdown | 可以自定义筛选菜单,此函数只负责渲染图层,需要自行编写各种交互 | ReactNode | - | | filterDropdownVisible | 用于控制自定义筛选菜单是否可见 | boolean | - | | onFilterDropdownVisibleChange | 自定义筛选菜单可见变化时调用 | function(visible) {} | - | | filteredValue | 筛选的受控属性,外界可用此控制列的筛选状态,值为已筛选的 value 数组 | string[] | - | | filtered | 标识数据是否经过过滤,筛选图标会高亮 | boolean | false | | filterIcon | 自定义 fiter 图标。| ReactNode | false | | sorter | 排序函数,本地排序使用一个函数(参考 [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 的 compareFunction),需要服务端排序可设为 true | Function\|boolean | - | | colSpan | 表头列合并,设置为 0 时,不渲染 | number | | | width | 列宽度 | string\|number | - | | className | 列的 className | string | - | | fixed | 列是否固定,可选 `true`(等效于 left) `'left'` `'right'` | boolean\|string | false | | sortOrder | 排序的受控属性,外界可用此控制列的排序,可设置为 `'ascend'` `'descend'` `false` | boolean\|string | - | | onCellClick | 单元格点击回调 | Function(record, event) | - | ### ColumnGroup | 参数 | 说明 | 类型 | 默认值 | |-----------|----------------------------|-----------------|---------| | title | 列头显示文字 | string\|ReactNode | - | ### rowSelection 选择功能的配置。 | 参数 | 说明 | 类型 | 默认值 | |------------------|--------------------------|-----------------|---------------------| | type | 多选/单选,`checkbox` or `radio` | string | `checkbox` | | selectedRowKeys | 指定选中项的 key 数组,需要和 onChange 进行配合 | string[] | [] | | onChange | 选中项发生变化的时的回调 | Function(selectedRowKeys, selectedRows) | - | | getCheckboxProps | 选择框的默认属性配置 | Function(record) | - | | onSelect | 用户手动选择/取消选择某列的回调 | Function(record, selected, selectedRows) | - | | onSelectAll | 用户手动选择/取消选择所有列的回调 | Function(selected, selectedRows, changeRows) | - | | onSelectInvert | 用户手动选择反选的回调 | Function(selectedRows) | - | | selections | 自定义选择项 [配置项](#selection), 设为 `true` 时使用默认选择项 | object[]\|boolean | true | | hideDefaultSelections | 去掉『全选』『反选』两个默认选项 | boolean | false | ### selection | 参数 | 说明 | 类型 | 默认值 | |------------------|--------------------------|-----------------|---------------------| | key | React 需要的 key,建议设置 | string | - | | text | 选择项显示的文字 | string\|React.ReactNode | - | | onSelect | 选择项点击回调 | Function(changeableRowKeys) | - | ## 在 TypeScript 中使用 ```jsx import { Table } from 'antd'; import { TableColumnConfig } from 'antd/lib/table/Table'; interface IUser { key: number; name: string; } const columns: TableColumnConfig[] = [{ key: 'name', title: 'Name', dataIndex: 'name', }]; const data: IUser[] = [{ key: 0, name: 'Jack', }]; class UserTable extends Table {} // 使用 JSX 风格的 API class NameColumn extends Table.Column {} ``` ## 注意 按照 [React 的规范](https://facebook.github.io/react/docs/lists-and-keys.html#keys),所有的组件数组必须绑定 key。在 Table 中,`dataSource` 和 `columns` 里的数据值都需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。 如果你的数据没有这个属性,务必使用 `rowKey` 来指定数据列的主键。若没有指定,控制台会出现以下的提示,表格组件也会出现各类奇怪的错误。 ![](https://os.alipayobjects.com/rmsportal/luLdLvhPOiRpyss.png) ```jsx // 比如你的数据主键是 uid return
; // 或 return
record.uid} />; ```