DatePickerState

public interface DatePickerState

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

Properties

selectedDateMillis

@get:Suppress("AutoBoxing") public var selectedDateMillis: Long?

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

Throws: IllegalArgumentException

in case the value is set with a timestamp that does not fall within the yearRange.

displayedMonthMillis

public var displayedMonthMillis: Long

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

Throws: IllegalArgumentException

in case the value is set with a timestamp that does not fall within the yearRange.

displayMode

public var displayMode: DisplayMode

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

yearRange

public val yearRange: IntRange

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

selectableDates

public 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.

locale

public val locale: CalendarLocale

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