# Checkbox

A labelled checkbox with a hint and an indeterminate state.

## Web 0.2.0

### Usage

Bind the checked state to one independent choice. Keep the visible label beside the control.

### Accessibility

Associate the label with the checkbox. Preserve Space activation and expose an indeterminate state when representing partial selection.

### When to use

Use for independent selections or agreement. Use Radio when exactly one choice is allowed.

### Install

Add this registry to your project's components.json once, before the first install. Keep your existing settings and other registries.

```json
{
  "registries": {
    "@maeso": "http://127.0.0.1:4321/r/{name}.json"
  }
}
```

Then install the registry's default theme once, and import its sheet in the CSS entry that imports Tailwind. It paints every item from this registry.

```sh
npx shadcn@latest add @maeso/maeso
```

```css
@import "./styles/theme.web.css";
```

```sh
npx shadcn@latest add @maeso/checkbox
```

### Props

#### Checkbox

| Prop | Type | Required | Description |
| --- | --- | --- | --- |
| checked | boolean \| undefined | no |  |
| className | string \| undefined | no |  |
| defaultChecked | boolean \| undefined | no |  |
| hint | ReactNode | no |  |
| indeterminate | boolean \| undefined | no |  |
| label | ReactNode | no |  |
| onCheckedChange | ((checked: boolean) => void) \| undefined | no |  |
| style | CSSProperties \| undefined | no |  |

##### Inherited

Also accepts every `<span>` attribute, 282 props

