toggle-button-group

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 of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
classes	object	-	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.
disabled	bool	false	If true, the component is disabled. This implies that all ToggleButton children will be disabled.
exclusive	bool	false	If true, only allow one of the child ToggleButton values to be selected.
fullWidth	bool	false	If true, the button group will take up the full width of its container.
onChange	func	-	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.
sx	Array<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.
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.

Theme default props

You can use MuiToggleButtonGroup to change the default props of this component with the theme.

These class names are useful for styling with CSS. They are applied to the component’s slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled	-	State class applied to the root element if disabled={true}.
.Mui-selected	-	State class applied to the root element if selected={true}.
.MuiToggleButtonGroup-firstButton	firstButton	Styles applied to the first button in the toggle button group.
.MuiToggleButtonGroup-fullWidth	fullWidth	Styles applied to the root element if fullWidth={true}.
.MuiToggleButtonGroup-grouped	grouped	Styles applied to the children.
.MuiToggleButtonGroup-groupedHorizontal	groupedHorizontal	Styles applied to the children if orientation="horizontal".
.MuiToggleButtonGroup-groupedVertical	groupedVertical	Styles applied to the children if orientation="vertical".
.MuiToggleButtonGroup-horizontal	horizontal	Styles applied to the root element if orientation="horizontal".
.MuiToggleButtonGroup-lastButton	lastButton	Styles applied to the last button in the toggle button group.
.MuiToggleButtonGroup-middleButton	middleButton	Styles applied to buttons in the middle of the toggle button group.
.MuiToggleButtonGroup-root	root	Styles applied to the root element.
.MuiToggleButtonGroup-vertical	vertical	Styles applied to the root element if orientation="vertical".

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

• With a global class name.
• With a rule name as part of the component’s styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.