TimePickerDialog

Functions summary

Unit
@Composable
TimePickerDialog(
    onDismissRequest: () -> Unit,
    confirmButton: @Composable () -> Unit,
    title: @Composable () -> Unit,
    modifier: Modifier,
    properties: DialogProperties,
    modeToggleButton: (@Composable () -> Unit)?,
    dismissButton: (@Composable () -> Unit)?,
    shape: Shape,
    containerColor: Color,
    content: @Composable ColumnScope.() -> Unit
)

Material Design time picker dialog

Cmn

Functions

TimePickerDialog

@Composable
fun TimePickerDialog(
    onDismissRequest: () -> Unit,
    confirmButton: @Composable () -> Unit,
    title: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    properties: DialogProperties = DialogProperties(usePlatformDefaultWidth = false),
    modeToggleButton: (@Composable () -> Unit)? = null,
    dismissButton: (@Composable () -> Unit)? = null,
    shape: Shape = TimePickerDialogDefaults.shape,
    containerColor: Color = TimePickerDialogDefaults.containerColor,
    content: @Composable ColumnScope.() -> Unit
): Unit

Material Design time picker dialog

A dialog for displaying a TimePicker. Time pickers let people select a time.

Parameters
onDismissRequest: () -> Unit

called when the user tries to dismiss the Dialog by clicking outside or pressing the back button. This is not called when the dismiss button is clicked.

confirmButton: @Composable () -> Unit

button which is meant to confirm a proposed action, thus resolving what triggered the dialog. The dialog does not set up any events for this button, nor does it control its enablement, so those need to be set up by the caller.

title: @Composable () -> Unit

The title to be displayed on top of the dialog.

modifier: Modifier = Modifier

the Modifier to be applied to this dialog's content.

properties: DialogProperties = DialogProperties(usePlatformDefaultWidth = false)

typically platform specific properties to further configure the dialog

modeToggleButton: (@Composable () -> Unit)? = null

Optional toggle to switch between clock and text input modes.

dismissButton: (@Composable () -> Unit)? = null

button which is meant to dismiss the dialog. The dialog does not set up any events for this button so they need to be set up by the caller.

shape: Shape = TimePickerDialogDefaults.shape

defines the dialog's surface shape as well its shadow

containerColor: Color = TimePickerDialogDefaults.containerColor

the color of the dialog's container

content: @Composable ColumnScope.() -> Unit

the content of the dialog (i.e. a TimePicker, for example)