Onboarding Checklist
Onboarding checklist: progress, hints with CTAs, dismissal and celebration. Pro · Work and teams › Sales and processes
Installation
npx valyro-cli@latest login
npx valyro-cli@latest add onboarding-checklist
npm install valyro-ui-pro
import 'valyro-ui-pro/styles.css';
import { OnboardingChecklist } from 'valyro-ui-pro';
Props
| Prop | Type | Default | |
|---|---|---|---|
tasks * | OnboardingTask[] | Checklist items in order; a task can depend on others, be locked, optional, or carry a call to action. | |
completedIds | string[] | Controlled completedIds; use with onCompletedIdsChange. | |
defaultCompletedIds | string[] | Initial completedIds when uncontrolled. | |
onCompletedIdsChange | (ids: string[]) => void | Called with the new completedIds when it changes. | |
dismissed | boolean | Hidden behind a small "Setup guide" button. | |
defaultDismissed | boolean | false | Initial dismissed when uncontrolled. |
onDismissedChange | (dismissed: boolean) => void | Called with the new dismissed when it changes. | |
manualComplete | boolean | true | Lets people tick tasks themselves. Turn off when tasks complete from product events. Default true. |
title | ReactNode | 'Get started' | Checklist heading. |
description | ReactNode | Text under the heading; replaces the "2 of 5 steps complete" progress line. | |
locale | string | BCP 47 locale for numbers and dates; defaults to the ThemeProvider's, then the browser's. | |
labels | Partial<OnboardingChecklistLabels> | Overrides for the built-in English text; keys left out keep their defaults. |
Related components
- CRM Pipeline — Deal pipeline: stages, amounts and probabilities, drag between stages
- Approval Flow — Multi-stage approvals: sequential and parallel stages, decisions with reasons, history
- Goal Tracker — OKRs: objectives and key results, statuses, confidence, check-ins with history
- Course Path Navigator — Course map: modules, locks, progress and skills, a list on narrow screens
- Calendar View — Event calendar
- Scheduler — Scheduler: day, week, month and resource timeline, drag and drop, recurrence
- Kanban Board — Task board
- Gantt Chart — Gantt charts with dependencies and drag to reschedule
- Booking Slots — Meeting booking: calendar, slots in the guest’s time zone, form and confirmation
- Team Members — Team members: roles, email invites, pending invitations, seat count
- Org Chart — Org chart: zoomable, pannable tree with search and collapsible branches
- Activity Feed — Activity feed
Previous: Goal Tracker · Next: Course Path Navigator · All Work and teams