Switch API

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

Component 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

If true, the component is checked.

Type:bool

checkedIcon

The icon to display when the component is checked.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Default:'primary'

defaultChecked

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

Type:bool

disabled

If true, the component is disabled.

Type:bool

disableRipple

If true, the ripple effect is disabled.

Type:bool

Default:false

edge

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

Type:'end' | 'start' | false

Default:false

icon

The icon to display when the component is unchecked.

Type:node

The id of the input element.

Type:string

inputProps

Attributes applied to the input element.

Type:object

inputRef

Pass a ref to the input element.

Type:ref

onChange

Callback fired when the state is changed.

Type:func

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

required

If true, the input element is required.

Type:bool

Default:false

size

The size of the component. small is equivalent to the dense switch styling.

Type:'medium' | 'small' | string

Default:'medium'

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

value

The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

Type:any

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.

.Mui-checkedSTATE

State class applied to the internal SwitchBase component's checked class.

.Mui-disabledSTATE

State class applied to the internal SwitchBase component's disabled class.

.MuiSwitch-colorPrimary

Styles applied to the internal SwitchBase component's root element if color="primary".

Rule name:colorPrimary

.MuiSwitch-colorSecondary

Styles applied to the internal SwitchBase component's root element if color="secondary".

Rule name:colorSecondary

.MuiSwitch-edgeEnd

Styles applied to the root element if edge="end".

Rule name:edgeEnd

.MuiSwitch-edgeStart

Styles applied to the root element if edge="start".

Rule name:edgeStart

.MuiSwitch-input

Styles applied to the internal SwitchBase component's input element.

Rule name:input

.MuiSwitch-root

Styles applied to the root element.

Rule name:root

.MuiSwitch-sizeMedium

Styles applied to the root element if size="medium".

Rule name:sizeMedium

.MuiSwitch-sizeSmall

Styles applied to the root element if size="small".

Rule name:sizeSmall

.MuiSwitch-switchBase

Styles applied to the internal SwitchBase component's root class.

Rule name:switchBase

.MuiSwitch-thumb

Styles used to create the thumb passed to the internal SwitchBase component icon prop.

Rule name:thumb

.MuiSwitch-track

Styles applied to the track element.

Rule name: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.