The Tabs component for Retool Apps

A group of tabs that trigger actions when clicked.

Tabs is a set of clickable UI elements to represent tabbed menu items. It can be linked to Container to create Tabbed Container.

Demo

Settings

Tabs includes the following configurable options when building apps in the IDE.

AlignDataDisabledEvent handlersHiddenShow on desktopShow on mobileOptionsMaintain space when hiddenMarginAlways show in edit modeStylesValue

Properties

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

alignment

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.
stretched	Justified alignment

---

data

any[]

The source data.

---

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

disabledByIndex

boolean[]

A list of boolean values for each item, by index, that reflect whether they are disabled.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type. Refer to the events section for a list of supported events.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

hiddenByIndex

boolean[]

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

---

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconPositionByIndex

string[]

A list of icon positions for each item, by index, relative to labels.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

itemMode

enum

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

Values

dynamic	Options dynamically mapped from an array.
manual	Options manually configured in the IDE.

---

labels

string

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

---

linePosition

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

navigateContainer

boolean

Whether the component is linked to a container for navigation.

---

pluginType

string

The plugin type.

---

selectedIndex

number

The selected value, by index.

---

selectedItem

object

The selected item.

---

selectedLabel

string

The label of the selected value, by index.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

targetContainerId

string

The ID of the linked container.

---

tooltipByIndex

string[]

A list of tooltips for each item, by index.

---

value

string | number

The value.

---

values

string[] | number[]

A list of possible values.

---

Methods

JavaScript API methods for interacting with Tabs. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValue

Clear the current values.

tabs.clearValue()

---

resetValue

Reset the current value to the default value.

tabs.resetValue()

---

scrollIntoView

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

tabs.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

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.

---

---

---

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

tabs.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

---

setHidden

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

tabs.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

tabs.setValue(value)

Parameters

value

string | number

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---