Show · Description
Description

Demos

How to import

Basic Usage

Alignment

You can use align to set alignment of key-value. Supporting values including: center(default), justify, left, and plain.

Row Display

Set row to display the data to two-row, supporting three sizes: small, medium(default), and large.

Descriptions Using JSX

Version: >= 1.17.0

API Reference

Descriptions

PropertiesInstructionstypeDefault
alignAlignment of the key-value data, one of center, left, plainstringcenter
classNameClassnamestring-
dataData to displayDataItem[]-
rowToggle whether to display data in double-rowbooleanfalse
sizeSize of the list for double-row display, one of small, medium, largestringmedium
styleInline styleCSSProperties-

DataItem

PropertiesInstructionstypeDefault
keyKey valueReactNode-
valueData valueReactNode | (() => ReactNode)-
hiddenToggle whether the data should be displayed v>=1.12.0boolean-

Descriptions.Item

v>=1.17.0
PropertiesInstructionstypeDefault
itemKeyKey valueReactNode-
hiddenToggle whether the data should be displayedboolean-
classNameClassnamestring-
styleInline styleCSSProperties-

Content Guidelines

  • Field names and values ​​are written in upper and lower case according to the Sentence case principle

Design Tokens