Pular para o conteúdo

Checkbox API

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

Importação

import Checkbox from '@mui/material/Checkbox';
// ou
import { Checkbox } 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 MuiCheckbox 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
checkedboolfalse
If true, the component is checked.
checkedIconnode<CheckBoxIcon />
The icon to display when the component is checked.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
color'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'primary'
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
defaultCheckedboolfalse
The default checked state. Use when the component is not controlled.
disabledboolfalse
Se true, o componente está desabilitado.
disableRippleboolfalse
If true, the ripple effect is disabled.
iconnode<CheckBoxOutlineBlankIcon />
The icon to display when the component is unchecked.
idstring
The id of the input element.
indeterminateboolfalse
If true, the component appears indeterminate. This does not set the native input element to indeterminate due to inconsistent behavior across browsers. However, we set a data-indeterminate attribute on the input.
indeterminateIconnode<IndeterminateCheckBoxIcon />
The icon to display when the component is indeterminate.
inputPropsobject
Attributes applied to the input element.
inputRefref
Pass a ref to the input element.
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).
requiredboolfalse
If true, the input element is required.
size'medium'
| 'small'
| string
'medium'
The size of the checkbox. small is equivalent to the dense checkbox styling.
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. The DOM API casts this to a string. The browser uses "on" as the default value.

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 Checkbox. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiCheckbox-rootEstilos aplicados ao elemento raiz.
checked.Mui-checkedPseudo-class aplicada a o elemento raiz se checked={true}.
disabled.Mui-disabledPseudo-class aplicada a o elemento raiz se disabled={true}.
indeterminate.MuiCheckbox-indeterminatePseudo-class aplicada a o elemento raiz se indeterminate={true}.
colorPrimary.MuiCheckbox-colorPrimaryEstilos aplicados para o elemento raiz se color="primary".
colorSecondary.MuiCheckbox-colorSecondaryEstilos aplicados para o elemento raiz se color="secondary".

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

Demonstrações