The Tags component for Retool Apps

A content area to display a set of tags.

Version: Cloud and 3.188 Edge

For more information about this component, refer to the Informational components guide.

Demo

Properties

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

allowRemoval

Whether to allow removal of items.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector
Default	false

Examples

true

---

allowWrap

Whether content can wrap to multiple lines.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Wrap text
Default	true

Examples

true

---

colorByIndex

A list of colors for each item, by index.

Type	array
Array values	string
Mutability	Read-only

---

data

The data.

Type	string | number | boolean | object | array
Format	Custom data
Mutability	Control Usage Retool UI Inspector Method copyToClipboard()

---

hiddenByIndex

A list of items, by index, and whether they are hidden.

Type	array
Array values	boolean
Mutability	Read-only
Default	[]

Examples

[true, false, true]

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Appearance > Alignment
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

---

iconByIndex

A list of icons for each item, by index.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["/icon:bold/shopping-gift", "/icon:bold/interface-user-single", "/icon:bold/interface-align-layers-1"]

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	tags1

Examples

query1

button1

---

imageByIndex

A list of images for each item, by index.

Type	array
Array values	string
Mutability	Read-only

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

itemMode

The configuration mode for options.

Type	string
Mutability	Control Usage Retool UI Inspector > Content > Options
Allowed Values	Value UI Option Description dynamic Mapped Options dynamically mapped from an array. static Manual Options manually configured in the IDE.
Default	dynamic

Examples

"dynamic"

---

labels

A list of labels for each item. Falls back to the corresponding value if no label is provided.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Label 1", "Label 2", "Label 3"]

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

textColorByIndex

A list of text color values, by index.

Type	array
Array values	string
Mutability	Read-only

---

tooltipByIndex

A list of tooltips for each item, by index.

Type	array
Array values	string
Mutability	Read-only
Default	[]

Examples

["Tooltip 1", "Tooltip 2"]

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	array
Array values	string
Mutability	Read-only

---

values

A list of possible values from which to select.

Type	array
Mutability	Read-only

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

tags.clearValue()

Clear the current values.

Definition

tags.clearValue()

Examples

Clear the current value of tags.

tags.clearValue();

---

tags.resetValue()

Reset the current value to the default value.

Definition

tags.resetValue()

Examples

Reset the current value of tags.

tags.resetValue();

---

tags.scrollIntoView()

Scrolls the canvas or parent container so that the selected component appears in the visible area.

Definition

tags.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description nearest Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view. start Scrolls to position the component at the top of the visible area. center Scrolls to position the component in the middle of the visible area. end Scrolls to position the component at the bottom of the visible area.

---

---

Examples

Scroll the minimum amount to immediately bring tags into view.

tags.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

tags.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

tags.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide tags.

tags.setHidden(true);

Unhide tags.

tags.setHidden(false);

---

tags.setValue()

Set the current value.

Definition

tags.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of tags to userValue.

tags.setValue(userValue);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Click	An item is clicked or pressed.