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

Name	Type	Default	Description
value^*	any		The value to associate with the button when selected in a ToggleButtonGroup.
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'standard' \| 'primary' \| 'secondary' \| string	'standard'	The color of the button when it is in an active state.
disabled	bool	false	If `true`, the component is disabled.
disableFocusRipple	bool	false	If `true`, the keyboard focus ripple is disabled.
disableRipple	bool	false	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-focusedVisible` class.
fullWidth	bool	false	If `true`, the button will take up the full width of its container.
selected	bool	false	If `true`, the button is rendered in an active state.
size	'large' \| 'medium' \| 'small' \| string	'medium'	The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
sx	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.
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 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}`.
standard	.MuiToggleButton-standard	Pseudo-class applied to the root element if `color="standard"`.
primary	.MuiToggleButton-primary	Pseudo-class applied to the root element if `color="primary"`.
secondary	.MuiToggleButton-secondary	Pseudo-class applied to the root element if `color="secondary"`.
label	.MuiToggleButton-label	Styles applied to the `label` wrapper element.
sizeSmall	.MuiToggleButton-sizeSmall	Styles applied to the root element if `size="small"`.
sizeMedium	.MuiToggleButton-sizeMedium	Styles applied to the root element if `size="medium"`.
sizeLarge	.MuiToggleButton-sizeLarge	Styles applied to the root element if `size="large"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Demos

Toggle Button