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 |
|---|---|---|
| Items | The 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 format | How 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 |
| Currency | Currency code, such as USD or EUR, for values and changes shown as currency. | Text. Default: USD |
| Locale | Locale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format. | Text |
| Delta format | How 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 |
| Appearance | Frame 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 |
| Size | Size of the figures: sm for small, lg for large. | sm, default, lg. Default: default |
| Align | Alignment 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 |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets 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 desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 visibility | Shows the component when true, hides it when false. | components.summarystrip1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.summarystrip1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.summarystrip1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
items | The 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}} |
valueFormat | How 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}} |
currency | Currency code, such as USD or EUR, for values and changes shown as currency. | {{components.summarystrip1.currency}} |
locale | Locale for number formatting, such as pt-BR. Leave it empty to follow the currency's usual format. | {{components.summarystrip1.locale}} |
deltaFormat | How 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}} |
appearance | Frame 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}} |
size | Size of the figures: sm for small, lg for large. | {{components.summarystrip1.size}} |
align | Alignment of the text in each figure. | {{components.summarystrip1.align}} |
isVisible | Whether the component is visible. | {{components.summarystrip1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.summarystrip1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.summarystrip1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 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.