Skip to content
Product block

Setup Checklist with Progress

The get-started card that ships with its first item already ticked, a native <progress> element rather than a div bar, and a dismiss control that appears only once there is nothing left to abandon.

230 lineslucide-reactAdded 8 Aug 2026Updated 10 Sept 2026
  • onboarding
  • checklist
  • progress
  • activation
  • getting started

What's included

  • components/onboarding-checklist.tsx
  • Needs lucide-react

Works with

  • React
  • Next.js
  • Tailwind CSS
  • TypeScript

npx hoverlab add onboarding-checklist

Or over MCP, from your editor's agent — no account needed.

License

Free to read, copy and install, for personal and non-commercial projects. Shipping it in client work or a paid product needs Pro ($79 once). The source lands in your repo and stops being ours — no attribution, nothing to upgrade.

Was this useful?

Start a page with this section — add more, order them, and leave with the page source.

Preview

Finish setting up

Five short steps and your workspace is ready to use.

1 of 5
  • Create your account

    Done — welcome aboard.

  • Create your first project

    A project holds your environments, keys and deployments.

    Start2 min
  • Install the CLI

    One command, and your terminal can deploy.

    Start3 min
  • Invite a teammate

    Projects are more useful with someone to share them with.

    Start1 min
  • Connect a domain

    Point a hostname at your first deployment.

    Start5 min

Rendered live in your current theme — this is the same component whose source is below, not a screenshot of it.

Source

components/onboarding-checklist.tsx
'use client'

/**
 * <OnboardingChecklist> — the "get set up" card that follows a new account.
 *
 * The thing that makes a checklist work is that the first item is already
 * ticked. An empty list of six tasks is a bill; a list with one done and a
 * bar showing 1/6 is progress you did not have to earn, and completion
 * rates follow from it. So `steps[0]` ships complete by default here, and
 * it is a real step ("Create your account") rather than a fake one.
 *
 * Details worth keeping:
 *
 *  - It is a `<ul>` of real `<button>`s, not divs with click handlers, so
 *    every row is keyboard-reachable and announces as an action.
 *  - Progress is a native `<progress>` element with a visible label. A
 *    div-with-a-width bar is invisible to assistive tech, and `<progress>`
 *    reports its value without any ARIA.
 *  - Completed rows keep their text legible rather than dropping to 40%
 *    opacity. Struck-through grey is the usual choice and it makes the
 *    record of what you did unreadable.
 *  - The dismiss control appears only once every step is done. Offering
 *    "hide this" on an incomplete checklist is an invitation to abandon it.
 *
 * `onToggle` reports the step id and its new state; wire it to your own
 * persistence. Local state is the default so the preview is interactive.
 */

import * as React from 'react'
import { ArrowRight, Check, X } from 'lucide-react'

export interface ChecklistStep {
  id: string
  label: string
  description: string
  /** Where the step is actually completed. */
  href?: string
  /** Rough time to finish — sets expectations before the click. */
  minutes?: number
}

export interface OnboardingChecklistProps {
  heading?: string
  subheading?: string
  steps?: ChecklistStep[]
  /** Ids that start complete. Defaults to the first step. */
  initialComplete?: string[]
  completeMessage?: string
  onToggle?: (id: string, complete: boolean) => void
  onDismiss?: () => void
  className?: string
}

const DEFAULT_STEPS: ChecklistStep[] = [
  {
    id: 'account',
    label: 'Create your account',
    description: 'Done — welcome aboard.',
    minutes: 1,
  },
  {
    id: 'project',
    label: 'Create your first project',
    description: 'A project holds your environments, keys and deployments.',
    href: '#',
    minutes: 2,
  },
  {
    id: 'install',
    label: 'Install the CLI',
    description: 'One command, and your terminal can deploy.',
    href: '#',
    minutes: 3,
  },
  {
    id: 'invite',
    label: 'Invite a teammate',
    description: 'Projects are more useful with someone to share them with.',
    href: '#',
    minutes: 1,
  },
  {
    id: 'domain',
    label: 'Connect a domain',
    description: 'Point a hostname at your first deployment.',
    href: '#',
    minutes: 5,
  },
]

