Progress tracker preview

Progress tracker

Onboarding checklist with an animated progress bar, ticks that draw themselves and auto play

  • Group
    Progress
  • Origin
    Copied · affectUI · source
  • License
    MIT
  • Added
    Oct 18
npx shadcn@latest add @deank/progress-tracker

The registry stays private. Install from the repo with a GitHub token — see the README.

Usage

import { ProgressTracker } from "@/registry/components/progress-tracker/progress-tracker";

<ProgressTracker steps={[/* … */]} />

Props

NameTypeDefaultDescription
stepsProgressStep[]Each step has an id, a label, an optional done flag and icon
titlestring"Getting started"Heading above the bar
autoPlaybooleanfalseTicks the open steps one by one and starts over – stops when someone clicks or types
intervalnumber2200Pause between two automatic steps, in ms
onChange(steps: ProgressStep[]) => voidCalled with every step and its state
classNamestringExtra class on the card

When to use

- Onboarding checklists that guide new users through their first steps - Any short list of tasks where progress should feel rewarding

When not to use

Step-by-step wizards that block navigation.

Related

Checklist · Profile menu