Skip to content

Descriptions

The Descriptions list is used to display read-only structured information.

Basic Usage

loading

Formatting

loading

Render Components

loading

Field Slots

loading

Descriptions Attributes

Attribute NameDescriptionTypeDefault
borderWhether to display borderbooleantrue
columnNumber of description items displayed per rownumber3
directionArrangement direction of description list'vertical' | 'horizontal''horizontal'
sizeList size'large' | 'default' | 'small''default'
titleTitle of description liststring-
extraOperation area of description liststring-
configConfiguration array of description itemsDescriptionsConfig[]-

Descriptions Slots

Slot NameDescriptionSubcomponent
defaultDefault slot for placing DescriptionsItem itemsDescriptionsItem
titleTitle content-
extraOperation area content-

DescriptionsItem Attributes

DescriptionsItem is defined through the config configuration item and supports the following attributes:

Attribute NameDescriptionTypeDefault
componentComponent typeany-
formatterFormatting functionFunction-
labelLabel textstring-
spanNumber of columnsnumber1
widthColumn widthstring | number-
minWidthMinimum column widthstring | number-
alignContent alignment of column'left' | 'center' | 'right''left'
labelAlignLabel text alignment'left' | 'center' | 'right'-
classNameCustom class name of column contentstring-
labelClassNameLabel class namestring-

DescriptionsItem Slots

DescriptionsItem slots are defined by field names, with slot names corresponding to the field field in config.

Slot NameDescriptionScope Parameters
[field]Custom description item content{ formData, configItem }
labelLabel text-