ToggleButtonGroup API

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

Import

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

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

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

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 using one of these customization options:

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