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';
// 或
import { ToggleButton } from '@material-ui/core';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiToggleButton can be used when providing default props or style overrides in the theme.

属性

名称	类型	默认值	描述
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' \| string	'standard'
disabled	bool	false	如果被设置为 `true`，那么该组件将会被禁用。
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 `focusVisibleClassName`.
fullWidth	bool	false
selected	bool	false	If `true`, the button is rendered in an active state.
size	'large' \| 'medium' \| 'small' \| string	'medium'	The size of the button. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
sx	object

ref 则会被传递到根元素中。
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	描述
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}`.
standard	.MuiToggleButton-standard
primary	.MuiToggleButton-primary
secondary	.MuiToggleButton-secondary
label	.MuiToggleButton-label	Styles applied to the `label` wrapper element.
sizeSmall	.MuiToggleButton-sizeSmall	Styles applied to the root element if `size="small"`.
sizeMedium	.MuiToggleButton-sizeMedium
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 styleOverrides property in a custom theme.

Demos

Toggle Button