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.
Settings
Tabs includes the following configurable options when building apps in the IDE.
AlignDataDisabledEvent handlersShow 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.
disabledByIndex
A list of boolean values for each item, by index, that reflect whether they are disabled.
global
Whether the object is globally scoped for use in all app pages.
Whether the component is visible.
hiddenByIndex
A list of items, by index, and whether they are hidden.
iconByIndex
A list of icons for each item, by index.
Values
iconPositionByIndex
A list of icon positions for each item, by index, relative to labels.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The configuration mode for option lists. Either dynamic
for mapped options or static
for manual options.
Values
labels
A list of labels for each item. Falls back to the corresponding value
if no label is provided.
linePosition
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
navigateContainer
Whether the component is linked to a container for navigation.
pluginType
The plugin type.
selectedIndex
The selected value, by index.
selectedItem
The selected item.
selectedLabel
The label of the selected value, by index.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
targetContainerId
The ID of the linked container.
tooltipByIndex
A list of tooltips for each item, by index.
values
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
setDisabled
Set the disabled
value to toggle whether the input field is disabled. Defaults to true
without a parameter.
tabs.setDisabled(disabled)
Parameters
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
tabs.setHidden(hidden)
Parameters
setValue
Set the current value.
tabs.setValue(value)
Parameters
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.