時刻選択ツール

時刻選択ツールを使用すると、ユーザーが時刻を選択できます。TimePicker コンポーザブルと TimeInput コンポーザブルを使用して、アプリに時間選択ツールを実装できます。

型

時間選択ツールには次の 2 種類があります。

  • ダイヤル: ダイヤルのハンドルを動かして時刻を設定できます。
  • 入力: ユーザーがキーボードを使用して時刻を設定できるようにします。

次の図は、左側にダイヤル時刻選択ツール、右側に入力時刻選択ツールの例を示しています。

文字盤と入力時間選択ツール。
図 1. ダイヤルと入力時間選択ツール。

API サーフェス

時刻選択ツールを実装するには、TimePicker または TimeInput コンポーザブルを使用します。

  • TimePicker: ダイヤル時刻選択ツールを実装します。
  • TimeInput: 入力時間選択ツールを実装します。

状態

TimePicker と TimeInput の両方の場合、TimePickerState も渡す必要があります。これにより、選択ツールに表示されるデフォルトの選択時間を設定できます。また、ユーザーが選択した時刻もキャプチャします。

ダイアログ

時間選択ツールはダイアログに表示されます。このガイドの例では、ダイアログは使用しません。ダイアログを使用する例については、時間選択ツールのダイアログガイドをご覧ください。

文字盤の時刻選択ツール

このスニペットは、基本的なダイヤル時刻選択ツールを実装する方法を示しています。

@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")
        }
    }
}
TimePickers.kt

このスニペットの次の点について考えてみましょう。

  • Calendar.getInstance() は、現在の時刻で TimePickerState を初期化します。
    • この例では java.util.Calendar を使用しています。プロジェクトで Java 8 以降の API の脱糖を有効にして、すべての Android バージョンで java.time.LocalTime を使用する。
  • TimePicker コンポーザブルは、timePickerState をパラメータとして受け取り、時刻選択ツールを表示します。
  • 実装には、選択内容を確認するボタンと選択ツールを閉じるボタンの 2 つのボタンが含まれています。

これを実装すると次のようになります。

ダイヤルの時刻選択ツール。ユーザーはダイヤルを使用して時刻を選択できます。
図 2. ダイヤル式時刻選択ツール。

時刻選択ツール

このスニペットは、基本的な入力スタイルの時刻選択ツールを実装する方法を示しています。

@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")
        }
    }
}
TimePickers.kt

この実装で注意すべき点は次のとおりです。

  • 構造は基本的にダイヤル時刻選択ツールと同じですが、主な違いは TimePicker ではなく TimeInput を使用する点です。
  • timePickerState の is24Hour パラメータは明示的に true に設定されています。デフォルト値は false です。

これを実装すると次のようになります。

入力時間選択ツール。ユーザーはテキスト フィールドを使用して時刻を入力できます。
図 3. 入力時間選択ツール。

状態を使用する

ユーザーが時間選択ツールで選択した時刻を使用するには、適切な TimePickerState を onConfirm 関数に渡します。親コンポーザブルは、TimePickerState.hour と TimePickerState.minute を介して選択した時間にアクセスできます。

次のスニペットは、これを行う方法を示しています。

@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")
        }
    }
}
TimePickers.kt

コンポーザブルは次のように呼び出します。

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.")
}

詳しくは、スニペット アプリの完全な実装をご覧ください。

参考情報