compose-pickers/io.github.kezlab.compose.pickers.time

Package-level declarations

Types

TimeFormat

enum TimeFormat : Enum<TimeFormat>

Hour presentation used by TimePicker and TimePickerState.

TimePeriod

enum TimePeriod : Enum<TimePeriod>

Half-day period selected by the AM/PM column of a 12-hour TimePicker.

TimePickerState

@Stable

class TimePickerState(initialHour: Int, initialMinute: Int, initialPeriod: TimePeriod, val timeFormat: TimeFormat)

State holder for the TimePicker.

Functions

rememberTimePickerState

@Composable

fun rememberTimePickerState(initialTime: LocalTime = currentDateTime().time, timeFormat: TimeFormat = TimeFormat.HOUR_24): TimePickerState

Creates and remembers a TimePickerState from a LocalTime.

@Composable

fun rememberTimePickerState(items: TimePickerItems, initialTime: LocalTime = currentDateTime().time, timeFormat: TimeFormat = TimeFormat.HOUR_24): TimePickerState

Creates and remembers a TimePickerState whose initial value is coerced by items.

@Composable

fun rememberTimePickerState(initialHour: Int, initialMinute: Int, initialPeriod: TimePeriod = if (initialHour >= 12) TimePeriod.PM else TimePeriod.AM, timeFormat: TimeFormat = TimeFormat.HOUR_24): TimePickerState

Creates and remembers a TimePickerState. Initial time values are read when the state is first created.

@Composable

fun rememberTimePickerState(items: TimePickerItems, initialHour: Int, initialMinute: Int, initialPeriod: TimePeriod = if (initialHour >= 12) TimePeriod.PM else TimePeriod.AM, timeFormat: TimeFormat = TimeFormat.HOUR_24): TimePickerState

Creates and remembers a TimePickerState whose explicit initial time parts are coerced by items.

TimePicker

@Composable

fun TimePicker(modifier: Modifier = Modifier, pickerModifier: Modifier = Modifier, state: TimePickerState = rememberTimePickerState(), onSelectedTimeChange: (LocalTime) -> Unit = {}, enabled: Boolean = true, items: TimePickerItems = PickerDefaults.timePickerItems(), format: TimePickerFormat = PickerDefaults.timePickerFormat(), style: PickerStyle = PickerDefaults.style(), selectionIndicator: PickerSelectionIndicator = PickerDefaults.selectionIndicator(style), layout: TimePickerLayout = PickerDefaults.timePickerLayout(), spacingBetweenPickers: Dp = PickerDefaults.SpacingBetweenPickers, semantics: TimePickerSemantics = PickerDefaults.timePickerSemantics())

A time picker component that allows the user to select hours, minutes, and—when using the 12-hour format—the AM/PM period.