Switch API

API reference docs for the React Switch component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Switch from '@mui/material/Switch';
// or
import { Switch } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

checked

checkedIcon

classes

color

defaultChecked

disabled

disableRipple

edge

icon

inputProps

inputRef

onChange

required

size

value

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the IconButton component are also available in Switch. You can take advantage of this to target nested components.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiSwitch-root

.MuiSwitch-edgeStart

.MuiSwitch-edgeEnd

.MuiSwitch-switchBase

.MuiSwitch-colorPrimary

.MuiSwitch-colorSecondary

.MuiSwitch-sizeSmall

.MuiSwitch-sizeMedium

.Mui-checkedSTATE

.Mui-disabledSTATE

.MuiSwitch-input

.MuiSwitch-thumb

.MuiSwitch-track

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.