Skip to content

ButtonGroup API

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

Props

Props of the native component are also available.

buttonFlex
children
color
component
disabled
orientation
size
slotProps
slots
spacing
sx
variant
The ref is forwarded to the root element.

Theme default props

You can use JoyButtonGroup 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

CSS classes

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

.MuiButtonGroup-colorContext
.MuiButtonGroup-colorDanger
.MuiButtonGroup-colorNeutral
.MuiButtonGroup-colorPrimary
.MuiButtonGroup-colorSuccess
.MuiButtonGroup-colorWarning
.MuiButtonGroup-horizontal
.MuiButtonGroup-sizeLg
.MuiButtonGroup-sizeMd
.MuiButtonGroup-sizeSm
.MuiButtonGroup-variantOutlined
.MuiButtonGroup-variantPlain
.MuiButtonGroup-variantSoft
.MuiButtonGroup-variantSolid
.MuiButtonGroup-vertical