API Reference

RootState

interface

State exposed by the Root component to its render function and descendants.

Defined in package/src/types.ts:216

PropTypeDefaultDescription
hasSelection*booleantrue when at least one date is selected.
selected*RawValueForFormat<F> | undefinedThe primary selected value in the configured format, or undefined.
selectedDates*RawValueForFormat<F>[]All selected dates in the configured format (sorted oldest-first).
rangeStart*RawValueForFormat<F> | undefinedRange start in the configured format, or undefined.
rangeEnd*RawValueForFormat<F> | undefinedRange end in the configured format, or undefined.
focused*PlainDateThe currently focused PlainDate in the grid.
viewing*PlainYearMonthThe month/year currently being viewed.
timeZone*stringResolved IANA time zone.
locale*stringResolved BCP 47 locale.
readOnly*booleanWhether the calendar is read-only.