Skip to main content

Summary Strip

Rocket 2.0

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

Properties​

Property
Description
Expected Value
FiguresFigures to show, each with a label and a value. Each can add a delta (the change), a caption, its own format or deltaFormat, a tone, and lowerIsBetter to color a fall as good.Array
Value formatHow figures are written unless a figure sets its own format, such as plain numbers, currency, percent, short forms like 12K, or dates.Auto, Number, Currency, Percent, Compact, Date. Default: Auto
Currency (ISO code, e.g. USD)Currency code used for figures formatted as currency, such as USD or EUR.Text. Default: USD
LocaleLocale used to format numbers, currency and dates, such as en-US. Leave empty to follow the currency.Text
Change format (numbers)How a numeric change is written unless a figure sets its own deltaFormat.Percent, Number, Currency. Default: Percent
AppearancePanel groups the figures in one bordered box, Plain shows them without a box, and Cards puts each figure in its own box.Panel, Plain, Cards. Default: Panel
SizeSize of the figures and their spacing.Small, Default, Large. Default: Default
AlignWhether each figure's text is aligned left or centered.Left, Center. Default: Left
Loading lookWhat shows while the component is loading: a spinner or a skeleton outline.Spinner, Skeleton. Default: Spinner

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
itemsFigures to show, each with a label and a value. Each can add a delta (the change), a caption, its own format or deltaFormat, a tone, and lowerIsBetter to color a fall as good.{{components.summarystrip1.items}}
valueFormatHow figures are written unless a figure sets its own format, such as plain numbers, currency, percent, short forms like 12K, or dates.{{components.summarystrip1.valueFormat}}
currencyCurrency code used for figures formatted as currency, such as USD or EUR.{{components.summarystrip1.currency}}
localeLocale used to format numbers, currency and dates, such as en-US. Leave empty to follow the currency.{{components.summarystrip1.locale}}
deltaFormatHow a numeric change is written unless a figure sets its own deltaFormat.{{components.summarystrip1.deltaFormat}}
appearancePanel groups the figures in one bordered box, Plain shows them without a box, and Cards puts each figure in its own box.{{components.summarystrip1.appearance}}
sizeSize of the figures and their spacing.{{components.summarystrip1.size}}
alignWhether each figure's text is aligned left or centered.{{components.summarystrip1.align}}
loadingIndicatorWhat shows while the component is loading: a spinner or a skeleton outline.{{components.summarystrip1.loadingIndicator}}
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
Panel backgroundTheme: Surface 1
Border and separator colorTheme: Default border
Label and caption colorTheme: Placeholder text
Figure colorTheme: Primary text
Positive change colorTheme: Success
Negative change colorTheme: Error
Panel radius—
Figure typefaceTheme font
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.