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

Name	Type	Default	Description
checked	bool		If `true`, the component is checked.
checkedIcon	node		The icon to display when the component is checked.
classes	object		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.
defaultChecked	bool		The default checked state. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled.
disableRipple	bool	false	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).
icon	node		The icon to display when the component is unchecked.
id	string		The id of the `input` element.
inputProps	object		Attributes applied to the `input` element.
inputRef	ref		Pass a ref to the `input` element.
onChange	func		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).
required	bool	false	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.
sx	Array<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.
value	any		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 name	Global class	Description
root	.MuiSwitch-root	Styles applied to the root element.
edgeStart	.MuiSwitch-edgeStart	Styles applied to the root element if `edge="start"`.
edgeEnd	.MuiSwitch-edgeEnd	Styles applied to the root element if `edge="end"`.
switchBase	.MuiSwitch-switchBase	Styles applied to the internal `SwitchBase` component's `root` class.
colorPrimary	.MuiSwitch-colorPrimary	Styles applied to the internal SwitchBase component's root element if `color="primary"`.
colorSecondary	.MuiSwitch-colorSecondary	Styles applied to the internal SwitchBase component's root element if `color="secondary"`.
sizeSmall	.MuiSwitch-sizeSmall	Styles applied to the root element if `size="small"`.
sizeMedium	.MuiSwitch-sizeMedium	Styles applied to the root element if `size="medium"`.
checked	.Mui-checked	State class applied to the internal `SwitchBase` component's `checked` class.
disabled	.Mui-disabled	State class applied to the internal SwitchBase component's disabled class.
input	.MuiSwitch-input	Styles applied to the internal SwitchBase component's input element.
thumb	.MuiSwitch-thumb	Styles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track	.MuiSwitch-track	Styles applied to the track element.

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.