mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-02 07:39:36 +08:00
Code Issues Actions 30 Packages Projects Releases Wiki Activity
3f18bfbaee
ant-design/components/descriptions/index.en-US.md
MadCcc e7edfa42d7
docs: update overview img (#38946) 
* docs: update overview img

* chore: code clean

* chore: code clean

* chore: update

* chore: code clean
2022-11-30 20:14:41 +08:00

2.4 KiB
Raw Blame History

category group title cover
Components Data Display Descriptions https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fHdlTpif6XQAAAAAAAAAAAAADrJ8AQ/original

Display multiple read-only fields in groups.

When To Use

Commonly displayed on the details page.

Examples

Basic border border Custom size responsive Vertical Vertical border Customize label & wrapper style

API

Descriptions

Property Description Type Default Version
bordered Whether to display the border boolean false
colon Change default props colon value of Descriptions.Item boolean true
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
contentStyle Customize content style CSSProperties - 4.10.0
extra The action area of the description list, placed at the top-right ReactNode - 4.5.0
labelStyle Customize label style CSSProperties - 4.10.0
layout Define description layout horizontal | vertical horizontal
size Set the size of the list. Can be set to middle,small, or not filled default | middle | small -
title The title of the description list, placed at the top ReactNode -

DescriptionItem

Property Description Type Default Version
contentStyle Customize content style CSSProperties - 4.9.0
label The description of the content ReactNode -
labelStyle Customize label style CSSProperties - 4.9.0
span The number of columns included number 1

The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. When both style and labelStyle(or contentStyle) configured, both of them will work. And next one will overwrite first when conflict.