mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-01 19:49:59 +08:00
d44f404eae
* chore: improve sort api table scripts * sort api * add ignore * Revert "sort api" This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207. * sort api * Update package.json * sort api * Delete sort-api.js * sort api * sort api * sort api * fix * Update index.zh-CN.md * fix input-number * fix input-number * sort func * fix * Method moved to the end * carousel method
73 lines
3.3 KiB
Markdown
73 lines
3.3 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Display
|
|
title: List
|
|
cols: 1
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/5FrZKStG_/List.svg
|
|
---
|
|
|
|
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 | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| bordered | Toggles rendering of the border around the list | boolean | false | |
|
|
| dataSource | DataSource array for list | any\[] | - | |
|
|
| footer | List footer renderer | ReactNode | - | |
|
|
| grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | [object](#List-grid-props) | - | |
|
|
| header | List header renderer | ReactNode | - | |
|
|
| itemLayout | The layout of list, default is `horizontal`, If a vertical list is desired, set the itemLayout property to `vertical` | string | - | |
|
|
| 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 | |
|
|
| loadMore | Shows a load more content | ReactNode | - | |
|
|
| locale | The i18n text including empty text | object | {emptyText: `No Data`} | |
|
|
| pagination | Pagination [config](/components/pagination/), hide it by setting it to false | boolean \| object | false | |
|
|
| renderItem | Customize list item when using `dataSource` | (item) => ReactNode | - | |
|
|
| rowKey | Item's unique key, could be a string or function that returns a string | string \| Function(record): string | `key` | |
|
|
| size | Size of list | `default` \| `large` \| `small` | `default` | |
|
|
| split | Toggles rendering of the split under the list item | boolean | true | |
|
|
|
|
### pagination
|
|
|
|
Properties for pagination.
|
|
|
|
| Property | Description | Type | Default |
|
|
| --- | --- | --- | --- |
|
|
| position | The specify the position of `Pagination` | `top` \| `bottom` \| `both` | `bottom` |
|
|
|
|
More about pagination, please check [`Pagination`](/components/pagination/).
|
|
|
|
### List grid props
|
|
|
|
| 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 | - | |
|
|
|
|
### List.Item
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| 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> | - | |
|
|
| extra | The extra content of list item. If `itemLayout` is `vertical`, shows the content on right, otherwise shows content on the far right | ReactNode | - | |
|
|
|
|
### List.Item.Meta
|
|
|
|
| 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 | - | |
|