Elements

Reference

Steps

Steps — linear progress through a sequence. Parts: Root, List, Item, Trigger, Indicator, Separator, Content, PrevTrigger, NextTrigger, Progress. Indicator and Separator carry data-complete / data-current / data-incomplete.

Root · List · Item · Trigger · Indicator · Separator · Content · NextTrigger · PrevTrigger · Progress

#CompletedContent

A styled part — no props of its own; it takes the anatomy's shared styling.

#Content

PropTypeDefaultDescription
indexnumber—

#Indicator

A styled part — no props of its own; it takes the anatomy's shared styling.

#ItemContext

A styled part — no props of its own; it takes the anatomy's shared styling.

#Item

PropTypeDefaultDescription
indexnumber—

#List

A styled part — no props of its own; it takes the anatomy's shared styling.

#NextTrigger

A styled part — no props of its own; it takes the anatomy's shared styling.

#PrevTrigger

A styled part — no props of its own; it takes the anatomy's shared styling.

#Progress

A styled part — no props of its own; it takes the anatomy's shared styling.

#Root

PropTypeDefaultDescription
sizeString as PropType<"sm" | "md" | "lg">"md"One rung of the control-height ladder every indicator stands on.
countnumberThe total number of steps
defaultStepnumberThe initial value of the stepper when rendered. Use when you don't need to control the value of the stepper.
idstringThe unique identifier of the machine.
idssteps.ElementIdsThe custom ids for the stepper elements
isStepSkippable(index: number) => booleanFunction that returns whether a step can be skipped
isStepValid(index: number) => booleanFunction that returns whether a step is valid
linearbooleanIf true, the stepper requires the user to complete the steps in order
orientation'horizontal' | 'vertical'"horizontal"The orientation of the stepper
stepnumberThe controlled value of the stepper
EventPayload
stepChangedetails: StepChangeDetails
stepComplete—
stepInvaliddetails: StepInvalidDetails
update:stepstep: number

#Separator

A styled part — no props of its own; it takes the anatomy's shared styling.

#Trigger

A styled part — no props of its own; it takes the anatomy's shared styling.