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

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

NameTypeDefaultDescription
checkedbool-

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 classes 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.

defaultCheckedbool-

The default checked state. Use when the component is not controlled.

disabledbool-

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) => 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 in Switch. You can take advantage of this to target nested components.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-checkedState class applied to the internal SwitchBase component's checked class.
.Mui-disabledState class applied to the internal SwitchBase component's disabled class.
.MuiSwitch-colorPrimarycolorPrimaryStyles applied to the internal SwitchBase component's root element if color="primary".
.MuiSwitch-colorSecondarycolorSecondaryStyles applied to the internal SwitchBase component's root element if color="secondary".
.MuiSwitch-edgeEndedgeEndStyles applied to the root element if edge="end".
.MuiSwitch-edgeStartedgeStartStyles applied to the root element if edge="start".
.MuiSwitch-inputinputStyles applied to the internal SwitchBase component's input element.
.MuiSwitch-rootrootStyles applied to the root element.
.MuiSwitch-sizeMediumsizeMediumStyles applied to the root element if size="medium".
.MuiSwitch-sizeSmallsizeSmallStyles applied to the root element if size="small".
.MuiSwitch-switchBaseswitchBaseStyles applied to the internal SwitchBase component's root class.
.MuiSwitch-thumbthumbStyles used to create the thumb passed to the internal SwitchBase component icon prop.
.MuiSwitch-tracktrackStyles applied to the track element.

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