TimePickerState

Artifact: androidx.compose.material3:material3

View Source

Added in 1.1.0

Common/AllAndroid/JVM

• Cmn

  interface TimePickerState

---

A state object that can be hoisted to observe the time picker state. It holds the current values and allows for directly setting those values.

See also
rememberTimePickerState	to construct the default implementation.

Summary

Public properties
Int	hour The currently selected hour (0-23).	Cmn
open Int	hourInput The input for the hour.	Cmn
Boolean	is24hour Indicates whether the time picker uses 24-hour format (true) or 12-hour format with AM/PM (false).	Cmn
Int	minute The currently selected minute (0-59).	Cmn
open Int	minuteInput The raw input for the minute.	Cmn
TimePickerSelectionMode	selection Specifies whether the hour or minute component is being actively selected by the user.	Cmn

Extension properties
Boolean	TimePickerState.isHourInputValid true if the current hourInput represents a valid hour (0-23).	Cmn
Boolean	TimePickerState.isInputValid true if the time input values are valid.	Cmn
Boolean	TimePickerState.isMinuteInputValid true if the current minuteInput represents a valid minute (0-59).	Cmn
Boolean	TimePickerState.isPm Indicates whether the selected time falls within the period from 12 PM inclusive to 12 AM non inclusive.	Cmn

Public properties

hour

Cmn

Added in 1.1.0

var hour: Int

The currently selected hour (0-23).

hourInput

Cmn

Added in 1.5.0-alpha08

open var hourInput: Int

The input for the hour. UI should be bound to this value. The default implementation validates the new value and updates hour if it's valid.

is24hour

Cmn

Added in 1.1.0

var is24hour: Boolean

Indicates whether the time picker uses 24-hour format (true) or 12-hour format with AM/PM (false).

minute

Cmn

Added in 1.1.0

var minute: Int

The currently selected minute (0-59).

minuteInput

Cmn

Added in 1.5.0-alpha08

open var minuteInput: Int

The raw input for the minute. UI should be bound to this value. The default implementation validates the new value and updates minute if it's valid.

selection

Cmn

Added in 1.3.0

var selection: TimePickerSelectionMode

Specifies whether the hour or minute component is being actively selected by the user.

Extension properties

isHourInputValid

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha08

val TimePickerState.isHourInputValid: Boolean

true if the current hourInput represents a valid hour (0-23).

isInputValid

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha08

val TimePickerState.isInputValid: Boolean

true if the time input values are valid.

isMinuteInputValid

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha08

val TimePickerState.isMinuteInputValid: Boolean

true if the current minuteInput represents a valid minute (0-59).

isPm

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.4.0

val TimePickerState.isPm: Boolean

Indicates whether the selected time falls within the period from 12 PM inclusive to 12 AM non inclusive.