Skip to content
Edit this page

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

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.

Type:

'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string

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
id

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'
sx

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

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


.MuiSwitch-rootroot

Styles applied to the root element.

.MuiSwitch-edgeStartedgeStart

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

.MuiSwitch-edgeEndedgeEnd

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

.MuiSwitch-switchBaseswitchBase

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

.MuiSwitch-colorPrimarycolorPrimary

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

.MuiSwitch-colorSecondarycolorSecondary

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

.MuiSwitch-sizeSmallsizeSmall

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

.MuiSwitch-sizeMediumsizeMedium

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

.Mui-checkedcheckedSTATE

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

.Mui-disableddisabledSTATE

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

.MuiSwitch-inputinput

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

.MuiSwitch-thumbthumb

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

.MuiSwitch-tracktrack

Styles applied to the track element.

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