export function OnboardingChecklist({
  heading = 'Finish setting up',
  subheading = 'Five short steps and your workspace is ready to use.',
  steps = DEFAULT_STEPS,
  initialComplete,
  completeMessage = 'All set. Nice work.',
  onToggle,
  onDismiss,
  className = '',
}: OnboardingChecklistProps) {
  // Per-instance ids. A literal id in a reusable component is a
  // collision waiting for the second copy on the page — and a <label>
  // then resolves to whichever input rendered first.
  const uid = React.useId()
  const [complete, setComplete] = React.useState<Set<string>>(
    () => new Set(initialComplete ?? (steps[0] ? [steps[0].id] : [])),
  )
  const [dismissed, setDismissed] = React.useState(false)

  const done = steps.filter((s) => complete.has(s.id)).length
  const allDone = done === steps.length

  function toggle(id: string) {
    setComplete((prev) => {
      const next = new Set(prev)
      const nowComplete = !next.has(id)
      if (nowComplete) next.add(id)
      else next.delete(id)
      onToggle?.(id, nowComplete)
      return next
    })
  }

  function dismiss() {
    setDismissed(true)
    onDismiss?.()
  }

  if (dismissed) return null

  return (
    <section
      className={`mx-auto w-full max-w-2xl rounded-2xl border border-border/60 bg-card/40 p-6 ${className}`}
    >
      <div className="flex items-start justify-between gap-4">
        <div className="min-w-0">
          <h2 className="text-lg font-bold tracking-tight">
            {allDone ? completeMessage : heading}
          </h2>
          {!allDone ? (
            <p className="mt-1 text-sm text-muted-foreground">{subheading}</p>
          ) : null}
        </div>

        {/* Only offered once there is nothing left to abandon. */}
        {allDone ? (
          <button
            type="button"
            onClick={dismiss}
            aria-label="Dismiss checklist"
            className="flex h-8 w-8 shrink-0 items-center justify-center rounded-lg text-muted-foreground transition-colors hover:bg-muted hover:text-foreground focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
          >
            <X aria-hidden className="h-4 w-4" />
          </button>
        ) : null}
      </div>

      {/* Native <progress>: reports its value to assistive tech for free. */}
      <div className="mt-5">
        <div className="flex items-center justify-between text-xs font-medium">
          <label htmlFor={`${uid}-onboarding-progress`} className="text-muted-foreground">
            Setup progress
          </label>
          <span>
            {done} of {steps.length}
          </span>
        </div>
        <progress
          id={`${uid}-onboarding-progress`}
          value={done}
          max={steps.length}
          className="mt-2 h-2 w-full overflow-hidden rounded-full [&::-moz-progress-bar]:bg-primary [&::-webkit-progress-bar]:rounded-full [&::-webkit-progress-bar]:bg-muted [&::-webkit-progress-value]:rounded-full [&::-webkit-progress-value]:bg-primary"
        />
      </div>

      <ul className="mt-6 space-y-2">
        {steps.map((step) => {
          const isDone = complete.has(step.id)
          return (
            <li key={step.id}>
              <div className="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
                <button
                  type="button"
                  onClick={() => toggle(step.id)}
                  aria-pressed={isDone}
                  className={`mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring ${
                    isDone
                      ? 'border-primary bg-primary text-primary-foreground'
                      : 'border-border hover:border-primary'
                  }`}
                >
                  {isDone ? <Check aria-hidden className="h-3 w-3" /> : null}
                  <span className="sr-only">
                    {isDone ? `Mark ${step.label} incomplete` : `Mark ${step.label} complete`}
                  </span>
                </button>

                <div className="min-w-0 flex-1">
                  {/* Completed rows stay readable — no strike-through, no
                      40% opacity. The list is also a record of what you did. */}
                  <p className={`break-words text-sm font-semibold ${isDone ? 'text-muted-foreground' : ''}`}>
                    {step.label}
                  </p>
                  <p className="mt-0.5 text-xs text-muted-foreground">{step.description}</p>
                </div>

                {!isDone && step.href ? (
                  <a
                    href={step.href}
                    className="inline-flex shrink-0 items-center gap-1 rounded-lg px-2.5 py-1.5 text-xs font-semibold text-primary transition-colors hover:bg-primary/10 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring"
                  >
                    Start
                    <ArrowRight aria-hidden className="h-3 w-3 rtl:rotate-180" />
                  </a>
                ) : null}

                {!isDone && step.minutes ? (
                  <span className="shrink-0 self-center text-[11px] text-muted-foreground">
                    {step.minutes} min
                  </span>
                ) : null}
              </div>
            </li>
          )
        })}
      </ul>
    </section>
  )
}

Before you paste

  • Styling is Tailwind utility classes on semantic tokens (bg-card, text-muted-foreground) — it inherits your theme instead of overriding it.
  • Install: npm i lucide-react
  • Every prop has a default, so it renders standalone before you wire it up.

Where it goes

Drop it at components/onboarding-checklist.tsx and import it where you need the section:

import { OnboardingChecklist } from '@/components/onboarding-checklist'

Customize

3 of this block’s props are simple enough to drive from here. Change them and the block below re-renders — it is the same component whose source is above, not a mock of it. Everything else it accepts is in the table underneath.

