Skip to main content
userTourKit
@tour-kit/checklistsComponents

Variants

CVA variant exports for @tour-kit/checklists — checklistVariants, checklistTaskVariants, checklistProgressVariants, checklistLauncherVariants, checklistPanelVariants, and the full styling surface

domidex01Published Updated

Each styled component is built on a cva() call. Import the variant function to extend or compose classes; import the matching *Variants type for prop-level autocomplete.

import { checklistVariants } from '@tour-kit/checklists'

<div className={checklistVariants({ size: 'lg' })}>
  {/* ... */}
</div>
import type { ChecklistVariants } from '@tour-kit/checklists'

type Size = ChecklistVariants['size'] // 'default' | 'sm' | 'lg' | 'md'

Checklist Container

Variant fnSlots
checklistVariantssize: 'default' | 'sm' | 'lg' | 'md'
checklistHeaderVariantsspacing: 'default' | 'none' | 'compact'
checklistContentVariantsspacing: 'default' | 'none' | 'compact'
checklistCompleteVariantsvariant: 'default' | 'none' | 'subtle'

Task

Variant fnSlots
checklistTaskVariantssize: 'default' | 'sm' | 'lg', state: 'default' | 'completed' | 'locked'
taskCheckboxVariantssize, state
taskTitleVariantssize, state
taskDescriptionVariantssize

Progress

Variant fnSlots
checklistProgressVariantssize: 'default' | 'sm' | 'lg'
progressTrackVariantssize
progressBarVariantsvariant: 'default' | 'success' | 'warning' | 'destructive'
progressTextVariantssize

Launcher

Variant fnSlots
checklistLauncherVariantssize, variant: 'default' | 'secondary' | 'outline'
launcherBadgeVariantssize, variant: 'default' | 'success' | 'secondary'
launcherPositionVariantsposition: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left'

Panel

Variant fnSlots
checklistPanelVariantssize: 'default' | 'sm' | 'lg' | 'md'
panelHeaderVariantsspacing, collapsible
panelContentVariantsexpanded
panelChevronVariantssize, expanded

Type aliases

Every variant function above has a matching VariantProps type alias listed in Type Reference → Variants Types.

The launcher uses two CVA layers — checklistLauncherVariants controls size/variant; launcherPositionVariants controls anchor position. Apply both via cn() when composing your own launcher.