Switch API

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

演示项目

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

导入

import Switch from '@mui/material/Switch';
// 或
import { Switch } from '@mui/material';

你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

组件名称

在主题中，名称“MuiSwitch”可用于提供默认属性（props），或者样式覆盖

属性

名称	类型	默认值	描述
checked	bool	false	If `true`, the component is checked.
checkedIcon	node		The icon to display when the component is checked.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'default' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'primary'	The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
defaultChecked	bool	false	The default checked state. Use when the component is not controlled.
disabled	bool	false	如果被设置为 `true`，那么该组件将会被禁用。
disableRipple	bool	false	If `true`, the ripple effect is disabled.
edge	'end' \| 'start' \| false	false	If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).
icon	node		The icon to display when the component is unchecked.
id	string		The id of the `input` element.
inputProps	object		Attributes applied to the `input` element.
inputRef	ref		Pass a ref to the `input` element.
onChange	func		Callback fired when the state is changed. Signature: `function(event: object) => 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).
required	bool	false	If `true`, the `input` element is required.
size	'medium' \| 'small' \| string	'medium'	The size of the switch. `small` is equivalent to the dense switch styling.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
value	any		The value of the component. The DOM API casts this to a string. The browser uses "on" as the default value.

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

继承

尽管上文没有明文记录， IconButton 组件的属性(props) 在组件Switch上同样是可用的。你可以利用这一点来指向嵌套组件

CSS

规则名称	全局类名	描述
root	.MuiSwitch-root	Styles applied to the root element.
edgeStart	.MuiSwitch-edgeStart	Styles applied to the root element if `edge="start"`.
edgeEnd	.MuiSwitch-edgeEnd	Styles applied to the root element if `edge="end"`.
switchBase	.MuiSwitch-switchBase	Styles applied to the internal `SwitchBase` component's `root` class.
colorPrimary	.MuiSwitch-colorPrimary	Styles applied to the internal SwitchBase component's root element if `color="primary"`.
colorSecondary	.MuiSwitch-colorSecondary	Styles applied to the internal SwitchBase component's root element if `color="secondary"`.
sizeSmall	.MuiSwitch-sizeSmall	Styles applied to the root element if `size="small"`.
sizeMedium	.MuiSwitch-sizeMedium	Styles applied to the root element if `size="medium"`.
checked	.Mui-checked	Pseudo-class applied to the internal `SwitchBase` component's `checked` class.
disabled	.Mui-disabled	Pseudo-class applied to the internal SwitchBase component's disabled class.
input	.MuiSwitch-input	Styles applied to the internal SwitchBase component's input element.
thumb	.MuiSwitch-thumb	Styles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track	.MuiSwitch-track	Styles applied to the track element.

您可以使用组件自定义选项对组件进行个性化：

具备全局类名.
在自定义主体中，设定一个规则名称作为组件的styleOverrides属性的一部分。