Skip to main content

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
TextText shown in the badge.Text. Default: Badge
VariantColor 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
AlignmentWhere the badge sits across the component's width: left, center or right.Left, Center, Right. Default: Left
Loading lookWhat 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
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

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

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On clickTriggers 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 visibilityShows the component when true, hides it when false.components.badge1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.badge1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.badge1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
textText shown in the badge.{{components.badge1.text}}
variantColor of the badge. success, warning and destructive use the theme's status colors; outline has a border and no fill.{{components.badge1.variant}}
alignWhere the badge sits across the component's width: left, center or right.{{components.badge1.align}}
loadingIndicatorWhat shows while the component is loading: a Spinner or a Skeleton placeholder in the component's shape.{{components.badge1.loadingIndicator}}
isVisibleWhether the component is visible.{{components.badge1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.badge1.isLoading}}
isDisabledWhether the component is disabled.{{components.badge1.isDisabled}}

Styles​

Style
Default
Badge backgroundTheme: Brand primary
Badge text colorTheme: Surface 1
Badge border colortransparent
Badge 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.