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>
  );
}

Anatomy

Import the component and assemble its parts:

Anatomy

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

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

API reference

Root

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

namestring

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

defaultCheckedboolean(default: false)

Name: defaultChecked
Description: Whether the switch is initially active.

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

checkedboolean

Name: checked
Description: Whether the switch is currently active.

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

onCheckedChangefunction

Name: onCheckedChange
Description: Event handler called when the switch is activated or deactivated.
Type: | (( checked: boolean, eventDetails: Switch.Root.ChangeEventDetails, ) => void) | undefined

nativeButtonboolean(default: true)

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

disabledboolean(default: false)

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

readOnlyboolean(default: false)

Name: readOnly
Description: Whether the user should be unable to activate or deactivate the switch.
Type: boolean | undefined
Default: false

requiredboolean(default: false)

Name: required
Description: Whether the user must activate the switch 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 switch 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: Switch.Root.State) => string)

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: Switch.Root.State, ) => ReactElement)

data-checked

Present when the switch is checked.

data-unchecked

Present when the switch is not checked.

data-disabled

Present when the switch is disabled.

data-readonly

Present when the switch is readonly.

data-required

Present when the switch is required.

data-valid

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

data-invalid

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

data-dirty

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

data-touched

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

data-filled

Present when the switch is active (when wrapped in Field.Root).

data-focused

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

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

Thumb

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