Skip to content
Edit this page

ToggleButtonGroup API

API reference docs for the React ToggleButtonGroup component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

Props of the native component are also available.

children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

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.

Type:

'standard' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string

Default:

'standard'
disabled

If true, the component is disabled. This implies that all ToggleButton children will be disabled.

Type:

bool

Default:

false
exclusive

If true, only allow one of the child ToggleButton values to be selected.

Type:

bool

Default:

false
fullWidth

If true, the button group will take up the full width of its container.

Type:

bool

Default:

false
onChange

Callback fired when the value changes.

Type:

func

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

The component orientation (layout flow direction).

Type:

'horizontal' | 'vertical'

Default:

'horizontal'
size

The size of the component.

Type:

'small' | 'medium' | 'large' | string

Default:

'medium'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
value

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.

Type:

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

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiToggleButtonGroup-rootroot

Styles applied to the root element.

.MuiToggleButtonGroup-verticalvertical

Styles applied to the root element if orientation="vertical".

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.MuiToggleButtonGroup-groupedgrouped

Styles applied to the children.

.MuiToggleButtonGroup-groupedHorizontalgroupedHorizontal

Styles applied to the children if orientation="horizontal".

.MuiToggleButtonGroup-groupedVerticalgroupedVertical

Styles applied to the children if orientation="vertical".

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