mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 13:08:41 +08:00
4ec1b8ae09
* feat: Description list plus extra operation area * 修复title与extra对齐，加版本等问题 * 去掉basic里extra * 修改extra样式 * title与extra都没有的时候不展示header * 更新测试用例 Co-authored-by: chenshuai2144 <qixian.cs@outlook.com>
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Display
|
|
title: Descriptions
|
|
cols: 1
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/MjtG9_FOI/Descriptions.svg
|
|
---
|
|
|
|
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 | - | |
|
|
| extra | The action area of the description list, placed at the top-right | string \| ReactNode | - | 4.5.0 |
|
|
| 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` | - | |
|
|
| layout | Define description layout | `horizontal` \| `vertical` | `horizontal` | |
|
|
| colon | Change default props `colon` value of Descriptions.Item | boolean | true | |
|
|
|
|
### DescriptionItem
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| -------- | ------------------------------ | --------- | ------- | ------- |
|
|
| label | The description of the content | ReactNode | - | |
|
|
| span | The number of columns included | number | 1 | |
|
|
|
|
> The number of span Description.Item. Span={2} takes up the width of two DescriptionItems.
|