Skip to content

ToggleButton API

API reference docs for the React ToggleButton component. Learn about the props, CSS, and other APIs of this exported module.

Demos

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

Import

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

Props of the ButtonBase component are also available.

NameTypeDefaultDescription
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
If true, the component is disabled.
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 .Mui-focusVisible class.
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.
selectedbool
If true, the button is rendered in an active state.
size'small'
| 'medium'
| 'large'
| string
'medium'
The size of the component. 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.

The ref is forwarded to the root element.

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 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: