ToggleButton API

The API documentation of the ToggleButton React component. Learn more about the props and the CSS customization points.

Import

import ToggleButton from '@material-ui/core/ToggleButton';
// or
import { ToggleButton } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiToggleButton name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
children	node		The content of the button.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
disabled	bool	false	If true, the button will be disabled.
disableFocusRipple	bool	false	If true, the keyboard focus ripple will be disabled.
disableRipple	bool		If true, the ripple effect will be 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 focusVisibleClassName.
selected	bool		If true, the button will be rendered in an active state.
size	'large' | 'medium' | 'small'	'medium'	The size of the button. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
value*	any		The 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).

CSS

Rule name	Global class	Description
root	.MuiToggleButton-root	Styles applied to the root element.
disabled	.Mui-disabled	Pseudo-class applied to the root element if disabled={true}.
selected	.Mui-selected	Pseudo-class applied to the root element if selected={true}.
label	.MuiToggleButton-label	Styles applied to the label wrapper element.
sizeSmall	.MuiToggleButton-sizeSmall	Styles applied to the root element if size="small".
sizeLarge	.MuiToggleButton-sizeLarge	Styles applied to the root element if size="large".

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.

Demos

• Toggle Button