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

Import

import ToggleButton from '@mui/material/ToggleButton';
// or
import { ToggleButton } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

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 classes 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, 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, 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 in ToggleButton. You can take advantage of this to target nested components.

Theme default props

You can use MuiToggleButton to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-selectedState class applied to the root element if selected={true}.
.MuiToggleButton-fullWidthfullWidthStyles applied to the root element if fullWidth={true}.
.MuiToggleButton-primaryprimaryState class applied to the root element if color="primary".
.MuiToggleButton-rootrootStyles applied to the root element.
.MuiToggleButton-secondarysecondaryState class applied to the root element if color="secondary".
.MuiToggleButton-sizeLargesizeLargeStyles applied to the root element if size="large".
.MuiToggleButton-sizeMediumsizeMediumStyles applied to the root element if size="medium".
.MuiToggleButton-sizeSmallsizeSmallStyles applied to the root element if size="small".
.MuiToggleButton-standardstandardState class applied to the root element if color="standard".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.