ButtonGroup API
API reference docs for the React ButtonGroup component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ButtonGroup from '@mui/joy/ButtonGroup';
// or
import { ButtonGroup } from '@mui/joy';Props of the native component are also available.
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
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.
Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
Default:'neutral'
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
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.
Type:'lg'
| 'md'
| 'sm'
| string
Default:'md'
The components used for each slot inside.
See Slots API below for more details.
Type:{ root?: elementType }
Default:{}
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
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
The global variant to use.
To learn how to add your own variants, check out Themed components—Extend variants.
Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
Default:'outlined'
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.
To learn how to customize the slot, check out the Overriding component structure guide.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name applied to the root element when color inversion is triggered.
Rule name:colorContext
Class name applied to the root element if color="danger".
Rule name:colorDanger
Class name applied to the root element if color="neutral".
Rule name:colorNeutral
Class name applied to the root element if color="primary".
Rule name:colorPrimary
Class name applied to the root element if color="success".
Rule name:colorSuccess
Class name applied to the root element if color="warning".
Rule name:colorWarning
Class name applied to the root element if orientation="horizontal".
Rule name:horizontal
Class name applied to the root element if variant="outlined".
Rule name:variantOutlined
Class name applied to the root element if variant="plain".
Rule name:variantPlain
Class name applied to the root element if variant="soft".
Rule name:variantSoft
Class name applied to the root element if variant="solid".
Rule name:variantSolid
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
styleOverridesproperty in a custom theme.