ToggleButtonGroup API

The API documentation of the ToggleButtonGroup React component. Learn more about the props and the CSS customization points.

Import

import ToggleButtonGroup from '@material-ui/lab/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiToggleButtonGroup name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
children	node		The content of the button.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
exclusive	bool	false	If true, only allow one of the child ToggleButton values to be selected.
onChange	func		Callback fired when the value changes. Signature: 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.
orientation	'horizontal' | 'vertical'	'horizontal'	The group orientation (layout flow direction).
size	'large' | 'medium' | 'small'	'medium'	The size of the buttons.
value	any		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.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name	Global class	Description
root	.MuiToggleButtonGroup-root	Styles applied to the root element.
vertical	.MuiToggleButtonGroup-vertical	Styles applied to the root element if orientation="vertical".
grouped	.MuiToggleButtonGroup-grouped	Styles applied to the children.
groupedHorizontal	.MuiToggleButtonGroup-groupedHorizontal	Styles applied to the children if orientation="horizontal".
groupedVertical	.MuiToggleButtonGroup-groupedVertical	Styles applied to the children if orientation="vertical".

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Toggle Button