DatePickerDefaults

object DatePickerDefaults

Contains default values used by the DatePicker.

Properties

YearRange

val YearRange: IntRange

The range of years for the date picker dialogs.

TonalElevation

val TonalElevation: Dp

The default tonal elevation used for DatePickerDialog.

shape

val shape: Shape

The default shape for date picker dialogs.

AllDates

val AllDates: SelectableDates

A default SelectableDates that allows all dates to be selected.

YearMonthSkeleton

const val YearMonthSkeleton: String

A date format skeleton used to format the date picker's year selection menu button (e.g. "March 2021")

YearAbbrMonthDaySkeleton

const val YearAbbrMonthDaySkeleton: String

A date format skeleton used to format a selected date (e.g. "Mar 27, 2021")

YearMonthWeekdayDaySkeleton

const val YearMonthWeekdayDaySkeleton: String

A date format skeleton used to format a selected date to be used as content description for screen readers (e.g. "Saturday, March 27, 2021")

Functions

colors

@Composable fun colors() = MaterialTheme.colorScheme.defaultDatePickerColors

Creates a DatePickerColors that will potentially animate between the provided colors according to the Material specification.

colors

@Composable
    fun colors(
        containerColor: Color = Color.Unspecified,
        titleContentColor: Color = Color.Unspecified,
        headlineContentColor: Color = Color.Unspecified,
        weekdayContentColor: Color = Color.Unspecified,
        subheadContentColor: Color = Color.Unspecified,
        navigationContentColor: Color = Color.Unspecified,
        yearContentColor: Color = Color.Unspecified,
        disabledYearContentColor: Color = Color.Unspecified,
        currentYearContentColor: Color = Color.Unspecified,
        selectedYearContentColor: Color = Color.Unspecified,
        disabledSelectedYearContentColor: Color = Color.Unspecified,
        selectedYearContainerColor: Color = Color.Unspecified,
        disabledSelectedYearContainerColor: Color = Color.Unspecified,
        dayContentColor: Color = Color.Unspecified,
        disabledDayContentColor: Color = Color.Unspecified,
        selectedDayContentColor: Color = Color.Unspecified,
        disabledSelectedDayContentColor: Color = Color.Unspecified,
        selectedDayContainerColor: Color = Color.Unspecified,
        disabledSelectedDayContainerColor: Color = Color.Unspecified,
        todayContentColor: Color = Color.Unspecified,
        todayDateBorderColor: Color = Color.Unspecified,
        dayInSelectionRangeContentColor: Color = Color.Unspecified,
        dayInSelectionRangeContainerColor: Color = Color.Unspecified,
        dividerColor: Color = Color.Unspecified,
        dateTextFieldColors: TextFieldColors? = null,
    ): DatePickerColors

Creates a DatePickerColors that will potentially animate between the provided colors according to the Material specification.

Parameters

dateFormatter

fun dateFormatter(
        yearSelectionSkeleton: String = YearMonthSkeleton,
        selectedDateSkeleton: String = YearAbbrMonthDaySkeleton,
        selectedDateDescriptionSkeleton: String = YearMonthWeekdayDaySkeleton,
    ): DatePickerFormatter

Returns a DatePickerFormatter.

The date formatter will apply the best possible localized form of the given skeleton and Locale. A skeleton is similar to, and uses the same format characters as, a Unicode UTS #35 pattern.

One difference is that order is irrelevant. For example, "MMMMd" will return "MMMM d" in the en_US locale, but "d. MMMM" in the de_CH locale.

Parameters

DatePickerTitle

@Composable
    fun DatePickerTitle(
        displayMode: DisplayMode,
        modifier: Modifier = Modifier,
        contentColor: Color = colors().titleContentColor,
    )

A default date picker title composable.

Parameters

DatePickerHeadline

@Composable
    fun DatePickerHeadline(
        @Suppress("AutoBoxing") selectedDateMillis: Long?,
        displayMode: DisplayMode,
        dateFormatter: DatePickerFormatter,
        modifier: Modifier = Modifier,
        contentColor: Color = colors().headlineContentColor,
    )

A default date picker headline composable that displays a default headline text when there is no date selection, and an actual date string when there is.

Parameters