ToggleButtonAPI

React ToggleButton 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

Demos

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

Toggle Button

Import

import ToggleButton from '@mui/material/ToggleButton';
// or
import { ToggleButton } from '@mui/material';

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

ButtonBase 组件的 Props 也可用。

名称	类型	默认值	描述
value*	any	-	在 ToggleButtonGroup 中选中时与按钮关联的值。
children	node	-	组件的内容。
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参见下方的 CSS classes API。
color	'standard' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'standard'	按钮在激活状态时的颜色。它同时支持默认主题颜色和自定义主题颜色，自定义主题颜色可以按照调色板自定义指南中所示的方式添加。
disabled	bool	false	如果 `true`，则组件被禁用。
disableFocusRipple	bool	false	如果 `true`，则禁用键盘焦点涟漪效果。
disableRipple	bool	false	如果 `true`，则禁用涟漪效果。 ⚠️ 如果没有涟漪效果，默认情况下 :focus-visible 没有样式。请务必通过使用 `.Mui-focusVisible` 类应用单独的样式来突出显示元素。
fullWidth	bool	false	如果 `true`，则按钮将占据其容器的全部宽度。
onChange	func	-	状态更改时触发的回调。签名：`function(event: React.MouseEvent, value: any) => void` `event` 回调的事件源。 `value` 所选按钮的值。
onClick	func	-	单击按钮时触发的回调。签名：`function(event: React.MouseEvent, value: any) => void` `event` 回调的事件源。 `value` 所选按钮的值。
selected	bool	-	如果 `true`，则按钮以激活状态渲染。
size	'small' \| 'medium' \| 'large' \| string	'medium'	组件的大小。此 prop 默认为从父 ToggleButtonGroup 组件继承的值。
sx	Array<func \| object \| bool> \| func \| object	-	系统属性，允许定义系统覆盖以及其他 CSS 样式。有关更多详细信息，请参见 `sx` 页面。

ref 被转发到根元素。

继承

尽管上面没有明确记录，但 ButtonBase 组件的 props 在 ToggleButton 中也可用。您可以利用这一点来定位嵌套组件。

主题默认 props

您可以使用 MuiToggleButton 通过主题更改此组件的默认 props。

CSS classes

这些类名对于使用 CSS 设置样式很有用。当触发特定状态时，它们将应用于组件的插槽。

类名	规则名称	描述
.Mui-disabled		如果 `disabled={true}`，则应用于根元素的状态类。
.Mui-selected		如果 `selected={true}`，则应用于根元素的状态类。
.MuiToggleButton-fullWidth	fullWidth	如果 `fullWidth={true}`，则应用于根元素的样式。
.MuiToggleButton-primary	primary	如果 `color="primary"`，则应用于根元素的状态类。
.MuiToggleButton-root	root	应用于根元素的样式。
.MuiToggleButton-secondary	secondary	如果 `color="secondary"`，则应用于根元素的状态类。
.MuiToggleButton-sizeLarge	sizeLarge	如果 `size="large"`，则应用于根元素的样式。
.MuiToggleButton-sizeMedium	sizeMedium	如果 `size="medium"`，则应用于根元素的样式。
.MuiToggleButton-sizeSmall	sizeSmall	如果 `size="small"`，则应用于根元素的样式。
.MuiToggleButton-standard	standard	如果 `color="standard"`，则应用于根元素的状态类。

您可以使用以下自定义选项之一来覆盖组件的样式

使用全局类名。
在自定义主题中使用规则名称作为组件的 styleOverrides 属性的一部分。

源代码

如果您在此页面中找不到所需信息，请考虑查看组件的实现以获取更多详细信息。