structyl

Stepper API

View component

The full prop reference for the Stepper component. A multi-step process indicator.

Import

tsx
import { Stepper } from '@structyl/styled';

Props

Primitives.Root

Headless numerical stepper component with increment/decrement controls

PropTypeDefault
value#number

Controlled current value of the stepper

defaultValue#number

Initial value when uncontrolled

0
onChange#(value: number) => void

Callback fired when value changes

min#number

Minimum allowed value; decrement is clamped to this

0
max#number

Maximum allowed value; increment is clamped to this

Infinity
step#number

Step size for increment/decrement operations

1
className#string

CSS class name applied to the root div element

Styled.Root

Root progress/visual stepper component that provides context and wraps Step children

PropTypeDefault
activeStep#number

Index 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#string

CSS class name applied to the root div

children#React.ReactNode

Step and Separator components to be rendered within the stepper

Styled.Step

Individual step component that displays status indicator and step content

PropTypeDefault
index#number

Zero-based index of this step; used to determine status (complete/current/upcoming)

className#string

CSS class name applied to the step div

children#React.ReactNode

Step content; defaults to Indicator if not provided

Styled.Title

Semantic wrapper for step title text

PropTypeDefault
className#string

CSS class name applied to the span

children#React.ReactNode

Title text content

Styled.Description

Semantic wrapper for step description text

PropTypeDefault
className#string

CSS class name applied to the span

children#React.ReactNode

Description text content

Styled.Separator

Horizontal or vertical divider between steps; orientation auto-adapts from parent Root

PropTypeDefault
className#string

CSS class name applied to the separator div

Source code

If you didn't find what you need here, read the component implementation .

structyl — Accessible React Component Library