Skip to content

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/joy/Switch';
// or
import { Switch } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

checked
color
component
defaultChecked
disabled
endDecorator
onChange
readOnly
required
size
slotProps
slots
startDecorator
sx
variant
The ref is forwarded to the root element.

Theme default props

You can use JoySwitch to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root
thumb
action
input
track
startDecorator
endDecorator

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-checkedSTATE
.Mui-disabledSTATE
.Mui-focusVisibleSTATE
.Mui-readOnlySTATE
.MuiSwitch-colorContext
.MuiSwitch-colorDanger
.MuiSwitch-colorPrimary
.MuiSwitch-colorSuccess
.MuiSwitch-colorWarning
.MuiSwitch-sizeLg
.MuiSwitch-sizeMd
.MuiSwitch-sizeSm
.MuiSwitch-variantOutlined
.MuiSwitch-variantSoft
.MuiSwitch-variantSolid