Skip to content

ToggleButtonGroup API

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

Demos

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.

NameTypeDefaultDescription
buttonFlexnumber
| string
-

The flex value of the button.

childrennode-

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.

componentelementType-

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

disabledboolfalse

If true, all the buttons will be disabled.

onChangefunc-

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.

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

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.

valueArray<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 nameClass nameDefault componentDescription
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 nameRule nameDescription
.MuiToggleButtonGroup-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiToggleButtonGroup-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiToggleButtonGroup-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiToggleButtonGroup-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiToggleButtonGroup-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiToggleButtonGroup-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiToggleButtonGroup-horizontalhorizontalClass name applied to the root element if orientation="horizontal".
.MuiToggleButtonGroup-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiToggleButtonGroup-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiToggleButtonGroup-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiToggleButtonGroup-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiToggleButtonGroup-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiToggleButtonGroup-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiToggleButtonGroup-variantSolidvariantSolidClass name applied to the root element if variant="solid".
.MuiToggleButtonGroup-verticalverticalClass name applied to the root element if orientation="vertical".

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