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:

Toggle Button

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.

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' \| '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.
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-focusVisible` class.
fullWidth	bool	false	If `true`, the button will take up the full width of its container.
onChange	func		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.
onClick	func		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.
selected	bool		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.
sx	Array<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

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

Global class	Rule name	Description
.MuiToggleButton-root	root	Styles applied to the root element.
.Mui-disabled	disabled	State class applied to the root element if `disabled={true}`.
.Mui-selected	selected	State class applied to the root element if `selected={true}`.
.MuiToggleButton-standard	standard	State class applied to the root element if `color="standard"`.
.MuiToggleButton-primary	primary	State class applied to the root element if `color="primary"`.
.MuiToggleButton-secondary	secondary	State class applied to the root element if `color="secondary"`.
.MuiToggleButton-sizeSmall	sizeSmall	Styles applied to the root element if `size="small"`.
.MuiToggleButton-sizeMedium	sizeMedium	Styles applied to the root element if `size="medium"`.
.MuiToggleButton-sizeLarge	sizeLarge	Styles applied to the root element if `size="large"`.
.MuiToggleButton-fullWidth	fullWidth	Styles applied to the root element if `fullWidth={true}`.

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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.