Skip to content

ToggleButtonGroup API

API reference docs for the React ToggleButtonGroup component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import ToggleButtonGroup from '@mui/material/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

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 selected. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

disabledboolfalse

If true, the component is disabled. This implies that all ToggleButton children will be disabled.

exclusiveboolfalse

If true, only allow one of the child ToggleButton values to be selected.

fullWidthboolfalse

If true, the button group will take up the full width of its container.

onChangefunc-

Callback fired when the value changes.

Signature:function(event: React.MouseEvent, value: any) => void
  • event The event source of the callback.
  • value of the selected buttons. When exclusive is true this is a single value; when false an array of selected values. If no value is selected and exclusive is true the value is null; when false an empty array.
orientation'horizontal'
| 'vertical'		'horizontal'

The component orientation (layout flow direction).

size'small'
| 'medium'
| 'large'
| string		'medium'

The size of the component.

sxArray<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.

valueany-

The currently selected value within the group or an array of selected values when exclusive is false.
The value must have reference equality with the option in order to be selected.

The ref is forwarded to the root element.

Theme default props

You can use MuiToggleButtonGroup 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 nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-selectedState class applied to the root element if selected={true}.
.MuiToggleButtonGroup-firstButtonfirstButtonStyles applied to the first button in the toggle button group.
.MuiToggleButtonGroup-fullWidthfullWidthStyles applied to the root element if fullWidth={true}.
.MuiToggleButtonGroup-groupedgroupedStyles applied to the children.
.MuiToggleButtonGroup-groupedHorizontalgroupedHorizontalStyles applied to the children if orientation="horizontal".
.MuiToggleButtonGroup-groupedVerticalgroupedVerticalStyles applied to the children if orientation="vertical".
.MuiToggleButtonGroup-horizontalhorizontalStyles applied to the root element if orientation="horizontal".
.MuiToggleButtonGroup-lastButtonlastButtonStyles applied to the last button in the toggle button group.
.MuiToggleButtonGroup-middleButtonmiddleButtonStyles applied to buttons in the middle of the toggle button group.
.MuiToggleButtonGroup-rootrootStyles applied to the root element.
.MuiToggleButtonGroup-verticalverticalStyles applied to the root element if orientation="vertical".

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