ToggleButton API
Import
import ToggleButton from '@mui/material/ToggleButton';
// or
import { ToggleButton } from '@mui/material';Component name
The nameMuiToggleButton can be used when providing default props or style overrides in the theme.Props
Props of the ButtonBase component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| value* | any | The value to associate with the button when selected in a ToggleButtonGroup. | |
| children | node | The content of the component. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | 'standard' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'standard' | 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. |
| disabled | bool | false | If true, the component is disabled. |
| disableFocusRipple | bool | false | If true, the keyboard focus ripple is disabled. |
| disableRipple | bool | false | 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. |
| fullWidth | bool | false | If true, the button will take up the full width of its container. |
| onChange | func | Callback fired when the state changes. Signature: function(event: React.MouseEvent<HTMLElement>, value: any) => voidevent: The event source of the callback. value: of the selected button. | |
| onClick | func | Callback fired when the button is clicked. Signature: function(event: React.MouseEvent<HTMLElement>, value: any) => voidevent: The event source of the callback. value: of the selected button. | |
| selected | bool | false | If true, the button is rendered in an active state. |
| size | 'small' | 'medium' | 'large' | string | 'medium' | The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component. |
| sx | Array<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. |
The
ref is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the ButtonBase component are also available on ToggleButton. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiToggleButton-root | Styles applied to the root element. |
| disabled | .Mui-disabled | State class applied to the root element if disabled={true}. |
| selected | .Mui-selected | State class applied to the root element if selected={true}. |
| standard | .MuiToggleButton-standard | State class applied to the root element if color="standard". |
| primary | .MuiToggleButton-primary | State class applied to the root element if color="primary". |
| secondary | .MuiToggleButton-secondary | State class applied to the root element if color="secondary". |
| sizeSmall | .MuiToggleButton-sizeSmall | Styles applied to the root element if size="small". |
| sizeMedium | .MuiToggleButton-sizeMedium | Styles applied to the root element if size="medium". |
| sizeLarge | .MuiToggleButton-sizeLarge | Styles applied to the root element if size="large". |
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.