ant-design/components/table/index.zh-CN.md

240 lines
10 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
cols: 1
type: 数据展示
2016-08-15 07:54:01 +08:00
title: Table
2016-09-08 16:53:50 +08:00
subtitle: 表格
2016-03-31 14:17:09 +08:00
---
2015-06-15 22:01:39 +08:00
2015-06-26 14:42:30 +08:00
展示行列数据。
2015-06-17 20:24:42 +08:00
2018-08-31 17:03:27 +08:00
## 设计师专属
2018-08-28 17:14:04 +08:00
2018-08-31 17:03:27 +08:00
安装 [Kitchen Sketch 插件 💎](https://kitchen.alipay.com/),两步就可以自动生成 Ant Design 表格组件。
2018-08-28 17:14:04 +08:00
2015-06-26 14:42:30 +08:00
## 何时使用
2015-06-17 20:24:42 +08:00
2015-06-26 14:42:30 +08:00
- 当有大量结构化的数据需要展现时;
- 当需要对数据进行排序、搜索、分页、自定义操作等复杂行为时。
2015-07-10 10:34:54 +08:00
2015-07-16 18:26:17 +08:00
## 如何使用
2015-07-10 10:34:54 +08:00
2015-12-09 21:49:32 +08:00
指定表格的数据源 `dataSource` 为一个数组。
```jsx
2015-12-09 21:49:32 +08:00
const dataSource = [{
2015-08-28 15:22:09 +08:00
key: '1',
name: '胡彦斌',
age: 32,
address: '西湖区湖底公园1号'
}, {
2015-08-28 15:22:09 +08:00
key: '2',
name: '胡彦祖',
age: 42,
address: '西湖区湖底公园1号'
}];
2015-12-09 21:49:32 +08:00
const columns = [{
title: '姓名',
2015-12-16 16:35:56 +08:00
dataIndex: 'name',
key: 'name',
2015-12-09 21:49:32 +08:00
}, {
title: '年龄',
2015-12-16 16:35:56 +08:00
dataIndex: 'age',
key: 'age',
2015-12-09 21:49:32 +08:00
}, {
title: '住址',
2015-12-16 16:35:56 +08:00
dataIndex: 'address',
key: 'address',
2015-12-09 21:49:32 +08:00
}];
2015-12-09 21:49:32 +08:00
<Table dataSource={dataSource} columns={columns} />
```
2015-07-16 18:26:17 +08:00
## API
2015-07-10 10:34:54 +08:00
### Table
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| bordered | 是否展示外边框和列边框 | boolean | false |
| childrenColumnName | 指定树形结构的列名 | string\[] | children |
2017-10-25 10:25:44 +08:00
| columns | 表格列的配置描述,具体项见下表 | [ColumnProps](https://git.io/vMMXC)\[] | - |
| components | 覆盖默认的 table 元素 | [TableComponents](https://git.io/fANxz) | - |
2017-10-25 10:25:44 +08:00
| dataSource | 数据数组 | any\[] | |
| defaultExpandAllRows | 初始时,是否展开所有行 | boolean | false |
2017-10-25 10:25:44 +08:00
| defaultExpandedRowKeys | 默认展开的行 | string\[] | - |
| expandedRowKeys | 展开的行,控制属性 | string\[] | - |
| expandedRowRender | 额外的展开行 | Function(record, index, indent, expanded):ReactNode | - |
2018-12-18 23:31:50 +08:00
| expandIcon | 自定义展开图标,参考[示例](http://react-component.github.io/table/examples/expandIcon.html) | Function(props):ReactNode | - |
2017-12-07 15:14:41 +08:00
| expandRowByClick | 通过点击行来展开子行 | boolean | `false` |
2017-10-25 10:25:44 +08:00
| footer | 表格尾部 | Function(currentPageData) | |
| indentSize | 展示树形数据时,每层缩进的宽度,以 px 为单位 | number | 15 |
| 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: '确定' <br> filterReset: '重置' <br> emptyText: '暂无数据' <br> [默认值](https://github.com/ant-design/ant-design/issues/575#issuecomment-159169511) |
| pagination | 分页器,参考[配置项](#pagination)或 [pagination](/components/pagination/),设为 false 时不展示和进行分页 | object | |
2017-10-25 10:25:44 +08:00
| rowClassName | 表格行的类名 | Function(record, index):string | - |
| rowKey | 表格行 key 的取值,可以是字符串或一个函数 | string\|Function(record):string | 'key' |
| rowSelection | 表格行是否可选择,[配置项](#rowSelection) | object | null |
| scroll | 设置横向或纵向滚动,也可用于指定滚动区域的宽和高,建议为 `x` 设置一个数字,如果要设置为 `true`,需要配合样式 `.ant-table td { white-space: nowrap; }` | { x: number \| true, y: number } | - |
2017-10-25 10:25:44 +08:00
| showHeader | 是否显示表头 | boolean | true |
| size | 正常或迷你类型,`default` or `small` | string | default |
| title | 表格标题 | Function(currentPageData) | |
| onChange | 分页、排序、筛选变化时触发 | Function(pagination, filters, sorter, extra: { currentDataSource: [] }) | |
2017-10-25 10:25:44 +08:00
| onExpand | 点击展开图标时触发 | Function(expanded, record) | |
| onExpandedRowsChange | 展开的行变化时触发 | Function(expandedRows) | |
2018-01-20 12:46:30 +08:00
| onHeaderRow | 设置头部行属性 | Function(column, index) | - |
| onRow | 设置行属性 | Function(record, index) | - |
2016-03-24 17:47:08 +08:00
2018-02-08 14:25:49 +08:00
#### onRow 用法
适用于 `onRow` `onHeaderRow` `onCell` `onHeaderCell`
2018-02-08 14:14:46 +08:00
```jsx
<Table
2018-02-16 15:19:12 +08:00
onRow={(record) => {
2018-02-08 14:14:46 +08:00
return {
onClick: (event) => {}, // 点击行
onDoubleClick: (event) => {},
onContextMenu: (event) => {},
onMouseEnter: (event) => {}, // 鼠标移入行
onMouseLeave: (event) => {}
2018-02-08 14:14:46 +08:00
};
2018-03-22 14:54:46 +08:00
}}
2018-02-08 14:14:46 +08:00
onHeaderRow={(column) => {
return {
2018-02-08 14:25:49 +08:00
onClick: () => {}, // 点击表头行
2018-02-08 14:14:46 +08:00
};
2018-03-22 14:54:46 +08:00
}}
2018-02-08 14:14:46 +08:00
/>
```
2015-07-14 20:58:54 +08:00
### Column
列描述数据对象,是 columns 中的一项Column 使用相同的 API。
2015-07-14 20:58:54 +08:00
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
2018-06-24 17:09:18 +08:00
| align | 设置列内容的对齐方式 | 'left' \| 'right' \| 'center' | 'left' |
2017-10-25 10:25:44 +08:00
| className | 列的 className | string | - |
| colSpan | 表头列合并,设置为 0 时,不渲染 | number | |
2018-11-03 03:28:47 +08:00
| dataIndex | 列数据在数据项中对应的 key支持 `a.b.c`、`a[0].b.c[1]` 的嵌套写法 | string | - |
| defaultSortOrder | 默认排序顺序 | 'ascend' \| 'descend' | - |
| filterDropdown | 可以自定义筛选菜单,此函数只负责渲染图层,需要自行编写各种交互 | ReactNode | - |
| filterDropdownVisible | 用于控制自定义筛选菜单是否可见 | boolean | - |
| filtered | 标识数据是否经过过滤,筛选图标会高亮 | boolean | false |
2017-10-25 10:25:44 +08:00
| filteredValue | 筛选的受控属性,外界可用此控制列的筛选状态,值为已筛选的 value 数组 | string\[] | - |
2018-07-02 18:34:17 +08:00
| filterIcon | 自定义 filter 图标。 | ReactNode\|(filtered: boolean) => ReactNode | false |
2017-10-25 10:25:44 +08:00
| filterMultiple | 是否多选 | boolean | true |
| filters | 表头的筛选菜单项 | object\[] | - |
| fixed | 列是否固定,可选 `true`(等效于 left) `'left'` `'right'` | boolean\|string | false |
| key | React 需要的 key如果已经设置了唯一的 `dataIndex`,可以忽略这个属性 | string | - |
| render | 生成复杂数据的渲染函数,参数分别为当前行的值,当前行数据,行索引,@return里面可以设置表格[行/列合并](#components-table-demo-colspan-rowspan) | Function(text, record, index) {} | - |
| sorter | 排序函数,本地排序使用一个函数(参考 [Array.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 的 compareFunction),需要服务端排序可设为 true | Function\|boolean | - |
| sortOrder | 排序的受控属性,外界可用此控制列的排序,可设置为 `'ascend'` `'descend'` `false` | boolean\|string | - |
| title | 列头显示文字 | ReactNode\|({ sortOrder, filters }) => ReactNode | - |
2017-10-25 10:25:44 +08:00
| width | 列宽度 | string\|number | - |
2018-10-15 14:02:04 +08:00
| onCell | 设置单元格属性 | Function(record, rowIndex) | - |
2017-10-25 10:25:44 +08:00
| onFilter | 本地模式下,确定筛选的运行函数 | Function | - |
| onFilterDropdownVisibleChange | 自定义筛选菜单可见变化时调用 | function(visible) {} | - |
| onHeaderCell | 设置头部单元格属性 | Function(column) | - |
2015-07-14 20:58:54 +08:00
### ColumnGroup
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| title | 列头显示文字 | string\|ReactNode | - |
### pagination
分页的配置项。
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| position | 指定分页显示的位置 | 'top' \| 'bottom' \| 'both' | 'bottom' |
更多配置项,请查看 [`Pagination`](/components/pagination/)。
2016-01-01 20:18:38 +08:00
### rowSelection
选择功能的配置。
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
2018-06-24 17:09:18 +08:00
| columnWidth | 自定义列表选择框宽度 | string\|number | - |
| columnTitle | 自定义列表选择框标题 | string\|React.ReactNode | - |
| fixed | 把选择框列固定在左边 | boolean | - |
2017-12-29 20:22:58 +08:00
| getCheckboxProps | 选择框的默认属性配置 | Function(record) | - |
| hideDefaultSelections | 去掉『全选』『反选』两个默认选项 | boolean | false |
2017-10-25 10:25:44 +08:00
| selectedRowKeys | 指定选中项的 key 数组,需要和 onChange 进行配合 | string\[] | \[] |
| selections | 自定义选择项 [配置项](#selection), 设为 `true` 时使用默认选择项 | object\[]\|boolean | true |
| type | 多选/单选,`checkbox` or `radio` | string | `checkbox` |
| onChange | 选中项发生变化时的回调 | Function(selectedRowKeys, selectedRows) | - |
| onSelect | 用户手动选择/取消选择某行的回调 | Function(record, selected, selectedRows, nativeEvent) | - |
| onSelectAll | 用户手动选择/取消选择所有行的回调 | Function(selected, selectedRows, changeRows) | - |
2017-10-25 10:25:44 +08:00
| onSelectInvert | 用户手动选择反选的回调 | Function(selectedRows) | - |
### selection
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| key | React 需要的 key建议设置 | string | - |
| text | 选择项显示的文字 | string\|React.ReactNode | - |
| onSelect | 选择项点击回调 | Function(changeableRowKeys) | - |
2016-01-01 20:18:38 +08:00
## 在 TypeScript 中使用
```tsx
import { Table } from 'antd';
import { ColumnProps } from 'antd/lib/table';
interface IUser {
key: number;
name: string;
}
const columns: ColumnProps<IUser>[] = [{
key: 'name',
title: 'Name',
dataIndex: 'name',
}];
const data: IUser[] = [{
key: 0,
name: 'Jack',
}];
class UserTable extends Table<IUser> {}
<UserTable columns={columns} dataSource={data} />
// 使用 JSX 风格的 API
class NameColumn extends Table.Column<IUser> {}
<UserTable dataSource={data}>
<NameColumn key="name" title="Name" dataIndex="name" />
</UserTable>
// TypeScript 2.9 之后也可以这样写
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#generic-type-arguments-in-jsx-elements
<Table<IUser> columns={columns} dataSource={data} />
2018-11-09 18:33:39 +08:00
<Table<IUser> dataSource={data}>
<Table.Column<IUser> key="name" title="Name" dataIndex="name" />
</Table>
```
2015-11-27 14:54:25 +08:00
## 注意
2017-02-19 17:02:58 +08:00
按照 [React 的规范](https://facebook.github.io/react/docs/lists-and-keys.html#keys),所有的组件数组必须绑定 key。在 Table 中,`dataSource` 和 `columns` 里的数据值都需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。
2015-11-27 15:08:56 +08:00
如果你的数据没有这个属性,务必使用 `rowKey` 来指定数据列的主键。若没有指定,控制台会出现以下的提示,表格组件也会出现各类奇怪的错误。
2018-05-21 23:42:57 +08:00
![控制台警告](https://os.alipayobjects.com/rmsportal/luLdLvhPOiRpyss.png)
2015-11-27 14:54:25 +08:00
```jsx
2016-03-03 15:32:16 +08:00
// 比如你的数据主键是 uid
2016-06-21 19:27:54 +08:00
return <Table rowKey="uid" />;
// 或
2016-03-03 15:32:16 +08:00
return <Table rowKey={record => record.uid} />;
2015-11-27 14:54:25 +08:00
```