Seletores de horário

Os seletores de horário oferecem uma maneira de os usuários selecionarem um horário. É possível usar os elementos combináveis TimePicker e TimeInput para implementar um seletor de horário no app.

Tipos

Há dois tipos de seletor de horário:

  • Mostrador: permite que os usuários definam um horário movendo um ponteiro em um mostrador.
  • Entrada: permite que os usuários definam um horário usando o teclado.

A imagem a seguir mostra um exemplo de seletor de horário de discagem à esquerda e um seletor de horário de entrada à direita:

Um seletor de hora de entrada e um mostrador.
Figura 1. Um seletor de horário de discagem e um de entrada.

Superfície da API

Para implementar um seletor de horário, use o elemento combinável TimePicker ou TimeInput:

  • TimePicker: implementa um seletor de horário de discagem.
  • TimeInput: implementa um seletor de horário de entrada.

Estado

Para TimePicker e TimeInput, também é necessário transmitir um TimePickerState. Isso permite definir o horário padrão selecionado que aparece no seletor. Ele também captura o horário que o usuário selecionou usando o seletor.

Dialog

Os seletores de horário aparecem em caixas de diálogo. Os exemplos neste guia não usam caixas de diálogo. Para exemplos que usam caixas de diálogo, consulte o guia Caixas de diálogo para seletores de horário.

Seletor de horário de discagem

Este snippet demonstra como implementar um seletor de hora básico.

@Composable
fun DialExample(
    onConfirm: () -> Unit,
    onDismiss: () -> Unit,
) {
    val currentTime = Calendar.getInstance()

    val timePickerState = rememberTimePickerState(
        initialHour = currentTime.get(Calendar.HOUR_OF_DAY),
        initialMinute = currentTime.get(Calendar.MINUTE),
        is24Hour = true,
    )

    Column {
        TimePicker(
            state = timePickerState,
        )
        Button(onClick = onDismiss) {
            Text("Dismiss picker")
        }
        Button(onClick = onConfirm) {
            Text("Confirm selection")
        }
    }
}

Considere o seguinte neste snippet:

  • Calendar.getInstance() inicializa o TimePickerState com o horário atual.
  • O elemento combinável TimePicker mostra o seletor de horário, usando timePickerState como parâmetro.
  • A implementação inclui dois botões: um para confirmar a seleção e outro para dispensar o seletor.

Essa implementação é mostrada abaixo:

Um seletor de horário de discagem. O usuário pode selecionar um horário usando o mostrador.
Figura 2. Um seletor de horário de discagem.

Seletor de horário de entrada

Este snippet demonstra como implementar um seletor de horário básico no estilo de entrada.

@Composable
fun InputExample(
    onConfirm: () -> Unit,
    onDismiss: () -> Unit,
) {
    val currentTime = Calendar.getInstance()

    val timePickerState = rememberTimePickerState(
        initialHour = currentTime.get(Calendar.HOUR_OF_DAY),
        initialMinute = currentTime.get(Calendar.MINUTE),
        is24Hour = true,
    )

    Column {
        TimeInput(
            state = timePickerState,
        )
        Button(onClick = onDismiss) {
            Text("Dismiss picker")
        }
        Button(onClick = onConfirm) {
            Text("Confirm selection")
        }
    }
}

Pontos importantes a serem observados nesta implementação:

  • A estrutura é essencialmente a mesma do seletor de hora de discagem, com a principal diferença sendo o uso de TimeInput em vez de TimePicker.
  • O parâmetro is24Hour para timePickerState está explicitamente definido como true. Por padrão, esse valor é false.

Essa implementação é mostrada abaixo:

Um seletor de horário de entrada. O usuário pode inserir um horário usando campos de texto.
Figura 3. Um seletor de horário de entrada.

Usar o estado

Para usar o horário que o usuário selecionou em um seletor de horário, transmita o TimePickerState adequado para a função onConfirm. O elemento combinável pai pode acessar o horário selecionado usando TimePickerState.hour e TimePickerState.minute.

O snippet a seguir demonstra como fazer isso:

@Composable
fun DialUseStateExample(
    onConfirm: (TimePickerState) -> Unit,
    onDismiss: () -> Unit,
) {
    val currentTime = Calendar.getInstance()

    val timePickerState = rememberTimePickerState(
        initialHour = currentTime.get(Calendar.HOUR_OF_DAY),
        initialMinute = currentTime.get(Calendar.MINUTE),
        is24Hour = true,
    )

    Column {
        TimePicker(
            state = timePickerState,
        )
        Button(onClick = onDismiss) {
            Text("Dismiss picker")
        }
        Button(onClick = { onConfirm(timePickerState) }) {
            Text("Confirm selection")
        }
    }
}

Em seguida, você pode chamar o elemento combinável desta forma:

var selectedTime: TimePickerState? by remember { mutableStateOf(null) }

// ...

DialUseStateExample(
    onDismiss = {
        showDialExample = false
    },
    onConfirm = {
            time ->
        selectedTime = time
        showDialExample = false
    },
)

// ...

if (selectedTime != null) {
    val cal = Calendar.getInstance()
    cal.set(Calendar.HOUR_OF_DAY, selectedTime!!.hour)
    cal.set(Calendar.MINUTE, selectedTime!!.minute)
    cal.isLenient = false
    Text("Selected time = ${formatter.format(cal.time)}")
} else {
    Text("No time selected.")
}

Para mais detalhes, consulte a implementação completa no app de snippets.

Outros recursos