Skip to content
EN

ToggleButton API

The API documentation of the ToggleButton React component. Learn more about the props and the CSS customization points.

Import

import ToggleButton from '@material-ui/lab/ToggleButton';
// or
import { ToggleButton } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

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 props supplied will be provided to the root element (ButtonBase).

CSS

  • Style sheet name: MuiToggleButton.
  • Style sheet details:
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 thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.

Demos