YuhuanStudioYunUIDocs
Feedback

Steps

A vertical stepper showing what is done, what is in progress and what is still ahead.

A vertical stepper: an ordered list of milestones with a connecting rail, showing what is finished, what is in progress, and what is still ahead.

Use it for a linear flow the reader is in the middle of — onboarding, a multi-page form, a setup wizard. For a bare completion ratio, use Progress instead.

Import

tsx
1import { Steps } from "@yuhuanowo/yunui";

Usage

steps is plain data — each entry is a title plus an optional description. current is the zero-based index of the active step: everything before it renders as done (a filled marker with a check), the step itself is outlined in the primary colour, and everything after stays muted. The rail between two completed steps is filled too, so progress reads at a glance.

Only the active step carries aria-current="step"; the markers and the rail are aria-hidden, so a screen reader hears the list of titles rather than a stream of decorative numbers.

Steps

  1. Create an account

    Verify your email address.

  2. Add a payment method

  3. Invite your team

    Optional — you can do this later.

Props

PropTypeDefaultDescription
currentnumber0Zero-based index of the active step; earlier steps render as completed.
steps*Step[]The milestones, in order, from first to last.

On this page