Back to Component Browser
Checkbox
Quartzlib/quartz/components/Checkbox/index.ts
Preview
Import
import { Checkbox } from '@/lib/quartz';Props (9)
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| description | string | optional | — | The description text for the `<Checkbox>`. Accessibly tied to the underlying `<input type="checkbox">`. |
| descriptionClassName | string | optional | — | The customized className for description text for the `<Checkbox>`. |
| children | ReactNode | optional | — | Additional content below the Checkbox |
| indeterminate | boolean | optional | — | Whether the indeterminate state will be shown. Overrides the visual of `checked` state when set to `true`. |
| childrenMarginTopUnits | enum | optional | 0 | The margin between the `children` and the description or label above it.... |
| marginBottomUnits | SpacingUnit | optional | — | Margin bottom spacing in units. Useful when checkbox is wrapped in components like tooltips. |
| _quartzInternal_childrenTestId | string | optional | — | @internal Used for testing within Quartz. |
| ref | Ref<HTMLInputElement> | optional | — | Allows getting a ref to the component instance.... |
| key | Key | optional | — | — |
Usage
Not used in any projects yet.