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.
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 |
| ||||||||
Default | left |
data
The data.
Type | string | number | boolean | object | array |
Format | Custom data |
Configurability | Inspector |
Default | null |
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Configurability | Inspector > Interaction > Disabled |
Default | false |
Examples
true
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
[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 |
Default | null |
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 |
Default | null |
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 |
Default | null |
type
The type of action to perform.
Type | string | ||||||||||||||
Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
Allowed Values |
| ||||||||||||||
Default | null |
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 |
| ||||||
Default | fixed |
hiddenByIndex
A list of items, by index, and whether they are hidden.
Type | array |
Array values | boolean |
Configurability | Read-only |
Default | [] |
Examples
[true, false, true]
iconByIndex
A list of icons for each item, by index.
Type | array |
Array values | string |
Configurability | Read-only |
Default | [] |
Examples
["/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 |
| ||||||
Default | null |
Examples
query1
button1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean |
Format | True/False |
Configurability | 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 |
Configurability | Inspector > Appearance > Advanced > Show on mobile |
Default | true |
Examples
true
itemMode
The configuration mode for options.
Type | string | |||||||||
Configurability | Inspector > Content > Options | |||||||||
Allowed Values |
| |||||||||
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 |
Configurability | Read-only |
Default | [] |
Examples
["Label 1", "Label 2", "Label 3"]
linePosition
The position of the line.
Type | string | ||||||||||
Configurability | Inspector | ||||||||||
Allowed Values |
| ||||||||||
Default | null |
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 |
Default | false |
Examples
true
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Configurability | Inspector > Spacing > Margin | |||||||||
Allowed Values |
| |||||||||
Default | 4px 8px |
Examples
4px 8px
navigateContainer
Whether a container is linked for navigation.
Type | boolean |
Configurability | Read-only |
Default | null |
selectedIndex
The selected values, by index.
Type | number |
Format | Integer |
Configurability | Read-only |
Default | [] |
Examples
["Value 1", "Value 2"]
selectedItem
The selected item.
Type | string | number | boolean | object | array |
Format | Custom data |
Configurability | Read-only |
Default | null |
Examples
{"id": "1", "name": "Item 1"}
selectedLabel
The label of the selected value, by index.
Type | string |
Format | string |
Configurability | Read-only |
Default | null |
Examples
Value 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 |
Default | false |
Examples
true
styleVariant
The style variant to use.
Type | string | ||||||
Format | Plain Text | ||||||
Configurability | Inspector > Appearance > Variant | ||||||
Allowed Values |
| ||||||
Default | solid |
Examples
solid
tooltipByIndex
A list of tooltips for each item, by index.
Type | array |
Array values | string |
Configurability | Read-only |
Default | [] |
Examples
["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 |
Default | null |
Examples
Submit
value
The current value.
Type | string | number | boolean | object | array |
Configurability | Read-only |
Default | null |
values
A list of possible values from which to select.
Type | array |
Configurability | Read-only |
Default | null |
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()
Examples
Clear the current value of tabs
.
tabs.clearValue();
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.
tabs.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
Type | string | ||||||
Allowed Values |
|
block
The scroll position relative to the component.
Type | string | ||||||||||
Allowed Values |
|
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.
tabs.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
Type | boolean |
Format | True/False |
Default |
|
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.
tabs.setHidden(hidden)
Parameters
Examples
true
Examples
Hide tabs
.
tabs.setHidden(true);
Unhide tabs
.
tabs.setHidden(false);
tabs.setValue(key, value)
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.
Event | Description |
---|---|
Change | The value is changed. |