Docs
shadcn/ui
Checklist

Checklist

Onboarding checklist card with progress bar and task checkboxes. Uses useChecklist() for state management.

Install

npx shadcn@latest add https://featuredrop.dev/r/checklist.json

Preview

Usage

import { Checklist as ChecklistComponent } from "featuredrop/react"
import { Checklist } from "@/components/featuredrop/checklist"
 
const tasks = [
  { id: "profile", title: "Complete your profile", description: "Add a photo and bio." },
  { id: "invite", title: "Invite a teammate", description: "Collaboration is better together." },
  { id: "first-project", title: "Create your first project" },
]
 
export function Onboarding() {
  return (
    <>
      {/* Register checklist state with FeatureDrop */}
      <ChecklistComponent id="onboarding" tasks={tasks} position="inline" />
      {/* Render the shadcn UI */}
      <Checklist
        checklistId="onboarding"
        tasks={tasks}
        title="Getting Started"
        description="Complete these steps to get the most out of your account."
      />
    </>
  )
}

Props

PropTypeDefaultDescription
checklistIdstringChecklist ID (must match the registered checklist)
tasks{ id, title, description? }[]Task display info
titlestring"Getting Started"Card title
descriptionstringCard description
classNamestringAdditional classes for the card
⚠️

Requires a FeatureDrop Checklist component to be mounted (registers the checklist controller) and a FeatureDropProvider ancestor.

shadcn Dependencies

  • card
  • checkbox
  • progress
  • button