Skip to content
Edit this page

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

If true, the component is checked.

Type:

bool
color

The color of the component. It supports those theme colors that make sense for this component.

Type:

'danger' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
defaultChecked

The default checked state. Use when the component is not controlled.

Type:

bool
disabled

If true, the component is disabled.

Type:

bool
endDecorator

The element that appears at the end of the switch.

Type:

node | func
onChange

Callback fired when the state is changed.

Type:

func

Signature:

function(event: React.ChangeEvent) => 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

If true, the component is read only.

Type:

bool
required

If true, the input element is required.

Type:

bool
size

The size of the component.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ action?: func | object, endDecorator?: func | object, input?: func | object, root?: func | object, startDecorator?: func | object, thumb?: func | object, track?: func | object }

Default:

{}
slots

The components used for each slot inside.

Type:

{ action?: elementType, endDecorator?: elementType, input?: elementType, root?: elementType, startDecorator?: elementType, thumb?: elementType, track?: elementType }

Default:

{}
startDecorator

The element that appears at the end of the switch.

Type:

node | func
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'solid'
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'div'Required

Global class: .MuiSwitch-root

Description: The component that renders the root.

thumb'span'Required

Global class: .MuiSwitch-thumb

Description: The component that renders the thumb.

action'div'Required

Global class: .MuiSwitch-action

Description: The component that renders the action.

input'input'Required

Global class: .MuiSwitch-input

Description: The component that renders the input.

track'span'Required

Global class: .MuiSwitch-track

Description: The component that renders the track.

startDecorator'span'Required

Global class: .MuiSwitch-startDecorator

Description: The component that renders the start decorator.

endDecorator'span'Required

Global class: .MuiSwitch-endDecorator

Description: The component that renders the end decorator.

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

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

State class applied to the root checked class.

.Mui-disabledSTATE

State class applied to the root disabled class.

.Mui-focusVisibleSTATE

State class applied to the root element if the switch has visible focus

.MuiSwitch-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiSwitch-colorDanger

Class name applied to the root element if color="danger".

.MuiSwitch-colorPrimary

Class name applied to the root element if color="primary".

.MuiSwitch-colorSuccess

Class name applied to the root element if color="success".

.MuiSwitch-colorWarning

Class name applied to the root element if color="warning".

.MuiSwitch-readOnly

Class name applied to the root element if the switch is read-only

.MuiSwitch-sizeLg

Class name applied to the root element if size="lg".

.MuiSwitch-sizeMd

Class name applied to the root element if size="md".

.MuiSwitch-sizeSm

Class name applied to the root element if size="sm".

.MuiSwitch-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiSwitch-variantSoft

Class name applied to the root element if variant="soft".

.MuiSwitch-variantSolid

Class name applied to the root element if variant="solid".