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:

Toggle Button Group

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.

Name	Type	Default	Description
buttonFlex	number \| string	-	The flex value of the button.
children	node	-	Used to render icon or text elements inside the ButtonGroup if `src` is not set. This can be an element, or just a string.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, all the buttons will be disabled.
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.
size	'sm' \| 'md' \| 'lg'	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
spacing	Array<number \| string> \| number \| { lg?: number \| string, md?: number \| string, sm?: number \| string, xl?: number \| string, xs?: number \| string } \| string	0	Defines the space between the type `item` components. It can only be used on a type `container` 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	Array<string> \| string	-	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.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'outlined'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

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.

Slot name	Class name	Default component	Description
root	.MuiToggleButtonGroup-root	`'div'`	The component that renders the root.

CSS classes

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
.MuiToggleButtonGroup-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiToggleButtonGroup-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiToggleButtonGroup-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiToggleButtonGroup-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiToggleButtonGroup-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiToggleButtonGroup-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiToggleButtonGroup-horizontal	horizontal	Class name applied to the root element if `orientation="horizontal"`.
.MuiToggleButtonGroup-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiToggleButtonGroup-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiToggleButtonGroup-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiToggleButtonGroup-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiToggleButtonGroup-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiToggleButtonGroup-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiToggleButtonGroup-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.
.MuiToggleButtonGroup-vertical	vertical	Class name 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.