Skip to content
Design System
GitHub

Where someone is in a fixed sequence of steps: done, current, upcoming and error steps, horizontal or vertical, with a compact bar for phones.

API reference

Generated from the types. Every part also takes className.

Stepper

Also takes every prop of <ol> (except onChange).

valuerequired
numberThe current step, from 1. A value past the last step marks every step done.
onValueChange
(step: number) => void
orientation
"vertical" | "horizontal" = "horizontal"
navigable
"none" | "done" | "all" = "none"
errors
number[] = []Steps that failed validation.
size
"sm" | "md" = "md"
labels
Partial<StepperLabels>The words it says, to translate them.

StepperItem

Also takes every prop of <li> (except title).

titlerequired
ReactNode
description
ReactNode
optional
string | booleanAdds "Optional" under the title.
disabled
boolean

StepperCompact

valuerequired
number
totalrequired
number
title
ReactNode
labels
Partial<StepperLabels>The words it says (position, progress), to translate them.