ToggleButtonGroupAPI

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

演示

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

Toggle Button

导入

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

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

Props

原生组件的 Props 也可用。

名称	类型	默认值	描述
children	node	-	组件的内容。
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参见下方的 CSS 类 API。
color	'standard' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'standard'	按钮在选中时的颜色。它同时支持默认主题颜色和自定义主题颜色，自定义主题颜色可以按照调色板自定义指南中所示的方式添加。
disabled	bool	false	如果为 `true`，则组件被禁用。这意味着所有的 ToggleButton 子组件都将被禁用。
exclusive	bool	false	如果为 `true`，则只允许选中子 ToggleButton 值中的一个。
fullWidth	bool	false	如果为 `true`，则按钮组将占据其容器的全部宽度。
onChange	func	-	当值更改时触发的回调。签名：`function(event: React.MouseEvent<htmlelement>, value: any) => void` `event` 回调的事件源。 `value` 选定按钮的值。当 `exclusive` 为 true 时，这是一个单一值；当 false 时，这是一个选定值的数组。如果未选中任何值且 `exclusive` 为 true，则值为 null；当 false 时，为一个空数组。
orientation	'horizontal' \| 'vertical'	'horizontal'	组件方向（布局流方向）。
size	'small' \| 'medium' \| 'large' \| string	'medium'	组件的大小。
sx	Array<func \| object \| bool> \| func \| object	-	允许定义系统覆盖以及其他 CSS 样式的系统属性。有关更多详细信息，请参见 `sx` 页面。
value	any	-	组中当前选定的值，或者当 `exclusive` 为 false 时，选定值的数组。该值必须与选项具有引用相等性才能被选中。

ref 被转发到根元素。

主题默认 props

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

CSS 类

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

类名	规则名称	描述
.Mui-disabled		如果 `disabled={true}`，则应用于根元素的状态类。
.Mui-selected		如果 `selected={true}`，则应用于根元素的状态类。
.MuiToggleButtonGroup-firstButton	firstButton	应用于 toggle button group 中第一个按钮的样式。
.MuiToggleButtonGroup-fullWidth	fullWidth	如果 `fullWidth={true}`，则应用于根元素的样式。
.MuiToggleButtonGroup-grouped	grouped	应用于子组件的样式。
.MuiToggleButtonGroup-groupedHorizontal	groupedHorizontal	如果 `orientation="horizontal"`，则应用于子组件的样式。已弃用－请结合使用 .MuiToggleButtonGroup-horizontal 和 .MuiToggleButtonGroup-grouped 类。有关更多详细信息，请参见从已弃用的 API 迁移。
.MuiToggleButtonGroup-groupedVertical	groupedVertical	如果 `orientation="vertical"`，则应用于子组件的样式。已弃用－请结合使用 .MuiToggleButtonGroup-vertical 和 .MuiToggleButtonGroup-grouped 类。有关更多详细信息，请参见从已弃用的 API 迁移。
.MuiToggleButtonGroup-horizontal	horizontal	如果 `orientation="horizontal"`，则应用于根元素的样式。
.MuiToggleButtonGroup-lastButton	lastButton	应用于 toggle button group 中最后一个按钮的样式。
.MuiToggleButtonGroup-middleButton	middleButton	应用于 toggle button group 中间按钮的样式。
.MuiToggleButtonGroup-root	root	应用于根元素的样式。
.MuiToggleButtonGroup-vertical	vertical	如果 `orientation="vertical"`，则应用于根元素的样式。

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

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

源代码

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