Unstyled switch

Switches are UI elements that let users choose between two states—most commonly on/off.

Introduction

The SwitchUnstyled component provides users with a switch for toggling between two mutually exclusive states.

Component

Usage

After installation, you can start building with this component using the following basic elements:

import SwitchUnstyled from '@mui/base/SwitchUnstyled';

export default function MyApp() {
  return <SwitchUnstyled />;
}

Basics

The following demo shows how to assign styles and props to the SwitchUnstyled component:

Anatomy

The SwitchUnstyled component is composed of a root <span> that houses three interior slots—a track, a thumb, and an input:

<span class="MuiSwitch-root">
  <span class="MuiSwitch-track"></span>
  <span class="MuiSwitch-thumb"></span>
  <input type="checkbox" class="MuiSwitch-input" />
</span>

Slot props

Use the component prop to override the root slot with a custom element:

<SwitchUnstyled component="div" />

Use the components prop to override any interior slots in addition to the root:

<SwitchUnstyled components={{ Root: 'div', Track: 'div' }} />

Use the componentsProps prop to pass custom props to internal slots. The following code snippet applies a CSS class called my-thumb to the thumb slot:

<SwitchUnstyled componentsProps={{ thumb: { className: 'my-thumb' } }} />

Hook

import { useSwitch } from '@mui/base/SwitchUnstyled';

The useSwitch hook lets you apply the functionality of SwitchUnstyled to a fully custom component. It returns props to be placed on the custom component, along with fields representing the component's internal state.

Hooks do not support slot props, but they do support customization props.

Basic example

Customized look and feel

Accessibility

To make the switch component accessible, you should ensure that the corresponding labels reflect the current state of the switch.

API

• <SwitchUnstyled />