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

56 lines
2.5 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Display
title: List
cols: 1
---
Simple List.
## 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.
## API
### List
| Property | Description | Type | Default |
|----------|----------------|----------|--------------|
| bordered | Toggles rendering of the border around the list | boolean | false |
| split | Toggles rendering of the split under the list item | boolean | true |
| loading | Shows a loading indicator while the contents of the list are being fetched | boolean | false |
| itemLayout | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | string | - |
| loadMore | Shows a load more content | string\|ReactNode | - |
| pagination | Pagination [config](https://ant.design/components/pagination/), hide it by setting it to false | boolean \| object | false |
| grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | object | - |
| header | List header renderer | string\|ReactNode | - |
| footer | List footer renderer | string\|ReactNode | - |
### List grid props
| Property | Description | Type | Default |
---------|-------------|------|---------
| gutter | spacing between grid | number | 0 |
| column | column of grid | number | - |
| 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 | - |
### List.Item
| Property | Description | Type | Default |
---------|-------------|------|---------
| extra | The extra content of list item. If `itemLayout` is `vertical`, shows the content on right, otherwise shows content on the far right. | string\|ReactNode | - |
| 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> | - |
### List.Item.Meta
| Property | Description | Type | Default |
---------|-------------|------|---------
| avatar | The avatar of list item | ReactNode | - |
| title | The title of list item | string\|ReactNode | - |
| description | The description of list item | string\|ReactNode | - |