BigBlocks

Step Indicator

Display progress through multi-step processes with horizontal and vertical variants

Installation

npx shadcn@latest add https://bigblocks-registry.vercel.app/r/step-indicator.json

Usage

import { StepIndicator } from "@/components/ui/step-indicator"
 
const steps = [
  { id: "1", label: "Account", status: "complete" },
  { id: "2", label: "Security", status: "active" },
  { id: "3", label: "Backup", status: "pending" },
  { id: "4", label: "Complete", status: "pending" }
]
 
export default function Example() {
  return <StepIndicator steps={steps} />
}

Examples

Vertical

Use the vertical variant for authentication flows and onboarding processes.

With Descriptions

Add descriptions to guide users through complex authentication steps.

API Reference

StepIndicator

PropTypeDefaultDescription
stepsStep[]-Array of step objects
classNamestring""Additional CSS classes
variant"horizontal" | "vertical""horizontal"Display orientation

Step Interface

interface Step {
  id: string
  label: string
  description?: string
  status: "pending" | "active" | "complete"
}