ValyroUI Русская версия

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

PropTypeDefault
tasks *OnboardingTask[]Checklist items in order; a task can depend on others, be locked, optional, or carry a call to action.
completedIdsstring[]Controlled completedIds; use with onCompletedIdsChange.
defaultCompletedIdsstring[]Initial completedIds when uncontrolled.
onCompletedIdsChange(ids: string[]) => voidCalled with the new completedIds when it changes.
dismissedbooleanHidden behind a small "Setup guide" button.
defaultDismissedbooleanfalseInitial dismissed when uncontrolled.
onDismissedChange(dismissed: boolean) => voidCalled with the new dismissed when it changes.
manualCompletebooleantrueLets people tick tasks themselves. Turn off when tasks complete from product events. Default true.
titleReactNode'Get started'Checklist heading.
descriptionReactNodeText under the heading; replaces the "2 of 5 steps complete" progress line.
localestringBCP 47 locale for numbers and dates; defaults to the ThemeProvider's, then the browser's.
labelsPartial<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