2017-08-09 15:45:08 +08:00
|
|
|
---
|
|
|
|
|
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 | - | string \| boolean | false |
|
2017-09-26 16:11:35 +08:00
|
|
|
| split | - | string \| boolean | true |
|
2017-08-09 15:45:08 +08:00
|
|
|
| loading | -| boolean | false |
|
|
|
|
|
| itemLayout | - | string | - |
|
2017-09-25 15:24:16 +08:00
|
|
|
| loadMore | -| string\|ReactNode | - |
|
2017-08-09 15:45:08 +08:00
|
|
|
| pagination | - | boolean \| object | false |
|
2017-08-21 21:14:20 +08:00
|
|
|
| grid | - | object | - |
|
2017-09-26 16:11:35 +08:00
|
|
|
| header | - | string\|ReactNode | - |
|
|
|
|
|
| footer | - | string\|ReactNode | - |
|
2017-08-21 21:14:20 +08:00
|
|
|
|
|
|
|
|
### List grid props
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
---------|-------------|------|---------
|
|
|
|
|
| gutter | - | number | 0 |
|
|
|
|
|
| column | - | number | - |
|
|
|
|
|
| xs | `<768px` - | number | - |
|
|
|
|
|
| sm | `≥768px` - | number | - |
|
|
|
|
|
| md | `≥992px` - | number | - |
|
|
|
|
|
| lg | `≥1200px` - | number | - |
|
|
|
|
|
| xl | `≥1600px` - | number | - |
|
2017-08-09 15:45:08 +08:00
|
|
|
|
|
|
|
|
### List.Item
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
---------|-------------|------|---------
|
|
|
|
|
| extra | - | string\|ReactNode | - |
|
2017-08-09 21:46:48 +08:00
|
|
|
| actions | - | Array<ReactNode> | - |
|
2017-08-09 15:45:08 +08:00
|
|
|
|
|
|
|
|
### List.Item.Meta
|
|
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
---------|-------------|------|---------
|
|
|
|
|
| avatar | - | ReactNode | - |
|
|
|
|
|
| title | - | string\|ReactNode | - |
|
|
|
|
|
| description | - | string\|ReactNode | - |
|
