Switch

O componente Switch permite que os usuários alternem entre dois estados: marcado e desmarcado. No app, você pode usar uma chave para permitir que o usuário faça uma das seguintes ações:

  • Ative ou desative uma configuração.
  • Ativar ou desativar um recurso.
  • Selecione uma opção.

O componente tem duas partes: o ícone e a faixa. O botão é a parte arrastável do botão e a faixa é o plano de fundo. O usuário pode arrastar o botão para a esquerda ou direita para mudar o estado da chave. Eles também podem tocar no interruptor para verificar e limpar.

Exemplos do componente Switch no modo claro e escuro.
Figura 1. O componente de chave.

Implementação básica

Consulte a referência Switch para ver a definição completa da API. Confira alguns dos principais parâmetros que você pode precisar usar:

  • checked: o estado inicial do switch.
  • onCheckedChange: um callback que é chamado quando o estado da chave muda.
  • enabled: indica se a chave está ativada ou desativada.
  • colors: as cores usadas para a troca.

O exemplo a seguir é uma implementação mínima do elemento combinável Switch.

@Composable
fun SwitchMinimalExample() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        }
    )
}
Switch.kt

Essa implementação aparece da seguinte maneira quando desmarcada:

Um interruptor básico que não está marcado.
Figura 2. Um switch desmarcado.

A aparência quando marcada:

Uma chave básica marcada.
Figura 3. Um switch marcado.

Implementação avançada

Os parâmetros principais que você pode usar ao implementar uma chave mais avançada são os seguintes:

  • thumbContent: use para personalizar a aparência do polegar quando ele estiver marcado.
  • colors: use para personalizar a cor da faixa e do ícone.

Miniatura personalizada

É possível transmitir qualquer elemento combinável para o parâmetro thumbContent e criar um polegar personalizado. Confira a seguir um exemplo de alternância que usa um ícone personalizado para o polegar:

@Composable
fun SwitchWithIconExample() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        },
        thumbContent = if (checked) {
            {
                Icon(
                    imageVector = Icons.Filled.Check,
                    contentDescription = null,
                    modifier = Modifier.size(SwitchDefaults.IconSize),
                )
            }
        } else {
            null
        }
    )
}
Switch.kt

Nesta implementação, a aparência desmarcada é igual ao exemplo na seção anterior. No entanto, quando marcada, essa implementação aparece da seguinte maneira:

Um switch que usa o parâmetro thumbContent para mostrar um ícone personalizado quando marcado.
Figura 4. Um interruptor com um ícone de verificação personalizado.

Cores personalizadas

O exemplo a seguir demonstra como usar o parâmetro de cores para mudar a cor do botão e da faixa de um interruptor, considerando se o interruptor está marcado.

@Composable
fun SwitchWithCustomColors() {
    var checked by remember { mutableStateOf(true) }

    Switch(
        checked = checked,
        onCheckedChange = {
            checked = it
        },
        colors = SwitchDefaults.colors(
            checkedThumbColor = MaterialTheme.colorScheme.primary,
            checkedTrackColor = MaterialTheme.colorScheme.primaryContainer,
            uncheckedThumbColor = MaterialTheme.colorScheme.secondary,
            uncheckedTrackColor = MaterialTheme.colorScheme.secondaryContainer,
        )
    )
}
Switch.kt

Essa implementação aparece da seguinte maneira:

Um botão que usa o parâmetro colors para mostrar um botão com cores personalizadas para o polegar e a tachinha.
Figura 5. Um interruptor com cores personalizadas.

Outros recursos