Component
Checkbox
Toggles a binary option in a form or settings surface.
Install
Run the CLI to copy the source into your project.
pnpm dlx @stalk-ui/cli add @stalk-ui/checkboxExamples
Live previews render through the docs app's PandaCSS codegen.
<Checkbox aria-label="Accept terms" />
<Checkbox defaultChecked aria-label="Subscribed" />
<Checkbox checked="indeterminate" aria-label="Bulk select" />
<Checkbox disabled aria-label="Locked" />
Props
Public component props extracted from the source TypeScript types.
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `invalid` | `boolean` | No | - | - |
| `size` | `CheckboxSize` | No | - | - |
Variants
Variant axes exposed by the underlying PandaCSS recipe or slot recipe.
| Variant | Values |
|---|---|
| `size` | `sm`, `md`, `lg` |
Registry
Files this component contributes to your registry install.
- Manifest: `/r/checkbox.json`
- Recipe: `checkbox`
- Files: `src/components/ui/checkbox.tsx`