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 classes 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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

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

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.