Checkbox
FormsA binary or indeterminate selection control with label and description support.
Live preview
You agree to the privacy policy.
Installation
Import the component from the kit. The package ships source and is transpiled by Next.js.
Usage
Compose the component with your own content. All controls share the same focus, disabled and invalid states.
API Reference
Props are additive to the underlying Base UI or native element.
| Prop | Type | Default | Description |
|---|---|---|---|
| label | ReactNode | — | Visible label. |
| description | ReactNode | — | Helper text. |
| checked | boolean | — | Controlled checked state. |
| defaultChecked | boolean | — | Initial unchecked state. |
| indeterminate | boolean | — | Shows the mixed state. |
| error | boolean | — | Applies the invalid visual state. |
| disabled | boolean | — | Disables the control. |