Skip to content

Switch API

API documentation for the React Switch component. Learn about the available props, and the CSS API.

Import

import Switch from '@material-ui/core/Switch';
// or
import { Switch } from '@material-ui/core';
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

NameTypeDefaultDescription
checkedboolfalseIf true, the component is checked.
checkedIconnodeThe icon to display when the component is checked.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'default'
| 'primary'
| 'secondary'
| string
'primary'The color of the component. It supports those theme colors that make sense for this component.
defaultCheckedboolfalseThe default checked state. Use when the component is not controlled.
disabledboolfalseIf true, the component is disabled.
disableRippleboolfalseIf true, the ripple effect is disabled.
edge'end'
| 'start'
| false
falseIf 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).
iconnodeThe icon to display when the component is unchecked.
idstringThe id of the input element.
inputPropsobjectAttributes applied to the input element.
inputRefrefPass a ref to the input element.
onChangefuncCallback fired when the state is changed.

Signature:
function(event: object) => 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).
requiredboolfalseIf true, the input element is required.
size'medium'
| 'small'
| string
'medium'The size of the component. small is equivalent to the dense switch styling.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
valueanyThe 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 nameGlobal classDescription
root.MuiSwitch-rootStyles applied to the root element.
edgeStart.MuiSwitch-edgeStartStyles applied to the root element if edge="start".
edgeEnd.MuiSwitch-edgeEndStyles applied to the root element if edge="end".
switchBase.MuiSwitch-switchBaseStyles applied to the internal `SwitchBase` component's `root` class.
colorPrimary.MuiSwitch-colorPrimaryStyles applied to the internal SwitchBase component's root element if color="primary".
colorSecondary.MuiSwitch-colorSecondaryStyles applied to the internal SwitchBase component's root element if color="secondary".
sizeSmall.MuiSwitch-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiSwitch-sizeMediumStyles applied to the root element if size="medium".
checked.Mui-checkedPseudo-class applied to the internal `SwitchBase` component's `checked` class.
disabled.Mui-disabledPseudo-class applied to the internal SwitchBase component's disabled class.
input.MuiSwitch-inputStyles applied to the internal SwitchBase component's input element.
thumb.MuiSwitch-thumbStyles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track.MuiSwitch-trackStyles applied to the track element.

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

Demos