ToggleButton API

Documentação da API para o componente React ToggleButton . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import ToggleButton from '@mui/material/ToggleButton';
// ou
import { ToggleButton } from '@mui/material';

Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

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

Propriedades

Propriedades do componente ButtonBase também estão disponíveis.

Nome	Tipo	Padrão	Descrição
value^*	any		The value to associate with the button when selected in a ToggleButtonGroup.
children	node		O conteúdo do componente.
classes	object		Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
color	'standard' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'standard'	The color of the button when it is in an active state.
disabled	bool	false	Se `true`, o componente está desabilitado.
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	If `true`, the button will take up the full width of its container.
onChange	func		Callback fired when the state changes. Signature: `function(event: React.MouseEvent<HTMLElement>, value: any) => void` event: The event source of the callback. value: of the selected button.
onClick	func		Callback fired when the button is clicked. Signature: `function(event: React.MouseEvent<HTMLElement>, value: any) => void` event: The event source of the callback. value: of the selected button.
selected	bool	false	If `true`, the button is rendered in an active state.
size	'small' \| 'medium' \| 'large' \| string	'medium'	The size of the button. The prop defaults to the value inherited from the parent ToggleButtonGroup component.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

O ref é encaminhado para o elemento raiz.

Herança

Embora não explicitamente documentado acima, as propriedades do componente ButtonBase também estão disponíveis em ToggleButton. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regra	Classe global	Descrição
root	.MuiToggleButton-root	Estilos aplicados ao elemento raiz.
disabled	.Mui-disabled	Pseudo-class aplicada a o elemento raiz se `disabled={true}`.
selected	.Mui-selected	Pseudo-class aplicada a o elemento raiz se `selected={true}`.
standard	.MuiToggleButton-standard	Pseudo-class aplicada a o elemento raiz se `color="standard"`.
primary	.MuiToggleButton-primary	Pseudo-class aplicada a o elemento raiz se `color="primary"`.
secondary	.MuiToggleButton-secondary	Pseudo-class aplicada a o elemento raiz se `color="secondary"`.
sizeSmall	.MuiToggleButton-sizeSmall	Estilos aplicados para o elemento raiz se `size="small"`.
sizeMedium	.MuiToggleButton-sizeMedium	Estilos aplicados para o elemento raiz se `size="medium"`.
sizeLarge	.MuiToggleButton-sizeLarge	Estilos aplicados para o elemento raiz se `size="large"`.

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Com um nome de classe global.
Com um nome de regra como parte da propriedade styleOverrides do componente em um tema personalizado.

Demonstrações

Toggle button