ToggleButtonGroup API

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

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

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: object) => 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.
size	'small' | 'medium' | 'large'	'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 component cannot hold a ref.

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

CSS

• Style sheet name: MuiToggleButtonGroup.
• Style sheet details:

Rule name	Global class	Description
root	MuiToggleButtonGroup-root	Styles applied to the root element.

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.

Notes

The component can cause issues in StrictMode.

Demos

• Toggle Button