Skip to Content
ComponentsCheckbox

Checkbox

A checkbox control built on Ark UI with multiple sizes and indeterminate state support.

Import

import { Checkbox } from '@grannyshot/ui'

Usage

<Checkbox label="Accept terms" />

Sizes

<Checkbox size="sm" label="Small" /> <Checkbox size="md" label="Medium" /> <Checkbox size="lg" label="Large" />

States

<Checkbox label="Unchecked" /> <Checkbox label="Checked" defaultChecked /> <Checkbox label="Indeterminate" checked="indeterminate" />

Disabled

<Checkbox label="Disabled" disabled /> <Checkbox label="Disabled checked" disabled defaultChecked />

Props

PropTypeDefaultDescription
labelstringCheckbox label text
size'sm' | 'md' | 'lg''md'Checkbox size
checkedboolean | 'indeterminate'Controlled checked state
defaultCheckedbooleanfalseInitial checked state
disabledbooleanfalseDisabled state
classNamestringAdditional CSS classes
Last updated on