ToggleButton API
API reference docs for the React ToggleButton component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ToggleButton from '@mui/material/ToggleButton';
// or
import { ToggleButton } from '@mui/material';
Props of the ButtonBase 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 in an active state. 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 ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusVisible
class.
Type:bool
Default:false
Callback fired when the state changes.
Type:func
function(event: React.MouseEvent, value: any) => void
event
The event source of the callback.value
of the selected button.
Callback fired when the button is clicked.
Type:func
function(event: React.MouseEvent, value: any) => void
event
The event source of the callback.value
of the selected button.
The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
Type:'small'
| 'medium'
| 'large'
| string
Default:'medium'
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.Inheritance
While not explicitly documented above, the props of the ButtonBase component are also available in ToggleButton. You can take advantage of this to target nested components.
Theme default props
You can use MuiToggleButton
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
State class applied to the root element if color="primary"
.
Rule name:primary
State class applied to the root element if color="secondary"
.
Rule name:secondary
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.