Checkbox

Basic

A checkbox is a small box you can tick to select an option. It’s either on or off.

Installation

npx shadcn@latest add @intentui/checkbox

Composed components

Manual installation

npm i react-aria-components @intentui/icons

Anatomy

import { Checkbox } from "@/components/ui/checkbox"
import { Description, Label } from "@/components/ui/field"

<Checkbox>
  <Label>Remember me</Label>
  <Description>Keep me logged in on this device</Description>
</Checkbox>

Label Prop

You can add a label to the checkbox by passing the label prop.

<Checkbox label="Enable Notifications" />

Description props

Add a description to the checkbox group by passing the description prop.

Invalid

The checkbox is in an error state.

Indeterminate

The checkbox is in an indeterminate state.

Controlled

You can control the checkbox value by using the value prop.

Uncontrolled

You can control the checkbox value by using the defaultValue prop.

Disabled

The checkbox is disabled.