Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

Stepper

A controlled onboarding sequence with back and next actions.

Preview

Live preview

Changes apply to this preview only.

step 2

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Read-only

A read-only composition using Stepper.

Open preview

Vertical

A vertical composition using Stepper.

Open preview

Disabled

A disabled step is skipped by the clickable navigation.

Open preview

Usage

Keep completion validation in the application; a step change is not proof a form is valid.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluStepperProps

Type source
PimoluStepperProps public API
NameTypeDefaultDescription
childrenRequiredReactNode—Public Pimolu prop; see the source declaration for details.
activeStepnumber | undefined—Controlled active step, starting at 1.
defaultActiveStepnumber | undefined1Initial step when uncontrolled. Defaults to 1.
onStepChange((step: number) => void) | undefined—Public Pimolu prop; see the source declaration for details.
orientation"horizontal" | "vertical" | undefined"horizontal"Layout of the steps. Defaults to "horizontal".
clickableboolean | undefinedfalseLet the user jump to a step. Defaults to false.
aria-labelstring | undefined—Accessible name of the ordered list.
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
childrenRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

activeStep

number | undefined

No default extracted.

Controlled active step, starting at 1.

defaultActiveStep

number | undefined

Default: 1

Initial step when uncontrolled. Defaults to 1.

onStepChange

((step: number) => void) | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

orientation

"horizontal" | "vertical" | undefined

Default: "horizontal"

Layout of the steps. Defaults to "horizontal".

clickable

boolean | undefined

Default: false

Let the user jump to a step. Defaults to false.

aria-label

string | undefined

No default extracted.

Accessible name of the ordered list.

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

PimoluStepperItemProps

Type source
PimoluStepperItemProps public API
NameTypeDefaultDescription
stepRequirednumber—Step number, starting at 1.
titleRequiredReactNode—Public Pimolu prop; see the source declaration for details.
descriptionReactNode—Public Pimolu prop; see the source declaration for details.
disabledboolean | undefinedfalsePublic Pimolu prop; see the source declaration for details.
childrenReactNode—Public Pimolu prop; see the source declaration for details.
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
stepRequired

number

No default extracted.

Step number, starting at 1.

titleRequired

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

description

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

disabled

boolean | undefined

Default: false

Public Pimolu prop; see the source declaration for details.

children

ReactNode

No default extracted.

Public Pimolu prop; see the source declaration for details.

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

Accessibility

  • Name the sequence and identify the active step in text as well as appearance.
Read the accessibility guide →