useSwitch API

API reference docs for the useSwitch hook. Learn about the input parameters and other APIs of this exported module.

Demos

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

import useSwitch from '@mui/base/useSwitch';

The basic building block for creating custom switches.

Name	Type	Description
checked	boolean	If `true`, the component is checked.
defaultChecked	boolean	The default checked state. Use when the component is not controlled.
disabled	boolean	If `true`, the component is disabled.
onBlur	React.FocusEventHandler
onChange	React.ChangeEventHandler<HTMLInputElement>	Callback fired when the state is changed.
onFocus	React.FocusEventHandler
onFocusVisible	React.FocusEventHandler
readOnly	boolean	If `true`, the component is read only.
required	boolean	If `true`, the `input` element is required.

Name	Type	Default	Description