A get-started checklist with a progress ring and segmented bar, expandable steps with actions, checkable tasks and a short celebration when everything is done.
The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.
Installation
Get a Pro licence key.
The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once
regular price $99for this and every other Pro item. Tax included.Money back if it does not work.Once per project: add the Pro registry and your licence key.
components.json{ "registries": { "@ballmac": "https://ui.ballmac.com/r/{name}.json", "@ballmac-pro": { "url": "https://ui.ballmac.com/r/pro/{name}.json", "headers": { "Authorization": "Bearer ${BALLMAC_LICENSE_KEY}" } } } }.env.localBALLMAC_LICENSE_KEY=your-licence-keyAdd it.
$ pnpm dlx shadcn@latest add @ballmac-pro/onboarding-checklist
Usage
import { OnboardingChecklist } from "@/components/ballmac/onboarding-checklist"The full example is in the Code tab above.
Examples
Complete and dismissible
The source is part of Ballmac UI Pro.
Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.
$49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.
API reference
| Prop | Type | Default |
|---|---|---|
steps*Tasks, in the order you want people to do them. | OnboardingStep[] | — |
completedControlled list of completed step ids. | string[] | — |
defaultCompletedInitial completed ids when uncontrolled. | string[] | [] |
onCompletedChangeCalled with the new list of completed ids whenever one is checked or unchecked. | (completed: string[]) => void | — |
titleHeading. | string | — |
descriptionText under the heading while tasks remain. | string | — |
completeMessageMessage shown once every step is done. | string | — |
defaultOpenIdWhich step is open at first. Defaults to the first unfinished one. | string | — |
onDismissAdds a dismiss button and calls this when it is pressed. | () => void | — |
Also accepts the standard attributes of its root element.
Accessibility
| Key | Action |
|---|---|
| Tab | Reaches each step's checkbox and its expand button |
| Space | Toggles a step done (role checkbox) |
| Enter / Space on the title | Expands or collapses the step (aria-expanded) |
| Reduced motion | Check, bar and panel changes are instant |
Quality scorecard
Every applicable check passes
Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.
Passed: Accessibility scan
No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).
Passed: Small screens
No sideways scrolling at 360, 390 or 1280 px wide.
Passed: Reduced motion
No endless animation to begin with.
Passed: Right to left
Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).
Passed: Clean console
No console errors or React hydration errors while loading.
Passed: Keyboard
13 tab stops, each showing a visible change when it takes focus. 4 documented keys.
Not applicable: Loading, empty and error
Does not show data or take submissions.
Passed: Automated tests
Covered by onboarding-checklist.test.tsx.
For information: Footprint
3.7 KB of source (gzip) in 1 file. Installs motion, lucide-react.
Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.
Use with AI
steps: {id,title,description,action}. completed/defaultCompleted/onCompletedChange track progress. The open step shows its description and action. With the shadcn MCP server set up (guide), ask your agent:
Add the Ballmac UI Onboarding Checklist (@ballmac-pro/onboarding-checklist) to this project with the shadcn MCP, then use it where it fits.
Use it for
- First-run setup for new accounts
- Activation nudges in a dashboard corner
Not for
- Multi-page wizards; use stepper-form
- A plain progress bar; use progress
Registry JSON (needs your licence key): https://ui.ballmac.com/r/pro/onboarding-checklist.json
Credits
Covered by the Ballmac UI Pro license.
Pairs well with
Progress Ring
A token-colored circular progress meter with a readable center and accessible value.
Card
A composable content surface with compact spacing, an action slot, and optional interactive feedback.
Button
A button with six variants, three sizes, a pill shape and a built-in loading state. buttonVariants() styles links the same way.
User Menu
An account menu on the dropdown: avatar or avatar-with-name trigger, a header card with plan, link groups with shortcuts and badges, a theme submenu and sign out.