Skip to content

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';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSwitch can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
checkedboolfalse
If true, the component is checked.
checkedIconnode
The icon to display when the component is checked.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'primary'
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
defaultCheckedboolfalse
The default checked state. Use when the component is not controlled.
disabledboolfalse
If true, the component is disabled.
disableRippleboolfalse
If true, the ripple effect is disabled.
edge'end'
| 'start'
| false
false
If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).
iconnode
The icon to display when the component is unchecked.
idstring
The id of the input element.
inputPropsobject
Attributes applied to the input element.
inputRefref
Pass a ref to the input element.
onChangefunc
Callback fired when the state is changed.

Signature:
function(event: React.ChangeEvent<HTMLInputElement>) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
requiredboolfalse
If true, the input element is required.
size'medium'
| 'small'
| string
'medium'
The size of the component. small is equivalent to the dense switch styling.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
valueany
The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

The ref is forwarded to the root element.

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiSwitch-rootStyles applied to the root element.
edgeStart.MuiSwitch-edgeStartStyles applied to the root element if edge="start".
edgeEnd.MuiSwitch-edgeEndStyles applied to the root element if edge="end".
switchBase.MuiSwitch-switchBaseStyles applied to the internal `SwitchBase` component's `root` class.
colorPrimary.MuiSwitch-colorPrimaryStyles applied to the internal SwitchBase component's root element if color="primary".
colorSecondary.MuiSwitch-colorSecondaryStyles applied to the internal SwitchBase component's root element if color="secondary".
sizeSmall.MuiSwitch-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiSwitch-sizeMediumStyles applied to the root element if size="medium".
checked.Mui-checkedState class applied to the internal `SwitchBase` component's `checked` class.
disabled.Mui-disabledState class applied to the internal SwitchBase component's disabled class.
input.MuiSwitch-inputStyles applied to the internal SwitchBase component's input element.
thumb.MuiSwitch-thumbStyles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track.MuiSwitch-trackStyles applied to the track element.

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