Skip to main content

The Wizard component for Retool Apps

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.

Demo

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​

string

The generated ID for step.

customInitialStepName​

string

The customized name for the first step in the wizard.

events​

object[]

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

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

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

The type of action to perform.

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​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

hideResetButton​

boolean

Whether to hide the reset button.

id​

string

The unique identifier.

initialStep​

string

The generated ID for the first step in the wizard.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

onReset​

enum

The query to run when the Reset button is clicked.

onStepChange​

enum

The query to run when users navigate between steps.

pluginType​

string

The plugin type.

scroll​

boolean

Whether to use scroll navigation.

Whether to remain visible in the editor if hidden is true.

spinWhenChildrenAreFetching​

boolean

Whether to use a loading state if nested components are fetching data.

steps​

string[]

A list of step names.

style​

object

Custom style options in use. Not all style options may be available for all components.

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​

string

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.