Pular para o conteúdo

FormControlLabel API

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

Importação

import FormControlLabel from '@mui/material/FormControlLabel';
// ou
import { FormControlLabel } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Drop-in replacement of the Radio, Switch and Checkbox component. Use this component if you want to display an extra label.

Nome do componente

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

Propriedades

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

NomeTipoPadrãoDescrição
control*element
A control element. For instance, it can be a Radio, a Switch or a Checkbox.
checkedboolfalse
If true, the component appears selected.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
componentsProps{ typography?: object }{}
The props used for each slot inside.
disabledboolfalse
If true, the control is disabled.
disableTypographyboolfalse
If true, the label is rendered as it is passed without an additional typography node.
inputRefref
Pass a ref to the input element.
labelnode
The text to be used in an enclosing label element.
labelPlacement'bottom'
| 'end'
| 'start'
| 'top'
'end'
The position of the label.
onChangefunc
Callback fired when the state is changed.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new checked state by accessing event.target.checked (boolean).
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.
valueany
The value of the component.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiFormControlLabel-rootEstilos aplicados ao elemento raiz.
labelPlacementStart.MuiFormControlLabel-labelPlacementStartEstilos aplicados para o elemento raiz se labelPlacement="start".
labelPlacementTop.MuiFormControlLabel-labelPlacementTopEstilos aplicados para o elemento raiz se labelPlacement="top".
labelPlacementBottom.MuiFormControlLabel-labelPlacementBottomEstilos aplicados para o elemento raiz se labelPlacement="bottom".
disabled.Mui-disabledPseudo-class aplicada a o elemento raiz se disabled={true}.
label.MuiFormControlLabel-labelEstilos aplicados a the label's Typography component.
error.Mui-errorState class applied to the root element if error={true}.

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

Demonstrações