Skip to main content

Descriptions

Ant Design

The Descriptions component shows a record's details as label and value pairs, such as the fields of an order or a customer profile.

Properties​

Property
Description
Expected Value
ItemsThe rows to show. Use a list of {label, children} objects, [label, value] pairs or one object of label and value. A row's format can be number, currency, percent, date, datetime, boolean, tag (a colored status tag) or link.Array
TitleHeading shown above the details.Text. Default: Order details
ExtraText shown at the right of the title.Text
ColumnNumber of label and value pairs per row, from 1 to 6.Number. Default: 1
BorderedDraws the details as a table with borders and shaded label cells.On or off. Default: Off
Layouthorizontal puts each label beside its value; vertical puts the label above the value.horizontal, vertical. Default: horizontal
SizeSpacing around each pair. It shows most clearly when Bordered is on.default, middle, small. Default: default
CurrencyCurrency code, such as USD or EUR, for rows with the currency format that don't set their own.Text. Default: USD
LocaleLocale for number, currency and date formats, such as pt-BR. Leave it empty to follow the currency's usual format.Text
Empty textText shown in place of an empty value.Text. Default: -

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set visibilityShows the component when true, hides it when false.components.descriptions1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.descriptions1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.descriptions1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
itemsThe rows to show. Use a list of {label, children} objects, [label, value] pairs or one object of label and value. A row's format can be number, currency, percent, date, datetime, boolean, tag (a colored status tag) or link.{{components.descriptions1.items}}
titleHeading shown above the details.{{components.descriptions1.title}}
extraText shown at the right of the title.{{components.descriptions1.extra}}
columnNumber of label and value pairs per row, from 1 to 6.{{components.descriptions1.column}}
borderedDraws the details as a table with borders and shaded label cells.{{components.descriptions1.bordered}}
layouthorizontal puts each label beside its value; vertical puts the label above the value.{{components.descriptions1.layout}}
sizeSpacing around each pair. It shows most clearly when Bordered is on.{{components.descriptions1.size}}
currencyCurrency code, such as USD or EUR, for rows with the currency format that don't set their own.{{components.descriptions1.currency}}
localeLocale for number, currency and date formats, such as pt-BR. Leave it empty to follow the currency's usual format.{{components.descriptions1.locale}}
emptyTextText shown in place of an empty value.{{components.descriptions1.emptyText}}
isVisibleWhether the component is visible.{{components.descriptions1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.descriptions1.isLoading}}
isDisabledWhether the component is disabled.{{components.descriptions1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.