structyl

Stepper

stable

A multi-step process indicator.

Basic usage

1
2
3

Examples

With labels

Each step labeled to describe what happens at that stage.

Account
Profile
Billing

Labeled checkout flow

Stepper supports active step state, titles, descriptions and vertical orientation.

Plan
Billing
Confirm
CreatedWorkspace is ready.
ReviewedChecks passed.

Semantic colors

Color prop sets the completed and active step indicator color.

primary
Active
Next
success
Active
Next
error
Active
Next
warning
Active
Next

Features

  • Complete / current / upcoming states.
  • Horizontal or vertical.

Installation

bash
pnpm dlx structyl add stepper

API Reference

Stepper.Root

A multi-step progress indicator.

PropTypeDefault
activeStepnumber

Zero-based index of the current step.

orientation'horizontal' | 'vertical'

Layout axis.

'horizontal'

Stepper.Step

A single step.

PropTypeDefault
indexnumber

Zero-based position of this step.

Stepper.Separator

Connector line between steps.

PropTypeDefault
Stepper | structyl