2018-06-16 13:30:41 +00:00
## API
### List
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-06-16 13:30:41 +00:00
| bordered | Toggles rendering of the border around the list | boolean | false |
| footer | List footer renderer | string\|slot | - |
| grid | The grid type of list. You can set grid to something like {gutter: 16, column: 4} | object | - |
| header | List header renderer | string\|slot | - |
| itemLayout | The layout of list, default is `horizontal` , If a vertical list is desired, set the itemLayout property to `vertical` | string | - |
2019-09-11 10:11:48 +00:00
| rowKey | Item's unique key, could be a string or function that returns a string | string\|Function(record):string | `key` |
2019-02-16 08:51:21 +00:00
| loading | Shows a loading indicator while the contents of the list are being fetched | boolean\|[object ](https://vue.ant.design/components/spin/#API ) | false |
2018-06-16 13:30:41 +00:00
| loadMore | Shows a load more content | string\|slot | - |
2018-09-05 13:28:54 +00:00
| locale | i18n text including empty text | object | emptyText: 'No Data' < br > |
2019-02-16 08:51:21 +00:00
| pagination | Pagination [config ](https://vue.ant.design/components/pagination/#API ), hide it by setting it to false | boolean \| object | false |
2018-06-16 13:30:41 +00:00
| split | Toggles rendering of the split under the list item | boolean | true |
2019-09-28 12:45:07 +00:00
| renderItem | Custom item renderer, slot="renderItem" and slot-scope="item, index" | (item, index) => vNode | | - |
2018-06-16 13:30:41 +00:00
2018-09-05 13:28:54 +00:00
### pagination
Properties for pagination.
2019-09-28 12:45:07 +00:00
| Property | Description | Type | Default |
| -------- | ------------------------------------ | --------------------------- | -------- |
2018-09-05 13:28:54 +00:00
| position | specify the position of `Pagination` | 'top' \| 'bottom' \| 'both' | 'bottom' |
2019-02-16 08:51:21 +00:00
More about pagination, please check [`Pagination` ](https://vue.ant.design/components/pagination/#API ).
2018-09-05 13:28:54 +00:00
2018-06-16 13:30:41 +00:00
### List grid props
2019-09-28 12:45:07 +00:00
| Property | Description | Type | Default |
| -------- | ------------------------ | ---------------------------------------- | --------- |
| column | column of grid | number oneOf [ 1, 2, 3, 4, 6, 8, 12, 24] | - |
| gutter | spacing between grid | number | 0 |
| size | Size of list | `default` \| `middle` \| `small` | `default` |
| 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 | - |
2018-06-16 13:30:41 +00:00
### List.Item
| Property | Description | Type | Default |
2019-09-28 12:45:07 +00:00
| --- | --- | --- | --- |
2018-06-16 13:30:41 +00: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\<vNode>\|slot | - |
| extra | The extra content of list item. If `itemLayout` is `vertical` , shows the content on right, otherwise shows content on the far right. | string\|slot | - |
### List.Item.Meta
2019-09-28 12:45:07 +00:00
| Property | Description | Type | Default |
| ----------- | ---------------------------- | ------------ | ------- |
| avatar | The avatar of list item | slot | - |
| description | The description of list item | string\|slot | - |
| title | The title of list item | string\|slot | - |