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

1.4 KiB

category type title cols cover
Components Data Display Descriptions 1 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 -
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.