Skip to content
VenusUI
Get started

Stepper

Progress through a multi-step flow, horizontal or vertical.

Preview

Installation

npx shadcn@latest add @venusui/stepper

Run this in a project set up with shadcn. If you haven’t set it up yet, run npx shadcn@latest init first.

Files added to your project

Paths use the default shadcn aliases. The CLI follows the aliases in your components.json.

  • @/components/ui/stepper.tsx

Usage

The code behind the preview above.

stepper-demo.tsx

import { Stepper } from "@/components/ui/stepper"

export default function StepperDemo() {
  return (
    <Stepper
      className="max-w-lg"
      current={1}
      steps={[
        { title: "Account", description: "Email and password" },
        { title: "Workspace", description: "Name your team" },
        { title: "Invite", description: "Add teammates" },
      ]}
    />
  )
}

API reference

PropTypeDefaultDescription
steps{ title: string; description?: string }[]—Steps in order. Required.
currentnumber—Index of the current step. Earlier steps are complete. Required.
orientation"horizontal" | "vertical""horizontal"Layout direction.

All <ol> props except children.

Requirements

  • lucide-react and Tailwind CSS v4. Works in Server Components.

Customization

  • Use vertical on narrow screens or for long step descriptions.

Accessibility

  • An ordered list; the current step has aria-current="step" and finished steps say “(completed)”.

Troubleshooting

Connector lines overlap text.
Keep step titles short in horizontal mode, or switch to vertical.
Unknown registry "@venusui"
Your shadcn CLI couldn’t find the namespace in the shadcn registry index. Use the latest CLI (npx shadcn@latest), install by URL, or register it with its address: npx shadcn@latest registry add @venusui=https://venusui.com/r/{name}.json.
No components.json found
Run npx shadcn@latest init in your project first.
Loading preview

Analog Clock

Data display

A station clock whose needle waits at twelve; drag the minute hand to set it by hand.

Loading preview

Animated Tabs

Navigation

Tabs with a sliding underline and fading panels, following the WAI-ARIA tabs pattern.

Loading preview

Avatar Stack

Data display

Overlapping avatars with a +N counter that spread apart on hover.