Package-level declarations

Types

Link copied to clipboard
class DatePickerState(initialYear: Int, initialMonth: Int, initialDay: Int)

State holder for the DatePicker.

Link copied to clipboard
data class DateRange(val startDate: LocalDate, val endDate: LocalDate)

Inclusive date range selected by DateRangePicker. Use ordered when app-owned start/end inputs may arrive in either order.

Link copied to clipboard
class DateRangePickerState(initialStartDate: LocalDate, initialEndDate: LocalDate)

State holder for DateRangePicker.

Link copied to clipboard
data class YearMonth(val year: Int, val month: Int) : Comparable<YearMonth>

Year and month value selected by YearMonthPicker.

Link copied to clipboard
class YearMonthPickerState(initialYear: Int, initialMonth: Int)

State holder for the YearMonthPicker.

Functions

Link copied to clipboard
fun DatePicker(modifier: Modifier = Modifier, pickerModifier: Modifier = Modifier, state: DatePickerState = rememberDatePickerState(), onSelectedDateChange: (LocalDate) -> Unit = {}, enabled: Boolean = true, items: DatePickerItems = PickerDefaults.datePickerItems(), format: DatePickerFormat = PickerDefaults.datePickerFormat(), style: PickerStyle = PickerDefaults.style(), selectionIndicator: PickerSelectionIndicator = PickerDefaults.selectionIndicator(style), layout: DatePickerLayout = PickerDefaults.datePickerLayout(), spacingBetweenPickers: Dp = PickerDefaults.SpacingBetweenPickers, semantics: DatePickerSemantics = PickerDefaults.datePickerSemantics())

A date picker component that allows selecting year, month, and day.

Link copied to clipboard
fun DateRangePicker(modifier: Modifier = Modifier, pickerModifier: Modifier = Modifier, state: DateRangePickerState = rememberDateRangePickerState(), onSelectedDateRangeChange: (DateRange) -> Unit = {}, enabled: Boolean = true, items: DatePickerItems = PickerDefaults.datePickerItems(), format: DatePickerFormat = PickerDefaults.datePickerFormat(), style: PickerStyle = PickerDefaults.style(), selectionIndicator: PickerSelectionIndicator = PickerDefaults.selectionIndicator(style), layout: DatePickerLayout = PickerDefaults.datePickerLayout(), spacingBetweenPickers: Dp = PickerDefaults.SpacingBetweenPickers, spacingBetweenDatePickers: Dp = 16.dp, startLabel: @Composable () -> Unit? = { DateRangePickerLabel("Start date") }, endLabel: @Composable () -> Unit? = { DateRangePickerLabel("End date") }, semantics: DateRangePickerSemantics = PickerDefaults.dateRangePickerSemantics())

A date range picker composed from two ordered DatePicker components.

Link copied to clipboard
fun rememberDatePickerState(initialDate: LocalDate = currentDate()): DatePickerState

Creates and remembers a DatePickerState. Initial date values are read when the state is first created.

fun rememberDatePickerState(items: DatePickerItems, initialDate: LocalDate = currentDate()): DatePickerState

Creates and remembers a DatePickerState whose initial value is coerced by items.

fun rememberDatePickerState(initialYear: Int, initialMonth: Int, initialDay: Int): DatePickerState

Creates and remembers a DatePickerState with explicit year, month, and day values.

fun rememberDatePickerState(items: DatePickerItems, initialYear: Int, initialMonth: Int, initialDay: Int): DatePickerState

Creates and remembers a DatePickerState whose explicit initial date parts are coerced by items.

Link copied to clipboard

Creates and remembers a DateRangePickerState from an initial DateRange.

Creates and remembers a DateRangePickerState from an initial DateRange coerced by items.

fun rememberDateRangePickerState(initialStartDate: LocalDate = currentDate(), initialEndDate: LocalDate = initialStartDate): DateRangePickerState

Creates and remembers a DateRangePickerState.

fun rememberDateRangePickerState(items: DatePickerItems, initialStartDate: LocalDate = currentDate(), initialEndDate: LocalDate = initialStartDate): DateRangePickerState

Creates and remembers a DateRangePickerState whose initial values are coerced by items.

fun rememberDateRangePickerState(initialStartYear: Int, initialStartMonth: Int, initialStartDay: Int, initialEndYear: Int = initialStartYear, initialEndMonth: Int = initialStartMonth, initialEndDay: Int = initialStartDay): DateRangePickerState

Creates and remembers a DateRangePickerState with explicit start and end date parts.

fun rememberDateRangePickerState(items: DatePickerItems, initialStartYear: Int, initialStartMonth: Int, initialStartDay: Int, initialEndYear: Int = initialStartYear, initialEndMonth: Int = initialStartMonth, initialEndDay: Int = initialStartDay): DateRangePickerState

Creates and remembers a DateRangePickerState with explicit start and end date parts coerced by items.

Link copied to clipboard

Creates and remembers a YearMonthPickerState from a YearMonth. Initial year and month are read when the state is first created.

fun rememberYearMonthPickerState(initialDate: LocalDate = currentDate()): YearMonthPickerState

Creates and remembers a YearMonthPickerState from a LocalDate. Initial year and month are read when the state is first created.

Creates and remembers a YearMonthPickerState whose initial YearMonth is coerced by items.

fun rememberYearMonthPickerState(items: YearMonthPickerItems, initialDate: LocalDate = currentDate()): YearMonthPickerState

Creates and remembers a YearMonthPickerState whose initial year/month is coerced by items.

Creates and remembers a YearMonthPickerState with explicit year and month values. Initial year and month are read when the state is first created.

Creates and remembers a YearMonthPickerState whose explicit initial year/month is coerced by items.

Link copied to clipboard
fun YearMonthPicker(modifier: Modifier = Modifier, pickerModifier: Modifier = Modifier, state: YearMonthPickerState = rememberYearMonthPickerState(), onSelectedYearMonthChange: (YearMonth) -> Unit = {}, enabled: Boolean = true, items: YearMonthPickerItems = PickerDefaults.yearMonthPickerItems(), format: YearMonthPickerFormat = PickerDefaults.yearMonthPickerFormat(), style: PickerStyle = PickerDefaults.style(), selectionIndicator: PickerSelectionIndicator = PickerDefaults.selectionIndicator(style), layout: YearMonthPickerLayout = PickerDefaults.yearMonthPickerLayout(), spacingBetweenPickers: Dp = PickerDefaults.SpacingBetweenPickers, semantics: YearMonthPickerSemantics = PickerDefaults.yearMonthPickerSemantics())

A year and month picker component.