Pular para o conteúdo
UI

Switch

Controle que permite ao usuário alternar entre os estados ligado e desligado.

Exemplos

Regular

Desabilitado

Com ícones personalizados

Com descrição

API

Switch

PropriedadeTipoPadrãoDescrição
asChildbooleanfalseTroca o elemento renderizado por padrão pelo que for passado como filho, mesclando props e comportamento.
defaultCheckedboolean-Estado do switch na primeira renderização. Use quando não precisar controlar o estado.
checkedboolean-Estado controlado do switch. Deve ser usado junto com onCheckedChange.
onCheckedChange(checked: boolean) => void-Função chamada quando o estado do switch muda.
disabledboolean-Quando true, impede o usuário de interagir com o switch.
requiredboolean-Quando true, indica que o usuário precisa ativar o switch antes de enviar o formulário que o contém.
namestring-Nome do switch. É enviado com o formulário que o contém como parte de um par nome/valor.
valuestring"on"Valor enviado como dado quando o switch é submetido com um name.
variant"regular""regular"Estilo visual do switch.
size"sm" | "md" | "lg""md"Tamanho do switch.
checkedIconReact.ReactNode-Ícone personalizado exibido quando o switch está ativado.
uncheckedIconReact.ReactNode-Ícone personalizado exibido quando o switch está desativado.
Atributo dataValores
[data-state]"checked" | "unchecked"
[data-disabled]Presente quando desabilitado