SYS:ONLINE● ACTIVE
THEME
GITHUBv0.1.0

CHECKBOX

Binary toggle built on Radix UI. Shows a filled square indicator when checked. Supports optional label with auto-generated ID binding.

DEPS:@radix-ui/react-checkbox

PREVIEW

INSTALLATION

BASH
npx shadcn@latest add @scificn/checkbox

USAGE

TSX
import { Checkbox } from '@/ui/checkbox'

export function Example() {
  return (
    <Checkbox
      label="ENABLE AUTO-TARGETING"
      onCheckedChange={(checked) => console.log(checked)}
    />
  )
}

STATES

UNCHECKED
CHECKED
DISABLED
CHECKED + DISABLED

CONTROLLED

TSX
import { useState } from 'react'
import { Checkbox } from '@/ui/checkbox'

export function Controlled() {
  const [checked, setChecked] = useState(false)
  return (
    <Checkbox
      label="ENGAGE WARP DRIVE"
      checked={checked}
      onCheckedChange={(v) => setChecked(v === true)}
    />
  )
}

PROPS

PROPTYPEDEFAULTDESCRIPTION
labelstringOptional text label rendered next to the checkbox. Auto-generates the id/htmlFor binding.
checkedboolean | "indeterminate"Controlled checked state.
defaultCheckedbooleanfalseInitial checked state (uncontrolled).
onCheckedChange(checked: boolean | "indeterminate") => voidCallback fired when the checked state changes.
disabledbooleanfalseDisables the checkbox and reduces opacity.
idstringOverride the auto-generated id.