Checkbox

An easily stylable checkbox component.

Base UI React 1.8.0

Enable notifications

FineSoft Stencil

Enable notifications

react-checkbox.tsx stencil-checkbox.tsx index.module.css

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

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

function CheckIcon(props: React.ComponentProps<'svg'>) {
  return (
    <svg
      width="16"
      height="16"
      viewBox="0 0 16 16"
      fill="none"
      stroke="currentColor"
      {...props}
      style={{ display: 'block', ...props.style }}
    >
      <path d="m2.5 8.5 4 4 7-9" />
    </svg>
  );
}

Stencil styling

fs-checkbox-root keeps its native control and form input in Light DOM to preserve native labels and form ownership. fs-checkbox-indicator uses an open ShadowRoot and exposes ::part(indicator); its author content remains in a native slot.

The Base UI theme is built in; set data-fs-theme="base-ui" on an ancestor for the default skin. Indicator classes remain on the host; use fs-checkbox-indicator::part(indicator) for internal styles. Checked, indeterminate, disabled and transition states are available on the host. Author inline styles still apply to the indicator container. Checkbox Group keeps its public layout and semantics in Light DOM.

Usage guidelines

Form controls must have an accessible name: It can be created using a <label> element or the Field component. See Labeling a checkbox and the forms guide.

Anatomy

Import the component and assemble its parts:

Anatomy

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

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

Examples

Labeling a checkbox

An enclosing <label> is the simplest labeling pattern:

Wrapping a label around a checkbox

<label>
  <Checkbox.Root />
  Accept terms and conditions
</label>

Rendering as a native button

By default, <Checkbox.Root> renders a <span> element to support enclosing labels. Prefer rendering the checkbox as a native button when using sibling labels (htmlFor/id).

Sibling label pattern with a native button

<div>
  <label htmlFor="notifications-checkbox">Enable notifications</label>
  <Checkbox.Root id="notifications-checkbox" nativeButton render={<button />}>
    <Checkbox.Indicator />
  </Checkbox.Root>
</div>

Native buttons with wrapping labels are supported by using the render callback to avoid invalid HTML, so the hidden input is placed outside the label:

Render callback

<Checkbox.Root
  nativeButton
  render={(buttonProps) => (
    <label>
      <button {...buttonProps} />
      Enable notifications
    </label>
  )}
/>

Form integration

Use Field to handle label associations and form integration:

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 checkbox’s value. Identifies it within a 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”.
Type: string | undefined

formstring—

Name: form
Description: Identifies the form that owns the hidden input. Useful when the checkbox is rendered outside the form.
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

inputRefReact.Ref<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) | undefined

styleReact.CSSProperties | function—

Name: style
Description: Style applied to the element, or a function that returns a style object based on the component’s state.
Type: | React.CSSProperties | (( state: Checkbox.Root.State, ) => React.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) | undefined

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 a valid state (when wrapped in Field.Root).

data-invalid

Present when the checkbox is in an 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).

data-indeterminate

Present when the checkbox is in an indeterminate state.

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 a valid state (when wrapped in Field.Root).
`data-invalid`	Present when the checkbox is in an 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).
`data-indeterminate`	Present when the checkbox is in an indeterminate state.

Checkbox.Root.PropsHide

Re-Export of Root props as CheckboxRootProps

Checkbox.Root.StateHide

type CheckboxRootState = {
  /** Whether the checkbox is currently ticked. */
  checked: boolean;
  /** Whether the component should ignore user interaction. */
  disabled: boolean;
  /** Whether the user should be unable to tick or untick the checkbox. */
  readOnly: boolean;
  /** Whether the user must tick the checkbox before submitting a form. */
  required: boolean;
  /** Whether the checkbox is in a mixed state: neither ticked, nor unticked. */
  indeterminate: boolean;
  /** Whether the field has been touched. */
  touched: boolean;
  /** Whether the field value has changed from its initial value. */
  dirty: boolean;
  /** Whether the field is valid. */
  valid: boolean | null;
  /** Whether the field has a value. */
  filled: boolean;
  /** Whether the field is focused. */
  focused: boolean;
}

Checkbox.Root.ChangeEventReasonHide

type CheckboxRootChangeEventReason = 'none'

Checkbox.Root.ChangeEventDetailsHide

type CheckboxRootChangeEventDetails = {
  /** The reason for the event. */
  reason: 'none';
  /** The native event associated with the custom event. */
  event: Event;
  /** Cancels Base UI from handling the event. */
  cancel: () => void;
  /** Allows the event to propagate in cases where Base UI will stop the propagation. */
  allowPropagation: () => void;
  /** Indicates whether the event has been canceled. */
  isCanceled: boolean;
  /** Indicates whether the event is allowed to propagate. */
  isPropagationAllowed: boolean;
  /** The element that triggered the event, if applicable. */
  trigger: Element | undefined;
}

Indicator

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