Skip to content

ToggleButton API

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

Import

import ToggleButton from '@material-ui/core/ToggleButton';
// or
import { ToggleButton } from '@material-ui/core';
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

NameTypeDefaultDescription
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
disabledboolfalseIf true, the component is disabled.
disableFocusRippleboolfalseIf true, the keyboard focus ripple is disabled.
disableRippleboolfalseIf 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-focusedVisible class.
selectedboolfalseIf true, the button is rendered in an active state.
size'large'
| 'medium'
| 'small'
'medium'The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
value*anyThe value to associate with the button when selected in a ToggleButtonGroup.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (ButtonBase).

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-disabledPseudo-class applied to the root element if disabled={true}.
selected.Mui-selectedPseudo-class applied to the root element if selected={true}.
label.MuiToggleButton-labelStyles applied to the `label` wrapper element.
sizeSmall.MuiToggleButton-sizeSmallStyles applied to the root element if size="small".
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: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos