CalendarState

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var endMonth: YearMonth?

Inclusive range end; null scrolls unboundedly into the future.

Link copied to clipboard
var firstDayOfWeek: DayOfWeek
Link copied to clipboard
val firstVisibleMonth: YearMonth

The month at the first visible page. Snapshot-observable.

Link copied to clipboard

Months in the effective range; unbounded sides count to the supported date extremes.

Link copied to clipboard
Link copied to clipboard
var startMonth: YearMonth?

Inclusive range start; null scrolls unboundedly into the past.

Functions

Link copied to clipboard
suspend fun animateScrollToDate(date: LocalDate)

Animated counterpart of scrollToDate.

Link copied to clipboard
suspend fun animateScrollToMonth(month: YearMonth)
Link copied to clipboard
suspend fun animateScrollToToday()

Animates back to the current month.

Link copied to clipboard
suspend fun scrollToDate(date: LocalDate)
Link copied to clipboard
suspend fun scrollToMonth(month: YearMonth)
Link copied to clipboard
fun updateRange(startMonth: YearMonth?, endMonth: YearMonth?)

Changes the month range (null = unbounded side), keeping the visible month if still in range.

Link copied to clipboard
fun CalendarState.visibleMonths(): Flow<YearMonth>

Emits the first visible month, deduplicated; collect outside composition.