時刻選択ツール

時刻選択ツールは、ユーザーが時刻を選択する方法を提供します。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")
        }
    }
}

このスニペットでは、次の点を考慮してください。

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

この実装で注意すべき重要なポイントは次のとおりです。

  • 構造は基本的にダイヤル時刻選択ツールと同じですが、主な違いは 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")
        }
    }
}

このコンポーザブルは、次のように呼び出すことができます。

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

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

参考情報