2019-05-22 23:22:09 +08:00
---
category: Components
type: Data Display
2019-12-18 12:09:05 +08:00
title: Descriptions
2019-05-22 23:22:09 +08:00
cols: 1
2020-05-31 11:48:34 +08:00
cover: https://gw.alipayobjects.com/zos/alicdn/MjtG9_FOI/Descriptions.svg
2019-05-22 23:22:09 +08:00
---
Display multiple read-only fields in groups.
## When To Use
Commonly displayed on the details page.
## API
### Descriptions
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
2019-11-20 20:31:43 +08:00
| title | The title of the description list, placed at the top | ReactNode | - | |
2020-07-14 20:37:21 +08:00
| extra | The action area of the description list, placed at the top-right | string \| ReactNode | - | 4.5.0 |
2020-07-01 22:37:55 +08:00
| 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` | - | |
2020-01-17 17:23:48 +08:00
| layout | Define description layout | `horizontal` \| `vertical` | `horizontal` | |
2020-07-01 22:37:55 +08:00
| colon | Change default props `colon` value of Descriptions.Item | boolean | true | |
2019-05-22 23:22:09 +08:00
### DescriptionItem
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| -------- | ------------------------------ | --------- | ------- | ------- |
2020-07-01 22:37:55 +08:00
| label | The description of the content | ReactNode | - | |
2019-11-20 20:31:43 +08:00
| span | The number of columns included | number | 1 | |
2019-08-16 10:01:46 +08:00
> The number of span Description.Item. Span={2} takes up the width of two DescriptionItems.
