Pular para o conteúdo

SwitchUnstyled API

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

Importação

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

The foundation for building custom-styled switches.

Propriedades

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

NomeTipoPadrãoDescrição
checkedboolfalse
If true, the component is checked.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
defaultCheckedboolfalse
The default checked state. Use when the component is not controlled.
disabledboolfalse
If true, the component is disabled.
onChangefunc
Callback fired when the state is changed.

Signature:
function(event: React.ChangeEvent<HTMLInputElement>) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean).
readOnlyboolfalse
If true, the component is read only.
requiredboolfalse
If true, the input element is required.
slotProps{ input?: func
| object, root?: func
| object, thumb?: func
| object, track?: func
| object }
{}
slots{ input?: elementType, root?: elementType, thumb?: elementType, track?: elementType
| null }
{}

O ref é encaminhado para o elemento raiz.

Demonstrações