跳转到内容

ToggleButton API

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

导入

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

组件名称

在主题中,名称“MuiToggleButton”可用于提供默认属性(props),或者样式覆盖

属性

ButtonBase 组件的属性也是可用的。

名称类型默认值描述
value*any
The value to associate with the button when selected in a ToggleButtonGroup.
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 in an active state. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
disabledboolfalse
如果被设置为 true,那么该组件将会被禁用。
disableFocusRippleboolfalse
If true, the keyboard focus ripple is disabled.
disableRippleboolfalse
If true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName.
fullWidthboolfalse
If true, the button will take up the full width of its container.
onChangefunc
Callback fired when the state changes.

Signature:
function(event: React.MouseEvent<HTMLElement>, value: any) => void
event: The event source of the callback.
value: of the selected button.
onClickfunc
Callback fired when the button is clicked.

Signature:
function(event: React.MouseEvent<HTMLElement>, value: any) => void
event: The event source of the callback.
value: of the selected button.
selectedboolfalse
If true, the button is rendered in an active state.
size'small'
| 'medium'
| 'large'
| string
'medium'
The size of the button. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
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.

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

继承

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

CSS

规则名称全局类名描述
root.MuiToggleButton-rootStyles applied to the root element.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
selected.Mui-selectedPseudo-class applied to the root element if selected={true}.
standard.MuiToggleButton-standardPseudo-class applied to the root element if color="standard".
primary.MuiToggleButton-primaryPseudo-class applied to the root element if color="primary".
secondary.MuiToggleButton-secondaryPseudo-class applied to the root element if color="secondary".
sizeSmall.MuiToggleButton-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiToggleButton-sizeMediumStyles applied to the root element if size="medium".
sizeLarge.MuiToggleButton-sizeLargeStyles applied to the root element if size="large".

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

演示项目