跳转到内容
编辑此页面

ToggleButtonGroup API

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

演示项目

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

导入

import ToggleButtonGroup from '@mui/material/ToggleButtonGroup';
// 或
import { ToggleButtonGroup } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

组件名称

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

属性

原生（Native） 组件的属性也是可用的。

名称类型默认值描述
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'standard'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string		'standard'
The color of the button when it is selected. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
disabledboolfalse
If true, the component is disabled. This implies that all ToggleButton children will be disabled.
exclusiveboolfalse
If true, only allow one of the child ToggleButton values to be selected.
fullWidthboolfalse
If true, the button group will take up the full width of its container.
onChangefunc
Callback fired when the value changes.

Signature:
function(event: object, value: any) => void
event: The event source of the callback.
value: of the selected buttons. When exclusive is true this is a single value; when false an array of selected values. If no value is selected and exclusive is true the value is null; when false an empty array.
orientation'horizontal'
| 'vertical'		'horizontal'
The group orientation (layout flow direction).
size'small'
| 'medium'
| 'large'
| string		'medium'
The size of the autocomplete.
sxArray<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.
valueany
The currently selected value within the group or an array of selected values when exclusive is false.
The value must have reference equality with the option in order to be selected.

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

CSS

规则名称全局类名描述
root.MuiToggleButtonGroup-rootStyles applied to the root element.
vertical.MuiToggleButtonGroup-verticalStyles applied to the root element if orientation="vertical".
disabled.Mui-disabledState class applied to the root element if disabled={true}.
grouped.MuiToggleButtonGroup-groupedStyles applied to the children.
groupedHorizontal.MuiToggleButtonGroup-groupedHorizontalStyles applied to the children if orientation="horizontal".
groupedVertical.MuiToggleButtonGroup-groupedVerticalStyles applied to the children if orientation="vertical".

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