Skip to content
Edit this page

ToggleButton API

API reference docs for the React ToggleButton component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import ToggleButton from '@mui/material/ToggleButton';
// or
import { ToggleButton } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

valueRequired

The value to associate with the button when selected in a ToggleButtonGroup.

Type:

any
children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

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'
disabled

If true, the component is disabled.

Type:

bool

Default:

false
disableFocusRipple

If true, the keyboard focus ripple is disabled.

Type:

bool

Default:

false
disableRipple

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
fullWidth

If true, the button will take up the full width of its container.

Type:

bool

Default:

false
onChange

Callback fired when the state changes.

Type:

func

Signature:

function(event: React.MouseEvent, value: any) => void
  • event The event source of the callback.
  • value of the selected button.
onClick

Callback fired when the button is clicked.

Type:

func

Signature:

function(event: React.MouseEvent, value: any) => void
  • event The event source of the callback.
  • value of the selected button.
selected

If true, the button is rendered in an active state.

Type:

bool
size

The size of the component. The prop defaults to the value inherited from the parent ToggleButtonGroup component.

Type:

'small' | 'medium' | 'large' | string

Default:

'medium'
sx

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
The 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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiToggleButton-rootroot

Styles applied to the root element.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.Mui-selectedselectedSTATE

State class applied to the root element if selected={true}.

.MuiToggleButton-standardstandard

State class applied to the root element if color="standard".

.MuiToggleButton-primaryprimary

State class applied to the root element if color="primary".

.MuiToggleButton-secondarysecondary

State class applied to the root element if color="secondary".

.MuiToggleButton-sizeSmallsizeSmall

Styles applied to the root element if size="small".

.MuiToggleButton-sizeMediumsizeMedium

Styles applied to the root element if size="medium".

.MuiToggleButton-sizeLargesizeLarge

Styles applied to the root element if size="large".

You can override the style of the component using one of these customization options: