Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Navigation

Stepper

Shows a person’s current position and progress through an ordered multi-step flow.

FrameworksAstro · React · Elements

Registry commandlumen add Stepper

InteractionNative markup

01

See it and copy it

Framework example

Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.

AstroCode target · live preview uses Astro
  1. 1AccountYour profile is ready
  2. 2WorkspaceChoose how your team works
  3. 3ReviewConfirm and finish setup
View Stepper code

Framework usage

Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.
astro
---
import { Stepper } from '@santi020k/lumen-astro'
---

<Stepper
  steps={[
    { title: 'Account', description: 'Your profile is ready' },
    { title: 'Workspace', description: 'Choose how your team works' },
    { title: 'Review', description: 'Confirm and finish setup' }
  ]}
  currentStep={1}
/>
Edit Stepper in browser
02

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add Stepper
lumen add Stepper

API reference

Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.

AttributeValuesDefaultDescription
stepsArray<string | { label, description? }>[]Defines the ordered steps.
currentStepnumber0Sets the zero-based active step.
orientation"horizontal" | "vertical""horizontal"Controls the step layout direction.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.

Web docsFull catalog