Switch API

API reference docs for the React Switch component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Switch

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.

To learn how to add your own colors, check out Themed components—Extend colors.

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.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

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.

See Slots API below for more details.

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

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

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

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

The component that renders the root.

Class name: .MuiSwitch-root

Default component: 'div'

thumb

The component that renders the thumb.

Class name: .MuiSwitch-thumb

Default component: 'span'

action

The component that renders the action.

Class name: .MuiSwitch-action

Default component: 'div'

input

The component that renders the input.

Class name: .MuiSwitch-input

Default component: 'input'

track

The component that renders the track.

Class name: .MuiSwitch-track

Default component: 'span'

startDecorator

The component that renders the start decorator.

Class name: .MuiSwitch-startDecorator

Default component: 'span'

endDecorator

The component that renders the end decorator.

Class name: .MuiSwitch-endDecorator

Default component: 'span'

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots 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

.Mui-readOnlySTATE

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

.MuiSwitch-colorContext

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

Rule name:colorContext

.MuiSwitch-colorDanger

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

Rule name:colorDanger

.MuiSwitch-colorPrimary

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

Rule name:colorPrimary

.MuiSwitch-colorSuccess

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

Rule name:colorSuccess

.MuiSwitch-colorWarning

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

Rule name:colorWarning

.MuiSwitch-sizeLg

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

Rule name:sizeLg

.MuiSwitch-sizeMd

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

Rule name:sizeMd

.MuiSwitch-sizeSm

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

Rule name:sizeSm

.MuiSwitch-variantOutlined

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

Rule name:variantOutlined

.MuiSwitch-variantSoft

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

Rule name:variantSoft

.MuiSwitch-variantSolid

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

Rule name:variantSolid

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.