ant-design/components/table/index.en-US.md

category	cols	type	title
Components	1	Data Display	Table

A table displays rows of data.

When To Use

• To display a collection of structured data.
• To sort, search, paginate, filter data.

How To Use

Specify dataSource of Table as an array of data.

const dataSource = [
  {
    key: '1',
    name: 'Mike',
    age: 32,
    address: '10 Downing Street',
  },
  {
    key: '2',
    name: 'John',
    age: 42,
    address: '10 Downing Street',
  },
];

const columns = [
  {
    title: 'Name',
    dataIndex: 'name',
    key: 'name',
  },
  {
    title: 'Age',
    dataIndex: 'age',
    key: 'age',
  },
  {
    title: 'Address',
    dataIndex: 'address',
    key: 'address',
  },
];

<Table dataSource={dataSource} columns={columns} />;

API

Table

Property	Description	Type	Default
tableLayout	table-layout attribute of table element	- | 'auto' | 'fixed'	- fixed when header/columns are fixed, or using column.ellipsis
bordered	Whether to show all table borders	boolean	false
columns	Columns of table	ColumnProps[]	-
components	Override default table elements	TableComponents	-
dataSource	Data record array to be displayed	any[]	-
expandable	Config expandable content	expandable	-
footer	Table footer renderer	Function(currentPageData)	-
loading	Loading status of table	boolean|object (more)	false
locale	i18n text including filter, sort, empty text, etc	object	filterConfirm: 'Ok' filterReset: 'Reset' emptyText: 'No Data' Default
pagination	Config of pagination. You can ref table pagination config or full pagination document, hide it by setting it to false	object	-
rowClassName	Row's className	Function(record, index):string	-
rowKey	Row's unique key, could be a string or function that returns a string	string|Function(record):string	key
rowSelection	Row selection config	object	null
scroll	Whether the table can be scrollable, config	object	-
showHeader	Whether to show table header	boolean	true
size	Size of table	default | middle | small	default
summary	Summary content	(currentData) => ReactNode	-
title	Table title renderer	Function(currentPageData)	-
onChange	Callback executed when pagination, filters or sorter is changed	Function(pagination, filters, sorter, extra: { currentDataSource: [] })	-
onHeaderRow	Set props on per header row	Function(column, index)	-
onRow	Set props on per row	Function(record, index)	-
getPopupContainer	the render container of dropdowns in table	(triggerNode) => HTMLElement	() => TableHtmlElement

onRow usage

Same as onRow onHeaderRow onCell onHeaderCell

<Table
  onRow={(record, rowIndex) => {
    return {
      onClick: event => {}, // click row
      onDoubleClick: event => {}, // double click row
      onContextMenu: event => {}, // right button click row
      onMouseEnter: event => {}, // mouse enter row
      onMouseLeave: event => {}, // mouse leave row
    };
  }}
  onHeaderRow={column => {
    return {
      onClick: () => {}, // click header row
    };
  }}
/>

Column

One of the Table columns prop for describing the table's columns, Column has the same API.

Property	Description	Type	Default
align	specify which way that column is aligned	'left' | 'right' | 'center'	'left'
ellipsis	ellipsis cell content, not working with sorter and filters for now. tableLayout would be fixed when ellipsis is true.	boolean	false
className	className of this column	string	-
colSpan	Span of this column's title	number	-
dataIndex	Display field of the data record, support nest path by string array	string | string[]	-
defaultFilteredValue	Default filtered values	string[]	-
defaultSortOrder	Default order of sorted values	'ascend' | 'descend'	-
filterDropdown	Customized filter overlay	React.ReactNode | (props: FilterDropdownProps) => React.ReactNode	-
filterDropdownVisible	Whether filterDropdown is visible	boolean	-
filtered	Whether the dataSource is filtered	boolean	false
filteredValue	Controlled filtered value, filter icon will highlight	string[]	-
filterIcon	Customized filter icon	ReactNode|(filtered: boolean) => ReactNode	false
filterMultiple	Whether multiple filters can be selected	boolean	true
filters	Filter menu config	object[]	-
fixed	(IE not support) Set column to be fixed: true(same as left) 'left' 'right'	boolean|string	false
key	Unique key of this column, you can ignore this prop if you've set a unique dataIndex	string	-
render	Renderer of the table cell. The return value should be a ReactNode, or an object for colSpan/rowSpan config	Function(text, record, index) {}	-
sorter	Sort function for local sort, see Array.sort's compareFunction. If you need sort buttons only, set to true	Function|boolean	-
sortOrder	Order of sorted values: 'ascend' 'descend' false	boolean|string	-
sortDirections	supported sort way, could be 'ascend', 'descend'	Array	['ascend', 'descend']
title	Title of this column	ReactNode|({ sortOrder, sortColumn, filters }) => ReactNode	-
width	Width of this column (width not working?)	string|number	-
onCell	Set props on per cell	Function(record, rowIndex)	-
onFilter	Callback executed when the confirm filter button is clicked	Function	-
onFilterDropdownVisibleChange	Callback executed when filterDropdownVisible is changed	function(visible) {}	-
onHeaderCell	Set props on per header cell	Function(column)	-

