Stable in React

Switch

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

Loading React 19.3.1…

Hover a part or use it. The code follows. · Loading React…

188Tests passing in React · 0 failing

7.5 KiBSize

Not measured yetMemory

Not measured yetSpeed

productdevbook and 15 upstream authors14 commits · last Nov 4

Install#

One package per framework. Switch's parts come from it; the anatomy tab at the top shows how they nest.

bun add @▢▢▢▢/react

Two parts. The example uses two of them; the data does not say which are required.

Switch.RootRepresents the switch itself.
Switch.ThumbThe movable part of the switch that indicates whether the switch is on or off.

Examples#

The demo at the top is the one example this component has so far.

Styling and accessibility#

The parts ship no styles. Style their states with these attributes; the CSS tab at the top has a sheet. The same CSS works in all five frameworks.

[data-checked]Present when the switch is checked. On Root, Thumb.
[data-unchecked]Present when the switch is not checked. On Root, Thumb.
[data-disabled]Present when the switch is disabled. On Root, Thumb.
[data-readonly]Present when the switch is readonly. On Root, Thumb.
[data-required]Present when the switch is required. On Root, Thumb.
[data-valid]Present when the switch is in a valid state (when wrapped in Field.Root). On Root, Thumb.
[data-invalid]Present when the switch is in an invalid state (when wrapped in Field.Root). On Root, Thumb.
[data-touched]Present when the switch has been touched (when wrapped in Field.Root). On Root, Thumb.
[data-dirty]Present when the switch's value has changed (when wrapped in Field.Root). On Root, Thumb.
[data-filled]Present when the switch is active (when wrapped in Field.Root). On Root, Thumb.
[data-focused]Present when the switch is focused (when wrapped in Field.Root). On Root, Thumb.

Keyboard

EnterSpaceTurns the switch on or off On Root.

Set for you

role="switch", aria-checkeda screen reader reads it as a switch and whether it is onRoot
aria-readonly, aria-required from readOnly and requiredthe constraints are announcedRoot
aria-labelledby to an associated labela <label> or Field label names the switchRoot
a hidden <input type="checkbox"> with aria-hidden="true" and tabindex="-1"the form gets the value without a second control to read or tab toRoot
renders a <span>the moving part is decoration; the state is on RootThumb

API reference#

13 props across 2 parts, in React syntax, and className, style, render once for every part. Open a row to try it.

Filter props

Switch · all parts

Shared propsEvery part that renders an element takes these.

classNameCSS class applied to the element, or a function that returns a class based on the component's state.string | ((state: State) => string | undefined)

styleStyle applied to the element, or a function that returns a style object based on the component's state.React.CSSProperties | ((state: State) => React.CSSProperties | undefined)

renderAllows you to replace the component's HTML element with a different tag, or compose it with another component.React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, State>

Use it in React#

What differs from the React API. Switch the framework at the top of the page.

@▢▢▢▢/react is the React 19 package. Its parts, props, data attributes and error messages are upstream Base UI's, and upstream's own tests run against it.

Parts
Each component is its own entry point and exports one namespace named after it.
```
import { Switch } from '@base-ui-next/react/switch'

export function Example() {
  return (
    <Switch.Root>
      <Switch.Thumb />
    </Switch.Root>
  )
}
```
A part renders the element its API reference names, such as a <span> for Switch.Root.
Props and events
Props and callbacks have upstream's names and signatures: onCheckedChange(checked, details), onOpenChange(open, details), onValueChange(value, details). details carries reason, event, cancel() and allowPropagation(). Native handlers are React's (onClick, onKeyDown), and event.preventBaseUIHandler() stops a part's own handler.
Styling
className takes a string or a function (state) => string; style takes an object or a function (state) => object. The state's data-* attributes are on the element for CSS.
render
render takes an element (render={<a href="/docs" />}) or a function (props, state) => element that spreads props on what it returns.
Refs
ref reaches the part's element. Imperative handles are ref props, as upstream: inputRef, and actionsRef ({ validate } on Field and Form, { unmount, close } on Dialog).
Binding
A part is controlled when its value prop (checked, open, value) is set, and uncontrolled with the default form (defaultChecked, defaultOpen, defaultValue). React has no two-way binding: pair the value with its change callback.
From @base-ui/react
Change the import from @base-ui/react/<component> to @▢▢▢▢/react/<component>.
From @base-ui/react
Nothing else changes: props, parts, data attributes and errors are the same.