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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

valueRequired
children
classes
color
disabled
disableFocusRipple
disableRipple
fullWidth
onChange
onClick
selected
size
sx
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiToggleButton-root
.Mui-disabledSTATE
.Mui-selectedSTATE
.MuiToggleButton-standard
.MuiToggleButton-primary
.MuiToggleButton-secondary
.MuiToggleButton-sizeSmall
.MuiToggleButton-sizeMedium
.MuiToggleButton-sizeLarge

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