跳转到内容

ToggleButton API

API documentation for the React ToggleButton component. Learn about the available props, and the CSS API.

Import

import ToggleButton from '@mui/material/ToggleButton';
// 或
import { ToggleButton } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiToggleButton can be used when providing default props or style overrides in the theme.

属性

Props of the ButtonBase component are also available.

名称类型默认值描述
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.
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.
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>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

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

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available on ToggleButton. You can take advantage of this to target nested components.

CSS

Rule nameGlobal class描述
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".

You can override the style of the component using one of these customization options:

Demos