2017-08-09 15:45:08 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Data Display
2018-05-21 21:52:18 +08:00
title: List
2024-03-22 14:22:42 +08:00
description: Basic list display, which can carry text, lists, pictures, paragraphs.
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*EYuhSpw1iSwAAAAAAAAAAAAADrJ8AQ/original
2023-02-09 22:17:31 +08:00
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*tBzwQ7raKX8AAAAAAAAAAAAADrJ8AQ/original
2017-08-09 15:45:08 +08:00
---
## When To Use
A list can be used to display content related to a single subject. The content can consist of multiple elements of varying type and size.
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/simple.tsx" > Simple list< / code >
< code src = "./demo/basic.tsx" > Basic list< / code >
< code src = "./demo/loadmore.tsx" > Load more< / code >
< code src = "./demo/vertical.tsx" > Vertical< / code >
2022-12-31 19:18:09 +08:00
< code src = "./demo/pagination.tsx" > Pagination Settings< / code >
2022-11-09 12:28:04 +08:00
< code src = "./demo/grid.tsx" > Grid< / code >
< code src = "./demo/grid-test.tsx" debug > Test Grid< / code >
< code src = "./demo/responsive.tsx" > Responsive grid list< / code >
< code src = "./demo/infinite-load.tsx" > Scrolling loaded< / code >
< code src = "./demo/virtual-list.tsx" > virtual list< / code >
2023-05-22 10:20:38 +08:00
< code src = "./demo/component-token.tsx" debug > custom component token< / code >
2022-11-09 12:28:04 +08:00
2017-08-09 15:45:08 +08:00
## API
2023-08-08 18:27:48 +08:00
Common props ref：
2017-08-09 15:45:08 +08:00
### List
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| bordered | Toggles rendering of the border around the list | boolean | false | |
2020-10-21 10:33:43 +08:00
| dataSource | DataSource array for list | any\[] | - | |
2020-10-09 10:08:52 +08:00
| footer | List footer renderer | ReactNode | - | |
2022-12-22 14:12:26 +08:00
| grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | [object ](#list-grid-props ) | - | |
2020-10-09 10:08:52 +08:00
| header | List header renderer | ReactNode | - | |
2021-03-03 10:50:57 +08:00
| itemLayout | The layout of list | `horizontal` \| `vertical` | `horizontal` | |
2022-12-22 14:12:26 +08:00
| loading | Shows a loading indicator while the contents of the list are being fetched | boolean \| [SpinProps ](/components/spin/#api ) ([more](https://github.com/ant-design/ant-design/issues/8659)) | false | |
2020-10-09 10:08:52 +08:00
| loadMore | Shows a load more content | ReactNode | - | |
2020-07-02 09:52:28 +08:00
| locale | The i18n text including empty text | object | {emptyText: `No Data` } | |
2020-04-17 17:56:42 +08:00
| pagination | Pagination [config ](/components/pagination/ ), hide it by setting it to false | boolean \| object | false | |
2020-10-21 10:33:43 +08:00
| renderItem | Customize list item when using `dataSource` | (item) => ReactNode | - | |
2021-09-07 12:05:59 +08:00
| rowKey | Item's unique value, could be an Item's key which holds a unique value of type `React.Key` or function that receives Item and returns a `React.Key` | `keyof` T \| (item: T) => `React.Key` | `"key"` | |
2020-01-17 18:23:58 +08:00
| size | Size of list | `default` \| `large` \| `small` | `default` | |
2019-07-11 14:14:33 +08:00
| split | Toggles rendering of the split under the list item | boolean | true | |
2017-08-21 21:14:20 +08:00
2018-05-21 21:52:18 +08:00
### pagination
Properties for pagination.
2022-12-31 19:18:09 +08:00
| Property | Description | Type | Default |
| -------- | ----------------------------------------- | ---------------------------- | -------- |
| position | The specify the position of `Pagination` | `top` \| `bottom` \| `both` | `bottom` |
| align | The specify the alignment of `Pagination` | `start` \| `center` \| `end` | `end` |
2018-05-21 21:52:18 +08:00
More about pagination, please check [`Pagination` ](/components/pagination/ ).
2017-08-21 21:14:20 +08:00
### List grid props
2017-10-25 10:27:38 +08:00
2021-09-07 12:05:59 +08:00
| Property | Description | Type | Default | Version |
| -------- | ------------------------ | ------ | ------- | ------- |
| column | The column of grid | number | - | |
| gutter | The spacing between grid | number | 0 | |
| xs | `<576px` column of grid | number | - | |
| sm | `≥576px` column of grid | number | - | |
| md | `≥768px` column of grid | number | - | |
| lg | `≥992px` column of grid | number | - | |
| xl | `≥1200px` column of grid | number | - | |
| xxl | `≥1600px` column of grid | number | - | |
2017-08-09 15:45:08 +08:00
### List.Item
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
2020-07-02 09:52:28 +08:00
| actions | The actions content of list item. If `itemLayout` is `vertical` , shows the content on bottom, otherwise shows content on the far right | Array< ReactNode> | - | |
2024-06-03 11:24:39 +08:00
| classNames | Semantic structure className | `Record<actions \| extra , string>` | - | 5.18.0 |
2020-10-09 10:08:52 +08:00
| extra | The extra content of list item. If `itemLayout` is `vertical` , shows the content on right, otherwise shows content on the far right | ReactNode | - | |
2024-06-03 11:24:39 +08:00
| styles | Semantic DOM style | `Record<actions \| extra , CSSProperties>` | - | 5.18.0 |
2017-08-09 15:45:08 +08:00
### List.Item.Meta
2021-09-07 12:05:59 +08:00
| Property | Description | Type | Default | Version |
| ----------- | ---------------------------- | --------- | ------- | ------- |
| avatar | The avatar of list item | ReactNode | - | |
| description | The description of list item | ReactNode | - | |
| title | The title of list item | ReactNode | - | |
2023-04-11 10:25:24 +08:00
## Design Token
< ComponentTokenTable component = "List" > < / ComponentTokenTable >
