Pular para o conteúdo

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.

NomeTipoPadrãoDescrição
value*any
The value to associate with the button when selected in a ToggleButtonGroup.
childrennode
O conteúdo do componente.
classesobject
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.
disabledboolfalse
Se true, o componente está desabilitado.
disableFocusRippleboolfalse
If true, the keyboard focus ripple is disabled.
disableRippleboolfalse
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.
fullWidthboolfalse
If true, the button will take up the full width of its container.
onChangefunc
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.
onClickfunc
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.
selectedboolfalse
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.
sxArray<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 regraClasse globalDescrição
root.MuiToggleButton-rootEstilos aplicados ao elemento raiz.
disabled.Mui-disabledPseudo-class aplicada a o elemento raiz se disabled={true}.
selected.Mui-selectedPseudo-class aplicada a o elemento raiz se selected={true}.
standard.MuiToggleButton-standardPseudo-class aplicada a o elemento raiz se color="standard".
primary.MuiToggleButton-primaryPseudo-class aplicada a o elemento raiz se color="primary".
secondary.MuiToggleButton-secondaryPseudo-class aplicada a o elemento raiz se color="secondary".
sizeSmall.MuiToggleButton-sizeSmallEstilos aplicados para o elemento raiz se size="small".
sizeMedium.MuiToggleButton-sizeMediumEstilos aplicados para o elemento raiz se size="medium".
sizeLarge.MuiToggleButton-sizeLargeEstilos aplicados para o elemento raiz se size="large".

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

Demonstrações