Skip to content

SwitchUnstyled API

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

Import

import SwitchUnstyled from '@mui/base/SwitchUnstyled';
// or
import { SwitchUnstyled } from '@mui/base';
You can learn about the difference by reading this guide on minimizing bundle size.

The foundation for building custom-styled switches.

Props

Props of the native component are also available.

NameTypeDefaultDescription
checkedboolfalse
If true, the component is checked.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
defaultCheckedboolfalse
The default checked state. Use when the component is not controlled.
disabledboolfalse
If true, the component is disabled.
onChangefunc
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).
readOnlyboolfalse
If true, the component is read only.
requiredboolfalse
If true, the input element is required.
slotProps{ input?: func
| object, root?: func
| object, thumb?: func
| object, track?: func
| object }
{}
The props used for each slot inside the Switch.
slots{ input?: elementType, root?: elementType, thumb?: elementType, track?: elementType
| null }
{}
The components used for each slot inside the Switch. Either a string to use a HTML element or a component.

The ref is forwarded to the root element.

Demos