Skip to main content

The Tabs component for classic apps

A group of tabs that trigger actions when clicked.

Classic apps

You're viewing documentation for classic apps, which use Retool's original app editor. The new app builder is the recommended way to build apps and where Retool focuses new development.

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

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.

alignment​

The horizontal alignment of the contents.

Type string
Format Plain Text
Configurability Inspector > Appearance > Align
Allowed Values
ValueDescription
left

Left alignment.

center

Center alignment.

right

Right alignment.

Defaultleft

data​

The data.

Type string | number | boolean | object | array
Format Custom data
Configurability Inspector
Defaultnull

disabled​

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

Type boolean
Format True/False
Configurability Inspector > Interaction > Disabled
Defaultfalse
Examples
falsetrue

disabledByIndex​

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

Type array
Array values boolean
Configurability Read-only
Default[]
Examples
false[true, false, true]

events​

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

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
Array Object Properties

event​

The event that triggers the action. Refer to the events section for details of available events for this object.

Type string
Configurability Inspector > Interaction > Event handlers > Event
Defaultnull

method​

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

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Defaultnull

type​

The type of action to perform.

Type string
Configurability Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values
ValueDescription
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).

Defaultnull

heightType​

Whether the height automatically adjusts to fit content or is a fixed size.

Type string
Format Plain Text
Configurability Inspector > Spacing > Height
Allowed Values
ValueDescription
fixed

Fixed height.

auto

Expand to fit content.

Defaultfixed

hiddenByIndex​

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

Type array
Array values boolean
Configurability Read-only
Default[]
Examples
false[true, false, true]

iconByIndex​

A list of icons for each item, by index.

Type array
Array values string
Configurability Read-only
Default[]
Examples
false["/icon:bold/shopping-gift", "/icon:bold/interface-user-single", "/icon:bold/interface-align-layers-1"]

iconPositionByIndex​

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

Type array
Array values string
Configurability Read-only
Allowed Values
ValueDescription
left

Left.

right

Right.

Defaultnull

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
Defaulttabs1
Examples
falsequery1
falsebutton1

isHiddenOnDesktop​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on desktop
Defaultfalse
Examples
falsetrue

isHiddenOnMobile​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on mobile
Defaulttrue
Examples
falsetrue

itemMode​

The configuration mode for options.

Type string
Configurability Inspector > Content > Options
Allowed Values
ValueUI OptionDescription
dynamicMapped

Options dynamically mapped from an array.

staticManual

Options manually configured in the IDE.

Defaultdynamic
Examples
false"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
Configurability Read-only
Default[]
Examples
false["Label 1", "Label 2", "Label 3"]

linePosition​

The position of the line.

Type string
Configurability Inspector
Allowed Values
ValueDescription
top

Top.

bottom

Bottom.

left

Left.

right

Right.

Defaultnull

maintainSpaceWhenHidden​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Maintain space when hidden
Defaultfalse
Examples
falsetrue

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
false4px 8px

navigateContainer​

Whether a container is linked for navigation.

Type boolean
Configurability Read-only
Defaultnull

selectedIndex​

The selected values, by index.

Type number
Format Integer
Configurability Read-only
Default[]
Examples
false["Value 1", "Value 2"]

selectedItem​

The selected item.

Type string | number | boolean | object | array
Format Custom data
Configurability Read-only
Defaultnull
Examples
false{"id": "1", "name": "Item 1"}

selectedLabel​

The label of the selected value, by index.

Type string
Formatstring
Configurability Read-only
Defaultnull
Examples
falseValue 1

showInEditor​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Always show in edit mode
Defaultfalse
Examples
falsetrue

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

styleVariant​

The style variant to use.

Type string
Format Plain Text
Configurability Inspector > Appearance > Variant
Allowed Values
ValueDescription
lineBottom
pill
Defaultsolid
Examples
falsesolid

targetContainerId​

The ID of the linked container.

Type string
Configurability Read-only
Defaultnull

tooltipByIndex​

A list of tooltips for each item, by index.

Type array
Array values string
Configurability Read-only
Default[]
Examples
false["Tooltip 1", "Tooltip 2"]

tooltipText​

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

Type string
Format Markdown
Configurability Inspector > Content > Add-ons > Helper text
Defaultnull
Examples
falseSubmit

value​

The current value.

Type string | number | boolean | object | array
Configurability Read-only
Defaultnull

values​

A list of possible values from which to select.

Type array
Configurability Read-only
Defaultnull

Methods​

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

tabs.clearValue()​

Clear the current values.

Definition
tabs.clearValue()
Examples

Clear the current value of tabs.

tabs.clearValue();

tabs.resetValue()​

Reset the current value to the default value.

Definition
tabs.resetValue()
Examples

Reset the current value of tabs.

tabs.resetValue();

tabs.scrollIntoView()​

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

Definition
tabs.scrollIntoView(options)
Parameters

options​

The scroll options.

Type object
Object Properties

behavior​

The scroll behavior.

Type string
Allowed Values
ValueDescription
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
ValueDescription
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 tabs into view.

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

tabs.setDisabled()​

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

Definition
tabs.setDisabled(disabled)
Parameters

disabled​

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

Type boolean
Format True/False
Default
false
Examples
true
Examples

Disable tabs.

tabs.setDisabled(true);

Enable tabs.

tabs.setDisabled(false);

tabs.setHidden()​

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

Definition
tabs.setHidden(hidden)
Parameters

hidden​

Whether this object is hidden from view.

Type boolean
Format True/False
Default
false
Examples
true
Examples

Hide tabs.

tabs.setHidden(true);

Unhide tabs.

tabs.setHidden(false);

tabs.setValue()​

Set the current value.

Definition
tabs.setValue(value)
Parameters

value​

The value.

Type string | number | boolean | object | array
Examples

Set the current value of tabs to userValue.

tabs.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.

EventDescription
ChangeThe value is changed.