Skip to main content

Summary Strip

Ant Design

The Summary Strip component shows a row of key figures side by side, each with a label, a value and an optional change, such as revenue, orders and refund rate at the top of a dashboard.

Properties​

Property
Description
Expected Value
ItemsThe figures, up to six, each with a label, a value and optional delta, caption, format, deltaFormat, tone and lowerIsBetter, such as [{ label: 'Revenue', value: 48250, delta: 0.12, caption: 'vs last month' }].Array
Value formatHow values are written when an item sets no format of its own. percent reads 0.021 as 2.1%, compact shortens large numbers to 12K or 1.2M, and auto shows money labels such as Revenue as currency.auto, number, currency, percent, compact, date. Default: auto
CurrencyCurrency code, such as USD or EUR, for values and changes shown as currency.Text. Default: USD
LocaleLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.Text
Delta formatHow a numeric delta is written. With percent, 0.12 shows as +12%. A rise shows a green up arrow and a fall a red down arrow, swapped for items with lowerIsBetter.percent, number, currency. Default: percent
AppearanceFrame around the figures. panel puts them in one bordered panel with dividers, cards gives each figure its own card, and plain has no frame.panel, plain, cards. Default: panel
SizeSize of the figures: sm for small, lg for large.sm, default, lg. Default: default
AlignAlignment of the text in each figure.left, center. Default: left

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.summarystrip1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.summarystrip1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.summarystrip1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
itemsThe figures, up to six, each with a label, a value and optional delta, caption, format, deltaFormat, tone and lowerIsBetter, such as [{ label: 'Revenue', value: 48250, delta: 0.12, caption: 'vs last month' }].{{components.summarystrip1.items}}
valueFormatHow values are written when an item sets no format of its own. percent reads 0.021 as 2.1%, compact shortens large numbers to 12K or 1.2M, and auto shows money labels such as Revenue as currency.{{components.summarystrip1.valueFormat}}
currencyCurrency code, such as USD or EUR, for values and changes shown as currency.{{components.summarystrip1.currency}}
localeLocale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format.{{components.summarystrip1.locale}}
deltaFormatHow a numeric delta is written. With percent, 0.12 shows as +12%. A rise shows a green up arrow and a fall a red down arrow, swapped for items with lowerIsBetter.{{components.summarystrip1.deltaFormat}}
appearanceFrame around the figures. panel puts them in one bordered panel with dividers, cards gives each figure its own card, and plain has no frame.{{components.summarystrip1.appearance}}
sizeSize of the figures: sm for small, lg for large.{{components.summarystrip1.size}}
alignAlignment of the text in each figure.{{components.summarystrip1.align}}
isVisibleWhether the component is visible.{{components.summarystrip1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.summarystrip1.isLoading}}
isDisabledWhether the component is disabled.{{components.summarystrip1.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.