Skip to content

Switch API

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

Import

import Switch from '@material-ui/core/Switch';
// or
import { Switch } from '@material-ui/core';

You can learn more about the difference by reading this guide.

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 '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 '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 ref Pass a ref to the input element.
onChange func Callback fired when the state is changed.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
required bool If true, the input element will be required.
size '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 DOM API casts this to a string.

The ref is forwarded to the root element.

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

CSS

  • Style sheet name: MuiSwitch.
  • Style sheet details:
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".
checked Mui-checked Pseudo-class applied to the internal SwitchBase component's checked class.
disabled Mui-disabled Pseudo-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 thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

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

Demos