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/joy/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

⚠️ ToggleButtonGroup must have Button and/or IconButton as direct children.

Props

Props of the native component are also available.

buttonFlex

The flex value of the button.

Type:

number | string
children

Used to render icon or text elements inside the ButtonGroup if src is not set. This can be an element, or just a string.

Type:

node
color

The color of the component. It supports those theme colors that make sense for this component.

Type:

'danger' | 'info' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
disabled

If true, all the buttons will be disabled.

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.

Type:

'horizontal' | 'vertical'

Default:

'horizontal'
size

The size of the component. It accepts theme values between 'sm' and 'lg'.

Type:

'sm' | 'md' | 'lg'

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}
slots

The components used for each slot inside.

Type:

{ root?: elementType }

Default:

{}
spacing

Defines the space between the type item components. It can only be used on a type container component.

Type:

Array<number | string> | number | { lg?: number | string, md?: number | string, sm?: number | string, xl?: number | string, xs?: number | string } | string

Default:

0
sx

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

Type:

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

The currently selected value within the group or an array of selected values.
The value must have reference equality with the option in order to be selected.

Type:

Array<string> | string
variant

The global variant to use.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'outlined'
The ref is forwarded to the root element.

Theme default props

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

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root'div'Required

Global class: .MuiToggleButtonGroup-root

Description: The component that renders the root.

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiToggleButtonGroup-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiToggleButtonGroup-colorDanger

Class name applied to the root element if color="danger".

.MuiToggleButtonGroup-colorNeutral

Class name applied to the root element if color="neutral".

.MuiToggleButtonGroup-colorPrimary

Class name applied to the root element if color="primary".

.MuiToggleButtonGroup-colorSuccess

Class name applied to the root element if color="success".

.MuiToggleButtonGroup-colorWarning

Class name applied to the root element if color="warning".

.MuiToggleButtonGroup-horizontal

Class name applied to the root element if orientation="horizontal".

.MuiToggleButtonGroup-sizeLg

Class name applied to the root element if size="lg".

.MuiToggleButtonGroup-sizeMd

Class name applied to the root element if size="md".

.MuiToggleButtonGroup-sizeSm

Class name applied to the root element if size="sm".

.MuiToggleButtonGroup-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiToggleButtonGroup-variantPlain

Class name applied to the root element if variant="plain".

.MuiToggleButtonGroup-variantSoft

Class name applied to the root element if variant="soft".

.MuiToggleButtonGroup-variantSolid

Class name applied to the root element if variant="solid".

.MuiToggleButtonGroup-vertical

Class name applied to the root element if orientation="vertical".