Skip to main content

Checklist

Interactive checklist component for displaying tasks with completion states and a progress bar.

Import​

import { Checklist } from '@scaffald/ui';

Basic Usage​

Live Preview
<ThemeProvider initialTheme="light">
<Checklist
  title="Getting Started"
  subtitle="Complete these steps"
  completionPercentage={50}
  items={[
    { id: '1', title: 'Create your account', description: 'Sign up with email or SSO', complete: true },
    { id: '2', title: 'Verify your email', description: 'Check your inbox', complete: true },
    { id: '3', title: 'Set your preferences', description: 'Choose settings', complete: false },
    { id: '4', title: 'Invite team members', description: 'Add collaborators', complete: false },
  ]}
/>
</ThemeProvider>

Props​

PropTypeDefaultDescription
titlestring—Header title
subtitlestring—Header subtitle
itemsChecklistItem[]—Array of checklist items
completionPercentagenumber—Progress percentage (0–100)
onItemPress(item) => void—Called when item is pressed
isLoadingbooleanfalseShow skeleton loading state
showProgressbooleantrueShow progress bar

ChecklistItem​

FieldTypeDescription
idstringUnique identifier
titlestringItem title
descriptionstringItem description
completebooleanWhether completed

Loading State​

Live Preview
<ThemeProvider initialTheme="light">
<Checklist isLoading completionPercentage={0} items={[]} />
</ThemeProvider>

Changelog​

See GitHub Releases for version history.