| Prop | Type | Required | Description |
| --- | --- | --- | --- |
| about | string \| undefined | no |  |
| accessKey | string \| undefined | no |  |
| aria-activedescendant | string \| undefined | no | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
| aria-atomic | Booleanish \| undefined | no | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
| aria-autocomplete | "both" \| "inline" \| "list" \| "none" \| undefined | no | Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be<br>presented if they are made. |
| aria-braillelabel | string \| undefined | no | Defines a string value that labels the current element, which is intended to be converted into Braille. |
| aria-brailleroledescription | string \| undefined | no | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
| aria-busy | Booleanish \| undefined | no |  |
| aria-checked | "false" \| "mixed" \| "true" \| boolean \| undefined | no | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
| aria-colcount | number \| undefined | no | Defines the total number of columns in a table, grid, or treegrid. |
| aria-colindex | number \| undefined | no | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
| aria-colindextext | string \| undefined | no | Defines a human readable text alternative of aria-colindex. |
| aria-colspan | number \| undefined | no | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
| aria-controls | string \| undefined | no | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
| aria-current | "date" \| "false" \| "location" \| "page" \| "step" \| "time" \| "true" \| boolean \| undefined | no | Indicates the element that represents the current item within a container or set of related elements. |
| aria-describedby | string \| undefined | no | Identifies the element (or elements) that describes the object. |
| aria-description | string \| undefined | no | Defines a string value that describes or annotates the current element. |
| aria-details | string \| undefined | no | Identifies the element that provides a detailed, extended description for the object. |
| aria-disabled | Booleanish \| undefined | no | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
| aria-dropeffect | "copy" \| "execute" \| "link" \| "move" \| "none" \| "popup" \| undefined | no | Indicates what functions can be performed when a dragged object is released on the drop target. |
| aria-errormessage | string \| undefined | no | Identifies the element that provides an error message for the object. |
| aria-expanded | Booleanish \| undefined | no | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
| aria-flowto | string \| undefined | no | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,<br>allows assistive technology to override the general default of reading in document source order. |
| aria-grabbed | Booleanish \| undefined | no | Indicates an element's "grabbed" state in a drag-and-drop operation. |
| aria-haspopup | "dialog" \| "false" \| "grid" \| "listbox" \| "menu" \| "tree" \| "true" \| boolean \| undefined | no | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
| aria-hidden | Booleanish \| undefined | no | Indicates whether the element is exposed to an accessibility API. |
| aria-invalid | "false" \| "grammar" \| "spelling" \| "true" \| boolean \| undefined | no | Indicates the entered value does not conform to the format expected by the application. |
| aria-keyshortcuts | string \| undefined | no | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
| aria-label | string \| undefined | no | Defines a string value that labels the current element. |
| aria-labelledby | string \| undefined | no | Identifies the element (or elements) that labels the current element. |
| aria-level | number \| undefined | no | Defines the hierarchical level of an element within a structure. |
| aria-live | "assertive" \| "off" \| "polite" \| undefined | no | Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
| aria-modal | Booleanish \| undefined | no | Indicates whether an element is modal when displayed. |
| aria-multiline | Booleanish \| undefined | no | Indicates whether a text box accepts multiple lines of input or only a single line. |
| aria-multiselectable | Booleanish \| undefined | no | Indicates that the user may select more than one item from the current selectable descendants. |
| aria-orientation | "horizontal" \| "vertical" \| undefined | no | Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
| aria-owns | string \| undefined | no | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship<br>between DOM elements where the DOM hierarchy cannot be used to represent the relationship. |
| aria-placeholder | string \| undefined | no | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.<br>A hint could be a sample value or a brief description of the expected format. |
| aria-posinset | number \| undefined | no | Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
| aria-pressed | "false" \| "mixed" \| "true" \| boolean \| undefined | no | Indicates the current "pressed" state of toggle buttons. |
| aria-readonly | Booleanish \| undefined | no | Indicates that the element is not editable, but is otherwise operable. |
| aria-relevant | "additions" \| "additions removals" \| "additions text" \| "all" \| "removals" \| "removals additions" \| "removals text" \| "text" \| "text additions" \| "text removals" \| undefined | no | Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. |
| aria-required | Booleanish \| undefined | no | Indicates that user input is required on the element before a form may be submitted. |
| aria-roledescription | string \| undefined | no | Defines a human-readable, author-localized description for the role of an element. |
| aria-rowcount | number \| undefined | no | Defines the total number of rows in a table, grid, or treegrid. |
| aria-rowindex | number \| undefined | no | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
| aria-rowindextext | string \| undefined | no | Defines a human readable text alternative of aria-rowindex. |
| aria-rowspan | number \| undefined | no | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
| aria-selected | Booleanish \| undefined | no | Indicates the current "selected" state of various widgets. |
| aria-setsize | number \| undefined | no | Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
| aria-sort | "ascending" \| "descending" \| "none" \| "other" \| undefined | no | Indicates if items in a table or grid are sorted in ascending or descending order. |
| aria-valuemax | number \| undefined | no | Defines the maximum allowed value for a range widget. |
| aria-valuemin | number \| undefined | no | Defines the minimum allowed value for a range widget. |
| aria-valuenow | number \| undefined | no | Defines the current value for a range widget. |
| aria-valuetext | string \| undefined | no | Defines the human readable text alternative of aria-valuenow for a range widget. |
| autoCapitalize | "characters" \| "none" \| "off" \| "on" \| "sentences" \| "words" \| (string & {}) \| undefined | no |  |
| autoCorrect | string \| undefined | no |  |
| autoFocus | boolean \| undefined | no |  |
| autoSave | string \| undefined | no |  |
| content | string \| undefined | no |  |
| contentEditable | "inherit" \| "plaintext-only" \| Booleanish \| undefined | no |  |
| contextMenu | string \| undefined | no |  |
| dangerouslySetInnerHTML | { __html: string \| TrustedHTML; } \| undefined | no |  |
| datatype | string \| undefined | no |  |
| dir | string \| undefined | no |  |
| disabled | boolean \| undefined | no | Whether the component should ignore user interaction. |
| draggable | Booleanish \| undefined | no |  |
| enterKeyHint | "done" \| "enter" \| "go" \| "next" \| "previous" \| "search" \| "send" \| undefined | no |  |
| exportparts | string \| undefined | no |  |
| form | string \| undefined | no | Identifies the form that owns the hidden input.<br>Useful when the checkbox is rendered outside the form. |
| hidden | boolean \| undefined | no |  |
| id | string \| undefined | no | The id of the input element. |
| inert | boolean \| undefined | no |  |
| inlist | any | no |  |
| inputMode | "decimal" \| "email" \| "none" \| "numeric" \| "search" \| "tel" \| "text" \| "url" \| undefined | no | Hints at the type of data that might be entered by the user while editing the element or its contents |
| inputRef | Ref<HTMLInputElement> \| undefined | no | A ref to access the hidden `<input>` element. |
| is | string \| undefined | no | Specify that a standard HTML element should behave like a defined custom built-in element |
| itemID | string \| undefined | no |  |
| itemProp | string \| undefined | no |  |
| itemRef | string \| undefined | no |  |
| itemScope | boolean \| undefined | no |  |
| itemType | string \| undefined | no |  |
| key | Key \| null \| undefined | no |  |
| lang | string \| undefined | no |  |
| name | string \| undefined | no | Identifies the field when a form is submitted. |
| nonce | string \| undefined | no |  |
| onAbort | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onAbortCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onAnimationEnd | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAnimationEndCapture | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAnimationIteration | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAnimationIterationCapture | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAnimationStart | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAnimationStartCapture | ((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onAuxClick | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onAuxClickCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onBeforeInput | ((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onBeforeInputCapture | ((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onBeforeToggle | ((event: BaseUIEvent<ToggleEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onBlur | ((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) \| undefined | no |  |
| onBlurCapture | ((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) \| undefined | no |  |
| onCanPlay | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onCanPlayCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onCanPlayThrough | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onCanPlayThroughCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onChangeCapture | ((event: BaseUIEvent<ChangeEvent<HTMLSpanElement, Element>>) => void) \| undefined | no |  |
| onClick | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onClickCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onCompositionEnd | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCompositionEndCapture | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCompositionStart | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCompositionStartCapture | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCompositionUpdate | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCompositionUpdateCapture | ((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onContextMenu | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onContextMenuCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onCopy | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCopyCapture | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCut | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onCutCapture | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDoubleClick | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onDoubleClickCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onDrag | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragEnd | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragEndCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragEnter | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragEnterCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragExit | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragExitCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragLeave | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragLeaveCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragOver | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragOverCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragStart | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDragStartCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDrop | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDropCapture | ((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onDurationChange | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onDurationChangeCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEmptied | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEmptiedCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEncrypted | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEncryptedCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEnded | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onEndedCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onError | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onErrorCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onFocus | ((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) \| undefined | no |  |
| onFocusCapture | ((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) \| undefined | no |  |
| onGotPointerCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onGotPointerCaptureCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onInput | ((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onInputCapture | ((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onInvalid | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onInvalidCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onKeyDown | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onKeyDownCapture | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onKeyPress | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onKeyPressCapture | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onKeyUp | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onKeyUpCapture | ((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onLoad | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadedData | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadedDataCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadedMetadata | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadedMetadataCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadStart | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLoadStartCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onLostPointerCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onLostPointerCaptureCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onMouseDown | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseDownCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseEnter | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseLeave | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseMove | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseMoveCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseOut | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseOutCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseOver | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseOverCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseUp | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onMouseUpCapture | ((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) \| undefined | no |  |
| onPaste | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPasteCapture | ((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPause | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPauseCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPlay | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPlayCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPlaying | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPlayingCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onPointerCancel | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerCancelCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerDown | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerDownCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerEnter | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerLeave | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerMove | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerMoveCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerOut | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerOutCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerOver | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerOverCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerUp | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onPointerUpCapture | ((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onProgress | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onProgressCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onRateChange | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onRateChangeCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onReset | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onResetCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onScroll | ((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) \| undefined | no |  |
| onScrollCapture | ((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) \| undefined | no |  |
| onScrollEnd | ((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) \| undefined | no |  |
| onScrollEndCapture | ((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) \| undefined | no |  |
| onSeeked | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSeekedCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSeeking | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSeekingCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSelect | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSelectCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onStalled | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onStalledCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSubmit | ((event: BaseUIEvent<SubmitEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onSubmitCapture | ((event: BaseUIEvent<SubmitEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onSuspend | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onSuspendCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onTimeUpdate | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onTimeUpdateCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onToggle | ((event: BaseUIEvent<ToggleEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchCancel | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchCancelCapture | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchEnd | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchEndCapture | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchMove | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchMoveCapture | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchStart | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTouchStartCapture | ((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionCancel | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionCancelCapture | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionEnd | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionEndCapture | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionRun | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionRunCapture | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionStart | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onTransitionStartCapture | ((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onVolumeChange | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onVolumeChangeCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onWaiting | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onWaitingCapture | ((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) \| undefined | no |  |
| onWheel | ((event: BaseUIEvent<WheelEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| onWheelCapture | ((event: BaseUIEvent<WheelEvent<HTMLSpanElement>>) => void) \| undefined | no |  |
| parent | boolean \| undefined | no | Whether the checkbox controls a group of child checkboxes.<br><br>Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group). |
| part | string \| undefined | no |  |
| popover | "" \| "auto" \| "hint" \| "manual" \| undefined | no |  |
| popoverTarget | string \| undefined | no |  |
| popoverTargetAction | "hide" \| "show" \| "toggle" \| undefined | no |  |
| prefix | string \| undefined | no |  |
| property | string \| undefined | no |  |
| radioGroup | string \| undefined | no |  |
| readOnly | boolean \| undefined | no | Whether the user should be unable to tick or untick the checkbox. |
| ref | Ref<HTMLElement> \| undefined | no | Allows getting a ref to the component instance.<br>Once the component unmounts, React will set `ref.current` to `null`<br>(or call the ref with `null` if you passed a callback ref). |
| rel | string \| undefined | no |  |
| required | boolean \| undefined | no | Whether the user must tick the checkbox before submitting a form. |
| resource | string \| undefined | no |  |
| results | number \| undefined | no |  |
| rev | string \| undefined | no |  |
| role | AriaRole \| undefined | no |  |
| security | string \| undefined | no |  |
| slot | string \| undefined | no |  |
| spellCheck | Booleanish \| undefined | no |  |
| suppressContentEditableWarning | boolean \| undefined | no |  |
| suppressHydrationWarning | boolean \| undefined | no |  |
| tabIndex | number \| undefined | no |  |
| title | string \| undefined | no |  |
| translate | "no" \| "yes" \| undefined | no |  |
| typeof | string \| undefined | no |  |
| uncheckedValue | string \| undefined | no | The value submitted with the form when the checkbox is unchecked.<br>By default, unchecked checkboxes do not submit any value, matching native checkbox behavior. |
| unselectable | "off" \| "on" \| undefined | no |  |
| value | string \| undefined | no | The checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted.<br>When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on". |
| vocab | string \| undefined | no |  |

### Proof

#### Contrast

measured on 0.2.0

| State | Foreground | Background | Ratio | Floor |
| --- | --- | --- | --- | --- |
| default | rgb(7 21 34) | rgb(248 245 240) | 16.95 | AA 4.5 |
| disabled | rgb(67 77 86) | rgb(248 245 240) | 7.93 | AA exempt |
| default (dark) | rgb(248 245 240) | rgb(7 21 34) | 16.95 | AA 4.5 |
| disabled (dark) | rgb(181 182 182) | rgb(7 21 34) | 9.07 | AA exempt |

#### Keyboard

measured on 0.2.0

| Key | Action |
| --- | --- |
| Space | Toggle checked value |
| Tab | Leave control without changing its value |
| Shift+Tab | Return focus with value preserved |

#### Size

26885 gzip bytes · measured on 0.2.0

### Example

```tsx
import { Checkbox } from "@/components/ui/_kit/forms/checkbox/Checkbox";

import { Stack } from "@/components/ui/_kit/layout/stack/Stack";

const Example = () => (
		<Stack gap={3}>
			<Checkbox label="Play a sound after each session" />
			<Checkbox label="Show session notifications" defaultChecked />
			<Checkbox label="Some notification types selected" indeterminate />
			<Checkbox label="Sound unavailable" disabled />
			<Checkbox label="Notifications required" defaultChecked disabled />
		</Stack>
	);
export default Example;
```

### Preview · 0.2.0

not on native yet
