ToggleButton API
The API documentation of the ToggleButton React component. Learn more about the properties and the CSS customization points.
import ToggleButton from '@material-ui/lab/ToggleButton';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children * | node | The content of the button. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| disabled | bool | false | If true, the button will be disabled. |
| disableFocusRipple | bool | false | If true, the keyboard focus ripple will be disabled. disableRipple must also be true. |
| disableRipple | bool | false | If true, the ripple effect will be disabled. |
| selected | bool | If true, the button will be rendered in an active state. |
|
| value * | any | The value to associate with the button when selected in a ToggleButtonGroup. |
The component cannot hold a ref.
Any other properties supplied will be provided to the root element (ButtonBase).
CSS
You can override all the class names injected by Material-UI thanks to the classes prop.
This prop accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| disabled | Pseudo-class applied to the root element if disabled={true}. |
| selected | Pseudo-class applied to the root element if selected={true}. |
| label | Styles applied to the label wrapper element. |
| sizeSmall | Styles applied to the root element if size="small". |
| sizeLarge | Styles applied to the root element if size="large". |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiToggleButton.
Inheritance
The properties of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.
Notes
The component can cause issues in StrictMode.