Components

Checkbox

Single checkbox control with checked and indeterminate states.

Email me product news

Select all channels

Checked, disabled

Off, disabled

Composition

Choice control

<Checkbox />

Installation

The Control UI source installs this primitive from src/registry/sources/control-ui/ui/checkbox.tsx.

Registry command

npx shadcn@latest add https://control-ui.dev/r/checkbox.json

See registry manifest

Raw code

Primary installed source

src/registry/sources/control-ui/ui/checkbox.tsx

"use client";

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

import type { CSSProperties } from "react";

import type { ChoiceKnobStyle } from "@/components/control-ui/knob-contracts/choice-knobs";

import { cn } from "@/components/control-ui/lib/cn";

export type CheckboxProps = Omit<

{

checked?: boolean;

defaultChecked?: boolean;

onCheckedChange?: (checked: boolean) => void;

indeterminate?: boolean;

disabled?: boolean;

readOnly?: boolean;

required?: boolean;

name?: string;

value?: string;

id?: string;

className?: string;

"aria-label"?: string;

"aria-labelledby"?: string;

"aria-describedby"?: string;

"aria-invalid"?: boolean | "true" | "false";

},

"style"

> & { style?: CSSProperties & ChoiceKnobStyle };

// tick and dash swap on Root's data-indeterminate in pure CSS.

export function Checkbox({

className,

checked,

defaultChecked,

onCheckedChange,

indeterminate,

disabled,

readOnly,

required,

name,

value,

id,

...props

}: CheckboxProps) {

return (

<CheckboxPrimitive.Root

data-control-ui="checkbox"

data-choice-kind="checkbox"

data-control-family="choice"

data-slot="root"

checked={checked}

defaultChecked={defaultChecked}

onCheckedChange={onCheckedChange}

indeterminate={indeterminate}

disabled={disabled}

readOnly={readOnly}

required={required}

name={name}

value={value}

id={id}

className={cn(

"group/checkbox relative inline-flex shrink-0 cursor-pointer items-center justify-center",

"data-[disabled]:cursor-not-allowed",

className,

)}

{...props}

>

<CheckboxPrimitive.Indicator

data-control-ui="checkbox"

data-control-family="choice"

data-choice-kind="checkbox"

data-slot="indicator"

className="flex items-center justify-center data-[unchecked]:hidden"

>

{/* tick (default) and dash (indeterminate) both mount; Root's data-indeterminate toggles which shows */}

        <svg viewBox="0 0 12 12" className="size-3 group-data-[indeterminate]/checkbox:hidden" aria-hidden="true" fill="none">

          <path d="M2.5 6.5 5 9l4.5-5" stroke="currentColor" strokeWidth="1.6" strokeLinecap="round" strokeLinejoin="round" />

</svg>

        <svg viewBox="0 0 12 12" className="hidden size-3 group-data-[indeterminate]/checkbox:block" aria-hidden="true" fill="none">

<path d="M2.75 6h6.5" stroke="currentColor" strokeWidth="1.6" strokeLinecap="round" />

</svg>

</CheckboxPrimitive.Indicator>

</CheckboxPrimitive.Root>

);

}

Knobs

Typed custom properties the recipe paints with. Set one on the root — style, a utility class, or a skin — and every slot inherits it.

--cui-choice-* · 7 knobsHow the cascade resolves

--cui-choice-radius<length-percentage>var(--radius-sm)

--cui-choice-border-color<color>var(--control-boundary)

--cui-choice-border-width<length>var(--control-rim-width)

--cui-choice-background<color>var(--control-fill)

--cui-choice-checked-background<color>var(--primary)

--cui-choice-checked-border-color<color>var(--primary)

--cui-choice-shadow*inset 0 0 0 var(--cui-choice-border-width) var(--cui-choice-border-color), var(--shadow-sm)