Checkbox

An easily stylable checkbox component.

Enable notifications

import * as React from 'react';
import { Checkbox } from '@base-ui-components/react/checkbox';
import styles from './index.module.css';

export default function ExampleCheckbox() {
  return (
    <label className={styles.Label}>
      <Checkbox.Root defaultChecked aria-label="Enable notifications" className={styles.Checkbox}>
        <Checkbox.Indicator className={styles.Indicator}>
          <CheckIcon className={styles.Icon} />
        </Checkbox.Indicator>
      </Checkbox.Root>
      Enable notifications
    </label>
  );
}

function CheckIcon(props: React.ComponentProps<'svg'>) {
  return (
    <svg fill="currentcolor" width="10" height="10" viewBox="0 0 10 10" {...props}>
      <path d="M9.1603 1.12218C9.50684 1.34873 9.60427 1.81354 9.37792 2.16038L5.13603 8.66012C5.01614 8.8438 4.82192 8.96576 4.60451 8.99384C4.3871 9.02194 4.1683 8.95335 4.00574 8.80615L1.24664 6.30769C0.939709 6.02975 0.916013 5.55541 1.19372 5.24822C1.47142 4.94102 1.94536 4.91731 2.2523 5.19524L4.36085 7.10461L8.12299 1.33999C8.34934 0.993152 8.81376 0.895638 9.1603 1.12218Z" />
    </svg>
  );
}

Usage guidelines

Form controls must have an accessible name: The checkbox must have a meaningful label. Prefer using <Field> to provide a visible text label and description, or use the aria-label attribute as an alternative. See the forms guide for more on building form controls.

Anatomy

Import the component and assemble its parts:

Anatomy

import { Checkbox } from '@base-ui-components/react/checkbox';

<Checkbox.Root>
  <Checkbox.Indicator />
</Checkbox.Root>

Examples

Form integration

To use a single checkbox in a form, pass the checkbox’s name to <Field> and use <Field.Label> to label the control.

Using Checkbox in a form

<Form>
  <Field.Root name="stayLoggedIn">
    <Field.Label>
      <Checkbox.Root />
      Stay logged in for 7 days
    </Field.Label>
  </Field.Root>
</Form>

API reference

Root

Represents the checkbox itself. Renders a <span> element and a hidden <input> beside.

namestringundefined

Name: name
Description: Identifies the field when a form is submitted.
Type: string | undefined
Default: undefined

defaultCheckedbooleanfalse

Name: defaultChecked
Description: Whether the checkbox is initially ticked.

To render a controlled checkbox, use the checked prop instead.
Type: boolean | undefined
Default: false

checkedbooleanundefined

Name: checked
Description: Whether the checkbox is currently ticked.

To render an uncontrolled checkbox, use the defaultChecked prop instead.
Type: boolean | undefined
Default: undefined

onCheckedChangefunction—

Name: onCheckedChange
Description: Event handler called when the checkbox is ticked or unticked.
Type: | (( checked: boolean, eventDetails: Checkbox.Root.ChangeEventDetails, ) => void) | undefined

indeterminatebooleanfalse

Name: indeterminate
Description: Whether the checkbox is in a mixed state: neither ticked, nor unticked.
Type: boolean | undefined
Default: false

valuestring—

Name: value
Description: The value of the selected checkbox.
Type: string | undefined

nativeButtonbooleanfalse

Name: nativeButton
Description: Whether the component renders a native <button> element when replacing it via the render prop. Set to true if the rendered element is a native button.
Type: boolean | undefined
Default: false

parentbooleanfalse

Name: parent
Description: Whether the checkbox controls a group of child checkboxes.

Must be used in a Checkbox Group.
Type: boolean | undefined
Default: false

uncheckedValuestring—

Name: uncheckedValue
Description: The value submitted with the form when the checkbox is unchecked. By default, unchecked checkboxes do not submit any value, matching native checkbox behavior.
Type: string | undefined

disabledbooleanfalse

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

readOnlybooleanfalse

Name: readOnly
Description: Whether the user should be unable to tick or untick the checkbox.
Type: boolean | undefined
Default: false

requiredbooleanfalse

Name: required
Description: Whether the user must tick the checkbox before submitting a form.
Type: boolean | undefined
Default: false

inputRefRef<HTMLInputElement>—

Name: inputRef
Description: A ref to access the hidden <input> element.
Type: React.Ref<HTMLInputElement> | undefined

idstring—

Name: id
Description: The id of the input element.
Type: string | undefined

classNamestring | function—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Checkbox.Root.State) => string | undefined)

styleReact.CSSProperties | function—

Name: style
Type: | React.CSSProperties | (( state: Checkbox.Root.State, ) => CSSProperties | undefined) | undefined

renderReactElement | function—

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Checkbox.Root.State, ) => ReactElement)

data-checked

Present when the checkbox is checked.

data-unchecked

Present when the checkbox is not checked.

data-disabled

Present when the checkbox is disabled.

data-readonly

Present when the checkbox is readonly.

data-required

Present when the checkbox is required.

data-valid

Present when the checkbox is in valid state (when wrapped in Field.Root).

data-invalid

Present when the checkbox is in invalid state (when wrapped in Field.Root).

data-dirty

Present when the checkbox's value has changed (when wrapped in Field.Root).

data-touched

Present when the checkbox has been touched (when wrapped in Field.Root).

data-filled

Present when the checkbox is checked (when wrapped in Field.Root).

data-focused

Present when the checkbox is focused (when wrapped in Field.Root).

Attribute	Description	-
`data-checked`	Present when the checkbox is checked.
`data-unchecked`	Present when the checkbox is not checked.
`data-disabled`	Present when the checkbox is disabled.
`data-readonly`	Present when the checkbox is readonly.
`data-required`	Present when the checkbox is required.
`data-valid`	Present when the checkbox is in valid state (when wrapped in Field.Root).
`data-invalid`	Present when the checkbox is in invalid state (when wrapped in Field.Root).
`data-dirty`	Present when the checkbox's value has changed (when wrapped in Field.Root).
`data-touched`	Present when the checkbox has been touched (when wrapped in Field.Root).
`data-filled`	Present when the checkbox is checked (when wrapped in Field.Root).
`data-focused`	Present when the checkbox is focused (when wrapped in Field.Root).

Indicator

Indicates whether the checkbox is ticked. Renders a <span> element.