The Wizard web component
A container for a series of steps with multiple branches and outcomes.
Wizard groups component into a series of steps that follow a linear path or branch into multiple ones. It supports running queries on step change or reset, virtual steps that display a loading screen, and setting the initial step dynamically.
Settings
Wizard includes the following configurable options when building apps in the IDE.
Event handlersShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles |
Properties
All properties for Wizard with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
currentStep
The generated ID for step.
customInitialStepName
The customized name for the first step in the wizard.
Properties
event
The event type.
Values
change | A user changes the value. |
click | A user clicks or taps the component. |
submit | A user submits the value. |
focus | A user selects the input field. |
blur | A user deselects the input field. |
scan | A user scans a barcode. |
open | A user opens the component. |
close | A user closes the component. |
true | A user sets the value to |
false | A user sets the value to |
select | A user selects a value. |
clear | A user clears the value. |
upload | A user uploads a file. |
parse | An uploaded file is parsed. |
inputValueChange | A user changes the value of the input field. |
method
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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
Whether the object is globally scoped for use in all app pages.
hideResetButton
Whether to hide the reset button.
id
The unique identifier.
initialStep
The generated ID for the first step in the wizard.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
onReset
The query to run when the Reset button is clicked.
onStepChange
The query to run when users navigate between steps.
pluginType
The plugin type.
scroll
Whether to use scroll navigation.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
spinWhenChildrenAreFetching
Whether to use a loading state if nested components are fetching data.
steps
A list of step names.
Methods
JavaScript API methods for interacting with Wizard. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
reset
Reset all child inputs to default values or clears them if no default values are set.
wizard.reset()
setStepId
Set the current step ID.
wizard.setStepId(stepId)
Parameters
stepId
The ID of the step.
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.