Skip to main content

Tags

Ant Design

The Tags component shows a row of colored tags, such as skills, labels or categories. Common status words get matching colors, and users can click a tag.

Properties​

Property
Description
Expected Value
TagsThe tags, as text or as { label, color } objects, such as ['Design', 'Urgent'].Array. Default: ["Design", "Frontend", "Urgent"]
Tag colorsColors for tag labels, such as { "Paid": "green", "Urgent": "red" }. Without one, words such as Paid or Overdue get a matching status color.Object
VariantLook of the tags. filled has a light tint, outlined adds a border, and solid fills each tag with its full color.filled, outlined, solid. Default: filled
OverflowWhat happens when the tags don't fit on one line. wrap moves them to new lines, single keeps one line and hides the rest, and scroll keeps one line that scrolls sideways.wrap, single, scroll. Default: wrap
RoundGives the tags fully rounded ends.On or off. Default: Off

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, or presses Enter or Space on it.

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
tagsThe tags, as text or as { label, color } objects, such as ['Design', 'Urgent'].{{components.tags1.tags}}
tagColorsColors for tag labels, such as { "Paid": "green", "Urgent": "red" }. Without one, words such as Paid or Overdue get a matching status color.{{components.tags1.tagColors}}
variantLook of the tags. filled has a light tint, outlined adds a border, and solid fills each tag with its full color.{{components.tags1.variant}}
overflowWhat happens when the tags don't fit on one line. wrap moves them to new lines, single keeps one line and hides the rest, and scroll keeps one line that scrolls sideways.{{components.tags1.overflow}}
roundGives the tags fully rounded ends.{{components.tags1.round}}
lastClickedTagLabel 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
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border 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.