Skip to content

ToggleButton API

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


import ToggleButton from '@mui/material/ToggleButton';
// or
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.

The value to associate with the button when selected in a ToggleButtonGroup.
The content of the component.
Override or extend the styles applied to the component. See CSS API below for more details.
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
The color of the button when it is in an active state.
If true, the component is disabled.
If true, the keyboard focus ripple is disabled.
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 .Mui-focusVisible class.
If true, the button will take up the full width of its container.
If true, the button is rendered in an active state.
| 'medium'
| 'large'
| string
The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.


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.


Rule nameGlobal classDescription
root.MuiToggleButton-rootStyles applied to the root element.
disabled.Mui-disabledState class applied to the root element if disabled={true}.
selected.Mui-selectedState class applied to the root element if selected={true}.
standard.MuiToggleButton-standardState class applied to the root element if color="standard".
primary.MuiToggleButton-primaryState class applied to the root element if color="primary".
secondary.MuiToggleButton-secondaryState 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: