Badge
Rocket 2.0
The Badge component shows a short label in a small pill, such as a status, a tag or a count.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Text | Text shown in the badge. | Text. Default: Badge |
| Variant | Color of the badge. success, warning and destructive use the theme's status colors; outline has a border and no fill. | default, secondary, outline, success, warning, destructive. Default: default |
| Alignment | Where the badge sits across the component's width: left, center or right. | Left, Center, Right. Default: Left |
| Loading look | What shows while the component is loading: a Spinner or a Skeleton placeholder in the component's shape. | 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 |
|---|---|---|
| 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 |
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 |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On click | Triggers when the user clicks the badge. |
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.badge1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.badge1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.badge1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
text | Text shown in the badge. | {{components.badge1.text}} |
variant | Color of the badge. success, warning and destructive use the theme's status colors; outline has a border and no fill. | {{components.badge1.variant}} |
align | Where the badge sits across the component's width: left, center or right. | {{components.badge1.align}} |
loadingIndicator | What shows while the component is loading: a Spinner or a Skeleton placeholder in the component's shape. | {{components.badge1.loadingIndicator}} |
isVisible | Whether the component is visible. | {{components.badge1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.badge1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.badge1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Badge background | Theme: Brand primary |
| Badge text color | Theme: Surface 1 |
| Badge border color | transparent |
| Badge 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.