Switch API

The API documentation of the Switch React component. Learn more about the properties and the CSS customization points.

import Switch from '@material-ui/core/Switch';

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	enum: 'primary' \| 'secondary' \| 'default'	'secondary'	The color of the component. It supports those theme colors that make sense for this component.
disabled	bool		If `true`, the switch will be disabled.
disableRipple	bool		If `true`, the ripple effect will be disabled.
edge	enum: 'start' \| 'end' \| 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	union: func \| object		This prop can be used to pass a ref callback to the `input` element.
onChange	func		Callback fired when the state is changed. Signature: `function(event: object, checked: boolean) => void` event: The event source of the callback. You can pull out the new value by accessing `event.target.checked`. checked: The `checked` value of the switch
size	enum: 'small' \| 'medium'	'medium'	The size of the switch. `small` is equivalent to the dense switch styling.
type	string		The input component prop `type`.
value	any		The value of the component.

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (IconButton).

You can override all the class names injected by Material-UI thanks to the classes prop. This prop accepts the following keys:

Name	Description
root	Styles applied to the root element.
edgeStart	Styles applied to the root element if `edge="start"`.
edgeEnd	Styles applied to the root element if `edge="end"`.
switchBase	Styles applied to the internal `SwitchBase` component's `root` class.
colorPrimary	Styles applied to the internal SwitchBase component's root element if `color="primary"`.
colorSecondary	Styles applied to the internal SwitchBase component's root element if `color="secondary"`.
sizeSmall	Styles applied to the root element if `size="small"`.
checked	Pseudo-class applied to the internal `SwitchBase` component's `checked` class.
disabled	Pseudo-class applied to the internal SwitchBase component's disabled class.
input	Styles applied to the internal SwitchBase component's input element.
thumb	Styles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track	Styles applied to the track element.

If using the overrides key of the theme, you need to use the following style sheet name: MuiSwitch.

The properties of the IconButton component are also available. You can take advantage of this behavior to target nested components.

The component is fully StrictMode compatible.