ColumnGroup

Property	Description	Type	Default
title	Title of the column group	string|ReactNode	-

pagination

Properties for pagination.

Property	Description	Type	Default
position	specify the position of Pagination	'top' | 'bottom' | 'both'	'bottom'

More about pagination, please check Pagination.

expandable

Properties for expandable.

Property	Description	Type	Default
childrenColumnName	The column contains children to display	string[]	children
defaultExpandAllRows	Expand all rows initially	boolean	false
defaultExpandedRowKeys	Initial expanded row keys	string[]	-
expandIcon	Customize row expand Icon. Ref example	Function(props):ReactNode	-
expandedRowKeys	Current expanded row keys	string[]	-
expandedRowRender	Expanded container render for each row	Function(record, index, indent, expanded):ReactNode	-
expandRowByClick	Whether to expand row by clicking anywhere in the whole row	boolean	false
indentSize	Indent size in pixels of tree data	number	15
rowExpandable	Enable row can be expandable	(record) => boolean	-
onExpand	Callback executed when the row expand icon is clicked	Function(expanded, record)	-
onExpandedRowsChange	Callback executed when the expanded rows change	Function(expandedRows)	-

rowSelection

Properties for row selection.

Property	Description	Type	Default
columnWidth	Set the width of the selection column	string|number	60px
columnTitle	Set the title of the selection column	string|React.ReactNode	-
fixed	Fixed selection column on the left	boolean	-
getCheckboxProps	Get Checkbox or Radio props	Function(record)	-
hideDefaultSelections	Remove the default Select All and Select Invert selections when custom selection	boolean	false
selectedRowKeys	Controlled selected row keys	string[]|number[]	[]
selections	Custom selection config, only displays default selections when set to true	object[]|boolean	-
type	checkbox or radio	checkbox | radio	checkbox
onChange	Callback executed when selected rows change	Function(selectedRowKeys, selectedRows)	-
onSelect	Callback executed when select/deselect one row	Function(record, selected, selectedRows, nativeEvent)	-
onSelectAll	Callback executed when select/deselect all rows	Function(selected, selectedRows, changeRows)	-
onSelectInvert	Callback executed when row selection is inverted	Function(selectedRows)	-

scroll

Property	Description	Type	Default
x	Set horizontal scrolling, can also be used to specify the width and height of the scroll area, could be number, percent value, true and 'max-content'	number | true	-
y	Set vertical scrolling, can also be used to specify the width and height of the scroll area, could be number, percent value, true and 'max-content'	number | true	-
scrollToFirstRowOnChange	Whether to scroll to the top of the table when paging, sorting, filtering changes	boolean	-

selection

Property	Description	Type	Default
key	Unique key of this selection	string	-
text	Display text of this selection	string|React.ReactNode	-
onSelect	Callback executed when this selection is clicked	Function(changeableRowKeys)	-

Using in TypeScript

import { Table } from 'antd';
import { ColumnProps } from 'antd/es/table';

interface User {
  key: number,
  name: string;
}

const columns: ColumnProps<User>[] = [{
  key: 'name',
  title: 'Name',
  dataIndex: 'name',
}];

const data: User[] = [{
  key: 0,
  name: 'Jack',
}];

class UserTable extends Table<User> {}

<UserTable columns={columns} dataSource={data} />

// Use JSX style API
class NameColumn extends Table.Column<User> {}

<UserTable dataSource={data}>
  <NameColumn key="name" title="Name" dataIndex="name" />
</UserTable>

// after TypeScript 2.9 can write like this
// https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-9.html#generic-type-arguments-in-jsx-elements
<Table<User> columns={columns} dataSource={data} />
<Table<User> dataSource={data}>
  <Table.Column<User> key="name" title="Name" dataIndex="name" />
</Table>

Note

According to the React documentation, every child in an array should be assigned a unique key. The values inside the Table's dataSource and columns should follow this rule. By default, dataSource[i].key will be treated as the key value for dataSource.

If dataSource[i].key is not provided, then you should specify the primary key of dataSource value via rowKey, as shown below. If not, warnings like the one above will show in browser console.

// primary key is uid
return <Table rowKey="uid" />;
// or
return <Table rowKey={record => record.uid} />;

Migrate to v4

Table removes onRowClick, onRowDoubleClick, onRowMouseEnter, onRowMouseLeave and some other api which is already deprecated in v3. If you only use api listing in official document, that's OK.

Besides, the breaking change is changing dataIndex from nest string path like user.age to string array path like ['user', 'age']. This help to resolve developer should additional work on the field which contains ..

FAQ

How to hide pagination when single page or not data

You can set hideOnSinglePage with pagination prop.