Props

Read out of the component’s own type and signature, so this cannot drift from the source below. Every prop has a default — the component renders standalone before you pass it anything.

PropTypeDefault
headingstring'Finish setting up'
subheadingstring'Five short steps and your workspace is ready…
stepsChecklistStep[]DEFAULT_STEPS
initialCompleteIds that start complete. Defaults to the first step.string[]—
completeMessagestring'All set. Nice work.'
onToggle(id: string, complete: boolean) => void—
onDismiss() => void—
classNamestring''

Not using React?

The same block rendered once to markup, wrapped as a file your framework compiles. Tailwind classes are framework-agnostic, so the design transfers intact — the behaviour does not.

This block is interactive. The markup below is its initial state with the event handlers stripped — you will need to re-wire the behaviour in your framework.

onboarding-checklist.html
<!--
  Setup Checklist with Progress — markup from the Hoverlab catalog.

  This is the block rendered once to HTML and wrapped as a component
  file. It is not a port of the React source: the Tailwind classes carry
  the design, which is the part that took the work, and they are the same
  in every framework.

  This block is interactive in React and the handlers are NOT here.
  Buttons, toggles and menus render in their initial state and do
  nothing until you wire them up.
-->
<section class="mx-auto w-full max-w-2xl rounded-2xl border border-border/60 bg-card/40 p-6 ">
  <div class="flex items-start justify-between gap-4">
    <div class="min-w-0">
      <h2 class="text-lg font-bold tracking-tight">Finish setting up</h2>
      <p class="mt-1 text-sm text-muted-foreground">Five short steps and your workspace is ready to use.</p>
    </div>
  </div>
  <div class="mt-5">
    <div class="flex items-center justify-between text-xs font-medium">
      <label for="_R_0_-onboarding-progress" class="text-muted-foreground">Setup progress</label>
      <span>1 of 5</span>
    </div>
    <progress id="_R_0_-onboarding-progress" value="1" max="5" class="mt-2 h-2 w-full overflow-hidden rounded-full [&amp;amp;::-moz-progress-bar]:bg-primary [&amp;amp;::-webkit-progress-bar]:rounded-full [&amp;amp;::-webkit-progress-bar]:bg-muted [&amp;amp;::-webkit-progress-value]:rounded-full [&amp;amp;::-webkit-progress-value]:bg-primary"></progress>
  </div>
  <ul class="mt-6 space-y-2">
    <li>
      <div class="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
        <button type="button" aria-pressed="true" class="mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring border-primary bg-primary text-primary-foreground">
          <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-check h-3 w-3" aria-hidden="true">
            <path d="M20 6 9 17l-5-5"></path>
          </svg>
          <span class="sr-only">Mark Create your account incomplete</span>
        </button>
        <div class="min-w-0 flex-1">
          <p class="break-words text-sm font-semibold text-muted-foreground">Create your account</p>
          <p class="mt-0.5 text-xs text-muted-foreground">Done — welcome aboard.</p>
        </div>
      </div>
    </li>
    <li>
      <div class="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
        <button type="button" aria-pressed="false" class="mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring border-border hover:border-primary">
          <span class="sr-only">Mark Create your first project complete</span>
        </button>
        <div class="min-w-0 flex-1">
          <p class="break-words text-sm font-semibold ">Create your first project</p>
          <p class="mt-0.5 text-xs text-muted-foreground">A project holds your environments, keys and deployments.</p>
        </div>
        <a href="#" class="inline-flex shrink-0 items-center gap-1 rounded-lg px-2.5 py-1.5 text-xs font-semibold text-primary transition-colors hover:bg-primary/10 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring">Start<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right h-3 w-3 rtl:rotate-180" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg></a>
        <span class="shrink-0 self-center text-[11px] text-muted-foreground">2 min</span>
      </div>
    </li>
    <li>
      <div class="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
        <button type="button" aria-pressed="false" class="mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring border-border hover:border-primary">
          <span class="sr-only">Mark Install the CLI complete</span>
        </button>
        <div class="min-w-0 flex-1">
          <p class="break-words text-sm font-semibold ">Install the CLI</p>
          <p class="mt-0.5 text-xs text-muted-foreground">One command, and your terminal can deploy.</p>
        </div>
        <a href="#" class="inline-flex shrink-0 items-center gap-1 rounded-lg px-2.5 py-1.5 text-xs font-semibold text-primary transition-colors hover:bg-primary/10 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring">Start<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right h-3 w-3 rtl:rotate-180" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg></a>
        <span class="shrink-0 self-center text-[11px] text-muted-foreground">3 min</span>
      </div>
    </li>
    <li>
      <div class="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
        <button type="button" aria-pressed="false" class="mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring border-border hover:border-primary">
          <span class="sr-only">Mark Invite a teammate complete</span>
        </button>
        <div class="min-w-0 flex-1">
          <p class="break-words text-sm font-semibold ">Invite a teammate</p>
          <p class="mt-0.5 text-xs text-muted-foreground">Projects are more useful with someone to share them with.</p>
        </div>
        <a href="#" class="inline-flex shrink-0 items-center gap-1 rounded-lg px-2.5 py-1.5 text-xs font-semibold text-primary transition-colors hover:bg-primary/10 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring">Start<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right h-3 w-3 rtl:rotate-180" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg></a>
        <span class="shrink-0 self-center text-[11px] text-muted-foreground">1 min</span>
      </div>
    </li>
    <li>
      <div class="flex items-start gap-3 rounded-xl border border-border/60 bg-background/60 p-3 transition-colors hover:border-border">
        <button type="button" aria-pressed="false" class="mt-0.5 flex h-6 w-6 shrink-0 items-center justify-center rounded-full border transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring border-border hover:border-primary">
          <span class="sr-only">Mark Connect a domain complete</span>
        </button>
        <div class="min-w-0 flex-1">
          <p class="break-words text-sm font-semibold ">Connect a domain</p>
          <p class="mt-0.5 text-xs text-muted-foreground">Point a hostname at your first deployment.</p>
        </div>
        <a href="#" class="inline-flex shrink-0 items-center gap-1 rounded-lg px-2.5 py-1.5 text-xs font-semibold text-primary transition-colors hover:bg-primary/10 focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring">Start<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-right h-3 w-3 rtl:rotate-180" aria-hidden="true"><path d="M5 12h14"></path><path d="m12 5 7 7-7 7"></path></svg></a>
        <span class="shrink-0 self-center text-[11px] text-muted-foreground">5 min</span>
      </div>
    </li>
  </ul>
