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

32 lines
1.1 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Display
title: Description List
cols: 1
---
Display multiple read-only fields in groups.
## When To Use
Commonly displayed on the details page.
## API
### Descriptions
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| title | The title of the description list, placed at the top | ReactNode | - |
| bordered | whether to display the border | boolean | false |
| column | the number of `DescriptionItems` in a row,could be a number or a object like `{ xs: 8, sm: 16, md: 24}`,(Only set `bordered={true}` to take effect) | number | 3 |
| size | set the size of the list. Can be set to `middle`,`small`, or not filled | `default | middle | small` | false |
2019-06-27 11:29:33 +08:00
| layout | Define description layout | `horizontal | vertical` | 'horizontal' |
### DescriptionItem
| Property | Description | Type | Default |
| -------- | ------------------------------ | --------- | ------- |
| label | description of the content | ReactNode | - |
| span | The number of columns included | number | 1 |