Command Palette

Search for a command to run...

Checkbox

shadcn/ui

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

Checkbox

import { Checkbox } from "@/components/optics/checkbox";import { Label } from "@/components/optics/label";<div className="w-full flex flex-col items-center justify-center gap-4">  <div className="flex flex-col items-start gap-4">    <div className="flex items-center space-x-2">      <Checkbox id="terms" />      <Label htmlFor="terms">        Accept terms and conditions      </Label>    </div>    <div className="flex items-center space-x-2">      <Checkbox id="newsletter" />      <Label htmlFor="newsletter">        Subscribe to newsletter      </Label>    </div>    <div className="flex items-center space-x-2">      <Checkbox        disabled        id="disabled"      />      <Label htmlFor="disabled">        Disabled checkbox      </Label>    </div>  </div></div>

Installation

pnpm dlx shadcn@latest add @optics/checkbox

Props

<Checkbox />
Name
Type
variant
string(default: black)
variantChecked
string(default: undefined)
variantUnchecked
string(default: undefined)
onCheckedChange
string(default: undefined)
indeterminate
boolean
inputRef
React.Ref<HTMLInputElement>
parent
boolean
uncheckedValue
string
nativeButton
boolean
render
React.ReactElement
keepMounted
boolean