</section>
  • This is rendered HTML, not a translation of the React source. The Tailwind classes carry the design and work in any framework.
  • It is one frame: the component in its initial state, with no props applied beyond the defaults.
  • This block is interactive in React — toggles, menus or form state. None of that survives here; the markup is the closed/default state and the handlers are gone. Re-wire them in your own framework.
  • Requires Tailwind, and the design tokens the classes reference (bg-card, text-muted-foreground, and so on). The template ZIPs ship a globals.css that defines them.

What each framework gets across the whole catalog — effects convert properly; this rung is markup.

For AI

The component, its props, the design tokens it expects and the command that installs it — as one prompt. Paste it into Claude, Cursor, v0 or ChatGPT and what they build around it will match the rest of the catalog instead of inventing its own system.

See the prompt

Used in these pages

Want the whole screen instead of this one section? Open a page and copy it entire.

7 more blocks in Onboarding

All of them free to read, copy and install — no account, no locked tiles, no watermarked preview. The whole catalog is open, and so are the API and the CLI.

Browse Onboarding

Shipping one commercially

Copying the code is free. Putting it in client work or a paid product is what Pro is for — the licence, not the access.

  • A commercial licence for everything in the catalog
  • Unlimited bundle exports, in Vue, Svelte and Tailwind
  • One payment — no subscription, nothing to renew
Pro — $79 once

More Onboarding blocks

View category
Open the full page for this block

Guided Setup Wizard

A choice-driven wizard with a persistent side rail, real radio groups in a fieldset so arrow keys work, and visited steps navigable while steps ahead stay out of the tab order.

Onboarding265 lines1 dep
Open the full page for this block

Team Invite Step

The onboarding step where a product becomes multiplayer: pasted addresses split into chips, typos marked rather than dropped, and an honest way to skip.

Onboarding279 lines1 dep
Open the full page for this block

Product Tour Coach Mark

A tour step anchored to the control it explains, with a spotlight cut by one spread shadow, a visible step count and focus that follows the step.

Onboarding262 lines1 dep
Open the full page for this block

Role Picker

The "what best describes you" step, asked honestly — every option states what it actually changes, the skip is visible and names what you get instead, and the choice is reversible.

Onboarding191 lines1 dep
Open the full page for this block

Import or Start Empty

The empty product’s real first question. Sample data is offered with equal weight rather than as grey small print, every connector names its scope before the redirect, and each option carries the honest duration.

Onboarding216 lines1 dep
Open the full page for this block

Workspace Setup Form

The first screen after signup, asking only the two things that cannot be changed silently later.

Onboarding176 linesNo deps
Open the full page for this block

Data Migration Split

What a migration actually moves and what it cannot, stated before the switch rather than discovered after it.

Onboarding158 linesNo deps