The Steps component for Retool Apps
A group of steps that trigger actions when clicked.
Steps is a set of UI elements that represent sequential steps. It can be linked to Container to create Stepped 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.
captionByIndex
A list of captions for each item, by index.
Type | array |
Format | Plain Text |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
data
The data.
Type | string | number | boolean | object | array | ||||||
Format | Custom data | ||||||
Mutability |
|
heightType
Whether the height automatically adjusts to fit content or is a fixed size.
Type | string | ||||||||
Format | Plain Text | ||||||||
Mutability |
| ||||||||
Allowed Values |
| ||||||||
Default |
|
hiddenByIndex
A list of items, by index, and whether they are hidden.
Type | array |
Array values | boolean |
Mutability | Read-only |
Default |
|
Examples
horizontalAlign
The horizontal alignment of the contents.
Type | string | ||||||||
Format | Plain Text | ||||||||
Mutability |
| ||||||||
Allowed Values |
| ||||||||
Default |
|
id
The unique identifier (name).
Type | string | ||||
Format | Plain Text | ||||
Mutability |
| ||||
Default |
|
Examples
indicateCompletedSteps
Whether to indicate completed steps with check marks when showStepNumbers
is true
.
Type | boolean |
Mutability | Read-only |
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
itemMode
The configuration mode for options.
Type | string | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
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
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
margin
The amount of margin to render outside.
Type | string | |||||||||
Format | Plain Text | |||||||||
Mutability |
| |||||||||
Allowed Values |
| |||||||||
Default |
|
Examples
orientation
The orientation.
Type | string | ||||||
Mutability |
| ||||||
Allowed Values |
|
Examples
selectedItem
The selected item.
Type | string | number | boolean | object | array |
Format | Custom data |
Mutability | Read-only |
Default |
|
Examples
selectedLabel
The label of the selected value, by index.
Type | string |
Format | string |
Mutability | Read-only |
Default |
|
Examples
showInEditor
Whether the component remains visible in the editor if hidden
is true
.
Type | boolean | ||||
Format | True/False | ||||
Mutability |
| ||||
Default |
|
Examples
style
Custom style options.
Type | object | ||||
Mutability |
|
tooltipByIndex
A list of tooltips for each item, by index.
Type | array |
Array values | string |
Mutability | Read-only |
Default |
|
Examples
tooltipText
The tooltip text to display next to the label on hover.
Type | string | ||||
Format | Markdown | ||||
Mutability |
| ||||
Default |
|
Examples
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
steps.resetValue()
Examples
steps.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
steps.scrollIntoView(options)
Parameters
Examples
steps.setHidden()
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
steps.setHidden(hidden)
Parameters
Examples
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 |
---|