mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-25 03:29:59 +08:00
930ad2eb40
* chore: 📝 Description List => Descriptions
* Update index.en-US.md
1.3 KiB
1.3 KiB
category | type | title | cols |
---|---|---|---|
Components | Data Display | Descriptions | 1 |
Display multiple read-only fields in groups.
When To Use
Commonly displayed on the details page.
API
Descriptions
Property | Description | Type | Default | Version |
---|---|---|---|---|
title | The title of the description list, placed at the top | ReactNode | - | 3.19.0 |
bordered | whether to display the border | boolean | false | 3.19.0 |
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 | 3.19.0 |
size | set the size of the list. Can be set to middle ,small , or not filled |
`default | middle | small` |
layout | Define description layout | `horizontal | vertical` | horizontal |
colon | change default props colon value of Descriptions.Item |
boolean | true | 3.21.0 |
DescriptionItem
Property | Description | Type | Default | Version |
---|---|---|---|---|
label | description of the content | ReactNode | - | 3.19.0 |
span | The number of columns included | number | 1 | 3.19.0 |
The number of span Description.Item. Span={2} takes up the width of two DescriptionItems.