# Checkbox

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

## Installation

```bash
npx shadcn@latest add https://reactdocs.canceydejean.dev/r/checkbox.json
```

[Registry JSON](https://reactdocs.canceydejean.dev/r/checkbox.json)

## Preview

```tsx
import { Checkbox } from "@/components/ui/checkbox/checkbox";

export function Preview() {
  return (
    <div className="flex items-center gap-2">
      <Checkbox id="terms" defaultChecked />
      <label htmlFor="terms" className="text-sm leading-none font-medium">
        Accept terms and conditions
      </label>
    </div>
  );
}
```


## Source

### checkbox.tsx

```tsx
"use client";

import { Checkbox as CheckboxPrimitive } from "@base-ui/react/checkbox";
import { IconCheck } from "@tabler/icons-react";

import { cn } from "cn";

function Checkbox({ className, ...props }: CheckboxPrimitive.Root.Props) {
  return (
    <CheckboxPrimitive.Root
      data-slot="checkbox"
      className={cn(
        "peer border-input focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:border-destructive aria-invalid:ring-destructive/20 aria-invalid:aria-checked:border-primary dark:bg-input/30 dark:aria-invalid:border-destructive/50 dark:aria-invalid:ring-destructive/40 data-checked:border-primary data-checked:bg-primary data-checked:text-primary-foreground dark:data-checked:bg-primary relative flex size-4 shrink-0 items-center justify-center rounded-[4px] border transition-colors outline-none group-has-disabled/field:opacity-50 after:absolute after:-inset-x-3 after:-inset-y-2 focus-visible:ring-3 disabled:cursor-not-allowed disabled:opacity-50 aria-invalid:ring-3",
        className,
      )}
      {...props}
    >
      <CheckboxPrimitive.Indicator
        data-slot="checkbox-indicator"
        className="grid place-content-center text-current transition-none [&>svg]:size-3.5"
      >
        <IconCheck />
      </CheckboxPrimitive.Indicator>
    </CheckboxPrimitive.Root>
  );
}

export { Checkbox };
```



## Usage

Use checkboxes for multi-select options, settings, and form field toggles.

```tsx
import { Checkbox } from "@/components/checkbox/checkbox";

export function Example() {
  return (
    <div className="flex items-center gap-2">
      <Checkbox id="terms" />
      <label htmlFor="terms">Accept terms and conditions</label>
    </div>
  );
}
```

Supports controlled/uncontrolled `checked` state, `disabled`, and `aria-invalid` styling for form
errors. Built on Base UI Checkbox.