ToggleButton API
API documentation for the React ToggleButton component. Learn about the available props, and the CSS API.
Import
import ToggleButton from '@material-ui/core/ToggleButton';
// or
import { ToggleButton } from '@material-ui/core';Component name
The nameMuiToggleButton can be used when providing default props or style overrides in the theme.Props
| 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. | |
| 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-focusedVisible class. |
| selected | bool | false | If true, the button is rendered in an active state. |
| size | 'large' | 'medium' | 'small' | 'medium' | The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (ButtonBase).
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 | Pseudo-class applied to the root element if disabled={true}. |
| selected | .Mui-selected | Pseudo-class applied to the root element if selected={true}. |
| label | .MuiToggleButton-label | Styles applied to the `label` wrapper element. |
| sizeSmall | .MuiToggleButton-sizeSmall | Styles applied to the root element if size="small". |
| 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 rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.