When to use it
Use a local wall-clock value rather than an epoch timestamp. Keep dates, time zones, overnight scheduling, and translated labels in the application.
Choose a local time with native clock or keyboard input and explicit confirmation.
Native example
Use a local wall-clock value rather than an epoch timestamp. Keep dates, time zones, overnight scheduling, and translated labels in the application.
LumenTimeField(
label = "Meeting time",
value = meetingTime,
onValueChange = { meetingTime = it },
minTime = LumenTimeSelection(8, 30),
maxTime = LumenTimeSelection(17, 0)
)Reference
The primary shared and platform-specific options exposed by LumenTimeField.
| API | Values or type | Default | Description |
|---|---|---|---|
| label | String | Required | Names the field and selection dialog. |
| value / onValueChange | LumenTimeSelection? / (LumenTimeSelection) -> Unit | Required | Controls the confirmed local hour and minute. |
| modifier | Modifier | Modifier | Applies layout and semantics to the field group. |
| minTime / maxTime | LumenTimeSelection? | null | Inclusive same-day bounds; minimum must not exceed maximum. |
| is24Hour | Boolean? | null | Follows the system preference unless explicitly set. |
| description / errorMessage | String? | null | Shows supporting context or host validation. |
| placeholder | String | Choose a time | Displays the empty state. |
| confirmLabel / dismissLabel | String | Confirm / Cancel | Names the native confirmation and cancellation actions. |
| inputLabel / dialLabel | String | Use keyboard / Use clock | Names the input mode switch. |
| rangeErrorLabel | String | Choose a time within the allowed range | Explains invalid draft selection. |
| enabled / readOnly | Boolean | true / false | Controls editing and dismisses open selection when editing becomes unavailable. |
Native behavior
Use a local wall-clock value rather than an epoch timestamp. Keep dates, time zones, overnight scheduling, and translated labels in the application.
Names the selected time and native dialog actions; confirmation publishes the draft, cancellation preserves the value, and disabled or read-only fields cannot open selection.
Shared component