Skip to content
Edit this page

ToggleButtonGroup API

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

Import

import ToggleButtonGroup from '@mui/material/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@mui/material';
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.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'standard'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string		'standard'
The color of a button when it is selected.
disabledboolfalse
If true, the component is disabled. This implies that all ToggleButton children will be disabled.
exclusiveboolfalse
If true, only allow one of the child ToggleButton values to be selected.
fullWidthboolfalse
If true, the button group will take up the full width of its container.
onChangefunc
Callback fired when the value changes.

Signature:
function(event: React.MouseEvent<HTMLElement>, 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.
sxArray<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.
valueany
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.

CSS

Rule nameGlobal classDescription
root.MuiToggleButtonGroup-rootStyles applied to the root element.
vertical.MuiToggleButtonGroup-verticalStyles applied to the root element if orientation="vertical".
disabled.Mui-disabledState class applied to the root element if disabled={true}.
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:

Demos