Compose Multiplatform Material3/androidx.compose.material3/DateRangePickerState

DateRangePickerState

@Stable
interface DateRangePickerState

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

Properties

Link copied to clipboard
abstract var displayedMonthMillis: Long

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

Link copied to clipboard
abstract var displayMode: DisplayMode

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

Link copied to clipboard
abstract val selectableDates: SelectableDates

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

Link copied to clipboard
abstract val selectedEndDateMillis: Long?

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

Link copied to clipboard
abstract val selectedStartDateMillis: Long?

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

Link copied to clipboard
abstract val yearRange: IntRange

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

Functions

Link copied to clipboard
abstract fun setSelection(startDateMillis: Long?, endDateMillis: Long?)

Sets a start and end selection dates.