Stepper API
View componentThe full prop reference for the Stepper component. A multi-step process indicator.
Import
import { Stepper } from '@structyl/styled';Props
Primitives.Root
Headless numerical stepper component with increment/decrement controls
| Prop | Type | Default |
|---|---|---|
| value# | numberControlled current value of the stepper | — |
| defaultValue# | numberInitial value when uncontrolled | 0 |
| onChange# | (value: number) => voidCallback fired when value changes | — |
| min# | numberMinimum allowed value; decrement is clamped to this | 0 |
| max# | numberMaximum allowed value; increment is clamped to this | Infinity |
| step# | numberStep size for increment/decrement operations | 1 |
| className# | stringCSS class name applied to the root div element | — |
Styled.Root
Root progress/visual stepper component that provides context and wraps Step children
| Prop | Type | Default |
|---|---|---|
| activeStep# | numberIndex of the currently active step; determines step status (complete/current/upcoming) | — |
| orientation# | 'horizontal' | 'vertical'Layout direction of the stepper | 'horizontal' |
| color# | 'primary' | 'secondary' | 'error' | 'warning' | 'info' | 'success'Color scheme for completed and current step indicators | 'primary' |
| className# | stringCSS class name applied to the root div | — |
| children# | React.ReactNodeStep and Separator components to be rendered within the stepper | — |
Styled.Step
Individual step component that displays status indicator and step content
| Prop | Type | Default |
|---|---|---|
| index# | numberZero-based index of this step; used to determine status (complete/current/upcoming) | — |
| className# | stringCSS class name applied to the step div | — |
| children# | React.ReactNodeStep content; defaults to Indicator if not provided | — |
Styled.Title
Semantic wrapper for step title text
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class name applied to the span | — |
| children# | React.ReactNodeTitle text content | — |
Styled.Description
Semantic wrapper for step description text
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class name applied to the span | — |
| children# | React.ReactNodeDescription text content | — |
Styled.Separator
Horizontal or vertical divider between steps; orientation auto-adapts from parent Root
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class name applied to the separator div | — |
Source code
If you didn't find what you need here, read the component implementation .