Switch

A control that indicates whether a setting is on or off.

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

export default function ExampleSwitch() {
  return (
    <Switch.Root defaultChecked className={styles.Switch}>
      <Switch.Thumb className={styles.Thumb} />
    </Switch.Root>
  );
}

API reference

Import the component and place its parts the following way:

Anatomy

import { Switch } from '@base-ui-components/react/switch';

<Switch.Root>
  <Switch.Thumb />
</Switch.Root>

Root

Represents the switch itself. Renders a <button> element and a hidden <input> beside.

Prop	Type	Default
`checked`	`boolean`	`undefined`
`className`	`string \| (state) => string`	`undefined`
`defaultChecked`	`boolean`	`false`
`disabled`	`boolean`	`false`
`inputRef`	`React.Ref`	`undefined`
`name`	`string`	`undefined`
`onCheckedChange`	`(checked, event) => void`	`undefined`
`readOnly`	`boolean`	`false`
`render`	`\| React.ReactElement \| (props, state) => React.ReactElement`	`undefined`
`required`	`boolean`	`false`

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

Thumb

The movable part of the switch that indicates whether the switch is on or off. Renders a <span>.

Prop	Type	Default
`className`	`string \| (state) => string`	`undefined`
`render`	`\| React.ReactElement \| (props, state) => React.ReactElement`	`undefined`

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