Pular para o conteúdo

Switch API

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

Importação

import Switch from '@mui/material/Switch';
// ou
import { Switch } 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 MuiSwitch can be used when providing default props or style overrides in the theme.

Propriedades

NomeTipoPadrãoDescrição
checkedboolfalse
If true, the component is checked.
checkedIconnode
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.
edge'end'
| 'start'
| false
false
If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).
iconnode
The icon to display when the component is unchecked.
idstring
The id of the input element.
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 value by accessing event.target.value (string). 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 switch. small is equivalent to the dense switch 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 IconButton também estão disponíveis em Switch. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiSwitch-rootEstilos aplicados ao elemento raiz.
edgeStart.MuiSwitch-edgeStartEstilos aplicados para o elemento raiz se edge="start".
edgeEnd.MuiSwitch-edgeEndEstilos aplicados para o elemento raiz se edge="end".
switchBase.MuiSwitch-switchBaseEstilos aplicados a the internal `SwitchBase` component's `root` class.
colorPrimary.MuiSwitch-colorPrimaryEstilos aplicados para the internal SwitchBase component's root element se color="primary".
colorSecondary.MuiSwitch-colorSecondaryEstilos aplicados para the internal SwitchBase component's root element se color="secondary".
sizeSmall.MuiSwitch-sizeSmallEstilos aplicados para o elemento raiz se size="small".
sizeMedium.MuiSwitch-sizeMediumEstilos aplicados para o elemento raiz se size="medium".
checked.Mui-checkedPseudo-class applied to the internal `SwitchBase` component's `checked` class.
disabled.Mui-disabledPseudo-class applied to the internal SwitchBase component's disabled class.
input.MuiSwitch-inputEstilos aplicados a the internal SwitchBase component's input element.
thumb.MuiSwitch-thumbStyles used to create the thumb passed to the internal `SwitchBase` component `icon` prop.
track.MuiSwitch-trackEstilos aplicados a the track element.

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

Demonstrações