Skip to main content

Interface: NavigationContextValue

Represents the value of the NavigationContext.

Properties

currentMonth

currentMonth: Date

The month to display in the calendar. Note that when numberOfMonths > 1 represent the first month in the displayed months.

Defined in

contexts/Navigation/NavigationContext.tsx:16


displayMonths

displayMonths: Date[]

The months rendered by DayPicker. DayPicker can render one than one month via numberOfMonths.

Defined in

contexts/Navigation/NavigationContext.tsx:18


nextMonth

Optional nextMonth: Date

The next month to display. undefined if no months left

Defined in

contexts/Navigation/NavigationContext.tsx:24


previousMonth

Optional previousMonth: Date

The previous month to display. undefined if no months left

Defined in

contexts/Navigation/NavigationContext.tsx:26

Methods

goToDate

goToDate(date, refDate?): void

Navigate to the specified date.

Parameters

NameType
dateDate
refDate?Date

Returns

void

Defined in

contexts/Navigation/NavigationContext.tsx:22


goToMonth

goToMonth(month): void

Navigate to the specified month.

Parameters

NameType
monthDate

Returns

void

Defined in

contexts/Navigation/NavigationContext.tsx:20


isDateDisplayed

isDateDisplayed(day): boolean

Return true if the day is currently included in the months displayed in the calendar.

Parameters

NameType
dayDate

Returns

boolean

Defined in

contexts/Navigation/NavigationContext.tsx:28