Skip to main content

Steps

Ant Design

The Steps component is Ant Design's step indicator. It shows where a process stands, such as an order's delivery or the stages of a form wizard.

Properties​

Property
Description
Expected Value
ItemsThe steps, each with a title and an optional description, such as [{ title: 'Packed', description: 'Sep 15' }].Array
CurrentPosition of the current step, counting from 0. Steps before it show as done.Number. Default: 0
DirectionLays the steps out in a row or a column.horizontal, vertical. Default: horizontal
SizeSize of the step icons and text.default, small. Default: default
TypeLook of the steps. navigation shows them as a navigation bar, and inline as a compact row of small dots.default, navigation, inline. Default: default
StatusState of the current step: process for in progress, wait for not started, finish for done and error for failed.process, wait, finish, error. Default: process
Progress dotShows small dots instead of numbered circles.On or off. Default: Off
ClickableLets the user click a step to make it the current one.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the current step changes, from a click or an action.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
NextMoves to the next step. Nothing happens on the last step.components.steps1.next()
PreviousMoves to the previous step. Nothing happens on the first step.components.steps1.prev()
Set currentMakes the step at the given Step index, counting from 0, the current one.components.steps1.setCurrent("")
Set visibilityShows the component when true, hides it when false.components.steps1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.steps1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.steps1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
itemsThe steps, each with a title and an optional description, such as [{ title: 'Packed', description: 'Sep 15' }].{{components.steps1.items}}
currentPosition of the current step, counting from 0. Steps before it show as done.{{components.steps1.current}}
directionLays the steps out in a row or a column.{{components.steps1.direction}}
sizeSize of the step icons and text.{{components.steps1.size}}
typeLook of the steps. navigation shows them as a navigation bar, and inline as a compact row of small dots.{{components.steps1.type}}
statusState of the current step: process for in progress, wait for not started, finish for done and error for failed.{{components.steps1.status}}
progressDotShows small dots instead of numbered circles.{{components.steps1.progressDot}}
clickableLets the user click a step to make it the current one.{{components.steps1.clickable}}
isVisibleWhether the component is visible.{{components.steps1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.steps1.isLoading}}
isDisabledWhether the component is disabled.{{components.steps1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.