Skip to content

ToggleButtonGroup API

API documentation for the React ToggleButtonGroup component. Learn about the available props, and the CSS API.


import ToggleButtonGroup from '@material-ui/core/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiToggleButtonGroup can be used when providing default props or style overrides in the theme.


childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
exclusiveboolfalseIf true, only allow one of the child ToggleButton values to be selected.
onChangefuncCallback fired when the value changes.

function(event: object, 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.
| 'vertical'
'horizontal'The component orientation (layout flow direction).
| 'medium'
| 'small'
'medium'The size of the component.
valueanyThe 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.
Any other props supplied will be provided to the root element (native element).


Rule nameGlobal classDescription
root.MuiToggleButtonGroup-rootStyles applied to the root element.
vertical.MuiToggleButtonGroup-verticalStyles applied to the root element if orientation="vertical".
grouped.MuiToggleButtonGroup-groupedStyles applied to the children.
groupedHorizontal.MuiToggleButtonGroup-groupedHorizontalStyles applied to the children if orientation="horizontal".
groupedVertical.MuiToggleButtonGroup-groupedVerticalStyles applied to the children if orientation="vertical".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.