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 Switch from '@mui/joy/Switch';
// or
import { Switch } from '@mui/joy';

The name JoySwitch can be used when providing default props or style overrides in the theme.

Props of the native component are also available.

Name	Type	Default	Description
checked	bool		If `true`, the component is checked.
color	'danger' \| 'info' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component.
defaultChecked	bool		The default checked state. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled.
endDecorator	node \| func		The element that appears at the end of the switch.
onChange	func		Callback fired when the state is changed. Signature: `function(event: React.ChangeEvent<HTMLInputElement>) => 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).
readOnly	bool		If `true`, the component is read only.
required	bool		If `true`, the `input` element is required.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component.
startDecorator	node \| func		The element that appears at the end of the switch.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'solid'	The variant to use.

The ref is forwarded to the root element.