backpack-common/net.skyscanner.backpack.calendar2/CalendarComponent

CalendarComponent

@Stable
interface CalendarComponent

Calendar public API.

It works like a state machine – calling each method updates its state in background and emits new state to state. The state could also be updated when some UI event (such as date selection) happens.

Inheritors

Properties

Link copied to clipboard
abstract val effects: SharedFlow<CalendarEffect>

The side effects the calendar emits.

Link copied to clipboard
abstract val state: StateFlow<CalendarState>

The current state the calendar in.

Functions

Link copied to clipboard
abstract fun setParams(value: CalendarParams)

Updates the params used to configure the calendar. Please note the changes won't apply immediately – the new state will be calculated in background thread.

Link copied to clipboard
abstract fun setSelection(selection: CalendarSelection)

Sets custom dates selection programmatically.