Standard Overlays & Menus
Onboarding Checklist Panel
A corner-docked getting-started checklist that collapses to a progress-ring badge, with its state persisted and a once-only completion callback.
$ velocityx add standard-onboarding-checklist-panel
Built for react.
Needs react already installed
as a peer dependency.
An Astro-only project needs @astrojs/react wired up first — this won't run on its own in plain Astro.
Full docs for Onboarding Checklist Panel →
Needs a licence key — buy lifetime access here, then
velocityx login once.
- Framework
- react
- Source
- 288 lines
- OnboardingChecklistPanel.jsx
- Runtime
- Interactive
- runs in the browser
- Theme
- 8 tokens
- re-themes from your scale
- Dark mode
- Built in
- dark: variants
- Accessibility
- 8 ARIA
- plus keyboard support
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| steps | { id: string, label: string, description?: string, complete: boolean, actionLabel?: string, actionHref?: string }[] | No | [] | |
| onAllComplete | () => void | Yes | ||
| onDismiss | () => void | Yes | dismiss entirely, separate from collapsing | |
| title | string | No | 'Getting started' | |
| persistKey | string | Yes | localStorage key for collapsed state | |
| open | boolean | Yes | ||
| defaultOpen | boolean | No | true | |
| onOpenChange | (open: boolean) => void | Yes | ||
| className | string | No | '' |
Using it
The smallest call that compiles — required props only. The import is
written for your own file at src/components/Example.jsx;
adjust the relative import if yours sits elsewhere.
Everything optional is in the table above, with its default.
import OnboardingChecklistPanel from './velocity/standard-onboarding-checklist-panel/OnboardingChecklistPanel';
export default function Example() {
return (
<OnboardingChecklistPanel
onAllComplete={() => {}}
onDismiss={() => {}}
persistKey='persistKey'
open={true}
onOpenChange={() => {}}
/>
);
}Built from Onboarding Checklist Panel's own prop signature and the path the CLI installs it to, so it can't drift from either.
Accessibility
- ARIA roles
- progressbar, region
- ARIA attributes
- aria-hidden, aria-label, aria-labelledby, aria-valuemax, aria-valuemin, aria-valuenow
- Keyboard
- Handles key events directly
- Focus
- Moves or traps focus deliberately
- Motion
- Respects prefers-reduced-motion
Read from the source, not asserted — anything not listed simply isn't in this component's markup.
Behaviour
- Ships client JS
- Yes — this one needs to hydrate
- React hooks
- useCallback, useEffect, useId, useRef, useState
- Browser APIs
- localStorage
- Dark mode
- Carries its own dark: variants
Theming
This component paints from 8 steps of
your theme scale — no hardcoded colours, and no font-family of
its own, so your type cascade wins. Override the variables and it follows.
primary-50primary-100primary-300primary-400primary-500primary-600primary-700primary-900Get the Velocity preset and CSS theme from the public source guide. The CLI theme command is not available on npm yet.
File this creates
The CLI writes this path into your project — nothing
else moves. Paths are under your source root, which defaults to
src/; pass
--dest if yours is elsewhere.
-
src/components/velocity/standard-onboarding-checklist-panel/OnboardingChecklistPanel.jsx288 lines
Copy the paths
src/components/velocity/standard-onboarding-checklist-panel/OnboardingChecklistPanel.jsxOnboarding Checklist Panel — questions
How do I install Onboarding Checklist Panel?
Run velocityx add standard-onboarding-checklist-panel . The CLI writes the source straight into your project — it is not a runtime package dependency.
Do I need a licence for Onboarding Checklist Panel?
Yes. It is part of the lifetime library — buy access at https://aidxn.com/shop/velocity-x-component-library/, authenticate once, and install it. Your lifetime licence includes future component updates.
Can I edit Onboarding Checklist Panel after installing it?
Yes — the files are yours once written. The CLI compares its lockfile hash before upgrades and refuses to overwrite code you changed.
Does Onboarding Checklist Panel ship JavaScript to my users?
Yes. It runs in the browser (useCallback, useEffect, useId, useRef, useState) and uses localStorage, so it needs to hydrate — in Astro, give it a client:* directive.
Will Onboarding Checklist Panel match my brand colours?
Yes. It paints entirely from your theme scale — 8 steps of primary-* / accent-* — with no hardcoded hex values and no font-family of its own. Override the theme CSS variables and it follows your design system instead of ours.
Is Onboarding Checklist Panel accessible?
It ships ARIA roles (progressbar, region), 6 ARIA attributes, its own keyboard handling, deliberate focus management. That is read directly from the source rather than claimed — you should still test it in the context you drop it into.
Does Onboarding Checklist Panel pull in any dependencies?
No external ones. Every component in the library is built with react/react-dom or plain Astro only — no GSAP, Radix, Swiper or Headless UI — which is what makes dropping it into an existing project safe.
Set up & reference
All docs →Install this component:
$ velocityx add standard-onboarding-checklist-panel- 2. Install the theme — run this first, once per project Do this once per project, before your first component.
- The palette gotcha — this one bites silently Silent failure — the component renders, just unstyled.
- Your edits are safe by default What happens to your changes when you upgrade.
- You own the code What you are actually buying.
Related components
More from Standard Overlays & Menus.
A right-docked panel manager for multiple drafts at once.
reactConfirmation dialog with least-destructive initial focus, async action support, Escape cancellation, and focus restoration.
reactA small marker pinned to a live element to flag something new or needing attention, that opens its explanation on click rather than hover. The badge itself persists until the user explicitly dismisses it, so a flagged field stays flagged until actually read, not until the cursor happens to pass over it.
reactStandardAssignmentDrawer — the right-docked panel for assigning one record: who, where, what state, and a note, with the record's context kept visible beside the fields instead of behind a dimmed modal.
react