Skip to main content

Tags

Rocket 2.0

The Tags component shows a read-only list of labels as colored chips, such as the categories, skills or statuses attached to a record. The user can click a tag to act on it.

Properties​

Property
Description
Expected Value
Tags (array or comma-separated)Tags to show, as a list or comma-separated text. Each can be plain text or an item with a label and a color.Array. Default: ["Design", "Frontend", "Urgent"]
Colours by tagA color for each tag, for example { "Urgent": "#dc2626" }. A tag's own color wins.Object. Default: {"Urgent": "#dc2626"}
VariantFill style of the chips: a light Soft tint, an Outline, or a Solid fill.Soft, Outline, Solid. Default: Soft
SizeSize of the chips.Sm, Default, Lg. Default: Default
OverflowWhat happens when the tags don't fit: Wrap onto more lines, show One line, +N with a count of the rest, or Scroll sideways on one line.Wrap, One line, +N, Scroll. Default: Wrap
Pill shapeGives the chips fully rounded ends.On or off. Default: Off
Loading lookWhat shows while the component is loading: a spinner or skeleton chips.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

Events​

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

Event
Description
On tag clickedTriggers when the user clicks a tag.

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

Exposed Variables​

Variable
Description
How To Access
tagsTags to show, as a list or comma-separated text. Each can be plain text or an item with a label and a color.{{components.tags1.tags}}
tagColorsA color for each tag, for example { "Urgent": "#dc2626" }. A tag's own color wins.{{components.tags1.tagColors}}
variantFill style of the chips: a light Soft tint, an Outline, or a Solid fill.{{components.tags1.variant}}
sizeSize of the chips.{{components.tags1.size}}
overflowWhat happens when the tags don't fit: Wrap onto more lines, show One line, +N with a count of the rest, or Scroll sideways on one line.{{components.tags1.overflow}}
pillGives the chips fully rounded ends.{{components.tags1.pill}}
loadingIndicatorWhat shows while the component is loading: a spinner or skeleton chips.{{components.tags1.loadingIndicator}}
lastClickedTagThe label of the tag the user clicked last.{{components.tags1.lastClickedTag}}
isVisibleWhether the component is visible.{{components.tags1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.tags1.isLoading}}
isDisabledWhether the component is disabled.{{components.tags1.isDisabled}}

Styles​

Style
Default
Tag background (unmapped tags)Theme: Surface 3
Tag text color (unmapped tags)Theme: Primary text
Tag border colortransparent
Tag 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.