UI

Checkbox

A labelled checkbox with a hint and an indeterminate state.

Read Markdown

Web 0.2.0

  • Defaultlight16.95 : 1AA 4.5dark16.95 : 1AA 4.5
  • Disabledlight7.93 : 1AA exemptdark9.07 : 1AA exempt
  • KeyboardSpaceTabShift+Tab
  • measured on 0.2.0
npx shadcn@latest add @maeso/checkbox
Size
26.9 kB gzipmeasured on 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.

{
  "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.

npx shadcn@latest add @maeso/maeso
@import "./styles/theme.web.css";
npx shadcn@latest add @maeso/checkbox

Props

Checkbox

PropTypeRequiredDescription
checkedboolean | undefinedno
classNamestring | undefinedno
defaultCheckedboolean | undefinedno
hintReactNodeno
indeterminateboolean | undefinedno
labelReactNodeno
onCheckedChange((checked: boolean) => void) | undefinedno
styleCSSProperties | undefinedno
Also accepts every <span> attribute282 props
PropTypeRequiredDescription
aboutstring | undefinedno
accessKeystring | undefinedno
aria-activedescendantstring | undefinednoIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicBooleanish | undefinednoIndicates 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" | undefinednoIndicates 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 presented if they are made.
aria-braillelabelstring | undefinednoDefines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring | undefinednoDefines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyBooleanish | undefinedno
aria-checked"false" | "mixed" | "true" | boolean | undefinednoIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber | undefinednoDefines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber | undefinednoDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring | undefinednoDefines a human readable text alternative of aria-colindex.
aria-colspannumber | undefinednoDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring | undefinednoIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-current"date" | "false" | "location" | "page" | "step" | "time" | "true" | boolean | undefinednoIndicates the element that represents the current item within a container or set of related elements.
aria-describedbystring | undefinednoIdentifies the element (or elements) that describes the object.
aria-descriptionstring | undefinednoDefines a string value that describes or annotates the current element.
aria-detailsstring | undefinednoIdentifies the element that provides a detailed, extended description for the object.
aria-disabledBooleanish | undefinednoIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"copy" | "execute" | "link" | "move" | "none" | "popup" | undefinednoIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring | undefinednoIdentifies the element that provides an error message for the object.
aria-expandedBooleanish | undefinednoIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring | undefinednoIdentifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbedBooleanish | undefinednoIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopup"dialog" | "false" | "grid" | "listbox" | "menu" | "tree" | "true" | boolean | undefinednoIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenBooleanish | undefinednoIndicates whether the element is exposed to an accessibility API.
aria-invalid"false" | "grammar" | "spelling" | "true" | boolean | undefinednoIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring | undefinednoIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring | undefinednoDefines a string value that labels the current element.
aria-labelledbystring | undefinednoIdentifies the element (or elements) that labels the current element.
aria-levelnumber | undefinednoDefines the hierarchical level of an element within a structure.
aria-live"assertive" | "off" | "polite" | undefinednoIndicates 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-modalBooleanish | undefinednoIndicates whether an element is modal when displayed.
aria-multilineBooleanish | undefinednoIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableBooleanish | undefinednoIndicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical" | undefinednoIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring | undefinednoIdentifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholderstring | undefinednoDefines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinsetnumber | undefinednoDefines 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 | undefinednoIndicates the current "pressed" state of toggle buttons.
aria-readonlyBooleanish | undefinednoIndicates 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" | undefinednoIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredBooleanish | undefinednoIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring | undefinednoDefines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber | undefinednoDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber | undefinednoDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring | undefinednoDefines a human readable text alternative of aria-rowindex.
aria-rowspannumber | undefinednoDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedBooleanish | undefinednoIndicates the current "selected" state of various widgets.
aria-setsizenumber | undefinednoDefines 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" | undefinednoIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber | undefinednoDefines the maximum allowed value for a range widget.
aria-valueminnumber | undefinednoDefines the minimum allowed value for a range widget.
aria-valuenownumber | undefinednoDefines the current value for a range widget.
aria-valuetextstring | undefinednoDefines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize"characters" | "none" | "off" | "on" | "sentences" | "words" | (string & {}) | undefinedno
autoCorrectstring | undefinedno
autoFocusboolean | undefinedno
autoSavestring | undefinedno
contentstring | undefinedno
contentEditable"inherit" | "plaintext-only" | Booleanish | undefinedno
contextMenustring | undefinedno
dangerouslySetInnerHTML{ __html: string | TrustedHTML; } | undefinedno
datatypestring | undefinedno
dirstring | undefinedno
disabledboolean | undefinednoWhether the component should ignore user interaction.
draggableBooleanish | undefinedno
enterKeyHint"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefinedno
exportpartsstring | undefinedno
formstring | undefinednoIdentifies the form that owns the hidden input. Useful when the checkbox is rendered outside the form.
hiddenboolean | undefinedno
idstring | undefinednoThe id of the input element.
inertboolean | undefinedno
inlistanyno
inputMode"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url" | undefinednoHints at the type of data that might be entered by the user while editing the element or its contents
inputRefRef<HTMLInputElement> | undefinednoA ref to access the hidden `<input>` element.
isstring | undefinednoSpecify that a standard HTML element should behave like a defined custom built-in element
itemIDstring | undefinedno
itemPropstring | undefinedno
itemRefstring | undefinedno
itemScopeboolean | undefinedno
itemTypestring | undefinedno
keyKey | null | undefinedno
langstring | undefinedno
namestring | undefinednoIdentifies the field when a form is submitted.
noncestring | undefinedno
onAbort((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onAbortCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onAnimationEnd((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAnimationEndCapture((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAnimationIteration((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAnimationIterationCapture((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAnimationStart((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAnimationStartCapture((event: BaseUIEvent<AnimationEvent<HTMLSpanElement>>) => void) | undefinedno
onAuxClick((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onAuxClickCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onBeforeInput((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) | undefinedno
onBeforeInputCapture((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) | undefinedno
onBeforeToggle((event: BaseUIEvent<ToggleEvent<HTMLSpanElement>>) => void) | undefinedno
onBlur((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) | undefinedno
onBlurCapture((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) | undefinedno
onCanPlay((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onCanPlayCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onCanPlayThrough((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onCanPlayThroughCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onChangeCapture((event: BaseUIEvent<ChangeEvent<HTMLSpanElement, Element>>) => void) | undefinedno
onClick((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onClickCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onCompositionEnd((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onCompositionEndCapture((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onCompositionStart((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onCompositionStartCapture((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onCompositionUpdate((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onCompositionUpdateCapture((event: BaseUIEvent<CompositionEvent<HTMLSpanElement>>) => void) | undefinedno
onContextMenu((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onContextMenuCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onCopy((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onCopyCapture((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onCut((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onCutCapture((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onDoubleClick((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onDoubleClickCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onDrag((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragEnd((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragEndCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragEnter((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragEnterCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragExit((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragExitCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragLeave((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragLeaveCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragOver((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragOverCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragStart((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDragStartCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDrop((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDropCapture((event: BaseUIEvent<DragEvent<HTMLSpanElement>>) => void) | undefinedno
onDurationChange((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onDurationChangeCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEmptied((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEmptiedCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEncrypted((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEncryptedCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEnded((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onEndedCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onError((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onErrorCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onFocus((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) | undefinedno
onFocusCapture((event: BaseUIEvent<FocusEvent<HTMLSpanElement, Element>>) => void) | undefinedno
onGotPointerCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onGotPointerCaptureCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onInput((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) | undefinedno
onInputCapture((event: BaseUIEvent<InputEvent<HTMLSpanElement>>) => void) | undefinedno
onInvalid((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onInvalidCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onKeyDown((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onKeyDownCapture((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onKeyPress((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onKeyPressCapture((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onKeyUp((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onKeyUpCapture((event: BaseUIEvent<KeyboardEvent<HTMLSpanElement>>) => void) | undefinedno
onLoad((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadedData((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadedDataCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadedMetadata((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadedMetadataCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadStart((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLoadStartCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onLostPointerCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onLostPointerCaptureCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onMouseDown((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseDownCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseEnter((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseLeave((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseMove((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseMoveCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseOut((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseOutCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseOver((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseOverCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseUp((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onMouseUpCapture((event: BaseUIEvent<MouseEvent<HTMLSpanElement, MouseEvent>>) => void) | undefinedno
onPaste((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onPasteCapture((event: BaseUIEvent<ClipboardEvent<HTMLSpanElement>>) => void) | undefinedno
onPause((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPauseCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPlay((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPlayCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPlaying((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPlayingCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onPointerCancel((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerCancelCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerDown((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerDownCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerEnter((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerLeave((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerMove((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerMoveCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerOut((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerOutCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerOver((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerOverCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerUp((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onPointerUpCapture((event: BaseUIEvent<PointerEvent<HTMLSpanElement>>) => void) | undefinedno
onProgress((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onProgressCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onRateChange((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onRateChangeCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onReset((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onResetCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onScroll((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) | undefinedno
onScrollCapture((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) | undefinedno
onScrollEnd((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) | undefinedno
onScrollEndCapture((event: BaseUIEvent<UIEvent<HTMLSpanElement, UIEvent>>) => void) | undefinedno
onSeeked((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSeekedCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSeeking((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSeekingCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSelect((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSelectCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onStalled((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onStalledCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSubmit((event: BaseUIEvent<SubmitEvent<HTMLSpanElement>>) => void) | undefinedno
onSubmitCapture((event: BaseUIEvent<SubmitEvent<HTMLSpanElement>>) => void) | undefinedno
onSuspend((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onSuspendCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onTimeUpdate((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onTimeUpdateCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onToggle((event: BaseUIEvent<ToggleEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchCancel((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchCancelCapture((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchEnd((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchEndCapture((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchMove((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchMoveCapture((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchStart((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTouchStartCapture((event: BaseUIEvent<TouchEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionCancel((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionCancelCapture((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionEnd((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionEndCapture((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionRun((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionRunCapture((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionStart((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onTransitionStartCapture((event: BaseUIEvent<TransitionEvent<HTMLSpanElement>>) => void) | undefinedno
onVolumeChange((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onVolumeChangeCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onWaiting((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onWaitingCapture((event: BaseUIEvent<SyntheticEvent<HTMLSpanElement, Event>>) => void) | undefinedno
onWheel((event: BaseUIEvent<WheelEvent<HTMLSpanElement>>) => void) | undefinedno
onWheelCapture((event: BaseUIEvent<WheelEvent<HTMLSpanElement>>) => void) | undefinedno
parentboolean | undefinednoWhether the checkbox controls a group of child checkboxes. Must be used in a [Checkbox Group](https://base-ui.com/react/components/checkbox-group).
partstring | undefinedno
popover"" | "auto" | "hint" | "manual" | undefinedno
popoverTargetstring | undefinedno
popoverTargetAction"hide" | "show" | "toggle" | undefinedno
prefixstring | undefinedno
propertystring | undefinedno
radioGroupstring | undefinedno
readOnlyboolean | undefinednoWhether the user should be unable to tick or untick the checkbox.
refRef<HTMLElement> | undefinednoAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).
relstring | undefinedno
requiredboolean | undefinednoWhether the user must tick the checkbox before submitting a form.
resourcestring | undefinedno
resultsnumber | undefinedno
revstring | undefinedno
roleAriaRole | undefinedno
securitystring | undefinedno
slotstring | undefinedno
spellCheckBooleanish | undefinedno
suppressContentEditableWarningboolean | undefinedno
suppressHydrationWarningboolean | undefinedno
tabIndexnumber | undefinedno
titlestring | undefinedno
translate"no" | "yes" | undefinedno
typeofstring | undefinedno
uncheckedValuestring | undefinednoThe value submitted with the form when the checkbox is unchecked. By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.
unselectable"off" | "on" | undefinedno
valuestring | undefinednoThe checkbox's value. Identifies it within a [Checkbox Group](https://base-ui.com/react/components/checkbox-group), falling back to `name` when omitted. When submitting a form, a checked box submits `value`; with no `value`, it submits the native "on".
vocabstring | undefinedno

Proof

Contrast

measured on 0.2.0

StateForegroundBackgroundRatioFloor
defaultrgb(7 21 34)rgb(248 245 240)16.95AA 4.5
disabledrgb(67 77 86)rgb(248 245 240)7.93AA exempt
default (dark)rgb(248 245 240)rgb(7 21 34)16.95AA 4.5
disabled (dark)rgb(181 182 182)rgb(7 21 34)9.07AA exempt

Keyboard

measured on 0.2.0

KeyAction
SpaceToggle checked value
TabLeave control without changing its value
Shift+TabReturn focus with value preserved

Size

26885 gzip bytes · measured on 0.2.0

Example

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;

not on native yet