API Reference

CalendarStateContextValue

interface

Volatile state provided by CalendarProvider — shared across all views.

Defined in package/src/calendar-types.ts:208

Prop Type Default Description

selected* DateValueObject | undefined — The currently selected value as a tagged DateValueObject.

selectedDates* PlainDate[] — Flat array of all selected dates (plain dates, sorted).

rangeStart* PlainDate | undefined — Start of the current range selection, or undefined.

rangeEnd* PlainDate | undefined — End of the current range selection, or undefined.

hoveredDate* PlainDate | undefined — The currently hovered date (for range preview).

previewStart* PlainDate | undefined — Start of the computed preview range.

previewEnd* PlainDate | undefined — End of the computed preview range.

baseRootState* BaseRootState — View-independent part of the render-prop RootState (selection + resolved config), built once here so MonthView and WeeksView expose identical state. Each view adds its own focused/viewing.

Prop	Type	Default	Description
selected*	DateValueObject \| undefined	—	The currently selected value as a tagged DateValueObject.
selectedDates*	PlainDate[]	—	Flat array of all selected dates (plain dates, sorted).
rangeStart*	PlainDate \| undefined	—	Start of the current range selection, or `undefined`.
rangeEnd*	PlainDate \| undefined	—	End of the current range selection, or `undefined`.
hoveredDate*	PlainDate \| undefined	—	The currently hovered date (for range preview).
previewStart*	PlainDate \| undefined	—	Start of the computed preview range.
previewEnd*	PlainDate \| undefined	—	End of the computed preview range.
baseRootState*	BaseRootState	—	View-independent part of the render-prop `RootState` (selection + resolved config), built once here so MonthView and WeeksView expose identical state. Each view adds its own `focused`/`viewing`.