saturation/uisaturation/ui
DocsComponentsBlocksPagesEmails
GitHub

Sections

IntroductionComponentsInstallationMCPThemingDesign

Components

Components

General

AvatarBadgeButtonKbdProgressSeparatorSkeletonSpin ResolveSpinnerSync ButtonTypography

Forms & Inputs

Address LookupCalendar PickerCheckboxComboboxDate PickerEmoji PickerFavicon SearchFieldInputInput GroupInput OTPRadio GroupSelectSliderSwitchTextareaToggleToggle Group

Data Display

AccordionAlertCardChartComparison SliderCredit CardData TableEmptyItemSaturation Credit CardTableTree

Navigation

BreadcrumbCommandMenubarNavigation MenuPaginationTabs

Overlays

CollapsibleContext MenuDialogDropdown MenuSheet

Layout

Button GroupFont ProviderWizard Split Layout

Feedback

Sonner

Animation & Effects

Animated GroupAnimated ListAnimated NumberBeamBlur FadeBorder TrailGlow EffectLiquid MetalLoading StateParallaxPixelProgressive BlurRippleSpotlightText EffectText Shimmer

Productivity

Agent ChatAI Chat InputCoding AgentFiltersFull CalendarKanbanNovel Editor
Docs/Components/Checkbox

Checkbox

A control that allows the user to toggle between checked and not checked.

Loading...

Installation

pnpm dlx shadcn@latest add @saturation-ui/checkbox

Tailwind v4 — Source Scanning

The public shadcn registry installs component source into your project. If Tailwind v4 isn't scanning your components directory, add this to your CSS entry file:

@source "../components";

This ensures all utility classes in CVA variants and data attribute selectors are included in your build.

Usage

import { Checkbox } from "@/components/ui/checkbox"
<Checkbox />

Examples

With Text

Loading...
A checkbox with accompanying text and description.

Disabled

Loading...
A disabled checkbox that cannot be interacted with.

With Label

Loading...
Using the Label component for better accessibility.

Circle

Loading...
A circular checkbox variant with three distinct states: empty (has a plus-shaped field with border), filled (circle filled with theme color and contains white checkmark), and disabled (circle like a dot-indicator content).

Select All

Loading...
A checkbox list with a select all option that shows indeterminate state when some items are selected.

API Reference

PropTypeDefaultDescription
checkedboolean | 'indeterminate'—The controlled checked state.
defaultCheckedboolean—The default checked state.
onCheckedChange(checked: boolean) => void—Event handler for state changes.
disabledbooleanfalseDisables the checkbox.
PreviousChartNextCoding Agent

On This Page

  • Installation
  • Usage
  • Examples
  • With Text
  • Disabled
  • With Label
  • Circle
  • Select All
  • API Reference

You agree to our Terms of Service and Privacy Policy.