Beta

Search Documentation

Search through documentation pages

Components

Checkbox

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

Preview

'use client';

import { Checkbox } from '@/registry/san-francisco/ui/checkbox';

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

Installation

bun
bunx shadcn@latest add @sft-ui/checkbox

Examples

Default

'use client';

import { Checkbox } from '@/registry/san-francisco/ui/checkbox';

export default function CheckboxDemoDefault() {
  return <Checkbox />;
}

Checked

'use client';

import { Checkbox } from '@/registry/san-francisco/ui/checkbox';

export default function CheckboxDemoChecked() {
  return <Checkbox defaultChecked />;
}

Disabled

'use client';

import { Checkbox } from '@/registry/san-francisco/ui/checkbox';

export default function CheckboxDemoDisabled() {
  return (
    <div className="flex items-center gap-2">
      <Checkbox id="disabled" disabled />
      <label htmlFor="disabled" className="text-muted-foreground text-sm">
        Disabled
      </label>
    </div>
  );
}

API Reference

See the Base UI Checkbox documentation for the API reference.