Interface: NavigationContextValue
Represents the value of the NavigationContext.
Properties
currentMonth
• currentMonth: Date
The month to display in the calendar. When numberOfMonths
is greater than one, is the first of the displayed months.
Defined in
src/contexts/Navigation/NavigationContext.tsx:14
displayMonths
• displayMonths: Date
[]
The months rendered by DayPicker. DayPicker can render multiple months via numberOfMonths
.
Defined in
src/contexts/Navigation/NavigationContext.tsx:16
goToDate
• goToDate: (date
: Date
, refDate?
: Date
) => void
Type declaration
▸ (date
, refDate?
): void
Navigate to the specified date.
Parameters
Name | Type |
---|---|
date | Date |
refDate? | Date |
Returns
void
Defined in
src/contexts/Navigation/NavigationContext.tsx:20
goToMonth
• goToMonth: (month
: Date
) => void
Type declaration
▸ (month
): void
Navigate to the specified month.
Parameters
Name | Type |
---|---|
month | Date |
Returns
void
Defined in
src/contexts/Navigation/NavigationContext.tsx:18
isDateDisplayed
• isDateDisplayed: (day
: Date
) => boolean
Type declaration
▸ (day
): boolean
Whether the given day is included in the displayed months.
Parameters
Name | Type |
---|---|
day | Date |
Returns
boolean
Defined in
src/contexts/Navigation/NavigationContext.tsx:26
nextMonth
• Optional
nextMonth: Date
The next month to display.
Defined in
src/contexts/Navigation/NavigationContext.tsx:22
previousMonth
• Optional
previousMonth: Date
The previous month to display.