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	union: bool |  string		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.
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		Use that property to pass a ref callback to the native input component.
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
type	string		The input component property type.
value	union: string |  number |  bool		The value of the component.

Any other properties supplied will be spread to the root element (native element).

CSS

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

Name	Description
root	Styles applied to the root element.
icon	Styles used to create the icon passed to the internal SwitchBase component icon prop.
iconChecked	Styles applied the icon element component if checked={true}.
switchBase	Styles applied to the internal SwitchBase component's root class.
checked	Styles applied to the internal SwitchBase component's checked 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".
disabled	Styles applied to the internal SwitchBase component's disabled class.
bar	Styles applied to the bar element.

Have a look at overriding with classes section and the implementation of the component for more detail.

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

Demos

• Selection Controls