ToggleButtonGroup API
API reference docs for the React ToggleButtonGroup component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ToggleButtonGroup from '@mui/material/ToggleButtonGroup';
// or
import { ToggleButtonGroup } from '@mui/material';
Props of the native component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The color of the button when it is selected. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
Type:'standard'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
Default:'standard'
If true
, the component is disabled. This implies that all ToggleButton children will be disabled.
Type:bool
Default:false
If true
, only allow one of the child ToggleButton values to be selected.
Type:bool
Default:false
If true
, the button group will take up the full width of its container.
Type:bool
Default:false
Callback fired when the value changes.
Type:func
function(event: React.MouseEvent, value: any) => void
event
The event source of the callback.value
of the selected buttons. Whenexclusive
is true this is a single value; when false an array of selected values. If no value is selected andexclusive
is true the value is null; when false an empty array.
The component orientation (layout flow direction).
Type:'horizontal'
| 'vertical'
Default:'horizontal'
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
ref
is forwarded to the root element.Theme default props
You can use MuiToggleButtonGroup
to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the root element if fullWidth={true}
.
Rule name:fullWidth
Styles applied to the children if orientation="horizontal"
.
Rule name:groupedHorizontal
Styles applied to the children if orientation="vertical"
.
Rule name:groupedVertical
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.