DatePickerState API Reference in Material 3 Compose

A state object that can be hoisted to observe the date picker state.

Source set: Common

interface DatePickerState

A state object that can be hoisted to observe the date picker state. See rememberDatePickerState.

Properties

Source set: Common

var selectedDateMillis: Long?

A timestamp that represents the selected date start of the day in UTC milliseconds from the epoch.

Source set: Common

var displayedMonthMillis: Long

A timestamp that represents the currently displayed month start date in UTC milliseconds from the epoch.

Source set: Common

var displayMode: DisplayMode

A DisplayMode that represents the current UI mode (i.e. picker or input).

Source set: Common

val yearRange: IntRange

An IntRange that holds the year range that the date picker will be limited to.

Source set: Common

val selectableDates: SelectableDates

A SelectableDates that is consulted to check if a date is allowed.

In case a date is not allowed to be selected, it will appear disabled in the UI.

Source set: Common

val locale: CalendarLocale

A locale that will be used when formatting dates, determining the input format, week-days, and more.