compose-pickers/io.github.kezlab.compose.pickers.date/YearMonthPickerState

YearMonthPickerState

@Stable

class YearMonthPickerState(initialYear: Int, initialMonth: Int)

State holder for the YearMonthPicker.

Manages the selected year and month.

Parameters

initialYear

The initial year to be selected. Must be in 1000..9999.

initialMonth

The initial month to be selected.

Throws

IllegalArgumentException

if initialYear or initialMonth is outside the supported range.

Constructors

YearMonthPickerState

constructor(initialYear: Int, initialMonth: Int)

constructor(initialYearMonth: YearMonth)

Creates a YearMonthPickerState from initialYearMonth.

constructor(initialDate: LocalDate)

Creates a YearMonthPickerState from the year/month portion of initialDate.

Types

Companion

object Companion

Properties

selectedMonth

val selectedMonth: Int

The currently selected month (1-12).

selectedMonthDate

val selectedMonthDate: LocalDate

The selected year and month represented as the first day of that month.

selectedYear

val selectedYear: Int

The currently selected year.

selectedYearMonth

val selectedYearMonth: YearMonth

The selected year/month value.

Functions

selectDate

fun selectDate(date: LocalDate)

Programmatically selects the year and month from date.

fun selectDate(date: LocalDate, items: YearMonthPickerItems)

Programmatically selects the closest year/month to date that is allowed by items.

selectYearMonth

fun selectYearMonth(yearMonth: YearMonth)

Programmatically selects yearMonth.

fun selectYearMonth(yearMonth: YearMonth, items: YearMonthPickerItems)

Programmatically selects the closest year/month to yearMonth that is allowed by items.

fun selectYearMonth(year: Int, month: Int)

Programmatically selects year and month.

fun selectYearMonth(year: Int, month: Int, items: YearMonthPickerItems)

Programmatically selects the closest year/month to year and month that is allowed by items.