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
| Prop | Type | Default | Description |
|---|---|---|---|
index | number | — |
#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
| Prop | Type | Default | Description |
|---|---|---|---|
index | number | — |
#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
| Prop | Type | Default | Description |
|---|---|---|---|
size | String as PropType<"sm" | "md" | "lg"> | "md" | One rung of the control-height ladder every indicator stands on. |
count | number | The total number of steps | |
defaultStep | number | The initial value of the stepper when rendered. Use when you don't need to control the value of the stepper. | |
id | string | The unique identifier of the machine. | |
ids | steps.ElementIds | The custom ids for the stepper elements | |
isStepSkippable | (index: number) => boolean | Function that returns whether a step can be skipped | |
isStepValid | (index: number) => boolean | Function that returns whether a step is valid | |
linear | boolean | If true, the stepper requires the user to complete the steps in order | |
orientation | 'horizontal' | 'vertical' | "horizontal" | The orientation of the stepper |
step | number | The controlled value of the stepper |
| Event | Payload |
|---|---|
stepChange | details: StepChangeDetails |
stepComplete | — |
stepInvalid | details: StepInvalidDetails |
update:step | step: 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.