跳转到内容

SwitchUnstyled API

想要学习更多组件属性和 CSS API,可以查阅 React SwitchUnstyled 组件的 API 文档。

导入

import SwitchUnstyled from '@mui/base/SwitchUnstyled';
// 或
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.

属性

原生(Native) 组件的属性也是可用的。

名称类型默认值描述
checkedboolfalse
If true, the component is checked.
classNamestring
Styles applied to the root element.
componentelementType
The component used for the Root slot. Either a string to use a HTML element or a component. This is equivalent to components.Root. If both are provided, the component is used.
components{ 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.
componentsProps{ input?: object, root?: object, thumb?: object, track?: object }{}
The props used for each slot inside the Switch.
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.

ref 则会被传递到根元素中。

演示项目