API reference for Stepper. For usage examples, see the React tab.
Stepper.Root
Name
Type
Default
children* (required)
ReactNode
—
The content of the Stepper (or the StepperStep).
orientation
"horizontal" | "vertical"
horizontal
The orientation of the Stepper.
Name
Type
Default
aria-describedby
string
—
Identifies the element (or elements) that describes the object.
aria-details
string
—
Identifies the element (or elements) that provide a detailed, extended description for the object.
aria-label
string
—
Defines a string value that labels the current element.
aria-labelledby
string
—
Identifies the element (or elements) that labels the current element.
id
string
—
The unique identifier for the DOM element.
role
AriaRole
—
The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc.
Name
Type
Default
className
string
—
CSS class names to apply custom styling.
style
CSSProperties
—
Inline styles specified as a React-compatible CSS properties object.
Stepper.Step
Name
Type
Default
step* (required)
number
—
children
ReactNode
—
The content or child elements nested within this component.
content
string
—
state
StepperStepState
inactive
Name
Type
Default
id
string
—
The unique identifier for the DOM element.
role
AriaRole
—
The ARIA role assigned to the element to improve accessibility. Example roles include "button", "navigation", "dialog", etc.
Name
Type
Default
key
Key | null
—
ref
Ref<HTMLLIElement>
—
Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).
