From 4008c94f60cca1144714f47a7c7aa9b88f39193d Mon Sep 17 00:00:00 2001 From: gpbl Date: Sat, 2 Mar 2024 08:05:24 -0500 Subject: [PATCH] remove api Signed-off-by: gpbl --- .../main/enumerations/InternalModifier.mdx | 21 --- docs/api/main/functions/Button.mdx | 24 --- docs/api/main/functions/Caption.mdx | 25 --- docs/api/main/functions/CaptionDropdowns.mdx | 24 --- docs/api/main/functions/CaptionLabel.mdx | 24 --- docs/api/main/functions/CaptionNavigation.mdx | 24 --- docs/api/main/functions/Day.mdx | 25 --- docs/api/main/functions/DayContent.mdx | 24 --- docs/api/main/functions/DayPicker.mdx | 108 ------------ docs/api/main/functions/DayPickerProvider.mdx | 25 --- docs/api/main/functions/Dropdown.mdx | 25 --- docs/api/main/functions/FocusProvider.mdx | 24 --- docs/api/main/functions/Footer.mdx | 24 --- docs/api/main/functions/Head.mdx | 18 -- docs/api/main/functions/HeadRow.mdx | 18 -- docs/api/main/functions/IconDropdown.mdx | 24 --- docs/api/main/functions/IconLeft.mdx | 24 --- docs/api/main/functions/IconRight.mdx | 24 --- docs/api/main/functions/Months.mdx | 24 --- .../api/main/functions/NavigationProvider.mdx | 25 --- docs/api/main/functions/RootProvider.mdx | 24 --- docs/api/main/functions/Row.mdx | 24 --- .../main/functions/SelectMultipleProvider.mdx | 24 --- .../SelectMultipleProviderInternal.mdx | 22 --- .../main/functions/SelectRangeProvider.mdx | 24 --- .../functions/SelectRangeProviderInternal.mdx | 22 --- .../main/functions/SelectSingleProvider.mdx | 24 --- .../SelectSingleProviderInternal.mdx | 22 --- docs/api/main/functions/WeekNumber.mdx | 25 --- docs/api/main/functions/addToRange.mdx | 28 ---- docs/api/main/functions/isDateAfterType.mdx | 24 --- docs/api/main/functions/isDateBeforeType.mdx | 24 --- docs/api/main/functions/isDateInterval.mdx | 24 --- docs/api/main/functions/isDateRange.mdx | 24 --- docs/api/main/functions/isDayOfWeekType.mdx | 24 --- .../api/main/functions/isDayPickerDefault.mdx | 24 --- .../main/functions/isDayPickerMultiple.mdx | 24 --- docs/api/main/functions/isDayPickerRange.mdx | 24 --- docs/api/main/functions/isDayPickerSingle.mdx | 24 --- docs/api/main/functions/isMatch.mdx | 39 ----- .../api/main/functions/useActiveModifiers.mdx | 27 --- docs/api/main/functions/useDayPicker.mdx | 21 --- docs/api/main/functions/useDayRender.mdx | 29 ---- docs/api/main/functions/useFocusContext.mdx | 21 --- docs/api/main/functions/useInput.mdx | 24 --- docs/api/main/functions/useNavigation.mdx | 21 --- docs/api/main/functions/useSelectMultiple.mdx | 20 --- docs/api/main/functions/useSelectRange.mdx | 20 --- docs/api/main/functions/useSelectSingle.mdx | 20 --- docs/api/main/index.mdx | 157 ------------------ .../api/main/interfaces/CaptionLabelProps.mdx | 16 -- docs/api/main/interfaces/CaptionProps.mdx | 16 -- docs/api/main/interfaces/CustomComponents.mdx | 31 ---- docs/api/main/interfaces/DayContentProps.mdx | 16 -- docs/api/main/interfaces/DayPickerBase.mdx | 81 --------- .../main/interfaces/DayPickerContextValue.mdx | 83 --------- .../main/interfaces/DayPickerDefaultProps.mdx | 78 --------- .../interfaces/DayPickerMultipleProps.mdx | 81 --------- .../interfaces/DayPickerProviderProps.mdx | 15 -- .../main/interfaces/DayPickerRangeProps.mdx | 81 --------- .../main/interfaces/DayPickerSingleProps.mdx | 80 --------- docs/api/main/interfaces/DayProps.mdx | 15 -- docs/api/main/interfaces/DropdownProps.mdx | 21 --- docs/api/main/interfaces/FooterProps.mdx | 12 -- .../interfaces/NavigationContextValue.mdx | 20 --- docs/api/main/interfaces/RootContext.mdx | 14 -- docs/api/main/interfaces/RowProps.mdx | 16 -- .../interfaces/SelectMultipleContextValue.mdx | 16 -- .../interfaces/SelectRangeContextValue.mdx | 16 -- .../interfaces/SelectRangeProviderProps.mdx | 13 -- .../interfaces/SelectSingleContextValue.mdx | 15 -- .../interfaces/SelectSingleProviderProps.mdx | 13 -- docs/api/main/interfaces/UseInputOptions.mdx | 26 --- docs/api/main/interfaces/UseInputValue.mdx | 17 -- docs/api/main/interfaces/WeekNumberProps.mdx | 15 -- .../api/main/type-aliases/ActiveModifiers.mdx | 21 --- docs/api/main/type-aliases/ButtonProps.mdx | 14 -- docs/api/main/type-aliases/CaptionLayout.mdx | 18 -- docs/api/main/type-aliases/ClassNames.mdx | 14 -- .../api/main/type-aliases/CustomModifiers.mdx | 15 -- docs/api/main/type-aliases/DateAfter.mdx | 20 --- docs/api/main/type-aliases/DateBefore.mdx | 20 --- docs/api/main/type-aliases/DateFormatter.mdx | 26 --- docs/api/main/type-aliases/DateInterval.mdx | 21 --- docs/api/main/type-aliases/DateRange.mdx | 21 --- .../type-aliases/DayClickEventHandler.mdx | 26 --- .../type-aliases/DayFocusEventHandler.mdx | 26 --- .../type-aliases/DayKeyboardEventHandler.mdx | 26 --- docs/api/main/type-aliases/DayLabel.mdx | 27 --- docs/api/main/type-aliases/DayModifiers.mdx | 14 -- .../type-aliases/DayMouseEventHandler.mdx | 26 --- docs/api/main/type-aliases/DayOfWeek.mdx | 20 --- docs/api/main/type-aliases/DayPickerProps.mdx | 12 -- .../type-aliases/DayPointerEventHandler.mdx | 26 --- docs/api/main/type-aliases/DayRender.mdx | 23 --- .../main/type-aliases/DaySelectionMode.mdx | 20 --- .../type-aliases/DayTouchEventHandler.mdx | 26 --- .../main/type-aliases/FocusContextValue.mdx | 33 ---- .../main/type-aliases/FocusProviderProps.mdx | 18 -- docs/api/main/type-aliases/Formatters.mdx | 25 --- .../main/type-aliases/InputDayPickerProps.mdx | 14 -- docs/api/main/type-aliases/InputProps.mdx | 14 -- .../main/type-aliases/InternalModifiers.mdx | 14 -- .../type-aliases/InternalModifiersElement.mdx | 14 -- docs/api/main/type-aliases/Labels.mdx | 26 --- docs/api/main/type-aliases/Matcher.mdx | 62 ------- docs/api/main/type-aliases/Modifier.mdx | 14 -- docs/api/main/type-aliases/Modifiers.mdx | 14 -- .../main/type-aliases/ModifiersClassNames.mdx | 14 -- .../api/main/type-aliases/ModifiersStyles.mdx | 14 -- .../type-aliases/MonthChangeEventHandler.mdx | 24 --- docs/api/main/type-aliases/MonthsProps.mdx | 20 --- docs/api/main/type-aliases/NavButtonLabel.mdx | 26 --- .../SelectMultipleEventHandler.mdx | 27 --- .../type-aliases/SelectMultipleModifiers.mdx | 14 -- .../SelectMultipleProviderProps.mdx | 19 --- .../type-aliases/SelectRangeEventHandler.mdx | 27 --- .../type-aliases/SelectRangeModifiers.mdx | 14 -- .../type-aliases/SelectSingleEventHandler.mdx | 27 --- .../api/main/type-aliases/StyledComponent.mdx | 22 --- docs/api/main/type-aliases/StyledElement.mdx | 66 -------- docs/api/main/type-aliases/Styles.mdx | 16 -- .../WeekNumberClickEventHandler.mdx | 26 --- .../main/type-aliases/WeekNumberFormatter.mdx | 26 --- .../api/main/type-aliases/WeekNumberLabel.mdx | 26 --- docs/api/main/type-aliases/WeekdayLabel.mdx | 26 --- docs/api/main/variables/DayPickerContext.mdx | 18 -- docs/api/main/variables/FocusContext.mdx | 16 -- docs/api/main/variables/NavigationContext.mdx | 15 -- .../main/variables/SelectMultipleContext.mdx | 17 -- .../api/main/variables/SelectRangeContext.mdx | 17 -- .../main/variables/SelectSingleContext.mdx | 17 -- docs/api/next/classes/CalendarDay.mdx | 59 ------- docs/api/next/classes/Month.mdx | 36 ---- docs/api/next/classes/Week.mdx | 36 ---- docs/api/next/enumerations/UI.mdx | 66 -------- docs/api/next/functions/Button.mdx | 28 ---- docs/api/next/functions/Chevron.mdx | 26 --- docs/api/next/functions/DayGridCell.mdx | 24 --- docs/api/next/functions/DayPicker.mdx | 38 ----- docs/api/next/functions/DayPickerProvider.mdx | 31 ---- docs/api/next/functions/Dropdown.mdx | 24 --- docs/api/next/functions/DropdownNav.mdx | 28 ---- docs/api/next/functions/Footer.mdx | 24 --- docs/api/next/functions/MonthCaption.mdx | 24 --- docs/api/next/functions/MonthGrid.mdx | 28 ---- docs/api/next/functions/Months.mdx | 24 --- docs/api/next/functions/MonthsDropdown.mdx | 25 --- docs/api/next/functions/Nav.mdx | 18 -- docs/api/next/functions/Option.mdx | 24 --- docs/api/next/functions/Select.mdx | 24 --- .../next/functions/WeekNumberRowHeader.mdx | 25 --- docs/api/next/functions/WeekRow.mdx | 24 --- .../next/functions/WeekdayColumnHeader.mdx | 27 --- docs/api/next/functions/WeekdaysRow.mdx | 18 -- docs/api/next/functions/YearsDropdown.mdx | 25 --- docs/api/next/functions/formatCaption.mdx | 25 --- docs/api/next/functions/formatDay.mdx | 25 --- .../api/next/functions/formatMonthCaption.mdx | 28 ---- .../next/functions/formatMonthDropdown.mdx | 25 --- docs/api/next/functions/formatWeekNumber.mdx | 25 --- docs/api/next/functions/formatWeekdayName.mdx | 25 --- docs/api/next/functions/formatYearCaption.mdx | 27 --- .../api/next/functions/formatYearDropdown.mdx | 24 --- docs/api/next/functions/labelDay.mdx | 26 --- .../api/next/functions/labelMonthDropdown.mdx | 24 --- docs/api/next/functions/labelNext.mdx | 25 --- docs/api/next/functions/labelPrevious.mdx | 25 --- docs/api/next/functions/labelWeekNumber.mdx | 25 --- .../next/functions/labelWeekNumberHeader.mdx | 24 --- docs/api/next/functions/labelWeekday.mdx | 25 --- docs/api/next/functions/labelYearDropdown.mdx | 24 --- docs/api/next/functions/useCalendar.mdx | 22 --- docs/api/next/functions/useDayPicker.mdx | 18 -- docs/api/next/functions/useSelection.mdx | 22 --- docs/api/next/index.mdx | 117 ------------- docs/api/next/interfaces/CalendarContext.mdx | 29 ---- docs/api/next/interfaces/DayGridCellProps.mdx | 15 -- docs/api/next/interfaces/DayPickerContext.mdx | 97 ----------- docs/api/next/interfaces/ModeProp.mdx | 18 -- docs/api/next/interfaces/ModePropsMap.mdx | 17 -- .../api/next/interfaces/MonthCaptionProps.mdx | 14 -- docs/api/next/interfaces/PropsBase.mdx | 83 --------- docs/api/next/interfaces/PropsMulti.mdx | 19 --- docs/api/next/interfaces/PropsRange.mdx | 19 --- docs/api/next/interfaces/PropsSingle.mdx | 17 -- docs/api/next/interfaces/SelectionContext.mdx | 18 -- docs/api/next/interfaces/WeekRowProps.mdx | 13 -- docs/api/next/type-aliases/CaptionLayout.mdx | 20 --- docs/api/next/type-aliases/ClassNames.mdx | 12 -- .../next/type-aliases/CustomComponents.mdx | 15 -- docs/api/next/type-aliases/DateAfter.mdx | 21 --- docs/api/next/type-aliases/DateBefore.mdx | 24 --- docs/api/next/type-aliases/DateInterval.mdx | 22 --- docs/api/next/type-aliases/DateRange.mdx | 22 --- .../type-aliases/DayClickEventHandler.mdx | 19 --- .../api/next/type-aliases/DayEventHandler.mdx | 30 ---- .../type-aliases/DayFocusEventHandler.mdx | 14 -- .../type-aliases/DayKeyboardEventHandler.mdx | 14 -- .../type-aliases/DayMouseEventHandler.mdx | 14 -- docs/api/next/type-aliases/DayOfWeek.mdx | 21 --- docs/api/next/type-aliases/DayPickerProps.mdx | 24 --- .../type-aliases/DayPointerEventHandler.mdx | 14 -- .../type-aliases/DayTouchEventHandler.mdx | 14 -- docs/api/next/type-aliases/DropdownOption.mdx | 14 -- docs/api/next/type-aliases/Formatters.mdx | 27 --- .../next/type-aliases/InternalModifier.mdx | 19 --- docs/api/next/type-aliases/Labels.mdx | 27 --- docs/api/next/type-aliases/Matcher.mdx | 14 -- docs/api/next/type-aliases/Mode.mdx | 23 --- docs/api/next/type-aliases/Modifiers.mdx | 14 -- .../next/type-aliases/ModifiersClassNames.mdx | 14 -- docs/api/next/type-aliases/ModifiersMap.mdx | 14 -- .../api/next/type-aliases/ModifiersStyles.mdx | 14 -- .../type-aliases/MonthChangeEventHandler.mdx | 24 --- docs/api/next/type-aliases/SelectHandler.mdx | 33 ---- docs/api/next/type-aliases/Selected.mdx | 20 --- docs/api/next/type-aliases/Styles.mdx | 12 -- .../WeekNumberClickEventHandler.mdx | 26 --- 219 files changed, 5700 deletions(-) delete mode 100644 docs/api/main/enumerations/InternalModifier.mdx delete mode 100644 docs/api/main/functions/Button.mdx delete mode 100644 docs/api/main/functions/Caption.mdx delete mode 100644 docs/api/main/functions/CaptionDropdowns.mdx delete mode 100644 docs/api/main/functions/CaptionLabel.mdx delete mode 100644 docs/api/main/functions/CaptionNavigation.mdx delete mode 100644 docs/api/main/functions/Day.mdx delete mode 100644 docs/api/main/functions/DayContent.mdx delete mode 100644 docs/api/main/functions/DayPicker.mdx delete mode 100644 docs/api/main/functions/DayPickerProvider.mdx delete mode 100644 docs/api/main/functions/Dropdown.mdx delete mode 100644 docs/api/main/functions/FocusProvider.mdx delete mode 100644 docs/api/main/functions/Footer.mdx delete mode 100644 docs/api/main/functions/Head.mdx delete mode 100644 docs/api/main/functions/HeadRow.mdx delete mode 100644 docs/api/main/functions/IconDropdown.mdx delete mode 100644 docs/api/main/functions/IconLeft.mdx delete mode 100644 docs/api/main/functions/IconRight.mdx delete mode 100644 docs/api/main/functions/Months.mdx delete mode 100644 docs/api/main/functions/NavigationProvider.mdx delete mode 100644 docs/api/main/functions/RootProvider.mdx delete mode 100644 docs/api/main/functions/Row.mdx delete mode 100644 docs/api/main/functions/SelectMultipleProvider.mdx delete mode 100644 docs/api/main/functions/SelectMultipleProviderInternal.mdx delete mode 100644 docs/api/main/functions/SelectRangeProvider.mdx delete mode 100644 docs/api/main/functions/SelectRangeProviderInternal.mdx delete mode 100644 docs/api/main/functions/SelectSingleProvider.mdx delete mode 100644 docs/api/main/functions/SelectSingleProviderInternal.mdx delete mode 100644 docs/api/main/functions/WeekNumber.mdx delete mode 100644 docs/api/main/functions/addToRange.mdx delete mode 100644 docs/api/main/functions/isDateAfterType.mdx delete mode 100644 docs/api/main/functions/isDateBeforeType.mdx delete mode 100644 docs/api/main/functions/isDateInterval.mdx delete mode 100644 docs/api/main/functions/isDateRange.mdx delete mode 100644 docs/api/main/functions/isDayOfWeekType.mdx delete mode 100644 docs/api/main/functions/isDayPickerDefault.mdx delete mode 100644 docs/api/main/functions/isDayPickerMultiple.mdx delete mode 100644 docs/api/main/functions/isDayPickerRange.mdx delete mode 100644 docs/api/main/functions/isDayPickerSingle.mdx delete mode 100644 docs/api/main/functions/isMatch.mdx delete mode 100644 docs/api/main/functions/useActiveModifiers.mdx delete mode 100644 docs/api/main/functions/useDayPicker.mdx delete mode 100644 docs/api/main/functions/useDayRender.mdx delete mode 100644 docs/api/main/functions/useFocusContext.mdx delete mode 100644 docs/api/main/functions/useInput.mdx delete mode 100644 docs/api/main/functions/useNavigation.mdx delete mode 100644 docs/api/main/functions/useSelectMultiple.mdx delete mode 100644 docs/api/main/functions/useSelectRange.mdx delete mode 100644 docs/api/main/functions/useSelectSingle.mdx delete mode 100644 docs/api/main/index.mdx delete mode 100644 docs/api/main/interfaces/CaptionLabelProps.mdx delete mode 100644 docs/api/main/interfaces/CaptionProps.mdx delete mode 100644 docs/api/main/interfaces/CustomComponents.mdx delete mode 100644 docs/api/main/interfaces/DayContentProps.mdx delete mode 100644 docs/api/main/interfaces/DayPickerBase.mdx delete mode 100644 docs/api/main/interfaces/DayPickerContextValue.mdx delete mode 100644 docs/api/main/interfaces/DayPickerDefaultProps.mdx delete mode 100644 docs/api/main/interfaces/DayPickerMultipleProps.mdx delete mode 100644 docs/api/main/interfaces/DayPickerProviderProps.mdx delete mode 100644 docs/api/main/interfaces/DayPickerRangeProps.mdx delete mode 100644 docs/api/main/interfaces/DayPickerSingleProps.mdx delete mode 100644 docs/api/main/interfaces/DayProps.mdx delete mode 100644 docs/api/main/interfaces/DropdownProps.mdx delete mode 100644 docs/api/main/interfaces/FooterProps.mdx delete mode 100644 docs/api/main/interfaces/NavigationContextValue.mdx delete mode 100644 docs/api/main/interfaces/RootContext.mdx delete mode 100644 docs/api/main/interfaces/RowProps.mdx delete mode 100644 docs/api/main/interfaces/SelectMultipleContextValue.mdx delete mode 100644 docs/api/main/interfaces/SelectRangeContextValue.mdx delete mode 100644 docs/api/main/interfaces/SelectRangeProviderProps.mdx delete mode 100644 docs/api/main/interfaces/SelectSingleContextValue.mdx delete mode 100644 docs/api/main/interfaces/SelectSingleProviderProps.mdx delete mode 100644 docs/api/main/interfaces/UseInputOptions.mdx delete mode 100644 docs/api/main/interfaces/UseInputValue.mdx delete mode 100644 docs/api/main/interfaces/WeekNumberProps.mdx delete mode 100644 docs/api/main/type-aliases/ActiveModifiers.mdx delete mode 100644 docs/api/main/type-aliases/ButtonProps.mdx delete mode 100644 docs/api/main/type-aliases/CaptionLayout.mdx delete mode 100644 docs/api/main/type-aliases/ClassNames.mdx delete mode 100644 docs/api/main/type-aliases/CustomModifiers.mdx delete mode 100644 docs/api/main/type-aliases/DateAfter.mdx delete mode 100644 docs/api/main/type-aliases/DateBefore.mdx delete mode 100644 docs/api/main/type-aliases/DateFormatter.mdx delete mode 100644 docs/api/main/type-aliases/DateInterval.mdx delete mode 100644 docs/api/main/type-aliases/DateRange.mdx delete mode 100644 docs/api/main/type-aliases/DayClickEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/DayFocusEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/DayKeyboardEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/DayLabel.mdx delete mode 100644 docs/api/main/type-aliases/DayModifiers.mdx delete mode 100644 docs/api/main/type-aliases/DayMouseEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/DayOfWeek.mdx delete mode 100644 docs/api/main/type-aliases/DayPickerProps.mdx delete mode 100644 docs/api/main/type-aliases/DayPointerEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/DayRender.mdx delete mode 100644 docs/api/main/type-aliases/DaySelectionMode.mdx delete mode 100644 docs/api/main/type-aliases/DayTouchEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/FocusContextValue.mdx delete mode 100644 docs/api/main/type-aliases/FocusProviderProps.mdx delete mode 100644 docs/api/main/type-aliases/Formatters.mdx delete mode 100644 docs/api/main/type-aliases/InputDayPickerProps.mdx delete mode 100644 docs/api/main/type-aliases/InputProps.mdx delete mode 100644 docs/api/main/type-aliases/InternalModifiers.mdx delete mode 100644 docs/api/main/type-aliases/InternalModifiersElement.mdx delete mode 100644 docs/api/main/type-aliases/Labels.mdx delete mode 100644 docs/api/main/type-aliases/Matcher.mdx delete mode 100644 docs/api/main/type-aliases/Modifier.mdx delete mode 100644 docs/api/main/type-aliases/Modifiers.mdx delete mode 100644 docs/api/main/type-aliases/ModifiersClassNames.mdx delete mode 100644 docs/api/main/type-aliases/ModifiersStyles.mdx delete mode 100644 docs/api/main/type-aliases/MonthChangeEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/MonthsProps.mdx delete mode 100644 docs/api/main/type-aliases/NavButtonLabel.mdx delete mode 100644 docs/api/main/type-aliases/SelectMultipleEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/SelectMultipleModifiers.mdx delete mode 100644 docs/api/main/type-aliases/SelectMultipleProviderProps.mdx delete mode 100644 docs/api/main/type-aliases/SelectRangeEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/SelectRangeModifiers.mdx delete mode 100644 docs/api/main/type-aliases/SelectSingleEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/StyledComponent.mdx delete mode 100644 docs/api/main/type-aliases/StyledElement.mdx delete mode 100644 docs/api/main/type-aliases/Styles.mdx delete mode 100644 docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx delete mode 100644 docs/api/main/type-aliases/WeekNumberFormatter.mdx delete mode 100644 docs/api/main/type-aliases/WeekNumberLabel.mdx delete mode 100644 docs/api/main/type-aliases/WeekdayLabel.mdx delete mode 100644 docs/api/main/variables/DayPickerContext.mdx delete mode 100644 docs/api/main/variables/FocusContext.mdx delete mode 100644 docs/api/main/variables/NavigationContext.mdx delete mode 100644 docs/api/main/variables/SelectMultipleContext.mdx delete mode 100644 docs/api/main/variables/SelectRangeContext.mdx delete mode 100644 docs/api/main/variables/SelectSingleContext.mdx delete mode 100644 docs/api/next/classes/CalendarDay.mdx delete mode 100644 docs/api/next/classes/Month.mdx delete mode 100644 docs/api/next/classes/Week.mdx delete mode 100644 docs/api/next/enumerations/UI.mdx delete mode 100644 docs/api/next/functions/Button.mdx delete mode 100644 docs/api/next/functions/Chevron.mdx delete mode 100644 docs/api/next/functions/DayGridCell.mdx delete mode 100644 docs/api/next/functions/DayPicker.mdx delete mode 100644 docs/api/next/functions/DayPickerProvider.mdx delete mode 100644 docs/api/next/functions/Dropdown.mdx delete mode 100644 docs/api/next/functions/DropdownNav.mdx delete mode 100644 docs/api/next/functions/Footer.mdx delete mode 100644 docs/api/next/functions/MonthCaption.mdx delete mode 100644 docs/api/next/functions/MonthGrid.mdx delete mode 100644 docs/api/next/functions/Months.mdx delete mode 100644 docs/api/next/functions/MonthsDropdown.mdx delete mode 100644 docs/api/next/functions/Nav.mdx delete mode 100644 docs/api/next/functions/Option.mdx delete mode 100644 docs/api/next/functions/Select.mdx delete mode 100644 docs/api/next/functions/WeekNumberRowHeader.mdx delete mode 100644 docs/api/next/functions/WeekRow.mdx delete mode 100644 docs/api/next/functions/WeekdayColumnHeader.mdx delete mode 100644 docs/api/next/functions/WeekdaysRow.mdx delete mode 100644 docs/api/next/functions/YearsDropdown.mdx delete mode 100644 docs/api/next/functions/formatCaption.mdx delete mode 100644 docs/api/next/functions/formatDay.mdx delete mode 100644 docs/api/next/functions/formatMonthCaption.mdx delete mode 100644 docs/api/next/functions/formatMonthDropdown.mdx delete mode 100644 docs/api/next/functions/formatWeekNumber.mdx delete mode 100644 docs/api/next/functions/formatWeekdayName.mdx delete mode 100644 docs/api/next/functions/formatYearCaption.mdx delete mode 100644 docs/api/next/functions/formatYearDropdown.mdx delete mode 100644 docs/api/next/functions/labelDay.mdx delete mode 100644 docs/api/next/functions/labelMonthDropdown.mdx delete mode 100644 docs/api/next/functions/labelNext.mdx delete mode 100644 docs/api/next/functions/labelPrevious.mdx delete mode 100644 docs/api/next/functions/labelWeekNumber.mdx delete mode 100644 docs/api/next/functions/labelWeekNumberHeader.mdx delete mode 100644 docs/api/next/functions/labelWeekday.mdx delete mode 100644 docs/api/next/functions/labelYearDropdown.mdx delete mode 100644 docs/api/next/functions/useCalendar.mdx delete mode 100644 docs/api/next/functions/useDayPicker.mdx delete mode 100644 docs/api/next/functions/useSelection.mdx delete mode 100644 docs/api/next/index.mdx delete mode 100644 docs/api/next/interfaces/CalendarContext.mdx delete mode 100644 docs/api/next/interfaces/DayGridCellProps.mdx delete mode 100644 docs/api/next/interfaces/DayPickerContext.mdx delete mode 100644 docs/api/next/interfaces/ModeProp.mdx delete mode 100644 docs/api/next/interfaces/ModePropsMap.mdx delete mode 100644 docs/api/next/interfaces/MonthCaptionProps.mdx delete mode 100644 docs/api/next/interfaces/PropsBase.mdx delete mode 100644 docs/api/next/interfaces/PropsMulti.mdx delete mode 100644 docs/api/next/interfaces/PropsRange.mdx delete mode 100644 docs/api/next/interfaces/PropsSingle.mdx delete mode 100644 docs/api/next/interfaces/SelectionContext.mdx delete mode 100644 docs/api/next/interfaces/WeekRowProps.mdx delete mode 100644 docs/api/next/type-aliases/CaptionLayout.mdx delete mode 100644 docs/api/next/type-aliases/ClassNames.mdx delete mode 100644 docs/api/next/type-aliases/CustomComponents.mdx delete mode 100644 docs/api/next/type-aliases/DateAfter.mdx delete mode 100644 docs/api/next/type-aliases/DateBefore.mdx delete mode 100644 docs/api/next/type-aliases/DateInterval.mdx delete mode 100644 docs/api/next/type-aliases/DateRange.mdx delete mode 100644 docs/api/next/type-aliases/DayClickEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayFocusEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayKeyboardEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayMouseEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayOfWeek.mdx delete mode 100644 docs/api/next/type-aliases/DayPickerProps.mdx delete mode 100644 docs/api/next/type-aliases/DayPointerEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DayTouchEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/DropdownOption.mdx delete mode 100644 docs/api/next/type-aliases/Formatters.mdx delete mode 100644 docs/api/next/type-aliases/InternalModifier.mdx delete mode 100644 docs/api/next/type-aliases/Labels.mdx delete mode 100644 docs/api/next/type-aliases/Matcher.mdx delete mode 100644 docs/api/next/type-aliases/Mode.mdx delete mode 100644 docs/api/next/type-aliases/Modifiers.mdx delete mode 100644 docs/api/next/type-aliases/ModifiersClassNames.mdx delete mode 100644 docs/api/next/type-aliases/ModifiersMap.mdx delete mode 100644 docs/api/next/type-aliases/ModifiersStyles.mdx delete mode 100644 docs/api/next/type-aliases/MonthChangeEventHandler.mdx delete mode 100644 docs/api/next/type-aliases/SelectHandler.mdx delete mode 100644 docs/api/next/type-aliases/Selected.mdx delete mode 100644 docs/api/next/type-aliases/Styles.mdx delete mode 100644 docs/api/next/type-aliases/WeekNumberClickEventHandler.mdx diff --git a/docs/api/main/enumerations/InternalModifier.mdx b/docs/api/main/enumerations/InternalModifier.mdx deleted file mode 100644 index b2d16231d1..0000000000 --- a/docs/api/main/enumerations/InternalModifier.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: Enum -title: InternalModifier ---- - -# Enumeration: InternalModifier - -The name of the modifiers that are used internally by DayPicker. - -## Enumeration Members - -| Enumeration Member | Value | Description | -| :------ | :------ | :------ | -| `Disabled` | `"disabled"` | Name of the modifier applied to the disabled days, using the `disabled` prop. | -| `Hidden` | `"hidden"` | Name of the modifier applied to the hidden days using the `hidden` prop). | -| `Outside` | `"outside"` | - | -| `RangeEnd` | `"range_end"` | The modifier applied to the day ending a selected range, when in range selection mode. | -| `RangeMiddle` | `"range_middle"` | The modifier applied to the days between the start and the end of a selected range, when in range selection mode. | -| `RangeStart` | `"range_start"` | The modifier applied to the day starting a selected range, when in range selection mode. | -| `Selected` | `"selected"` | Name of the modifier applied to the selected days using the `selected` prop). | -| `Today` | `"today"` | Name of the modifier applied to the day specified using the `today` prop). | diff --git a/docs/api/main/functions/Button.mdx b/docs/api/main/functions/Button.mdx deleted file mode 100644 index c0ef1d4ec1..0000000000 --- a/docs/api/main/functions/Button.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Button ---- - -# Function: Button() - -> **Button**(`props`): `ReactNode` - -Render a button HTML element applying the reset class name. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Omit`\<`DetailedHTMLProps`\<`ButtonHTMLAttributes`\<`HTMLButtonElement`\>, `HTMLButtonElement`\>, `"ref"`\> & `RefAttributes`\<`HTMLButtonElement`\> | - -## Returns - -`ReactNode` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Button/Button.tsx:9 diff --git a/docs/api/main/functions/Caption.mdx b/docs/api/main/functions/Caption.mdx deleted file mode 100644 index 39152b6c39..0000000000 --- a/docs/api/main/functions/Caption.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: Caption ---- - -# Function: Caption() - -> **Caption**(`props`): `JSX.Element` - -Render the caption of a month. The caption has a different layout when -setting the [DayPickerBase.captionLayout](/docs/api/main/interfaces/DayPickerBase.mdx) prop. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Caption/Caption.tsx:29 diff --git a/docs/api/main/functions/CaptionDropdowns.mdx b/docs/api/main/functions/CaptionDropdowns.mdx deleted file mode 100644 index 018c1f641f..0000000000 --- a/docs/api/main/functions/CaptionDropdowns.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: CaptionDropdowns ---- - -# Function: CaptionDropdowns() - -> **CaptionDropdowns**(`props`): `JSX.Element` - -Render a caption with the dropdowns to navigate between months and years. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/CaptionDropdowns/CaptionDropdowns.tsx:14 diff --git a/docs/api/main/functions/CaptionLabel.mdx b/docs/api/main/functions/CaptionLabel.mdx deleted file mode 100644 index e6a4c66a00..0000000000 --- a/docs/api/main/functions/CaptionLabel.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: CaptionLabel ---- - -# Function: CaptionLabel() - -> **CaptionLabel**(`props`): `JSX.Element` - -Render the caption for the displayed month. This component is used when `captionLayout="buttons"`. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`CaptionLabelProps`](/docs/api/main/interfaces/CaptionLabelProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/CaptionLabel/CaptionLabel.tsx:14 diff --git a/docs/api/main/functions/CaptionNavigation.mdx b/docs/api/main/functions/CaptionNavigation.mdx deleted file mode 100644 index b3d952dbd2..0000000000 --- a/docs/api/main/functions/CaptionNavigation.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: CaptionNavigation ---- - -# Function: CaptionNavigation() - -> **CaptionNavigation**(`props`): `JSX.Element` - -Render a caption with a button-based navigation. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/CaptionNavigation/CaptionNavigation.tsx:13 diff --git a/docs/api/main/functions/Day.mdx b/docs/api/main/functions/Day.mdx deleted file mode 100644 index 88f3ccf3c2..0000000000 --- a/docs/api/main/functions/Day.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: Day ---- - -# Function: Day() - -> **Day**(`props`): `JSX.Element` - -The content of a day cell – as a button or span element according to its -modifiers. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayProps`](/docs/api/main/interfaces/DayProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Day/Day.tsx:19 diff --git a/docs/api/main/functions/DayContent.mdx b/docs/api/main/functions/DayContent.mdx deleted file mode 100644 index 063deff870..0000000000 --- a/docs/api/main/functions/DayContent.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: DayContent ---- - -# Function: DayContent() - -> **DayContent**(`props`): `JSX.Element` - -Render the content of the day cell. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayContentProps`](/docs/api/main/interfaces/DayContentProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/DayContent/DayContent.tsx:15 diff --git a/docs/api/main/functions/DayPicker.mdx b/docs/api/main/functions/DayPicker.mdx deleted file mode 100644 index 123c161f48..0000000000 --- a/docs/api/main/functions/DayPicker.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -section: Function -title: DayPicker ---- - -# Function: DayPicker() - -> **DayPicker**(`props`): `JSX.Element` - -DayPicker render a date picker component to let users pick dates from a -calendar. See http://react-day-picker.js.org for updated documentation and -examples. - -### Customization - -DayPicker offers different customization props. For example, - -- show multiple months using `numberOfMonths` -- display a dropdown to navigate the months via `captionLayout` -- display the week numbers with `showWeekNumbers` -- disable or hide days with `disabled` or `hidden` - -### Controlling the months - -Change the initially displayed month using the `defaultMonth` prop. The -displayed months are controlled by DayPicker and stored in its internal -state. To control the months yourself, use `month` instead of `defaultMonth` -and use the `onMonthChange` event to set it. - -To limit the months the user can navigate to, use -`fromDate`/`fromMonth`/`fromYear` or `toDate`/`toMonth`/`toYear`. - -### Selection modes - -DayPicker supports different selection mode that can be toggled using the -`mode` prop: - -- `mode="single"`: only one day can be selected. Use `required` to make the - selection required. Use the `onSelect` event handler to get the selected - days. -- `mode="multiple"`: users can select one or more days. Limit the amount of - days that can be selected with the `min` or the `max` props. -- `mode="range"`: users can select a range of days. Limit the amount of days - in the range with the `min` or the `max` props. -- `mode="default"` (default): the built-in selections are disabled. Implement - your own selection mode with `onDayClick`. - -The selection modes should cover the most common use cases. In case you -need a more refined way of selecting days, use `mode="default"`. Use the -`selected` props and add the day event handlers to add/remove days from the -selection. - -### Modifiers - -A _modifier_ represents different styles or states for the days displayed in -the calendar (like "selected" or "disabled"). Define custom modifiers using -the `modifiers` prop. - -### Formatters and custom component - -You can customize how the content is displayed in the date picker by using -either the formatters or replacing the internal components. - -For the most common cases you want to use the `formatters` prop to change how -the content is formatted in the calendar. Use the `components` prop to -replace the internal components, like the navigation icons. - -### Styling - -DayPicker comes with a default, basic style in `react-day-picker/style` – use -it as template for your own style. - -If you are using CSS modules, pass the imported styles object the -`classNames` props. - -You can also style the elements via inline styles using the `styles` prop. - -### Form fields - -If you need to bind the date picker to a form field, you can use the -`useInput` hooks for a basic behavior. See the `useInput` source as an -example to bind the date picker with form fields. - -### Localization - -To localize DayPicker, import the locale from `date-fns` package and use the -`locale` prop. - -For example, to use Spanish locale: - -``` -import { es } from 'date-fns/locale'; - -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerSingleProps`](/docs/api/main/interfaces/DayPickerSingleProps.mdx) \| [`DayPickerMultipleProps`](/docs/api/main/interfaces/DayPickerMultipleProps.mdx) \| [`DayPickerRangeProps`](/docs/api/main/interfaces/DayPickerRangeProps.mdx) \| [`DayPickerDefaultProps`](/docs/api/main/interfaces/DayPickerDefaultProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -typedoc/node\_modules/react-day-picker-v8/src/DayPicker.tsx:102 diff --git a/docs/api/main/functions/DayPickerProvider.mdx b/docs/api/main/functions/DayPickerProvider.mdx deleted file mode 100644 index a810b65c39..0000000000 --- a/docs/api/main/functions/DayPickerProvider.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: DayPickerProvider ---- - -# Function: DayPickerProvider() - -> **DayPickerProvider**(`props`): `JSX.Element` - -The provider for the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx), assigning the defaults from the -initial DayPicker props. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerProviderProps`](/docs/api/main/interfaces/DayPickerProviderProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/DayPicker/DayPickerContext.tsx:71 diff --git a/docs/api/main/functions/Dropdown.mdx b/docs/api/main/functions/Dropdown.mdx deleted file mode 100644 index bc8653789d..0000000000 --- a/docs/api/main/functions/Dropdown.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: Dropdown ---- - -# Function: Dropdown() - -> **Dropdown**(`props`): `JSX.Element` - -Render a styled select component – displaying a caption and a custom -drop-down icon. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DropdownProps`](/docs/api/main/interfaces/DropdownProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Dropdown/Dropdown.tsx:30 diff --git a/docs/api/main/functions/FocusProvider.mdx b/docs/api/main/functions/FocusProvider.mdx deleted file mode 100644 index 654efb10f8..0000000000 --- a/docs/api/main/functions/FocusProvider.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: FocusProvider ---- - -# Function: FocusProvider() - -> **FocusProvider**(`props`): `JSX.Element` - -The provider for the [FocusContext](/docs/api/main/variables/FocusContext.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`FocusProviderProps`](/docs/api/main/type-aliases/FocusProviderProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Focus/FocusContext.tsx:60 diff --git a/docs/api/main/functions/Footer.mdx b/docs/api/main/functions/Footer.mdx deleted file mode 100644 index 267cfeb504..0000000000 --- a/docs/api/main/functions/Footer.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Footer ---- - -# Function: Footer() - -> **Footer**(`props`): `JSX.Element` - -Render the Footer component (empty as default). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`FooterProps`](/docs/api/main/interfaces/FooterProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Footer/Footer.tsx:9 diff --git a/docs/api/main/functions/Head.mdx b/docs/api/main/functions/Head.mdx deleted file mode 100644 index dda9fb6e34..0000000000 --- a/docs/api/main/functions/Head.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Function -title: Head ---- - -# Function: Head() - -> **Head**(): `JSX.Element` - -Render the table head. - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Head/Head.tsx:5 diff --git a/docs/api/main/functions/HeadRow.mdx b/docs/api/main/functions/HeadRow.mdx deleted file mode 100644 index 2b31b6dff6..0000000000 --- a/docs/api/main/functions/HeadRow.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Function -title: HeadRow ---- - -# Function: HeadRow() - -> **HeadRow**(): `JSX.Element` - -Render the HeadRow component - i.e. the table head row with the weekday names. - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/HeadRow/HeadRow.tsx:8 diff --git a/docs/api/main/functions/IconDropdown.mdx b/docs/api/main/functions/IconDropdown.mdx deleted file mode 100644 index a0553190b4..0000000000 --- a/docs/api/main/functions/IconDropdown.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: IconDropdown ---- - -# Function: IconDropdown() - -> **IconDropdown**(`props`): `JSX.Element` - -Render the icon in the styled drop-down. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/IconDropdown/IconDropdown.tsx:6 diff --git a/docs/api/main/functions/IconLeft.mdx b/docs/api/main/functions/IconLeft.mdx deleted file mode 100644 index 2bd0ac1c89..0000000000 --- a/docs/api/main/functions/IconLeft.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: IconLeft ---- - -# Function: IconLeft() - -> **IconLeft**(`props`): `JSX.Element` - -Render the "previous month" button in the navigation. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/IconLeft/IconLeft.tsx:6 diff --git a/docs/api/main/functions/IconRight.mdx b/docs/api/main/functions/IconRight.mdx deleted file mode 100644 index c9927b134e..0000000000 --- a/docs/api/main/functions/IconRight.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: IconRight ---- - -# Function: IconRight() - -> **IconRight**(`props`): `JSX.Element` - -Render the "next month" button in the navigation. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/IconRight/IconRight.tsx:6 diff --git a/docs/api/main/functions/Months.mdx b/docs/api/main/functions/Months.mdx deleted file mode 100644 index 1a06a0404c..0000000000 --- a/docs/api/main/functions/Months.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Months ---- - -# Function: Months() - -> **Months**(`props`): `JSX.Element` - -Render the wrapper for the month grids. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`MonthsProps`](/docs/api/main/type-aliases/MonthsProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Months/Months.tsx:11 diff --git a/docs/api/main/functions/NavigationProvider.mdx b/docs/api/main/functions/NavigationProvider.mdx deleted file mode 100644 index 423db8f5cd..0000000000 --- a/docs/api/main/functions/NavigationProvider.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: NavigationProvider ---- - -# Function: NavigationProvider() - -> **NavigationProvider**(`props`): `JSX.Element` - -Provides the values for the [NavigationContext](/docs/api/main/variables/NavigationContext.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.children`? | `ReactNode` | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Navigation/NavigationContext.tsx:38 diff --git a/docs/api/main/functions/RootProvider.mdx b/docs/api/main/functions/RootProvider.mdx deleted file mode 100644 index f16ad2111e..0000000000 --- a/docs/api/main/functions/RootProvider.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: RootProvider ---- - -# Function: RootProvider() - -> **RootProvider**(`props`): `JSX.Element` - -Provide the value for all the context providers. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`RootContext`](/docs/api/main/interfaces/RootContext.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/RootProvider.tsx:18 diff --git a/docs/api/main/functions/Row.mdx b/docs/api/main/functions/Row.mdx deleted file mode 100644 index 1874461e8d..0000000000 --- a/docs/api/main/functions/Row.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Row ---- - -# Function: Row() - -> **Row**(`props`): `JSX.Element` - -Render a row in the calendar, with the days and the week number. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`RowProps`](/docs/api/main/interfaces/RowProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Row/Row.tsx:20 diff --git a/docs/api/main/functions/SelectMultipleProvider.mdx b/docs/api/main/functions/SelectMultipleProvider.mdx deleted file mode 100644 index be2bcf8b05..0000000000 --- a/docs/api/main/functions/SelectMultipleProvider.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: SelectMultipleProvider ---- - -# Function: SelectMultipleProvider() - -> **SelectMultipleProvider**(`props`): `JSX.Element` - -Provides the values for the [SelectMultipleContext](/docs/api/main/variables/SelectMultipleContext.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`SelectMultipleProviderProps`](/docs/api/main/type-aliases/SelectMultipleProviderProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:45 diff --git a/docs/api/main/functions/SelectMultipleProviderInternal.mdx b/docs/api/main/functions/SelectMultipleProviderInternal.mdx deleted file mode 100644 index 0f8a5be7f9..0000000000 --- a/docs/api/main/functions/SelectMultipleProviderInternal.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: Function -title: SelectMultipleProviderInternal ---- - -# Function: SelectMultipleProviderInternal() - -> **SelectMultipleProviderInternal**(`__namedParameters`): `JSX.Element` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `__namedParameters` | `SelectMultipleProviderInternalProps` | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:75 diff --git a/docs/api/main/functions/SelectRangeProvider.mdx b/docs/api/main/functions/SelectRangeProvider.mdx deleted file mode 100644 index 62f45eedf8..0000000000 --- a/docs/api/main/functions/SelectRangeProvider.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: SelectRangeProvider ---- - -# Function: SelectRangeProvider() - -> **SelectRangeProvider**(`props`): `JSX.Element` - -Provides the values for the [SelectRangeProvider](/docs/api/main/functions/SelectRangeProvider.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`SelectRangeProviderProps`](/docs/api/main/interfaces/SelectRangeProviderProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/SelectRangeContext.tsx:53 diff --git a/docs/api/main/functions/SelectRangeProviderInternal.mdx b/docs/api/main/functions/SelectRangeProviderInternal.mdx deleted file mode 100644 index e166112973..0000000000 --- a/docs/api/main/functions/SelectRangeProviderInternal.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: Function -title: SelectRangeProviderInternal ---- - -# Function: SelectRangeProviderInternal() - -> **SelectRangeProviderInternal**(`__namedParameters`): `JSX.Element` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `__namedParameters` | `SelectRangeProviderInternalProps` | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/SelectRangeContext.tsx:86 diff --git a/docs/api/main/functions/SelectSingleProvider.mdx b/docs/api/main/functions/SelectSingleProvider.mdx deleted file mode 100644 index 1278963b23..0000000000 --- a/docs/api/main/functions/SelectSingleProvider.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: SelectSingleProvider ---- - -# Function: SelectSingleProvider() - -> **SelectSingleProvider**(`props`): `JSX.Element` - -Provides the values for the [SelectSingleProvider](/docs/api/main/functions/SelectSingleProvider.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`SelectSingleProviderProps`](/docs/api/main/interfaces/SelectSingleProviderProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectSingle/SelectSingleContext.tsx:31 diff --git a/docs/api/main/functions/SelectSingleProviderInternal.mdx b/docs/api/main/functions/SelectSingleProviderInternal.mdx deleted file mode 100644 index 75872c7e26..0000000000 --- a/docs/api/main/functions/SelectSingleProviderInternal.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: Function -title: SelectSingleProviderInternal ---- - -# Function: SelectSingleProviderInternal() - -> **SelectSingleProviderInternal**(`__namedParameters`): `JSX.Element` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `__namedParameters` | [`SelectSingleProviderInternal`](/docs/api/main/functions/SelectSingleProviderInternal.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectSingle/SelectSingleContext.tsx:58 diff --git a/docs/api/main/functions/WeekNumber.mdx b/docs/api/main/functions/WeekNumber.mdx deleted file mode 100644 index 86058c63cd..0000000000 --- a/docs/api/main/functions/WeekNumber.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: WeekNumber ---- - -# Function: WeekNumber() - -> **WeekNumber**(`props`): `JSX.Element` - -Render the week number element. If `onWeekNumberClick` is passed to DayPicker, it -renders a button, otherwise a span element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`WeekNumberProps`](/docs/api/main/interfaces/WeekNumberProps.mdx) | - -## Returns - -`JSX.Element` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/WeekNumber/WeekNumber.tsx:21 diff --git a/docs/api/main/functions/addToRange.mdx b/docs/api/main/functions/addToRange.mdx deleted file mode 100644 index d78e471d60..0000000000 --- a/docs/api/main/functions/addToRange.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -section: Function -title: addToRange ---- - -# Function: addToRange() - -> **addToRange**(`day`, `range`?): [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) \| `undefined` - -Add a day to an existing range. - -The returned range takes in account the `undefined` values and if the added -day is already present in the range. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `range`? | [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) | - -## Returns - -[`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) \| `undefined` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/utils/addToRange.ts:11 diff --git a/docs/api/main/functions/isDateAfterType.mdx b/docs/api/main/functions/isDateAfterType.mdx deleted file mode 100644 index 9ad3c59232..0000000000 --- a/docs/api/main/functions/isDateAfterType.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDateAfterType ---- - -# Function: isDateAfterType() - -> **isDateAfterType**(`value`): `value is DateAfter` - -Returns true if `value` is of type [DateAfter](/docs/api/main/type-aliases/DateAfter.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `unknown` | - -## Returns - -`value is DateAfter` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:94 diff --git a/docs/api/main/functions/isDateBeforeType.mdx b/docs/api/main/functions/isDateBeforeType.mdx deleted file mode 100644 index f515d7678b..0000000000 --- a/docs/api/main/functions/isDateBeforeType.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDateBeforeType ---- - -# Function: isDateBeforeType() - -> **isDateBeforeType**(`value`): `value is DateBefore` - -Returns true if `value` is of type [DateBefore](/docs/api/main/type-aliases/DateBefore.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `unknown` | - -## Returns - -`value is DateBefore` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:99 diff --git a/docs/api/main/functions/isDateInterval.mdx b/docs/api/main/functions/isDateInterval.mdx deleted file mode 100644 index bab0997975..0000000000 --- a/docs/api/main/functions/isDateInterval.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDateInterval ---- - -# Function: isDateInterval() - -> **isDateInterval**(`matcher`): `matcher is DateInterval` - -Returns true if `matcher` is of type [DateInterval](/docs/api/main/type-aliases/DateInterval.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `matcher` | `unknown` | - -## Returns - -`matcher is DateInterval` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:79 diff --git a/docs/api/main/functions/isDateRange.mdx b/docs/api/main/functions/isDateRange.mdx deleted file mode 100644 index 9af6fdbf6f..0000000000 --- a/docs/api/main/functions/isDateRange.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDateRange ---- - -# Function: isDateRange() - -> **isDateRange**(`value`): `value is DateRange` - -Returns true if `value` is a [DateRange](/docs/api/main/type-aliases/DateRange.mdx) type. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `unknown` | - -## Returns - -`value is DateRange` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:89 diff --git a/docs/api/main/functions/isDayOfWeekType.mdx b/docs/api/main/functions/isDayOfWeekType.mdx deleted file mode 100644 index 852f4fd2bc..0000000000 --- a/docs/api/main/functions/isDayOfWeekType.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDayOfWeekType ---- - -# Function: isDayOfWeekType() - -> **isDayOfWeekType**(`value`): `value is DayOfWeek` - -Returns true if `value` is a [DayOfWeek](/docs/api/main/type-aliases/DayOfWeek.mdx) type. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `value` | `unknown` | - -## Returns - -`value is DayOfWeek` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:104 diff --git a/docs/api/main/functions/isDayPickerDefault.mdx b/docs/api/main/functions/isDayPickerDefault.mdx deleted file mode 100644 index 504b2ea2b7..0000000000 --- a/docs/api/main/functions/isDayPickerDefault.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDayPickerDefault ---- - -# Function: isDayPickerDefault() - -> **isDayPickerDefault**(`props`): `props is DayPickerDefaultProps` - -Returns true when the props are of type [DayPickerDefaultProps](/docs/api/main/interfaces/DayPickerDefaultProps.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `DayPickerProps` | - -## Returns - -`props is DayPickerDefaultProps` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/DayPickerDefault.ts:11 diff --git a/docs/api/main/functions/isDayPickerMultiple.mdx b/docs/api/main/functions/isDayPickerMultiple.mdx deleted file mode 100644 index 1a36164e0c..0000000000 --- a/docs/api/main/functions/isDayPickerMultiple.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDayPickerMultiple ---- - -# Function: isDayPickerMultiple() - -> **isDayPickerMultiple**(`props`): `props is DayPickerMultipleProps` - -Returns true when the props are of type [DayPickerMultipleProps](/docs/api/main/interfaces/DayPickerMultipleProps.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) \| `DayPickerProps` | - -## Returns - -`props is DayPickerMultipleProps` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/DayPickerMultiple.ts:22 diff --git a/docs/api/main/functions/isDayPickerRange.mdx b/docs/api/main/functions/isDayPickerRange.mdx deleted file mode 100644 index 8e27bb851a..0000000000 --- a/docs/api/main/functions/isDayPickerRange.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDayPickerRange ---- - -# Function: isDayPickerRange() - -> **isDayPickerRange**(`props`): `props is DayPickerRangeProps` - -Returns true when the props are of type [DayPickerRangeProps](/docs/api/main/interfaces/DayPickerRangeProps.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) \| `DayPickerProps` | - -## Returns - -`props is DayPickerRangeProps` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/DayPickerRange.ts:23 diff --git a/docs/api/main/functions/isDayPickerSingle.mdx b/docs/api/main/functions/isDayPickerSingle.mdx deleted file mode 100644 index 8e995cedd1..0000000000 --- a/docs/api/main/functions/isDayPickerSingle.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: isDayPickerSingle ---- - -# Function: isDayPickerSingle() - -> **isDayPickerSingle**(`props`): `props is DayPickerSingleProps` - -Returns true when the props are of type [DayPickerSingleProps](/docs/api/main/interfaces/DayPickerSingleProps.mdx). - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) \| `DayPickerProps` | - -## Returns - -`props is DayPickerSingleProps` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/DayPickerSingle.ts:20 diff --git a/docs/api/main/functions/isMatch.mdx b/docs/api/main/functions/isMatch.mdx deleted file mode 100644 index 1232b7b71a..0000000000 --- a/docs/api/main/functions/isMatch.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -section: Function -title: isMatch ---- - -# Function: isMatch() - -> **isMatch**(`day`, `matchers`): `boolean` - -Returns whether a day matches against at least one of the given Matchers. - -``` -const day = new Date(2022, 5, 19); -const matcher1: DateRange = { - from: new Date(2021, 12, 21), - to: new Date(2021, 12, 30) -} -const matcher2: DateRange = { - from: new Date(2022, 5, 1), - to: new Date(2022, 5, 23) -} - -const isMatch(day, [matcher1, matcher2]); // true, since day is in the matcher1 range. -``` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `matchers` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | - -## Returns - -`boolean` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Modifiers/utils/isMatch.ts:41 diff --git a/docs/api/main/functions/useActiveModifiers.mdx b/docs/api/main/functions/useActiveModifiers.mdx deleted file mode 100644 index 3a3a637a3e..0000000000 --- a/docs/api/main/functions/useActiveModifiers.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: Function -title: useActiveModifiers ---- - -# Function: useActiveModifiers() - -> **useActiveModifiers**(`day`, `displayMonth`?): [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) - -Return the active modifiers for the specified day. - -This hook is meant to be used inside internal or custom components. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `day` | `Date` | | -| `displayMonth`? | `Date` | | - -## Returns - -[`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useActiveModifiers/useActiveModifiers.tsx:12 diff --git a/docs/api/main/functions/useDayPicker.mdx b/docs/api/main/functions/useDayPicker.mdx deleted file mode 100644 index cf10d5fb57..0000000000 --- a/docs/api/main/functions/useDayPicker.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: Function -title: useDayPicker ---- - -# Function: useDayPicker() - -> **useDayPicker**(): [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) - -Hook to access the [DayPickerContextValue](/docs/api/main/interfaces/DayPickerContextValue.mdx). - -Use the DayPicker context to access to the props passed to DayPicker inside -internal or custom components. - -## Returns - -[`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/DayPicker/DayPickerContext.tsx:144 diff --git a/docs/api/main/functions/useDayRender.mdx b/docs/api/main/functions/useDayRender.mdx deleted file mode 100644 index d230685b03..0000000000 --- a/docs/api/main/functions/useDayRender.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -section: Function -title: useDayRender ---- - -# Function: useDayRender() - -> **useDayRender**(`day`, `displayMonth`, `buttonRef`): [`DayRender`](/docs/api/main/type-aliases/DayRender.mdx) - -Return props and data used to render the [Day](/docs/api/main/functions/Day.mdx) component. - -Use this hook when creating a component to replace the built-in `Day` -component. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `day` | `Date` | The date to render. | -| `displayMonth` | `Date` | The month where the date is displayed (if not the same as `date`, it means it is an "outside" day). | -| `buttonRef` | `RefObject`\<`HTMLButtonElement`\> | A ref to the button element that will be target of focus when rendered (if required). | - -## Returns - -[`DayRender`](/docs/api/main/type-aliases/DayRender.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useDayRender/useDayRender.tsx:43 diff --git a/docs/api/main/functions/useFocusContext.mdx b/docs/api/main/functions/useFocusContext.mdx deleted file mode 100644 index 0a439abc3d..0000000000 --- a/docs/api/main/functions/useFocusContext.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: Function -title: useFocusContext ---- - -# Function: useFocusContext() - -> **useFocusContext**(): [`FocusContextValue`](/docs/api/main/type-aliases/FocusContextValue.mdx) - -Hook to access the [FocusContextValue](/docs/api/main/type-aliases/FocusContextValue.mdx). Use this hook to handle the -focus state of the elements. - -This hook is meant to be used inside internal or custom components. - -## Returns - -[`FocusContextValue`](/docs/api/main/type-aliases/FocusContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Focus/FocusContext.tsx:131 diff --git a/docs/api/main/functions/useInput.mdx b/docs/api/main/functions/useInput.mdx deleted file mode 100644 index e6134eb2eb..0000000000 --- a/docs/api/main/functions/useInput.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: useInput ---- - -# Function: useInput() - -> **useInput**(`options`): [`UseInputValue`](/docs/api/main/interfaces/UseInputValue.mdx) - -Return props and setters for binding an input field to DayPicker. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `options` | [`UseInputOptions`](/docs/api/main/interfaces/UseInputOptions.mdx) | - -## Returns - -[`UseInputValue`](/docs/api/main/interfaces/UseInputValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useInput/useInput.ts:78 diff --git a/docs/api/main/functions/useNavigation.mdx b/docs/api/main/functions/useNavigation.mdx deleted file mode 100644 index bcfa4eb2c4..0000000000 --- a/docs/api/main/functions/useNavigation.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: Function -title: useNavigation ---- - -# Function: useNavigation() - -> **useNavigation**(): [`NavigationContextValue`](/docs/api/main/interfaces/NavigationContextValue.mdx) - -Hook to access the [NavigationContextValue](/docs/api/main/interfaces/NavigationContextValue.mdx). Use this hook to navigate -between months or years in DayPicker. - -This hook is meant to be used inside internal or custom components. - -## Returns - -[`NavigationContextValue`](/docs/api/main/interfaces/NavigationContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Navigation/NavigationContext.tsx:89 diff --git a/docs/api/main/functions/useSelectMultiple.mdx b/docs/api/main/functions/useSelectMultiple.mdx deleted file mode 100644 index c33e78e7f4..0000000000 --- a/docs/api/main/functions/useSelectMultiple.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: Function -title: useSelectMultiple ---- - -# Function: useSelectMultiple() - -> **useSelectMultiple**(): [`SelectMultipleContextValue`](/docs/api/main/interfaces/SelectMultipleContextValue.mdx) - -Hook to access the [SelectMultipleContextValue](/docs/api/main/interfaces/SelectMultipleContextValue.mdx). - -This hook is meant to be used inside internal or custom components. - -## Returns - -[`SelectMultipleContextValue`](/docs/api/main/interfaces/SelectMultipleContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:143 diff --git a/docs/api/main/functions/useSelectRange.mdx b/docs/api/main/functions/useSelectRange.mdx deleted file mode 100644 index 84173e7cd0..0000000000 --- a/docs/api/main/functions/useSelectRange.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: Function -title: useSelectRange ---- - -# Function: useSelectRange() - -> **useSelectRange**(): [`SelectRangeContextValue`](/docs/api/main/interfaces/SelectRangeContextValue.mdx) - -Hook to access the [SelectRangeContextValue](/docs/api/main/interfaces/SelectRangeContextValue.mdx). - -This hook is meant to be used inside internal or custom components. - -## Returns - -[`SelectRangeContextValue`](/docs/api/main/interfaces/SelectRangeContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/SelectRangeContext.tsx:190 diff --git a/docs/api/main/functions/useSelectSingle.mdx b/docs/api/main/functions/useSelectSingle.mdx deleted file mode 100644 index 18a1522b44..0000000000 --- a/docs/api/main/functions/useSelectSingle.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: Function -title: useSelectSingle ---- - -# Function: useSelectSingle() - -> **useSelectSingle**(): [`SelectSingleContextValue`](/docs/api/main/interfaces/SelectSingleContextValue.mdx) - -Hook to access the [SelectSingleContextValue](/docs/api/main/interfaces/SelectSingleContextValue.mdx). - -This hook is meant to be used inside internal or custom components. - -## Returns - -[`SelectSingleContextValue`](/docs/api/main/interfaces/SelectSingleContextValue.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectSingle/SelectSingleContext.tsx:88 diff --git a/docs/api/main/index.mdx b/docs/api/main/index.mdx deleted file mode 100644 index efc0f40ff6..0000000000 --- a/docs/api/main/index.mdx +++ /dev/null @@ -1,157 +0,0 @@ -# API Reference v8.10.0 - -## Enumerations - -| Enumeration | Description | -| :------ | :------ | -| [InternalModifier](/docs/api/main/enumerations/InternalModifier.mdx) | The name of the modifiers that are used internally by DayPicker. | - -## Interfaces - -| Interface | Description | -| :------ | :------ | -| [CaptionLabelProps](/docs/api/main/interfaces/CaptionLabelProps.mdx) | The props for the [CaptionLabel](/docs/api/main/functions/CaptionLabel.mdx) component. | -| [CaptionProps](/docs/api/main/interfaces/CaptionProps.mdx) | Represent the props of the [Caption](/docs/api/main/functions/Caption.mdx) component. | -| [CustomComponents](/docs/api/main/interfaces/CustomComponents.mdx) | Map of the components that can be changed using the `components` prop. | -| [DayContentProps](/docs/api/main/interfaces/DayContentProps.mdx) | Represent the props for the [DayContent](/docs/api/main/functions/DayContent.mdx) component. | -| [DayPickerBase](/docs/api/main/interfaces/DayPickerBase.mdx) | The base props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component and the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx). | -| [DayPickerContextValue](/docs/api/main/interfaces/DayPickerContextValue.mdx) | The value of the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx) extends the props from DayPicker
with default and cleaned up values. | -| [DayPickerDefaultProps](/docs/api/main/interfaces/DayPickerDefaultProps.mdx) | The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="default"` or `undefined`. | -| [DayPickerMultipleProps](/docs/api/main/interfaces/DayPickerMultipleProps.mdx) | The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="multiple"`. | -| [DayPickerProviderProps](/docs/api/main/interfaces/DayPickerProviderProps.mdx) | The props for the [DayPickerProvider](/docs/api/main/functions/DayPickerProvider.mdx). | -| [DayPickerRangeProps](/docs/api/main/interfaces/DayPickerRangeProps.mdx) | The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="range"`. | -| [DayPickerSingleProps](/docs/api/main/interfaces/DayPickerSingleProps.mdx) | The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="single"`. | -| [DayProps](/docs/api/main/interfaces/DayProps.mdx) | Represent the props used by the [Day](/docs/api/main/functions/Day.mdx) component. | -| [DropdownProps](/docs/api/main/interfaces/DropdownProps.mdx) | The props for the [Dropdown](/docs/api/main/functions/Dropdown.mdx) component. | -| [FooterProps](/docs/api/main/interfaces/FooterProps.mdx) | - | -| [NavigationContextValue](/docs/api/main/interfaces/NavigationContextValue.mdx) | Represents the value of the [NavigationContext](/docs/api/main/variables/NavigationContext.mdx). | -| [RootContext](/docs/api/main/interfaces/RootContext.mdx) | The props of [RootProvider](/docs/api/main/functions/RootProvider.mdx). | -| [RowProps](/docs/api/main/interfaces/RowProps.mdx) | The props for the [Row](/docs/api/main/functions/Row.mdx) component. | -| [SelectMultipleContextValue](/docs/api/main/interfaces/SelectMultipleContextValue.mdx) | Represents the value of a [SelectMultipleContext](/docs/api/main/variables/SelectMultipleContext.mdx). | -| [SelectRangeContextValue](/docs/api/main/interfaces/SelectRangeContextValue.mdx) | Represents the value of a [SelectRangeContext](/docs/api/main/variables/SelectRangeContext.mdx). | -| [SelectRangeProviderProps](/docs/api/main/interfaces/SelectRangeProviderProps.mdx) | - | -| [SelectSingleContextValue](/docs/api/main/interfaces/SelectSingleContextValue.mdx) | Represents the value of a [SelectSingleContext](/docs/api/main/variables/SelectSingleContext.mdx). | -| [SelectSingleProviderProps](/docs/api/main/interfaces/SelectSingleProviderProps.mdx) | - | -| [UseInputOptions](/docs/api/main/interfaces/UseInputOptions.mdx) | - | -| [UseInputValue](/docs/api/main/interfaces/UseInputValue.mdx) | Represent the value returned by [useInput](/docs/api/main/functions/useInput.mdx). | -| [WeekNumberProps](/docs/api/main/interfaces/WeekNumberProps.mdx) | The props for the [WeekNumber](/docs/api/main/functions/WeekNumber.mdx) component. | - -## Type Aliases - -| Type alias | Description | -| :------ | :------ | -| [ActiveModifiers](/docs/api/main/type-aliases/ActiveModifiers.mdx) | The modifiers that are matching a day in the calendar. Use the [useActiveModifiers](/docs/api/main/functions/useActiveModifiers.mdx) hook to get the modifiers for a day.

` const activeModifiers: ActiveModifiers = { selected: true, customModifier: true } ` | -| [ButtonProps](/docs/api/main/type-aliases/ButtonProps.mdx) | The props for the [Button](/docs/api/main/functions/Button.mdx) component. | -| [CaptionLayout](/docs/api/main/type-aliases/CaptionLayout.mdx) | The layout of the caption:

- `dropdown`: display dropdowns for choosing the month and the year.
- `buttons`: display previous month / next month buttons.
- `dropdown-buttons`: display both month / year dropdowns and previous month / next month buttons. | -| [ClassNames](/docs/api/main/type-aliases/ClassNames.mdx) | The class names of each element. | -| [CustomModifiers](/docs/api/main/type-aliases/CustomModifiers.mdx) | A map of matchers used as custom modifiers by DayPicker component. This is
the same as []], but it accepts only array of [[Matcher](/docs/api/main/type-aliases/DayModifiers.mdx)s. | -| [DateAfter](/docs/api/main/type-aliases/DateAfter.mdx) | A matcher to match a day falling after the specified date, with the date not included. | -| [DateBefore](/docs/api/main/type-aliases/DateBefore.mdx) | A matcher to match a day falling before the specified date, with the date not included. | -| [DateFormatter](/docs/api/main/type-aliases/DateFormatter.mdx) | - | -| [DateInterval](/docs/api/main/type-aliases/DateInterval.mdx) | A matcher to match a day falling before and/or after two dates, where the dates are not included. | -| [DateRange](/docs/api/main/type-aliases/DateRange.mdx) | A matcher to match a range of dates. The range can be open. Differently from [DateInterval](/docs/api/main/type-aliases/DateInterval.mdx), the dates here are included. | -| [DayClickEventHandler](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | - | -| [DayFocusEventHandler](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | - | -| [DayKeyboardEventHandler](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | - | -| [DayLabel](/docs/api/main/type-aliases/DayLabel.mdx) | - | -| [DayModifiers](/docs/api/main/type-aliases/DayModifiers.mdx) | The custom modifiers passed to the [DayPickerBase.modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | -| [DayMouseEventHandler](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | - | -| [DayOfWeek](/docs/api/main/type-aliases/DayOfWeek.mdx) | A matcher to match a date being one of the specified days of the week (`0-6`, where `0` is Sunday). | -| [DayPickerProps](/docs/api/main/type-aliases/DayPickerProps.mdx) | - | -| [DayPointerEventHandler](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | - | -| [DayRender](/docs/api/main/type-aliases/DayRender.mdx) | - | -| [DaySelectionMode](/docs/api/main/type-aliases/DaySelectionMode.mdx) | Selection modes supported by DayPicker.

- `single`: use DayPicker to select single days.
- `multiple`: allow selecting multiple days.
- `range`: use DayPicker to select a range of days
- `default`: disable the built-in selection behavior. Customize what is
selected by using [DayPickerBase.onDayClick](/docs/api/main/interfaces/DayPickerBase.mdx). | -| [DayTouchEventHandler](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | - | -| [FocusContextValue](/docs/api/main/type-aliases/FocusContextValue.mdx) | Represents the value of the [FocusContext](/docs/api/main/variables/FocusContext.mdx). | -| [FocusProviderProps](/docs/api/main/type-aliases/FocusProviderProps.mdx) | - | -| [Formatters](/docs/api/main/type-aliases/Formatters.mdx) | Represent a map of formatters used to render localized content. | -| [InputDayPickerProps](/docs/api/main/type-aliases/InputDayPickerProps.mdx) | The props to attach to the DayPicker component when using [useInput](/docs/api/main/functions/useInput.mdx). | -| [InputProps](/docs/api/main/type-aliases/InputProps.mdx) | The props to attach to the input field when using [useInput](/docs/api/main/functions/useInput.mdx). | -| [InternalModifiers](/docs/api/main/type-aliases/InternalModifiers.mdx) | Map of matchers used for the internal modifiers. | -| [InternalModifiersElement](/docs/api/main/type-aliases/InternalModifiersElement.mdx) | These elements must not be in the `styles` or `classNames` records as they are styled via the `modifiersStyles` or `modifiersClassNames` pop | -| [Labels](/docs/api/main/type-aliases/Labels.mdx) | Map of functions to translate ARIA labels for the relative elements. | -| [Matcher](/docs/api/main/type-aliases/Matcher.mdx) | A value or a function that matches a specific day.


Matchers are passed to DayPicker via [DayPickerBase.disabled](/docs/api/main/interfaces/DayPickerBase.mdx),
[]] or [[DayPickerProps.selected](/docs/api/main/interfaces/DayPickerBase.mdx) and are used to
determine if a day should get a [Modifier](/docs/api/main/type-aliases/Modifier.mdx).

Matchers can be of different types:

` // will always match the day const booleanMatcher: Matcher = true; // will match the today's date const dateMatcher: Matcher = new Date(); // will match the days in the array const arrayMatcher: Matcher = [new Date(2019, 1, 2), new Date(2019, 1, 4)]; // will match days after the 2nd of February 2019 const afterMatcher: DateAfter = { after: new Date(2019, 1, 2) }; // will match days before the 2nd of February 2019 } const beforeMatcher: DateBefore = { before: new Date(2019, 1, 2) }; // will match Sundays const dayOfWeekMatcher: DayOfWeek = { dayOfWeek: 0 }; // will match the included days, except the two dates const intervalMatcher: DateInterval = { after: new Date(2019, 1, 2), before: new Date(2019, 1, 5) }; // will match the included days, including the two dates const rangeMatcher: DateRange = { from: new Date(2019, 1, 2), to: new Date(2019, 1, 5) }; // will match when the function return true const functionMatcher: Matcher = (day: Date) => { return day.getMonth() === 2 // match when month is March }; ` | -| [Modifier](/docs/api/main/type-aliases/Modifier.mdx) | A _modifier_ represents different styles or states of a day displayed in the calendar. | -| [Modifiers](/docs/api/main/type-aliases/Modifiers.mdx) | The modifiers used by DayPicker. | -| [ModifiersClassNames](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | The classnames to assign to each day element matching a modifier. | -| [ModifiersStyles](/docs/api/main/type-aliases/ModifiersStyles.mdx) | The style to apply to each day element matching a modifier. | -| [MonthChangeEventHandler](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | - | -| [MonthsProps](/docs/api/main/type-aliases/MonthsProps.mdx) | The props for the [Months](/docs/api/main/functions/Months.mdx) component. | -| [NavButtonLabel](/docs/api/main/type-aliases/NavButtonLabel.mdx) | - | -| [SelectMultipleEventHandler](/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx) | - | -| [SelectMultipleModifiers](/docs/api/main/type-aliases/SelectMultipleModifiers.mdx) | Represent the modifiers that are changed by the multiple selection. | -| [SelectMultipleProviderProps](/docs/api/main/type-aliases/SelectMultipleProviderProps.mdx) | - | -| [SelectRangeEventHandler](/docs/api/main/type-aliases/SelectRangeEventHandler.mdx) | - | -| [SelectRangeModifiers](/docs/api/main/type-aliases/SelectRangeModifiers.mdx) | Represent the modifiers that are changed by the range selection. | -| [SelectSingleEventHandler](/docs/api/main/type-aliases/SelectSingleEventHandler.mdx) | - | -| [StyledComponent](/docs/api/main/type-aliases/StyledComponent.mdx) | Props of a component that can be styled via classNames or inline-styles. | -| [StyledElement](/docs/api/main/type-aliases/StyledElement.mdx) | The style (either via class names or via in-line styles) of an element. | -| [Styles](/docs/api/main/type-aliases/Styles.mdx) | The inline-styles of each styled element, to use with the `styles` prop. Day
modifiers, such as `today` or `hidden`, should be styled using the
`modifiersStyles` prop. | -| [WeekNumberClickEventHandler](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | - | -| [WeekNumberFormatter](/docs/api/main/type-aliases/WeekNumberFormatter.mdx) | - | -| [WeekNumberLabel](/docs/api/main/type-aliases/WeekNumberLabel.mdx) | - | -| [WeekdayLabel](/docs/api/main/type-aliases/WeekdayLabel.mdx) | - | - -## Variables - -| Variable | Description | -| :------ | :------ | -| [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx) | The DayPicker context shares the props passed to DayPicker within internal
and custom components. It is used to set the default values and perform
one-time calculations required to render the days.

Access to this context from the [useDayPicker](/docs/api/main/functions/useDayPicker.mdx) hook. | -| [FocusContext](/docs/api/main/variables/FocusContext.mdx) | The Focus context shares details about the focused day for the keyboard

Access this context from the [useFocusContext](/docs/api/main/functions/useFocusContext.mdx) hook. | -| [NavigationContext](/docs/api/main/variables/NavigationContext.mdx) | The Navigation context shares details and methods to navigate the months in DayPicker.
Access this context from the [useNavigation](/docs/api/main/functions/useNavigation.mdx) hook. | -| [SelectMultipleContext](/docs/api/main/variables/SelectMultipleContext.mdx) | The SelectMultiple context shares details about the selected days when in
multiple selection mode.

Access this context from the [useSelectMultiple](/docs/api/main/functions/useSelectMultiple.mdx) hook. | -| [SelectRangeContext](/docs/api/main/variables/SelectRangeContext.mdx) | The SelectRange context shares details about the selected days when in
range selection mode.

Access this context from the [useSelectRange](/docs/api/main/functions/useSelectRange.mdx) hook. | -| [SelectSingleContext](/docs/api/main/variables/SelectSingleContext.mdx) | The SelectSingle context shares details about the selected days when in
single selection mode.

Access this context from the [useSelectSingle](/docs/api/main/functions/useSelectSingle.mdx) hook. | - -## Functions - -| Function | Description | -| :------ | :------ | -| [Button](/docs/api/main/functions/Button.mdx) | Render a button HTML element applying the reset class name. | -| [Caption](/docs/api/main/functions/Caption.mdx) | Render the caption of a month. The caption has a different layout when
setting the [DayPickerBase.captionLayout](/docs/api/main/interfaces/DayPickerBase.mdx) prop. | -| [CaptionDropdowns](/docs/api/main/functions/CaptionDropdowns.mdx) | Render a caption with the dropdowns to navigate between months and years. | -| [CaptionLabel](/docs/api/main/functions/CaptionLabel.mdx) | Render the caption for the displayed month. This component is used when `captionLayout="buttons"`. | -| [CaptionNavigation](/docs/api/main/functions/CaptionNavigation.mdx) | Render a caption with a button-based navigation. | -| [Day](/docs/api/main/functions/Day.mdx) | The content of a day cell – as a button or span element according to its
modifiers. | -| [DayContent](/docs/api/main/functions/DayContent.mdx) | Render the content of the day cell. | -| [DayPicker](/docs/api/main/functions/DayPicker.mdx) | DayPicker render a date picker component to let users pick dates from a
calendar. See http://react-day-picker.js.org for updated documentation and
examples.

### Customization

DayPicker offers different customization props. For example,

- show multiple months using `numberOfMonths`
- display a dropdown to navigate the months via `captionLayout`
- display the week numbers with `showWeekNumbers`
- disable or hide days with `disabled` or `hidden`

### Controlling the months

Change the initially displayed month using the `defaultMonth` prop. The
displayed months are controlled by DayPicker and stored in its internal
state. To control the months yourself, use `month` instead of `defaultMonth`
and use the `onMonthChange` event to set it.

To limit the months the user can navigate to, use
`fromDate`/`fromMonth`/`fromYear` or `toDate`/`toMonth`/`toYear`.

### Selection modes

DayPicker supports different selection mode that can be toggled using the
`mode` prop:

- `mode="single"`: only one day can be selected. Use `required` to make the
selection required. Use the `onSelect` event handler to get the selected
days.
- `mode="multiple"`: users can select one or more days. Limit the amount of
days that can be selected with the `min` or the `max` props.
- `mode="range"`: users can select a range of days. Limit the amount of days
in the range with the `min` or the `max` props.
- `mode="default"` (default): the built-in selections are disabled. Implement
your own selection mode with `onDayClick`.

The selection modes should cover the most common use cases. In case you
need a more refined way of selecting days, use `mode="default"`. Use the
`selected` props and add the day event handlers to add/remove days from the
selection.

### Modifiers

A _modifier_ represents different styles or states for the days displayed in
the calendar (like "selected" or "disabled"). Define custom modifiers using
the `modifiers` prop.

### Formatters and custom component

You can customize how the content is displayed in the date picker by using
either the formatters or replacing the internal components.

For the most common cases you want to use the `formatters` prop to change how
the content is formatted in the calendar. Use the `components` prop to
replace the internal components, like the navigation icons.

### Styling

DayPicker comes with a default, basic style in `react-day-picker/style` – use
it as template for your own style.

If you are using CSS modules, pass the imported styles object the
`classNames` props.

You can also style the elements via inline styles using the `styles` prop.

### Form fields

If you need to bind the date picker to a form field, you can use the
`useInput` hooks for a basic behavior. See the `useInput` source as an
example to bind the date picker with form fields.

### Localization

To localize DayPicker, import the locale from `date-fns` package and use the
`locale` prop.

For example, to use Spanish locale:

` import { es } from 'date-fns/locale'; ` | -| [DayPickerProvider](/docs/api/main/functions/DayPickerProvider.mdx) | The provider for the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx), assigning the defaults from the
initial DayPicker props. | -| [Dropdown](/docs/api/main/functions/Dropdown.mdx) | Render a styled select component – displaying a caption and a custom
drop-down icon. | -| [FocusProvider](/docs/api/main/functions/FocusProvider.mdx) | The provider for the [FocusContext](/docs/api/main/variables/FocusContext.mdx). | -| [Footer](/docs/api/main/functions/Footer.mdx) | Render the Footer component (empty as default). | -| [Head](/docs/api/main/functions/Head.mdx) | Render the table head. | -| [HeadRow](/docs/api/main/functions/HeadRow.mdx) | Render the HeadRow component - i.e. the table head row with the weekday names. | -| [IconDropdown](/docs/api/main/functions/IconDropdown.mdx) | Render the icon in the styled drop-down. | -| [IconLeft](/docs/api/main/functions/IconLeft.mdx) | Render the "previous month" button in the navigation. | -| [IconRight](/docs/api/main/functions/IconRight.mdx) | Render the "next month" button in the navigation. | -| [Months](/docs/api/main/functions/Months.mdx) | Render the wrapper for the month grids. | -| [NavigationProvider](/docs/api/main/functions/NavigationProvider.mdx) | Provides the values for the [NavigationContext](/docs/api/main/variables/NavigationContext.mdx). | -| [RootProvider](/docs/api/main/functions/RootProvider.mdx) | Provide the value for all the context providers. | -| [Row](/docs/api/main/functions/Row.mdx) | Render a row in the calendar, with the days and the week number. | -| [SelectMultipleProvider](/docs/api/main/functions/SelectMultipleProvider.mdx) | Provides the values for the [SelectMultipleContext](/docs/api/main/variables/SelectMultipleContext.mdx). | -| [SelectMultipleProviderInternal](/docs/api/main/functions/SelectMultipleProviderInternal.mdx) | - | -| [SelectRangeProvider](/docs/api/main/functions/SelectRangeProvider.mdx) | Provides the values for the [SelectRangeProvider](/docs/api/main/functions/SelectRangeProvider.mdx). | -| [SelectRangeProviderInternal](/docs/api/main/functions/SelectRangeProviderInternal.mdx) | - | -| [SelectSingleProvider](/docs/api/main/functions/SelectSingleProvider.mdx) | Provides the values for the [SelectSingleProvider](/docs/api/main/functions/SelectSingleProvider.mdx). | -| [SelectSingleProviderInternal](/docs/api/main/functions/SelectSingleProviderInternal.mdx) | - | -| [WeekNumber](/docs/api/main/functions/WeekNumber.mdx) | Render the week number element. If `onWeekNumberClick` is passed to DayPicker, it
renders a button, otherwise a span element. | -| [addToRange](/docs/api/main/functions/addToRange.mdx) | Add a day to an existing range.

The returned range takes in account the `undefined` values and if the added
day is already present in the range. | -| [isDateAfterType](/docs/api/main/functions/isDateAfterType.mdx) | Returns true if `value` is of type [DateAfter](/docs/api/main/type-aliases/DateAfter.mdx). | -| [isDateBeforeType](/docs/api/main/functions/isDateBeforeType.mdx) | Returns true if `value` is of type [DateBefore](/docs/api/main/type-aliases/DateBefore.mdx). | -| [isDateInterval](/docs/api/main/functions/isDateInterval.mdx) | Returns true if `matcher` is of type [DateInterval](/docs/api/main/type-aliases/DateInterval.mdx). | -| [isDateRange](/docs/api/main/functions/isDateRange.mdx) | Returns true if `value` is a [DateRange](/docs/api/main/type-aliases/DateRange.mdx) type. | -| [isDayOfWeekType](/docs/api/main/functions/isDayOfWeekType.mdx) | Returns true if `value` is a [DayOfWeek](/docs/api/main/type-aliases/DayOfWeek.mdx) type. | -| [isDayPickerDefault](/docs/api/main/functions/isDayPickerDefault.mdx) | Returns true when the props are of type [DayPickerDefaultProps](/docs/api/main/interfaces/DayPickerDefaultProps.mdx). | -| [isDayPickerMultiple](/docs/api/main/functions/isDayPickerMultiple.mdx) | Returns true when the props are of type [DayPickerMultipleProps](/docs/api/main/interfaces/DayPickerMultipleProps.mdx). | -| [isDayPickerRange](/docs/api/main/functions/isDayPickerRange.mdx) | Returns true when the props are of type [DayPickerRangeProps](/docs/api/main/interfaces/DayPickerRangeProps.mdx). | -| [isDayPickerSingle](/docs/api/main/functions/isDayPickerSingle.mdx) | Returns true when the props are of type [DayPickerSingleProps](/docs/api/main/interfaces/DayPickerSingleProps.mdx). | -| [isMatch](/docs/api/main/functions/isMatch.mdx) | Returns whether a day matches against at least one of the given Matchers.

` const day = new Date(2022, 5, 19); const matcher1: DateRange = { from: new Date(2021, 12, 21), to: new Date(2021, 12, 30) } const matcher2: DateRange = { from: new Date(2022, 5, 1), to: new Date(2022, 5, 23) } const isMatch(day, [matcher1, matcher2]); // true, since day is in the matcher1 range. ` | -| [useActiveModifiers](/docs/api/main/functions/useActiveModifiers.mdx) | Return the active modifiers for the specified day.

This hook is meant to be used inside internal or custom components. | -| [useDayPicker](/docs/api/main/functions/useDayPicker.mdx) | Hook to access the [DayPickerContextValue](/docs/api/main/interfaces/DayPickerContextValue.mdx).

Use the DayPicker context to access to the props passed to DayPicker inside
internal or custom components. | -| [useDayRender](/docs/api/main/functions/useDayRender.mdx) | Return props and data used to render the [Day](/docs/api/main/functions/Day.mdx) component.

Use this hook when creating a component to replace the built-in `Day`
component. | -| [useFocusContext](/docs/api/main/functions/useFocusContext.mdx) | Hook to access the [FocusContextValue](/docs/api/main/type-aliases/FocusContextValue.mdx). Use this hook to handle the
focus state of the elements.

This hook is meant to be used inside internal or custom components. | -| [useInput](/docs/api/main/functions/useInput.mdx) | Return props and setters for binding an input field to DayPicker. | -| [useNavigation](/docs/api/main/functions/useNavigation.mdx) | Hook to access the [NavigationContextValue](/docs/api/main/interfaces/NavigationContextValue.mdx). Use this hook to navigate
between months or years in DayPicker.

This hook is meant to be used inside internal or custom components. | -| [useSelectMultiple](/docs/api/main/functions/useSelectMultiple.mdx) | Hook to access the [SelectMultipleContextValue](/docs/api/main/interfaces/SelectMultipleContextValue.mdx).

This hook is meant to be used inside internal or custom components. | -| [useSelectRange](/docs/api/main/functions/useSelectRange.mdx) | Hook to access the [SelectRangeContextValue](/docs/api/main/interfaces/SelectRangeContextValue.mdx).

This hook is meant to be used inside internal or custom components. | -| [useSelectSingle](/docs/api/main/functions/useSelectSingle.mdx) | Hook to access the [SelectSingleContextValue](/docs/api/main/interfaces/SelectSingleContextValue.mdx).

This hook is meant to be used inside internal or custom components. | diff --git a/docs/api/main/interfaces/CaptionLabelProps.mdx b/docs/api/main/interfaces/CaptionLabelProps.mdx deleted file mode 100644 index 3410efab53..0000000000 --- a/docs/api/main/interfaces/CaptionLabelProps.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: CaptionLabelProps ---- - -# Interface: CaptionLabelProps - -The props for the [CaptionLabel](/docs/api/main/functions/CaptionLabel.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `displayIndex?` | `number` | The index of the month where the caption is displayed. Older custom components may miss this prop. | -| `displayMonth` | `Date` | The month where the caption is displayed. | -| `id?` | `string` | The ID for the heading element. Must be the same as the labelled-by in Table. | diff --git a/docs/api/main/interfaces/CaptionProps.mdx b/docs/api/main/interfaces/CaptionProps.mdx deleted file mode 100644 index 906a18cc7f..0000000000 --- a/docs/api/main/interfaces/CaptionProps.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: CaptionProps ---- - -# Interface: CaptionProps - -Represent the props of the [Caption](/docs/api/main/functions/Caption.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `displayIndex?` | `number` | The index of the month where the caption is displayed. Older custom components may miss this prop. | -| `displayMonth` | `Date` | The month where the caption is displayed. | -| `id?` | `string` | The ID for the heading element. Must be the same as the labelled-by in Table. | diff --git a/docs/api/main/interfaces/CustomComponents.mdx b/docs/api/main/interfaces/CustomComponents.mdx deleted file mode 100644 index a069485258..0000000000 --- a/docs/api/main/interfaces/CustomComponents.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -section: Interface -title: CustomComponents ---- - -# Interface: CustomComponents - -Map of the components that can be changed using the `components` prop. - -## See - -https://github.com/gpbl/react-day-picker/tree/main/src/components - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `Caption?` | (`props`: [`CaptionProps`](/docs/api/main/interfaces/CaptionProps.mdx)) => `null` \| `Element` | The component for the caption element. | -| `CaptionLabel?` | (`props`: [`CaptionLabelProps`](/docs/api/main/interfaces/CaptionLabelProps.mdx)) => `null` \| `Element` | The component for the caption element. | -| `Day?` | (`props`: [`DayProps`](/docs/api/main/interfaces/DayProps.mdx)) => `null` \| `Element` | The component for the day element.

Each `Day` in DayPicker should render one of the following, according to
the return value of [useDayRender](/docs/api/main/functions/useDayRender.mdx).

- an empty `Fragment`, to render if `isHidden` is true
- a `button` element, when the day is interactive, e.g. is selectable
- a `div` or a `span` element, when the day is not interactive | -| `DayContent?` | (`props`: [`DayContentProps`](/docs/api/main/interfaces/DayContentProps.mdx)) => `null` \| `Element` | The component for the content of the day element. | -| `Dropdown?` | (`props`: [`DropdownProps`](/docs/api/main/interfaces/DropdownProps.mdx)) => `null` \| `Element` | The component for the drop-down elements. | -| `Footer?` | (`props`: [`FooterProps`](/docs/api/main/interfaces/FooterProps.mdx)) => `null` \| `Element` | The component for the table footer. | -| `Head?` | () => `null` \| `Element` | The component for the table’s head. | -| `HeadRow?` | () => `null` \| `Element` | The component for the table’s head row. | -| `IconDropdown?` | (`props`: [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx)) => `null` \| `Element` | The component for the small icon in the drop-downs. | -| `IconLeft?` | (`props`: [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx)) => `null` \| `Element` | The arrow left icon (used for the Navigation buttons). | -| `IconRight?` | (`props`: [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx)) => `null` \| `Element` | The arrow right icon (used for the Navigation buttons). | -| `Months?` | (`props`: [`MonthsProps`](/docs/api/main/type-aliases/MonthsProps.mdx)) => `null` \| `Element` | The component wrapping the month grids. | -| `Row?` | (`props`: [`RowProps`](/docs/api/main/interfaces/RowProps.mdx)) => `null` \| `Element` | The component for the table rows. | -| `WeekNumber?` | (`props`: [`WeekNumberProps`](/docs/api/main/interfaces/WeekNumberProps.mdx)) => `null` \| `Element` | The component for the week number in the table rows. | diff --git a/docs/api/main/interfaces/DayContentProps.mdx b/docs/api/main/interfaces/DayContentProps.mdx deleted file mode 100644 index fb6c11cc57..0000000000 --- a/docs/api/main/interfaces/DayContentProps.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: DayContentProps ---- - -# Interface: DayContentProps - -Represent the props for the [DayContent](/docs/api/main/functions/DayContent.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | The active modifiers for the given date. | -| `date` | `Date` | The date representing the day. | -| `displayMonth` | `Date` | The month where the day is displayed. | diff --git a/docs/api/main/interfaces/DayPickerBase.mdx b/docs/api/main/interfaces/DayPickerBase.mdx deleted file mode 100644 index f139f2424f..0000000000 --- a/docs/api/main/interfaces/DayPickerBase.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -section: Interface -title: DayPickerBase ---- - -# Interface: DayPickerBase - -The base props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component and the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx). - -## Extended by - -- [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx) -- [`DayPickerDefaultProps`](/docs/api/main/interfaces/DayPickerDefaultProps.mdx) -- [`DayPickerMultipleProps`](/docs/api/main/interfaces/DayPickerMultipleProps.mdx) -- [`DayPickerRangeProps`](/docs/api/main/interfaces/DayPickerRangeProps.mdx) -- [`DayPickerSingleProps`](/docs/api/main/interfaces/DayPickerSingleProps.mdx) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | -| `captionLayout?` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | -| `classNames?` | `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | -| `formatters?` | `Partial`\<[`Formatters`](/docs/api/main/type-aliases/Formatters.mdx)\> | A map of formatters. Use the formatters to override the default formatting
functions. | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | -| `fromYear?` | `number` | The earliest year to start the month navigation. | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | -| `labels?` | `Partial`\<[`Labels`](/docs/api/main/type-aliases/Labels.mdx)\> | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | -| `lang?` | `string` | Add the language tag to the container element. | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | -| `modifiers?` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | -| `modifiersClassNames?` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | -| `numberOfMonths?` | `number` | The number of displayed months.

**Default Value**
` 1 ` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | -| `selected?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `selected` modifier to the matching days. | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | -| `style?` | `CSSProperties` | Style to apply to the container element. | -| `styles?` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | -| `title?` | `string` | Add a `title` attribute to the container element. | -| `toDate?` | `Date` | The latest day to end the month navigation. | -| `toMonth?` | `Date` | The latest month to end the month navigation. | -| `toYear?` | `number` | The latest year to end the month navigation. | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | diff --git a/docs/api/main/interfaces/DayPickerContextValue.mdx b/docs/api/main/interfaces/DayPickerContextValue.mdx deleted file mode 100644 index 29810a795a..0000000000 --- a/docs/api/main/interfaces/DayPickerContextValue.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -section: Interface -title: DayPickerContextValue ---- - -# Interface: DayPickerContextValue - -The value of the [DayPickerContext](/docs/api/main/variables/DayPickerContext.mdx) extends the props from DayPicker -with default and cleaned up values. - -## Extends - -- [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | -| `captionLayout` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | -| `classNames` | `Required`\<`Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | -| `formatters` | [`Formatters`](/docs/api/main/type-aliases/Formatters.mdx) | A map of formatters. Use the formatters to override the default formatting
functions. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | -| `labels` | [`Labels`](/docs/api/main/type-aliases/Labels.mdx) | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | -| `lang?` | `string` | Add the language tag to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | -| `locale` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | -| `max?` | `number` | - | - | - | -| `min?` | `number` | - | - | - | -| `mode` | [`DaySelectionMode`](/docs/api/main/type-aliases/DaySelectionMode.mdx) | - | - | - | -| `modifiers` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | -| `modifiersClassNames` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | -| `numberOfMonths` | `number` | The number of displayed months.

**Default Value**
` 1 ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | -| `onSelect?` | [`SelectSingleEventHandler`](/docs/api/main/type-aliases/SelectSingleEventHandler.mdx) \| [`SelectMultipleEventHandler`](/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx) \| [`SelectRangeEventHandler`](/docs/api/main/type-aliases/SelectRangeEventHandler.mdx) | - | - | - | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | -| `required?` | `boolean` | - | - | - | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | -| `selected?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `selected` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | -| `style?` | `CSSProperties` | Style to apply to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | -| `styles` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | -| `title?` | `string` | Add a `title` attribute to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | -| `toDate?` | `Date` | The latest day to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | -| `today` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | diff --git a/docs/api/main/interfaces/DayPickerDefaultProps.mdx b/docs/api/main/interfaces/DayPickerDefaultProps.mdx deleted file mode 100644 index 4e6dba8a72..0000000000 --- a/docs/api/main/interfaces/DayPickerDefaultProps.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -section: Interface -title: DayPickerDefaultProps ---- - -# Interface: DayPickerDefaultProps - -The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="default"` or `undefined`. - -## Extends - -- [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | -| `captionLayout?` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | -| `classNames?` | `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | -| `formatters?` | `Partial`\<[`Formatters`](/docs/api/main/type-aliases/Formatters.mdx)\> | A map of formatters. Use the formatters to override the default formatting
functions. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | -| `labels?` | `Partial`\<[`Labels`](/docs/api/main/type-aliases/Labels.mdx)\> | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | -| `lang?` | `string` | Add the language tag to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | -| `mode?` | `"default"` | - | - | -| `modifiers?` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | -| `modifiersClassNames?` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | -| `numberOfMonths?` | `number` | The number of displayed months.

**Default Value**
` 1 ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | -| `selected?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `selected` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | -| `style?` | `CSSProperties` | Style to apply to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | -| `styles?` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | -| `title?` | `string` | Add a `title` attribute to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | -| `toDate?` | `Date` | The latest day to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | diff --git a/docs/api/main/interfaces/DayPickerMultipleProps.mdx b/docs/api/main/interfaces/DayPickerMultipleProps.mdx deleted file mode 100644 index 241899ab12..0000000000 --- a/docs/api/main/interfaces/DayPickerMultipleProps.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -section: Interface -title: DayPickerMultipleProps ---- - -# Interface: DayPickerMultipleProps - -The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="multiple"`. - -## Extends - -- [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | -| `captionLayout?` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | -| `classNames?` | `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | -| `formatters?` | `Partial`\<[`Formatters`](/docs/api/main/type-aliases/Formatters.mdx)\> | A map of formatters. Use the formatters to override the default formatting
functions. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | -| `labels?` | `Partial`\<[`Labels`](/docs/api/main/type-aliases/Labels.mdx)\> | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | -| `lang?` | `string` | Add the language tag to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | -| `max?` | `number` | The maximum amount of days that can be selected. | - | - | -| `min?` | `number` | The minimum amount of days that can be selected. | - | - | -| `mode` | `"multiple"` | - | - | - | -| `modifiers?` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | -| `modifiersClassNames?` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | -| `numberOfMonths?` | `number` | The number of displayed months.

**Default Value**
` 1 ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | -| `onSelect?` | [`SelectMultipleEventHandler`](/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx) | Event fired when a days added or removed to the selection. | - | - | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | -| `selected?` | `Date`[] | The selected days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | -| `style?` | `CSSProperties` | Style to apply to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | -| `styles?` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | -| `title?` | `string` | Add a `title` attribute to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | -| `toDate?` | `Date` | The latest day to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | diff --git a/docs/api/main/interfaces/DayPickerProviderProps.mdx b/docs/api/main/interfaces/DayPickerProviderProps.mdx deleted file mode 100644 index 8755c622c7..0000000000 --- a/docs/api/main/interfaces/DayPickerProviderProps.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: Interface -title: DayPickerProviderProps ---- - -# Interface: DayPickerProviderProps - -The props for the [DayPickerProvider](/docs/api/main/functions/DayPickerProvider.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `children?` | `ReactNode` | - | -| `initialProps` | `DayPickerProps` | The initial props from the DayPicker component. | diff --git a/docs/api/main/interfaces/DayPickerRangeProps.mdx b/docs/api/main/interfaces/DayPickerRangeProps.mdx deleted file mode 100644 index de596b38ae..0000000000 --- a/docs/api/main/interfaces/DayPickerRangeProps.mdx +++ /dev/null @@ -1,81 +0,0 @@ ---- -section: Interface -title: DayPickerRangeProps ---- - -# Interface: DayPickerRangeProps - -The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="range"`. - -## Extends - -- [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | -| `captionLayout?` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | -| `classNames?` | `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | -| `formatters?` | `Partial`\<[`Formatters`](/docs/api/main/type-aliases/Formatters.mdx)\> | A map of formatters. Use the formatters to override the default formatting
functions. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | -| `labels?` | `Partial`\<[`Labels`](/docs/api/main/type-aliases/Labels.mdx)\> | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | -| `lang?` | `string` | Add the language tag to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | -| `max?` | `number` | The maximum amount of days that can be selected. | - | - | -| `min?` | `number` | The minimum amount of days that can be selected. | - | - | -| `mode` | `"range"` | - | - | - | -| `modifiers?` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | -| `modifiersClassNames?` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | -| `numberOfMonths?` | `number` | The number of displayed months.

**Default Value**
` 1 ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | -| `onSelect?` | [`SelectRangeEventHandler`](/docs/api/main/type-aliases/SelectRangeEventHandler.mdx) | Event fired when a range (or a part of the range) is selected. | - | - | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | -| `selected?` | [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) | The selected range of days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | -| `style?` | `CSSProperties` | Style to apply to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | -| `styles?` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | -| `title?` | `string` | Add a `title` attribute to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | -| `toDate?` | `Date` | The latest day to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | diff --git a/docs/api/main/interfaces/DayPickerSingleProps.mdx b/docs/api/main/interfaces/DayPickerSingleProps.mdx deleted file mode 100644 index 185e564510..0000000000 --- a/docs/api/main/interfaces/DayPickerSingleProps.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -section: Interface -title: DayPickerSingleProps ---- - -# Interface: DayPickerSingleProps - -The props for the [DayPicker](/docs/api/main/functions/DayPicker.mdx) component when using `mode="single"`. - -## Extends - -- [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) - -## Properties - -| Property | Type | Description | Overrides | Inherited from | -| :------ | :------ | :------ | :------ | :------ | -| `ISOWeek?` | `boolean` | Use ISO week dates instead of the locale setting. Setting this prop will
ignore [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**See**
https://en.wikipedia.org/wiki/ISO_week_date | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`ISOWeek` | -| `captionLayout?` | [`CaptionLayout`](/docs/api/main/type-aliases/CaptionLayout.mdx) | Change the layout of the caption:

- `buttons`: display prev/right buttons
- `dropdown`: display drop-downs to change the month and the year

**Note:** the `dropdown` layout is available only when `fromDate`,
`fromMonth` or`fromYear` and `toDate`, `toMonth` or `toYear` are set.

**Default Value**
` buttons ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`captionLayout` | -| `className?` | `string` | The CSS class to add to the container element. To change the name of the
class instead, use `classNames.root`. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`className` | -| `classNames?` | `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> | Change the class names of the HTML elements.

Use this prop when you need to change the default class names — for example
when using CSS modules. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`classNames` | -| `components?` | [`CustomComponents`](/docs/api/main/interfaces/CustomComponents.mdx) | Map of components used to create the layout. Look at the [components
source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
to understand how internal components are built and provide your custom components. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`components` | -| `defaultMonth?` | `Date` | The initial month to show in the calendar. Use this prop to let DayPicker
control the current month. If you need to set the month programmatically,
use []] and [[onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` The current month ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`defaultMonth` | -| `dir?` | `string` | The text direction of the calendar. Use `ltr` for left-to-right (default)
or `rtl` for right-to-left. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`dir` | -| `disableNavigation?` | `boolean` | Disable the navigation between months.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disableNavigation` | -| `disabled?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `disabled` modifier to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`disabled` | -| `firstWeekContainsDate?` | `1` \| `4` | The day of January, which is always in the first week of the year. Can be
either Monday (`1`) or Thursday (`4`).

**See**
- https://date-fns.org/docs/getWeek
- https://en.wikipedia.org/wiki/Week#Numbering
- [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx).
| [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`firstWeekContainsDate` | -| `fixedWeeks?` | `boolean` | Display six weeks per months, regardless the month’s number of weeks.
To use this prop, [showOutsideDays](/docs/api/main/interfaces/DayPickerBase.mdx) must be set.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fixedWeeks` | -| `footer?` | `ReactNode` | Content to add to the table footer element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`footer` | -| `formatters?` | `Partial`\<[`Formatters`](/docs/api/main/type-aliases/Formatters.mdx)\> | A map of formatters. Use the formatters to override the default formatting
functions. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`formatters` | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`fromYear` | -| `hidden?` | [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[] | Apply the `hidden` modifier to the matching days. Will hide them from the
calendar. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hidden` | -| `hideHead?` | `boolean` | Hide the month’s head displaying the weekday names.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`hideHead` | -| `id?` | `string` | A unique id to replace the random generated id – used by DayPicker for
accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`id` | -| `initialFocus?` | `boolean` | When a selection mode is set, DayPicker will focus the first selected day
(if set) or the today's date (if not disabled).

Use this prop when you need to focus DayPicker after a user actions, for
improved accessibility. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`initialFocus` | -| `labels?` | `Partial`\<[`Labels`](/docs/api/main/type-aliases/Labels.mdx)\> | Labels creators to override the defaults. Use this prop to customize the
ARIA labels attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`labels` | -| `lang?` | `string` | Add the language tag to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`lang` | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`locale` | -| `mode` | `"single"` | - | - | - | -| `modifiers?` | [`DayModifiers`](/docs/api/main/type-aliases/DayModifiers.mdx) | Add modifiers to the matching days. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiers` | -| `modifiersClassNames?` | [`ModifiersClassNames`](/docs/api/main/type-aliases/ModifiersClassNames.mdx) | Change the class name for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersClassNames` | -| `modifiersStyles?` | [`ModifiersStyles`](/docs/api/main/type-aliases/ModifiersStyles.mdx) | Change the inline style for the day matching the [modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`modifiersStyles` | -| `month?` | `Date` | The month displayed in the calendar.

As opposed to [DayPickerBase.defaultMonth](/docs/api/main/interfaces/DayPickerBase.mdx), use this prop with
[DayPickerBase.onMonthChange](/docs/api/main/interfaces/DayPickerBase.mdx) to change the month programmatically. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`month` | -| `nonce?` | `string` | A cryptographic nonce ("number used once") which can be used by Content
Security Policy for the inline `style` attributes. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`nonce` | -| `numberOfMonths?` | `number` | The number of displayed months.

**Default Value**
` 1 ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`numberOfMonths` | -| `onDayBlur?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user blurs from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayBlur` | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event callback fired when the user clicks on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayClick` | -| `onDayFocus?` | [`DayFocusEventHandler`](/docs/api/main/type-aliases/DayFocusEventHandler.mdx) | Event callback fired when the user focuses on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayFocus` | -| `onDayKeyDown?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyDown` | -| `onDayKeyPress?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyPress` | -| `onDayKeyUp?` | [`DayKeyboardEventHandler`](/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx) | Event callback fired when the user presses a key on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayKeyUp` | -| `onDayMouseEnter?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers on a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseEnter` | -| `onDayMouseLeave?` | [`DayMouseEventHandler`](/docs/api/main/type-aliases/DayMouseEventHandler.mdx) | Event callback fired when the user hovers away from a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayMouseLeave` | -| `onDayPointerEnter?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer enters a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerEnter` | -| `onDayPointerLeave?` | [`DayPointerEventHandler`](/docs/api/main/type-aliases/DayPointerEventHandler.mdx) | Event callback fired when the pointer leaves a day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayPointerLeave` | -| `onDayTouchCancel?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event is canceled. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchCancel` | -| `onDayTouchEnd?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event ends. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchEnd` | -| `onDayTouchMove?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event moves. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchMove` | -| `onDayTouchStart?` | [`DayTouchEventHandler`](/docs/api/main/type-aliases/DayTouchEventHandler.mdx) | Event callback when a day touch event starts. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onDayTouchStart` | -| `onMonthChange?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event fired when the user navigates between months. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onMonthChange` | -| `onNextClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the next month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onNextClick` | -| `onPrevClick?` | [`MonthChangeEventHandler`](/docs/api/main/type-aliases/MonthChangeEventHandler.mdx) | Event callback fired when the previous month button is clicked. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onPrevClick` | -| `onSelect?` | [`SelectSingleEventHandler`](/docs/api/main/type-aliases/SelectSingleEventHandler.mdx) | Event fired when a day is selected. | - | - | -| `onWeekNumberClick?` | [`WeekNumberClickEventHandler`](/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx) | Event callback fired when the week number is clicked. Requires
`showWeekNumbers` set. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`onWeekNumberClick` | -| `pagedNavigation?` | `boolean` | Paginate the month navigation displaying the [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) at
time.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`pagedNavigation` | -| `required?` | `boolean` | Make the selection required. | - | - | -| `reverseMonths?` | `boolean` | Render the months in reversed order (when [numberOfMonths](/docs/api/main/interfaces/DayPickerBase.mdx) is greater
than `1`) to display the most recent month first.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`reverseMonths` | -| `selected?` | `Date` | The selected day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`selected` | -| `showOutsideDays?` | `boolean` | Show the outside days. An outside day is a day falling in the next or the
previous month.

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showOutsideDays` | -| `showWeekNumber?` | `boolean` | Show the week numbers column. Weeks are numbered according to the local
week index.

- to use ISO week numbering, use the [ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx) prop.
- to change how the week numbers are displayed, use the [Formatters](/docs/api/main/type-aliases/Formatters.mdx) prop.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx), [weekStartsOn](/docs/api/main/interfaces/DayPickerBase.mdx) and [firstWeekContainsDate](/docs/api/main/interfaces/DayPickerBase.mdx).

**Default Value**
` false ` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`showWeekNumber` | -| `style?` | `CSSProperties` | Style to apply to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`style` | -| `styles?` | `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> | Change the inline styles of the HTML elements. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`styles` | -| `title?` | `string` | Add a `title` attribute to the container element. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`title` | -| `toDate?` | `Date` | The latest day to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`toYear` | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`today` | -| `weekStartsOn?` | `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` | The index of the first day of the week (0 - Sunday). Overrides the locale's one.

**See**
[ISOWeek](/docs/api/main/interfaces/DayPickerBase.mdx). | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx).`weekStartsOn` | diff --git a/docs/api/main/interfaces/DayProps.mdx b/docs/api/main/interfaces/DayProps.mdx deleted file mode 100644 index 98e35703fe..0000000000 --- a/docs/api/main/interfaces/DayProps.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: Interface -title: DayProps ---- - -# Interface: DayProps - -Represent the props used by the [Day](/docs/api/main/functions/Day.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `date` | `Date` | The date to render. | -| `displayMonth` | `Date` | The month where the date is displayed. | diff --git a/docs/api/main/interfaces/DropdownProps.mdx b/docs/api/main/interfaces/DropdownProps.mdx deleted file mode 100644 index 6fe182807b..0000000000 --- a/docs/api/main/interfaces/DropdownProps.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: Interface -title: DropdownProps ---- - -# Interface: DropdownProps - -The props for the [Dropdown](/docs/api/main/functions/Dropdown.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `aria-label?` | `string` | - | -| `caption?` | `ReactNode` | The caption displayed to replace the hidden select. | -| `children?` | `ReactNode` | - | -| `className?` | `string` | - | -| `name?` | `string` | The name attribute of the element. | -| `onChange?` | `ChangeEventHandler`\<`HTMLSelectElement`\> | - | -| `style?` | `CSSProperties` | - | -| `value?` | `string` \| `number` | The selected value. | diff --git a/docs/api/main/interfaces/FooterProps.mdx b/docs/api/main/interfaces/FooterProps.mdx deleted file mode 100644 index 59d3a96097..0000000000 --- a/docs/api/main/interfaces/FooterProps.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -section: Interface -title: FooterProps ---- - -# Interface: FooterProps - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `displayMonth?` | `Date` | The month where the footer is displayed. | diff --git a/docs/api/main/interfaces/NavigationContextValue.mdx b/docs/api/main/interfaces/NavigationContextValue.mdx deleted file mode 100644 index a0060577e5..0000000000 --- a/docs/api/main/interfaces/NavigationContextValue.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: Interface -title: NavigationContextValue ---- - -# Interface: NavigationContextValue - -Represents the value of the [NavigationContext](/docs/api/main/variables/NavigationContext.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `currentMonth` | `Date` | The month to display in the calendar. When `numberOfMonths` is greater than one, is the first of the displayed months. | -| `displayMonths` | `Date`[] | The months rendered by DayPicker. DayPicker can render multiple months via `numberOfMonths`. | -| `goToDate` | (`date`: `Date`, `refDate`?: `Date`) => `void` | Navigate to the specified date. | -| `goToMonth` | (`month`: `Date`) => `void` | Navigate to the specified month. | -| `isDateDisplayed` | (`day`: `Date`) => `boolean` | Whether the given day is included in the displayed months. | -| `nextMonth?` | `Date` | The next month to display. | -| `previousMonth?` | `Date` | The previous month to display. | diff --git a/docs/api/main/interfaces/RootContext.mdx b/docs/api/main/interfaces/RootContext.mdx deleted file mode 100644 index 0d4dccdd0f..0000000000 --- a/docs/api/main/interfaces/RootContext.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: Interface -title: RootContext ---- - -# Interface: RootContext - -The props of [RootProvider](/docs/api/main/functions/RootProvider.mdx). - -## Properties - -| Property | Type | -| :------ | :------ | -| `children?` | `ReactNode` | diff --git a/docs/api/main/interfaces/RowProps.mdx b/docs/api/main/interfaces/RowProps.mdx deleted file mode 100644 index 662c91aab3..0000000000 --- a/docs/api/main/interfaces/RowProps.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: RowProps ---- - -# Interface: RowProps - -The props for the [Row](/docs/api/main/functions/Row.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `dates` | `Date`[] | The days contained in the week. | -| `displayMonth` | `Date` | The month where the row is displayed. | -| `weekNumber` | `number` | The number of the week to render. | diff --git a/docs/api/main/interfaces/SelectMultipleContextValue.mdx b/docs/api/main/interfaces/SelectMultipleContextValue.mdx deleted file mode 100644 index 9a58a60660..0000000000 --- a/docs/api/main/interfaces/SelectMultipleContextValue.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: SelectMultipleContextValue ---- - -# Interface: SelectMultipleContextValue - -Represents the value of a [SelectMultipleContext](/docs/api/main/variables/SelectMultipleContext.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `modifiers` | [`SelectMultipleModifiers`](/docs/api/main/type-aliases/SelectMultipleModifiers.mdx) | The modifiers for the corresponding selection. | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event handler to attach to the day button to enable the multiple select. | -| `selected` | `undefined` \| `Date`[] | The days that have been selected. | diff --git a/docs/api/main/interfaces/SelectRangeContextValue.mdx b/docs/api/main/interfaces/SelectRangeContextValue.mdx deleted file mode 100644 index a1db94de61..0000000000 --- a/docs/api/main/interfaces/SelectRangeContextValue.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Interface -title: SelectRangeContextValue ---- - -# Interface: SelectRangeContextValue - -Represents the value of a [SelectRangeContext](/docs/api/main/variables/SelectRangeContext.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `modifiers` | [`SelectRangeModifiers`](/docs/api/main/type-aliases/SelectRangeModifiers.mdx) | The modifiers for the corresponding selection. | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event handler to attach to the day button to enable the range select. | -| `selected` | `undefined` \| [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) | The range of days that has been selected. | diff --git a/docs/api/main/interfaces/SelectRangeProviderProps.mdx b/docs/api/main/interfaces/SelectRangeProviderProps.mdx deleted file mode 100644 index 11401059e0..0000000000 --- a/docs/api/main/interfaces/SelectRangeProviderProps.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -section: Interface -title: SelectRangeProviderProps ---- - -# Interface: SelectRangeProviderProps - -## Properties - -| Property | Type | -| :------ | :------ | -| `children?` | `ReactNode` | -| `initialProps` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) | diff --git a/docs/api/main/interfaces/SelectSingleContextValue.mdx b/docs/api/main/interfaces/SelectSingleContextValue.mdx deleted file mode 100644 index 4a148ecbec..0000000000 --- a/docs/api/main/interfaces/SelectSingleContextValue.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: Interface -title: SelectSingleContextValue ---- - -# Interface: SelectSingleContextValue - -Represents the value of a [SelectSingleContext](/docs/api/main/variables/SelectSingleContext.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `onDayClick?` | [`DayClickEventHandler`](/docs/api/main/type-aliases/DayClickEventHandler.mdx) | Event handler to attach to the day button to enable the single select. | -| `selected` | `undefined` \| `Date` | The day that has been selected. | diff --git a/docs/api/main/interfaces/SelectSingleProviderProps.mdx b/docs/api/main/interfaces/SelectSingleProviderProps.mdx deleted file mode 100644 index 019d8e1ea3..0000000000 --- a/docs/api/main/interfaces/SelectSingleProviderProps.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -section: Interface -title: SelectSingleProviderProps ---- - -# Interface: SelectSingleProviderProps - -## Properties - -| Property | Type | -| :------ | :------ | -| `children?` | `ReactNode` | -| `initialProps` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) | diff --git a/docs/api/main/interfaces/UseInputOptions.mdx b/docs/api/main/interfaces/UseInputOptions.mdx deleted file mode 100644 index e395b4ef4e..0000000000 --- a/docs/api/main/interfaces/UseInputOptions.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: Interface -title: UseInputOptions ---- - -# Interface: UseInputOptions - -## Extends - -- `Pick`\<[`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx), `"locale"` \| `"fromDate"` \| `"toDate"` \| `"fromMonth"` \| `"toMonth"` \| `"fromYear"` \| `"toYear"` \| `"today"`\> - -## Properties - -| Property | Type | Description | Inherited from | -| :------ | :------ | :------ | :------ | -| `defaultSelected?` | `Date` | The initially selected date | - | -| `format?` | `string` | The format string for formatting the input field. See
https://date-fns.org/docs/format for a list of format strings.

**Default Value**
` PP ` | - | -| `fromDate?` | `Date` | The earliest day to start the month navigation. | `Pick.fromDate` | -| `fromMonth?` | `Date` | The earliest month to start the month navigation. | `Pick.fromMonth` | -| `fromYear?` | `number` | The earliest year to start the month navigation. | `Pick.fromYear` | -| `locale?` | `Locale` | The date-fns locale object used to localize dates.

**Default Value**
` en-US ` | `Pick.locale` | -| `required?` | `boolean` | Make the selection required. | - | -| `toDate?` | `Date` | The latest day to end the month navigation. | `Pick.toDate` | -| `toMonth?` | `Date` | The latest month to end the month navigation. | `Pick.toMonth` | -| `toYear?` | `number` | The latest year to end the month navigation. | `Pick.toYear` | -| `today?` | `Date` | The today’s date. Default is the current date. This Date will get the
`today` modifier to style the day. | `Pick.today` | diff --git a/docs/api/main/interfaces/UseInputValue.mdx b/docs/api/main/interfaces/UseInputValue.mdx deleted file mode 100644 index c1a334650a..0000000000 --- a/docs/api/main/interfaces/UseInputValue.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -section: Interface -title: UseInputValue ---- - -# Interface: UseInputValue - -Represent the value returned by [useInput](/docs/api/main/functions/useInput.mdx). - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `dayPickerProps` | [`InputDayPickerProps`](/docs/api/main/type-aliases/InputDayPickerProps.mdx) | The props to pass to a DayPicker component. | -| `inputProps` | [`InputProps`](/docs/api/main/type-aliases/InputProps.mdx) | The props to pass to an input field. | -| `reset` | () => `void` | A function to reset to the initial state. | -| `setSelected` | (`day`: `undefined` \| `Date`) => `void` | A function to set the selected day. | diff --git a/docs/api/main/interfaces/WeekNumberProps.mdx b/docs/api/main/interfaces/WeekNumberProps.mdx deleted file mode 100644 index 1baa026fe7..0000000000 --- a/docs/api/main/interfaces/WeekNumberProps.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: Interface -title: WeekNumberProps ---- - -# Interface: WeekNumberProps - -The props for the [WeekNumber](/docs/api/main/functions/WeekNumber.mdx) component. - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `dates` | `Date`[] | The dates in the week. | -| `number` | `number` | The number of the week. | diff --git a/docs/api/main/type-aliases/ActiveModifiers.mdx b/docs/api/main/type-aliases/ActiveModifiers.mdx deleted file mode 100644 index 85ec9844b7..0000000000 --- a/docs/api/main/type-aliases/ActiveModifiers.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: TypeAlias -title: ActiveModifiers ---- - -# Type alias: ActiveModifiers - -> **ActiveModifiers**: `Record`\<[`Modifier`](/docs/api/main/type-aliases/Modifier.mdx), `true`\> & `Partial`\<`Record`\<[`InternalModifier`](/docs/api/main/enumerations/InternalModifier.mdx), `true`\>\> - -The modifiers that are matching a day in the calendar. Use the [useActiveModifiers](/docs/api/main/functions/useActiveModifiers.mdx) hook to get the modifiers for a day. - -``` -const activeModifiers: ActiveModifiers = { - selected: true, - customModifier: true -} -``` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:44 diff --git a/docs/api/main/type-aliases/ButtonProps.mdx b/docs/api/main/type-aliases/ButtonProps.mdx deleted file mode 100644 index 41ee52c303..0000000000 --- a/docs/api/main/type-aliases/ButtonProps.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: ButtonProps ---- - -# Type alias: ButtonProps - -> **ButtonProps**: `JSX.IntrinsicElements`\[`"button"`\] - -The props for the [Button](/docs/api/main/functions/Button.mdx) component. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Button/Button.tsx:6 diff --git a/docs/api/main/type-aliases/CaptionLayout.mdx b/docs/api/main/type-aliases/CaptionLayout.mdx deleted file mode 100644 index 1f6075dc74..0000000000 --- a/docs/api/main/type-aliases/CaptionLayout.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: TypeAlias -title: CaptionLayout ---- - -# Type alias: CaptionLayout - -> **CaptionLayout**: `"dropdown"` \| `"buttons"` \| `"dropdown-buttons"` - -The layout of the caption: - -- `dropdown`: display dropdowns for choosing the month and the year. -- `buttons`: display previous month / next month buttons. -- `dropdown-buttons`: display both month / year dropdowns and previous month / next month buttons. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Caption/Caption.tsx:23 diff --git a/docs/api/main/type-aliases/ClassNames.mdx b/docs/api/main/type-aliases/ClassNames.mdx deleted file mode 100644 index fa35bb0895..0000000000 --- a/docs/api/main/type-aliases/ClassNames.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: ClassNames ---- - -# Type alias: ClassNames - -> **ClassNames**: `Partial`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`string`\>\> - -The class names of each element. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Styles.ts:109 diff --git a/docs/api/main/type-aliases/CustomModifiers.mdx b/docs/api/main/type-aliases/CustomModifiers.mdx deleted file mode 100644 index a7b70f8a3b..0000000000 --- a/docs/api/main/type-aliases/CustomModifiers.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: TypeAlias -title: CustomModifiers ---- - -# Type alias: CustomModifiers - -> **CustomModifiers**: `Record`\<[`Modifier`](/docs/api/main/type-aliases/Modifier.mdx), [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[]\> - -A map of matchers used as custom modifiers by DayPicker component. This is -the same as []], but it accepts only array of [[Matcher](/docs/api/main/type-aliases/DayModifiers.mdx)s. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:62 diff --git a/docs/api/main/type-aliases/DateAfter.mdx b/docs/api/main/type-aliases/DateAfter.mdx deleted file mode 100644 index e936038308..0000000000 --- a/docs/api/main/type-aliases/DateAfter.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: TypeAlias -title: DateAfter ---- - -# Type alias: DateAfter - -> **DateAfter**: `Object` - -A matcher to match a day falling after the specified date, with the date not included. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `after` | `Date` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:64 diff --git a/docs/api/main/type-aliases/DateBefore.mdx b/docs/api/main/type-aliases/DateBefore.mdx deleted file mode 100644 index b2f55d4abe..0000000000 --- a/docs/api/main/type-aliases/DateBefore.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: TypeAlias -title: DateBefore ---- - -# Type alias: DateBefore - -> **DateBefore**: `Object` - -A matcher to match a day falling before the specified date, with the date not included. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `before` | `Date` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:67 diff --git a/docs/api/main/type-aliases/DateFormatter.mdx b/docs/api/main/type-aliases/DateFormatter.mdx deleted file mode 100644 index 179a846bae..0000000000 --- a/docs/api/main/type-aliases/DateFormatter.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DateFormatter ---- - -# Type alias: DateFormatter - -> **DateFormatter**: (`date`, `options`?) => `ReactNode` - -Represents a function to format a date. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `date` | `Date` | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`ReactNode` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Formatters.ts:6 diff --git a/docs/api/main/type-aliases/DateInterval.mdx b/docs/api/main/type-aliases/DateInterval.mdx deleted file mode 100644 index cdb336fd57..0000000000 --- a/docs/api/main/type-aliases/DateInterval.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: TypeAlias -title: DateInterval ---- - -# Type alias: DateInterval - -> **DateInterval**: `Object` - -A matcher to match a day falling before and/or after two dates, where the dates are not included. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `after` | `Date` | -| `before` | `Date` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:70 diff --git a/docs/api/main/type-aliases/DateRange.mdx b/docs/api/main/type-aliases/DateRange.mdx deleted file mode 100644 index e7df3181e1..0000000000 --- a/docs/api/main/type-aliases/DateRange.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -section: TypeAlias -title: DateRange ---- - -# Type alias: DateRange - -> **DateRange**: `Object` - -A matcher to match a range of dates. The range can be open. Differently from [DateInterval](/docs/api/main/type-aliases/DateInterval.mdx), the dates here are included. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `from` | `Date` \| `undefined` | -| `to` | `Date` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:73 diff --git a/docs/api/main/type-aliases/DayClickEventHandler.mdx b/docs/api/main/type-aliases/DayClickEventHandler.mdx deleted file mode 100644 index f441314d0b..0000000000 --- a/docs/api/main/type-aliases/DayClickEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayClickEventHandler ---- - -# Type alias: DayClickEventHandler - -> **DayClickEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day is clicked. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:14 diff --git a/docs/api/main/type-aliases/DayFocusEventHandler.mdx b/docs/api/main/type-aliases/DayFocusEventHandler.mdx deleted file mode 100644 index eb79ff4881..0000000000 --- a/docs/api/main/type-aliases/DayFocusEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayFocusEventHandler ---- - -# Type alias: DayFocusEventHandler - -> **DayFocusEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day is focused. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `FocusEvent` \| `KeyboardEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:21 diff --git a/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx b/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx deleted file mode 100644 index 741274ae35..0000000000 --- a/docs/api/main/type-aliases/DayKeyboardEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayKeyboardEventHandler ---- - -# Type alias: DayKeyboardEventHandler - -> **DayKeyboardEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day gets a keyboard event. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `KeyboardEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:28 diff --git a/docs/api/main/type-aliases/DayLabel.mdx b/docs/api/main/type-aliases/DayLabel.mdx deleted file mode 100644 index 64ba65d788..0000000000 --- a/docs/api/main/type-aliases/DayLabel.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: TypeAlias -title: DayLabel ---- - -# Type alias: DayLabel - -> **DayLabel**: (`day`, `activeModifiers`, `options`?) => `string` - -Return the ARIA label for the [Day](/docs/api/main/functions/Day.mdx) component. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`string` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Labels.ts:18 diff --git a/docs/api/main/type-aliases/DayModifiers.mdx b/docs/api/main/type-aliases/DayModifiers.mdx deleted file mode 100644 index bd089374d8..0000000000 --- a/docs/api/main/type-aliases/DayModifiers.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: DayModifiers ---- - -# Type alias: DayModifiers - -> **DayModifiers**: `Record`\<[`Modifier`](/docs/api/main/type-aliases/Modifier.mdx), [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx) \| [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[]\> - -The custom modifiers passed to the [DayPickerBase.modifiers](/docs/api/main/interfaces/DayPickerBase.mdx). - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:56 diff --git a/docs/api/main/type-aliases/DayMouseEventHandler.mdx b/docs/api/main/type-aliases/DayMouseEventHandler.mdx deleted file mode 100644 index 622e1e82ad..0000000000 --- a/docs/api/main/type-aliases/DayMouseEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayMouseEventHandler ---- - -# Type alias: DayMouseEventHandler - -> **DayMouseEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day gets a mouse event. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:35 diff --git a/docs/api/main/type-aliases/DayOfWeek.mdx b/docs/api/main/type-aliases/DayOfWeek.mdx deleted file mode 100644 index c5338bdcb1..0000000000 --- a/docs/api/main/type-aliases/DayOfWeek.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: TypeAlias -title: DayOfWeek ---- - -# Type alias: DayOfWeek - -> **DayOfWeek**: `Object` - -A matcher to match a date being one of the specified days of the week (`0-6`, where `0` is Sunday). - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `dayOfWeek` | `number`[] | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:76 diff --git a/docs/api/main/type-aliases/DayPickerProps.mdx b/docs/api/main/type-aliases/DayPickerProps.mdx deleted file mode 100644 index d2f204824b..0000000000 --- a/docs/api/main/type-aliases/DayPickerProps.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -section: TypeAlias -title: DayPickerProps ---- - -# Type alias: DayPickerProps - -> **DayPickerProps**: [`DayPickerDefaultProps`](/docs/api/main/interfaces/DayPickerDefaultProps.mdx) \| [`DayPickerSingleProps`](/docs/api/main/interfaces/DayPickerSingleProps.mdx) \| [`DayPickerMultipleProps`](/docs/api/main/interfaces/DayPickerMultipleProps.mdx) \| [`DayPickerRangeProps`](/docs/api/main/interfaces/DayPickerRangeProps.mdx) - -## Source - -typedoc/node\_modules/react-day-picker-v8/src/DayPicker.tsx:9 diff --git a/docs/api/main/type-aliases/DayPointerEventHandler.mdx b/docs/api/main/type-aliases/DayPointerEventHandler.mdx deleted file mode 100644 index c4651ebb66..0000000000 --- a/docs/api/main/type-aliases/DayPointerEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayPointerEventHandler ---- - -# Type alias: DayPointerEventHandler - -> **DayPointerEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day gets a pointer event. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `PointerEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:42 diff --git a/docs/api/main/type-aliases/DayRender.mdx b/docs/api/main/type-aliases/DayRender.mdx deleted file mode 100644 index dde8179859..0000000000 --- a/docs/api/main/type-aliases/DayRender.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -section: TypeAlias -title: DayRender ---- - -# Type alias: DayRender - -> **DayRender**: `Object` - -## Type declaration - -| Member | Type | Description | -| :------ | :------ | :------ | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | The modifiers active for the given day. | -| `buttonProps` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) & `Pick`\<[`ButtonProps`](/docs/api/main/type-aliases/ButtonProps.mdx), `"disabled"` \| `"aria-selected"` \| `"tabIndex"`\> & `DayEventHandlers` | The props to apply to the button element (when `isButton` is true). | -| `divProps` | [`StyledComponent`](/docs/api/main/type-aliases/StyledComponent.mdx) | The props to apply to the div element (when `isButton` is false). | -| `isButton` | `boolean` | Whether the day should be rendered a `button` instead of a `div` | -| `isHidden` | `boolean` | Whether the day should be hidden. | -| `selectedDays` | `SelectedDays` | - | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useDayRender/useDayRender.tsx:21 diff --git a/docs/api/main/type-aliases/DaySelectionMode.mdx b/docs/api/main/type-aliases/DaySelectionMode.mdx deleted file mode 100644 index 3ecd1d1480..0000000000 --- a/docs/api/main/type-aliases/DaySelectionMode.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: TypeAlias -title: DaySelectionMode ---- - -# Type alias: DaySelectionMode - -> **DaySelectionMode**: `"single"` \| `"multiple"` \| `"range"` \| `"default"` - -Selection modes supported by DayPicker. - -- `single`: use DayPicker to select single days. -- `multiple`: allow selecting multiple days. -- `range`: use DayPicker to select a range of days -- `default`: disable the built-in selection behavior. Customize what is - selected by using [DayPickerBase.onDayClick](/docs/api/main/interfaces/DayPickerBase.mdx). - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/DayPickerBase.ts:44 diff --git a/docs/api/main/type-aliases/DayTouchEventHandler.mdx b/docs/api/main/type-aliases/DayTouchEventHandler.mdx deleted file mode 100644 index 23f600ebf5..0000000000 --- a/docs/api/main/type-aliases/DayTouchEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: DayTouchEventHandler ---- - -# Type alias: DayTouchEventHandler - -> **DayTouchEventHandler**: (`day`, `activeModifiers`, `e`) => `void` - -The event handler when a day gets a touch event. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `TouchEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:96 diff --git a/docs/api/main/type-aliases/FocusContextValue.mdx b/docs/api/main/type-aliases/FocusContextValue.mdx deleted file mode 100644 index ef2ad11cf8..0000000000 --- a/docs/api/main/type-aliases/FocusContextValue.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -section: TypeAlias -title: FocusContextValue ---- - -# Type alias: FocusContextValue - -> **FocusContextValue**: `Object` - -Represents the value of the [FocusContext](/docs/api/main/variables/FocusContext.mdx). - -## Type declaration - -| Member | Type | Description | -| :------ | :------ | :------ | -| `blur` | () => `void` | Blur the focused day. | -| `focus` | (`day`) => `void` | Focus a day. | -| `focusDayAfter` | () => `void` | Focus the day after the focused day. | -| `focusDayBefore` | () => `void` | Focus the day before the focused day. | -| `focusEndOfWeek` | () => `void` | - | -| `focusMonthAfter` | () => `void` | - | -| `focusMonthBefore` | () => `void` | - | -| `focusStartOfWeek` | () => `void` | - | -| `focusTarget` | `Date` \| `undefined` | Day that will be focused. | -| `focusWeekAfter` | () => `void` | Focus the day in the week after the focused day. | -| `focusWeekBefore` | () => `void` | Focus the day in the week before the focused day. | -| `focusYearAfter` | () => `void` | - | -| `focusYearBefore` | () => `void` | - | -| `focusedDay` | `Date` \| `undefined` | The day currently focused. | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Focus/FocusContext.tsx:17 diff --git a/docs/api/main/type-aliases/FocusProviderProps.mdx b/docs/api/main/type-aliases/FocusProviderProps.mdx deleted file mode 100644 index 2862ec5175..0000000000 --- a/docs/api/main/type-aliases/FocusProviderProps.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: TypeAlias -title: FocusProviderProps ---- - -# Type alias: FocusProviderProps - -> **FocusProviderProps**: `Object` - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `children` | `ReactNode` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Focus/FocusContext.tsx:57 diff --git a/docs/api/main/type-aliases/Formatters.mdx b/docs/api/main/type-aliases/Formatters.mdx deleted file mode 100644 index dc80979bd7..0000000000 --- a/docs/api/main/type-aliases/Formatters.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: TypeAlias -title: Formatters ---- - -# Type alias: Formatters - -> **Formatters**: `Object` - -Represent a map of formatters used to render localized content. - -## Type declaration - -| Member | Type | Description | -| :------ | :------ | :------ | -| `formatCaption` | [`DateFormatter`](/docs/api/main/type-aliases/DateFormatter.mdx) | Format the month in the caption when `captionLayout` is `buttons`. | -| `formatDay` | [`DateFormatter`](/docs/api/main/type-aliases/DateFormatter.mdx) | Format the day in the day cell. | -| `formatMonthCaption` | [`DateFormatter`](/docs/api/main/type-aliases/DateFormatter.mdx) | Format the month in the navigation dropdown. | -| `formatWeekNumber` | [`WeekNumberFormatter`](/docs/api/main/type-aliases/WeekNumberFormatter.mdx) | Format the week number. | -| `formatWeekdayName` | [`DateFormatter`](/docs/api/main/type-aliases/DateFormatter.mdx) | Format the week day name in the header | -| `formatYearCaption` | [`DateFormatter`](/docs/api/main/type-aliases/DateFormatter.mdx) | Format the year in the navigation dropdown. | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Formatters.ts:14 diff --git a/docs/api/main/type-aliases/InputDayPickerProps.mdx b/docs/api/main/type-aliases/InputDayPickerProps.mdx deleted file mode 100644 index 332993f7e2..0000000000 --- a/docs/api/main/type-aliases/InputDayPickerProps.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: InputDayPickerProps ---- - -# Type alias: InputDayPickerProps - -> **InputDayPickerProps**: `Pick`\<[`DayPickerSingleProps`](/docs/api/main/interfaces/DayPickerSingleProps.mdx), `"fromDate"` \| `"toDate"` \| `"locale"` \| `"month"` \| `"onDayClick"` \| `"onMonthChange"` \| `"selected"` \| `"today"`\> - -The props to attach to the DayPicker component when using [useInput](/docs/api/main/functions/useInput.mdx). - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useInput/useInput.ts:28 diff --git a/docs/api/main/type-aliases/InputProps.mdx b/docs/api/main/type-aliases/InputProps.mdx deleted file mode 100644 index 15cd1adf36..0000000000 --- a/docs/api/main/type-aliases/InputProps.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: InputProps ---- - -# Type alias: InputProps - -> **InputProps**: `Pick`\<`InputHTMLAttributes`\<`HTMLInputElement`\>, `"onBlur"` \| `"onChange"` \| `"onFocus"` \| `"value"` \| `"placeholder"`\> - -The props to attach to the input field when using [useInput](/docs/api/main/functions/useInput.mdx). - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/hooks/useInput/useInput.ts:22 diff --git a/docs/api/main/type-aliases/InternalModifiers.mdx b/docs/api/main/type-aliases/InternalModifiers.mdx deleted file mode 100644 index 04e8a31b80..0000000000 --- a/docs/api/main/type-aliases/InternalModifiers.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: InternalModifiers ---- - -# Type alias: InternalModifiers - -> **InternalModifiers**: `Record`\<[`InternalModifier`](/docs/api/main/enumerations/InternalModifier.mdx), [`Matcher`](/docs/api/main/type-aliases/Matcher.mdx)[]\> - -Map of matchers used for the internal modifiers. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:31 diff --git a/docs/api/main/type-aliases/InternalModifiersElement.mdx b/docs/api/main/type-aliases/InternalModifiersElement.mdx deleted file mode 100644 index 9109f641b2..0000000000 --- a/docs/api/main/type-aliases/InternalModifiersElement.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: InternalModifiersElement ---- - -# Type alias: InternalModifiersElement - -> **InternalModifiersElement**: `"day_outside"` \| `"day_selected"` \| `"day_disabled"` \| `"day_hidden"` \| `"day_range_start"` \| `"day_range_end"` \| `"day_range_middle"` \| `"day_today"` - -These elements must not be in the `styles` or `classNames` records as they are styled via the `modifiersStyles` or `modifiersClassNames` pop - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Styles.ts:98 diff --git a/docs/api/main/type-aliases/Labels.mdx b/docs/api/main/type-aliases/Labels.mdx deleted file mode 100644 index 9db28a53d3..0000000000 --- a/docs/api/main/type-aliases/Labels.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: Labels ---- - -# Type alias: Labels - -> **Labels**: `Object` - -Map of functions to translate ARIA labels for the relative elements. - -## Type declaration - -| Member | Type | Description | -| :------ | :------ | :------ | -| `labelDay` | [`DayLabel`](/docs/api/main/type-aliases/DayLabel.mdx) | **Deprecated**
This label is not used anymore and this function will be removed in the future. | -| `labelMonthDropdown` | () => `string` | - | -| `labelNext` | [`NavButtonLabel`](/docs/api/main/type-aliases/NavButtonLabel.mdx) | - | -| `labelPrevious` | [`NavButtonLabel`](/docs/api/main/type-aliases/NavButtonLabel.mdx) | - | -| `labelWeekNumber` | [`WeekNumberLabel`](/docs/api/main/type-aliases/WeekNumberLabel.mdx) | - | -| `labelWeekday` | [`WeekdayLabel`](/docs/api/main/type-aliases/WeekdayLabel.mdx) | - | -| `labelYearDropdown` | () => `string` | - | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Labels.ts:6 diff --git a/docs/api/main/type-aliases/Matcher.mdx b/docs/api/main/type-aliases/Matcher.mdx deleted file mode 100644 index a7c7af58f5..0000000000 --- a/docs/api/main/type-aliases/Matcher.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -section: TypeAlias -title: Matcher ---- - -# Type alias: Matcher - -> **Matcher**: `boolean` \| (`date`) => `boolean` \| `Date` \| `Date`[] \| [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) \| [`DateBefore`](/docs/api/main/type-aliases/DateBefore.mdx) \| [`DateAfter`](/docs/api/main/type-aliases/DateAfter.mdx) \| [`DateInterval`](/docs/api/main/type-aliases/DateInterval.mdx) \| [`DayOfWeek`](/docs/api/main/type-aliases/DayOfWeek.mdx) - -A value or a function that matches a specific day. - -Matchers are passed to DayPicker via [DayPickerBase.disabled](/docs/api/main/interfaces/DayPickerBase.mdx), -[]] or [[DayPickerProps.selected](/docs/api/main/interfaces/DayPickerBase.mdx) and are used to -determine if a day should get a [Modifier](/docs/api/main/type-aliases/Modifier.mdx). - -Matchers can be of different types: - -``` -// will always match the day -const booleanMatcher: Matcher = true; - - // will match the today's date -const dateMatcher: Matcher = new Date(); - -// will match the days in the array -const arrayMatcher: Matcher = [new Date(2019, 1, 2), new Date(2019, 1, 4)]; - -// will match days after the 2nd of February 2019 -const afterMatcher: DateAfter = { after: new Date(2019, 1, 2) }; - // will match days before the 2nd of February 2019 } -const beforeMatcher: DateBefore = { before: new Date(2019, 1, 2) }; - -// will match Sundays -const dayOfWeekMatcher: DayOfWeek = { - dayOfWeek: 0 -}; - -// will match the included days, except the two dates -const intervalMatcher: DateInterval = { - after: new Date(2019, 1, 2), - before: new Date(2019, 1, 5) -}; - -// will match the included days, including the two dates -const rangeMatcher: DateRange = { - from: new Date(2019, 1, 2), - to: new Date(2019, 1, 5) -}; - -// will match when the function return true -const functionMatcher: Matcher = (day: Date) => { - return day.getMonth() === 2 // match when month is March -}; -``` - -## See - -[isMatch](/docs/api/main/functions/isMatch.mdx) - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Matchers.ts:52 diff --git a/docs/api/main/type-aliases/Modifier.mdx b/docs/api/main/type-aliases/Modifier.mdx deleted file mode 100644 index 80d1ca00ff..0000000000 --- a/docs/api/main/type-aliases/Modifier.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: Modifier ---- - -# Type alias: Modifier - -> **Modifier**: `string` - -A _modifier_ represents different styles or states of a day displayed in the calendar. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:6 diff --git a/docs/api/main/type-aliases/Modifiers.mdx b/docs/api/main/type-aliases/Modifiers.mdx deleted file mode 100644 index 46af9dd745..0000000000 --- a/docs/api/main/type-aliases/Modifiers.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: Modifiers ---- - -# Type alias: Modifiers - -> **Modifiers**: [`CustomModifiers`](/docs/api/main/type-aliases/CustomModifiers.mdx) & [`InternalModifiers`](/docs/api/main/type-aliases/InternalModifiers.mdx) - -The modifiers used by DayPicker. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:9 diff --git a/docs/api/main/type-aliases/ModifiersClassNames.mdx b/docs/api/main/type-aliases/ModifiersClassNames.mdx deleted file mode 100644 index 9ea94ccf09..0000000000 --- a/docs/api/main/type-aliases/ModifiersClassNames.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: ModifiersClassNames ---- - -# Type alias: ModifiersClassNames - -> **ModifiersClassNames**: `Record`\<[`Modifier`](/docs/api/main/type-aliases/Modifier.mdx), `string`\> & `Partial`\<`Record`\<[`InternalModifier`](/docs/api/main/enumerations/InternalModifier.mdx), `string`\>\> - -The classnames to assign to each day element matching a modifier. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:52 diff --git a/docs/api/main/type-aliases/ModifiersStyles.mdx b/docs/api/main/type-aliases/ModifiersStyles.mdx deleted file mode 100644 index 486ff162c4..0000000000 --- a/docs/api/main/type-aliases/ModifiersStyles.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: ModifiersStyles ---- - -# Type alias: ModifiersStyles - -> **ModifiersStyles**: `Record`\<[`Modifier`](/docs/api/main/type-aliases/Modifier.mdx), `CSSProperties`\> & `Partial`\<`Record`\<[`InternalModifier`](/docs/api/main/enumerations/InternalModifier.mdx), `CSSProperties`\>\> - -The style to apply to each day element matching a modifier. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Modifiers.ts:48 diff --git a/docs/api/main/type-aliases/MonthChangeEventHandler.mdx b/docs/api/main/type-aliases/MonthChangeEventHandler.mdx deleted file mode 100644 index 0db124c9e0..0000000000 --- a/docs/api/main/type-aliases/MonthChangeEventHandler.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: TypeAlias -title: MonthChangeEventHandler ---- - -# Type alias: MonthChangeEventHandler - -> **MonthChangeEventHandler**: (`month`) => `void` - -The event handler when a month is changed in the calendar. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `month` | `Date` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:49 diff --git a/docs/api/main/type-aliases/MonthsProps.mdx b/docs/api/main/type-aliases/MonthsProps.mdx deleted file mode 100644 index 972a659df9..0000000000 --- a/docs/api/main/type-aliases/MonthsProps.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -section: TypeAlias -title: MonthsProps ---- - -# Type alias: MonthsProps - -> **MonthsProps**: `Object` - -The props for the [Months](/docs/api/main/functions/Months.mdx) component. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `children` | `ReactNode` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/components/Months/Months.tsx:6 diff --git a/docs/api/main/type-aliases/NavButtonLabel.mdx b/docs/api/main/type-aliases/NavButtonLabel.mdx deleted file mode 100644 index 98c22bf6cd..0000000000 --- a/docs/api/main/type-aliases/NavButtonLabel.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: NavButtonLabel ---- - -# Type alias: NavButtonLabel - -> **NavButtonLabel**: (`month`?, `options`?) => `string` - -Return the ARIA label for the "next month" / "prev month" buttons in the navigation. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `month`? | `Date` | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`string` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Labels.ts:27 diff --git a/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx b/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx deleted file mode 100644 index d4e61b072f..0000000000 --- a/docs/api/main/type-aliases/SelectMultipleEventHandler.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: TypeAlias -title: SelectMultipleEventHandler ---- - -# Type alias: SelectMultipleEventHandler - -> **SelectMultipleEventHandler**: (`days`, `selectedDay`, `activeModifiers`, `e`) => `void` - -The event handler when selecting multiple days. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `days` | `Date`[] \| `undefined` | -| `selectedDay` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:52 diff --git a/docs/api/main/type-aliases/SelectMultipleModifiers.mdx b/docs/api/main/type-aliases/SelectMultipleModifiers.mdx deleted file mode 100644 index 16698d8175..0000000000 --- a/docs/api/main/type-aliases/SelectMultipleModifiers.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: SelectMultipleModifiers ---- - -# Type alias: SelectMultipleModifiers - -> **SelectMultipleModifiers**: `Pick`\<[`Modifiers`](/docs/api/main/type-aliases/Modifiers.mdx), `InternalModifier.Disabled`\> - -Represent the modifiers that are changed by the multiple selection. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:14 diff --git a/docs/api/main/type-aliases/SelectMultipleProviderProps.mdx b/docs/api/main/type-aliases/SelectMultipleProviderProps.mdx deleted file mode 100644 index 0c9c527c8f..0000000000 --- a/docs/api/main/type-aliases/SelectMultipleProviderProps.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -section: TypeAlias -title: SelectMultipleProviderProps ---- - -# Type alias: SelectMultipleProviderProps - -> **SelectMultipleProviderProps**: `Object` - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `children` | `ReactNode` | -| `initialProps` | [`DayPickerBase`](/docs/api/main/interfaces/DayPickerBase.mdx) | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:39 diff --git a/docs/api/main/type-aliases/SelectRangeEventHandler.mdx b/docs/api/main/type-aliases/SelectRangeEventHandler.mdx deleted file mode 100644 index d6971fa1f4..0000000000 --- a/docs/api/main/type-aliases/SelectRangeEventHandler.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: TypeAlias -title: SelectRangeEventHandler ---- - -# Type alias: SelectRangeEventHandler - -> **SelectRangeEventHandler**: (`range`, `selectedDay`, `activeModifiers`, `e`) => `void` - -The event handler when selecting a range of days. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `range` | [`DateRange`](/docs/api/main/type-aliases/DateRange.mdx) \| `undefined` | -| `selectedDay` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:64 diff --git a/docs/api/main/type-aliases/SelectRangeModifiers.mdx b/docs/api/main/type-aliases/SelectRangeModifiers.mdx deleted file mode 100644 index af879ff56e..0000000000 --- a/docs/api/main/type-aliases/SelectRangeModifiers.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -section: TypeAlias -title: SelectRangeModifiers ---- - -# Type alias: SelectRangeModifiers - -> **SelectRangeModifiers**: `Pick`\<[`Modifiers`](/docs/api/main/type-aliases/Modifiers.mdx), `InternalModifier.Disabled` \| `InternalModifier.RangeEnd` \| `InternalModifier.RangeMiddle` \| `InternalModifier.RangeStart`\> - -Represent the modifiers that are changed by the range selection. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/SelectRangeContext.tsx:19 diff --git a/docs/api/main/type-aliases/SelectSingleEventHandler.mdx b/docs/api/main/type-aliases/SelectSingleEventHandler.mdx deleted file mode 100644 index cb039d5be3..0000000000 --- a/docs/api/main/type-aliases/SelectSingleEventHandler.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: TypeAlias -title: SelectSingleEventHandler ---- - -# Type alias: SelectSingleEventHandler - -> **SelectSingleEventHandler**: (`day`, `selectedDay`, `activeModifiers`, `e`) => `void` - -The event handler when selecting a single day. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` \| `undefined` | -| `selectedDay` | `Date` | -| `activeModifiers` | [`ActiveModifiers`](/docs/api/main/type-aliases/ActiveModifiers.mdx) | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:75 diff --git a/docs/api/main/type-aliases/StyledComponent.mdx b/docs/api/main/type-aliases/StyledComponent.mdx deleted file mode 100644 index b1977ebe5d..0000000000 --- a/docs/api/main/type-aliases/StyledComponent.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: TypeAlias -title: StyledComponent ---- - -# Type alias: StyledComponent - -> **StyledComponent**: `Object` - -Props of a component that can be styled via classNames or inline-styles. - -## Type declaration - -| Member | Type | -| :------ | :------ | -| `children` | `ReactNode` | -| `className` | `string` | -| `style` | `CSSProperties` | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Styles.ts:121 diff --git a/docs/api/main/type-aliases/StyledElement.mdx b/docs/api/main/type-aliases/StyledElement.mdx deleted file mode 100644 index 9439c1221f..0000000000 --- a/docs/api/main/type-aliases/StyledElement.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -section: TypeAlias -title: StyledElement ---- - -# Type alias: StyledElement\ - -> **StyledElement**\<`T`\>: `Object` - -The style (either via class names or via in-line styles) of an element. - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` | `string` \| `CSSProperties` | - -## Type declaration - -| Member | Type | Description | -| :------ | :------ | :------ | -| `button` | `T` | The buttons. | -| `button_reset` | `T` | The style for resetting the buttons. | -| `caption` | `T` | The caption (showing the calendar heading and the navigation) | -| `caption_between` | `T` | The caption when between two months (when `multipleMonths > 2`). | -| `caption_dropdowns` | `T` | The drop-downs container. | -| `caption_end` | `T` | The caption when at the end of a series of months. | -| `caption_label` | `T` | The caption label. | -| `caption_start` | `T` | The caption when at the start of a series of months. | -| `cell` | `T` | The table cell containing the day element. | -| `day` | `T` | The day element: it is a `span` when not interactive, a `button` otherwise. | -| `day_disabled` | `T` | The day when disabled. | -| `day_hidden` | `T` | The day when hidden. | -| `day_outside` | `T` | The day when outside the month. | -| `day_range_end` | `T` | The day when at the end of a selected range. | -| `day_range_middle` | `T` | The day in the middle of a selected range: it does not include the "from" and the "to" days. | -| `day_range_start` | `T` | The day when at the start of a selected range. | -| `day_selected` | `T` | The day when selected. | -| `day_today` | `T` | The day when today. | -| `dropdown` | `T` | The drop-down (select) element. | -| `dropdown_icon` | `T` | The drop-down icon. | -| `dropdown_month` | `T` | The drop-down to change the month. | -| `dropdown_year` | `T` | The drop-down to change the year. | -| `head` | `T` | The table’s head. | -| `head_cell` | `T` | The head cell. | -| `head_row` | `T` | The row in the head. | -| `month` | `T` | The table wrapper. | -| `months` | `T` | The months wrapper. | -| `multiple_months` | `T` | The root element when `numberOfMonths > 1`. | -| `nav` | `T` | The navigation container. | -| `nav_button` | `T` | The navigation button. | -| `nav_button_next` | `T` | The "next month" navigation button. | -| `nav_button_previous` | `T` | The "previous month" navigation button. | -| `nav_icon` | `T` | The icon for the navigation button. | -| `root` | `T` | The root element. | -| `row` | `T` | The table’s row. | -| `table` | `T` | Table containing the monthly calendar. | -| `tbody` | `T` | The table body. | -| `tfoot` | `T` | The table footer. | -| `vhidden` | `T` | The style of an element visually hidden. | -| `weeknumber` | `T` | The weeknumber displayed in the column. | -| `with_weeknumber` | `T` | The root element when `showWeekNumber={true}`. | - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Styles.ts:4 diff --git a/docs/api/main/type-aliases/Styles.mdx b/docs/api/main/type-aliases/Styles.mdx deleted file mode 100644 index 36a36f1680..0000000000 --- a/docs/api/main/type-aliases/Styles.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: TypeAlias -title: Styles ---- - -# Type alias: Styles - -> **Styles**: `Partial`\<`Omit`\<[`StyledElement`](/docs/api/main/type-aliases/StyledElement.mdx)\<`CSSProperties`\>, [`InternalModifiersElement`](/docs/api/main/type-aliases/InternalModifiersElement.mdx)\>\> - -The inline-styles of each styled element, to use with the `styles` prop. Day -modifiers, such as `today` or `hidden`, should be styled using the -`modifiersStyles` prop. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Styles.ts:116 diff --git a/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx b/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx deleted file mode 100644 index 26a8b688c2..0000000000 --- a/docs/api/main/type-aliases/WeekNumberClickEventHandler.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: WeekNumberClickEventHandler ---- - -# Type alias: WeekNumberClickEventHandler - -> **WeekNumberClickEventHandler**: (`weekNumber`, `dates`, `e`) => `void` - -The event handler when the week number is clicked. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekNumber` | `number` | -| `dates` | `Date`[] | -| `e` | `MouseEvent` | - -## Returns - -`void` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/EventHandlers.ts:86 diff --git a/docs/api/main/type-aliases/WeekNumberFormatter.mdx b/docs/api/main/type-aliases/WeekNumberFormatter.mdx deleted file mode 100644 index b353d96db1..0000000000 --- a/docs/api/main/type-aliases/WeekNumberFormatter.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: WeekNumberFormatter ---- - -# Type alias: WeekNumberFormatter - -> **WeekNumberFormatter**: (`weekNumber`, `options`?) => `ReactNode` - -Represent a function to format the week number. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekNumber` | `number` | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`ReactNode` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Formatters.ts:30 diff --git a/docs/api/main/type-aliases/WeekNumberLabel.mdx b/docs/api/main/type-aliases/WeekNumberLabel.mdx deleted file mode 100644 index e5723e03ee..0000000000 --- a/docs/api/main/type-aliases/WeekNumberLabel.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: WeekNumberLabel ---- - -# Type alias: WeekNumberLabel - -> **WeekNumberLabel**: (`n`, `options`?) => `string` - -Return the ARIA label of the week number. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `n` | `number` | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`string` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Labels.ts:43 diff --git a/docs/api/main/type-aliases/WeekdayLabel.mdx b/docs/api/main/type-aliases/WeekdayLabel.mdx deleted file mode 100644 index 016cefe5d1..0000000000 --- a/docs/api/main/type-aliases/WeekdayLabel.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: TypeAlias -title: WeekdayLabel ---- - -# Type alias: WeekdayLabel - -> **WeekdayLabel**: (`day`, `options`?) => `string` - -Return the ARIA label for the Head component. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | `Date` | -| `options`? | `Object` | -| `options.locale`? | `Locale` | - -## Returns - -`string` - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/types/Labels.ts:35 diff --git a/docs/api/main/variables/DayPickerContext.mdx b/docs/api/main/variables/DayPickerContext.mdx deleted file mode 100644 index 415ad200cd..0000000000 --- a/docs/api/main/variables/DayPickerContext.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Variable -title: DayPickerContext ---- - -# Variable: DayPickerContext - -> **`const`** **DayPickerContext**: `Context`\<`undefined` \| [`DayPickerContextValue`](/docs/api/main/interfaces/DayPickerContextValue.mdx)\> - -The DayPicker context shares the props passed to DayPicker within internal -and custom components. It is used to set the default values and perform -one-time calculations required to render the days. - -Access to this context from the [useDayPicker](/docs/api/main/functions/useDayPicker.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/DayPicker/DayPickerContext.tsx:57 diff --git a/docs/api/main/variables/FocusContext.mdx b/docs/api/main/variables/FocusContext.mdx deleted file mode 100644 index 8b31d00db5..0000000000 --- a/docs/api/main/variables/FocusContext.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -section: Variable -title: FocusContext ---- - -# Variable: FocusContext - -> **`const`** **FocusContext**: `Context`\<`undefined` \| [`FocusContextValue`](/docs/api/main/type-aliases/FocusContextValue.mdx)\> - -The Focus context shares details about the focused day for the keyboard - -Access this context from the [useFocusContext](/docs/api/main/functions/useFocusContext.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Focus/FocusContext.tsx:53 diff --git a/docs/api/main/variables/NavigationContext.mdx b/docs/api/main/variables/NavigationContext.mdx deleted file mode 100644 index e060c5bbc9..0000000000 --- a/docs/api/main/variables/NavigationContext.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -section: Variable -title: NavigationContext ---- - -# Variable: NavigationContext - -> **`const`** **NavigationContext**: `Context`\<`undefined` \| [`NavigationContextValue`](/docs/api/main/interfaces/NavigationContextValue.mdx)\> - -The Navigation context shares details and methods to navigate the months in DayPicker. -Access this context from the [useNavigation](/docs/api/main/functions/useNavigation.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/Navigation/NavigationContext.tsx:33 diff --git a/docs/api/main/variables/SelectMultipleContext.mdx b/docs/api/main/variables/SelectMultipleContext.mdx deleted file mode 100644 index b8816528c5..0000000000 --- a/docs/api/main/variables/SelectMultipleContext.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -section: Variable -title: SelectMultipleContext ---- - -# Variable: SelectMultipleContext - -> **`const`** **SelectMultipleContext**: `Context`\<`undefined` \| [`SelectMultipleContextValue`](/docs/api/main/interfaces/SelectMultipleContextValue.mdx)\> - -The SelectMultiple context shares details about the selected days when in -multiple selection mode. - -Access this context from the [useSelectMultiple](/docs/api/main/functions/useSelectMultiple.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectMultiple/SelectMultipleContext.tsx:35 diff --git a/docs/api/main/variables/SelectRangeContext.mdx b/docs/api/main/variables/SelectRangeContext.mdx deleted file mode 100644 index d7793462e4..0000000000 --- a/docs/api/main/variables/SelectRangeContext.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -section: Variable -title: SelectRangeContext ---- - -# Variable: SelectRangeContext - -> **`const`** **SelectRangeContext**: `Context`\<`undefined` \| [`SelectRangeContextValue`](/docs/api/main/interfaces/SelectRangeContextValue.mdx)\> - -The SelectRange context shares details about the selected days when in -range selection mode. - -Access this context from the [useSelectRange](/docs/api/main/functions/useSelectRange.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectRange/SelectRangeContext.tsx:43 diff --git a/docs/api/main/variables/SelectSingleContext.mdx b/docs/api/main/variables/SelectSingleContext.mdx deleted file mode 100644 index fef611e99a..0000000000 --- a/docs/api/main/variables/SelectSingleContext.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -section: Variable -title: SelectSingleContext ---- - -# Variable: SelectSingleContext - -> **`const`** **SelectSingleContext**: `Context`\<`undefined` \| [`SelectSingleContextValue`](/docs/api/main/interfaces/SelectSingleContextValue.mdx)\> - -The SelectSingle context shares details about the selected days when in -single selection mode. - -Access this context from the [useSelectSingle](/docs/api/main/functions/useSelectSingle.mdx) hook. - -## Source - -node\_modules/.pnpm/react-day-picker@8.10.0\_date-fns@3.3.1\_react@18.2.0/node\_modules/react-day-picker/src/contexts/SelectSingle/SelectSingleContext.tsx:21 diff --git a/docs/api/next/classes/CalendarDay.mdx b/docs/api/next/classes/CalendarDay.mdx deleted file mode 100644 index 8993eb4d04..0000000000 --- a/docs/api/next/classes/CalendarDay.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -section: Class -title: CalendarDay ---- - -# Class: CalendarDay - -A day displayed in a month grid. - -## Constructors - -### new CalendarDay(date, displayMonth) - -> **new CalendarDay**(`date`, `displayMonth`): [`CalendarDay`](/docs/api/next/classes/CalendarDay.mdx) - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `date` | `Date` | -| `displayMonth` | `Date` | - -#### Returns - -[`CalendarDay`](/docs/api/next/classes/CalendarDay.mdx) - -#### Source - -[src/classes/CalendarDay.ts:6](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/classes/CalendarDay.ts#L6) - -## Properties - -| Property | Modifier | Type | Description | -| :------ | :------ | :------ | :------ | -| `date` | `readonly` | `Date` | The date represented by this Day. | -| `displayMonth` | `readonly` | `Date` | The months where the date is displayed | -| `outside` | `readonly` | `boolean` | In case of an outside day, the months where the date is displayed. | - -## Methods - -### isEqualTo() - -> **isEqualTo**(`day`): `boolean` - -Whether the day is the same as the given day. - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `day` | [`CalendarDay`](/docs/api/next/classes/CalendarDay.mdx) | - -#### Returns - -`boolean` - -#### Source - -[src/classes/CalendarDay.ts:22](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/classes/CalendarDay.ts#L22) diff --git a/docs/api/next/classes/Month.mdx b/docs/api/next/classes/Month.mdx deleted file mode 100644 index 9c11e314af..0000000000 --- a/docs/api/next/classes/Month.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -section: Class -title: Month ---- - -# Class: Month - -A month displayed in the month grid. Contains the weeks. - -## Constructors - -### new Month(month, weeks) - -> **new Month**(`month`, `weeks`): [`Month`](/docs/api/next/classes/Month.mdx) - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `month` | `Date` | -| `weeks` | [`Week`](/docs/api/next/classes/Week.mdx)[] | - -#### Returns - -[`Month`](/docs/api/next/classes/Month.mdx) - -#### Source - -[src/classes/CalendarMonth.ts:8](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/classes/CalendarMonth.ts#L8) - -## Properties - -| Property | Type | Description | -| :------ | :------ | :------ | -| `date` | `Date` | The date of the month. | -| `weeks` | [`Week`](/docs/api/next/classes/Week.mdx)[] | The weeks within the month. | diff --git a/docs/api/next/classes/Week.mdx b/docs/api/next/classes/Week.mdx deleted file mode 100644 index 86079287bd..0000000000 --- a/docs/api/next/classes/Week.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -section: Class -title: Week ---- - -# Class: Week - -A week displayed in a month grid. Contains the days. - -## Constructors - -### new Week(weekNumber, days) - -> **new Week**(`weekNumber`, `days`): [`Week`](/docs/api/next/classes/Week.mdx) - -#### Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekNumber` | `number` | -| `days` | [`CalendarDay`](/docs/api/next/classes/CalendarDay.mdx)[] | - -#### Returns - -[`Week`](/docs/api/next/classes/Week.mdx) - -#### Source - -[src/classes/CalendarWeek.ts:8](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/classes/CalendarWeek.ts#L8) - -## Properties - -| Property | Type | -| :------ | :------ | -| `days` | [`CalendarDay`](/docs/api/next/classes/CalendarDay.mdx)[] | -| `weekNumber` | `number` | diff --git a/docs/api/next/enumerations/UI.mdx b/docs/api/next/enumerations/UI.mdx deleted file mode 100644 index 564b6502b5..0000000000 --- a/docs/api/next/enumerations/UI.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -section: Enum -title: UI -deprecated: true ---- - -# Enumeration: ~~UI~~ - -The UI elements that can be styled. - -## Deprecated - -## Enumeration Members - -| Enumeration Member | Value | Description | -| :------ | :------ | :------ | -| `ButtonIcon` | `"button_icon"` | - | -| `ButtonNext` | `"button_next"` | - | -| `ButtonPrevious` | `"button_previous"` | - | -| `Caption` | `"caption"` | - | -| `CaptionBetween` | `"caption_between"` | - | -| `CaptionDropdowns` | `"caption_dropdowns"` | - | -| `CaptionEnd` | `"caption_end"` | - | -| `CaptionLabel` | `"caption_label"` | - | -| `CaptionStart` | `"caption_start"` | - | -| `Cell` | `"cell"` | - | -| `ContrastNoPreference` | `"contrast_no_preference"` | - | -| `Day` | `"day"` | - | -| `DayDisabled` | `"day_disabled"` | - | -| `DayExcluded` | `"day_excluded"` | - | -| `DayFocusable` | `"day_focusable"` | - | -| `DayFocused` | `"day_focused"` | - | -| `DayHidden` | `"day_hidden"` | - | -| `DayOutside` | `"day_outside"` | - | -| `DayRangeEnd` | `"day_range_end"` | - | -| `DayRangeMiddle` | `"day_range_middle"` | - | -| `DayRangeStart` | `"day_range_start"` | - | -| `DaySelected` | `"day_selected"` | - | -| `DayToday` | `"day_today"` | - | -| `Dropdown` | `"dropdown"` | - | -| `DropdownIcon` | `"dropdown_icon"` | - | -| `DropdownMonth` | `"dropdown_month"` | Modifiers added to the [Dropdown](/docs/api/next/enumerations/UI.mdx) root when displaying the months. | -| `DropdownNav` | `"dropdown_nav"` | The root element of the [DropdownNav](/docs/api/next/enumerations/UI.mdx) component. | -| `DropdownRoot` | `"dropdown_root"` | The root element of the [Dropdown](/docs/api/next/enumerations/UI.mdx) component. | -| `DropdownYear` | `"dropdown_year"` | Modifiers added to the [Dropdown](/docs/api/next/enumerations/UI.mdx) root when displaying the years. | -| `Footer` | `"footer"` | The root element of the [Footer](/docs/api/next/enumerations/UI.mdx) component. | -| `Head` | `"head"` | - | -| `HeadCell` | `"head_cell"` | - | -| `HeadRow` | `"head_row"` | - | -| `HideWeekdays` | `"hide_weekdays"` | TODO | -| `MonthCaption` | `"month_caption"` | - | -| `MonthGrid` | `"month_grid"` | - | -| `MonthGridWrapper` | `"month_grid_wrapper"` | - | -| `MonthRowGroup` | `"month_rowgroup"` | - | -| `MonthsDropdown` | `"months_dropdown"` | - | -| `MonthsWrapper` | `"months_wrapper"` | - | -| `MultipleMonths` | `"multiple_months"` | - | -| `Nav` | `"nav"` | - | -| `Root` | `"rdp"` | Represents the root element. | -| `Row` | `"row"` | - | -| `Select` | `"select"` | - | -| `WeekDayColumnHeader` | `"weekday_columnheader"` | - | -| `WeekDaysRow` | `"weekdays_row"` | - | -| `WeekNumberRowHeader` | `"weeknumber_rowheader"` | - | -| `WeekRow` | `"week_row"` | - | -| `WithWeekNumber` | `"with_weeknumber"` | - | diff --git a/docs/api/next/functions/Button.mdx b/docs/api/next/functions/Button.mdx deleted file mode 100644 index d94d83a064..0000000000 --- a/docs/api/next/functions/Button.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -section: Function -title: Button ---- - -# Function: Button() - -> **Button**(`props`): `Element` - -The component used to generate the button elements in the calendar. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `ButtonHTMLAttributes`\<`HTMLButtonElement`\> | - -## Returns - -`Element` - -## Author - -GP - -## Source - -[src/components/Button.tsx:8](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Button.tsx#L8) diff --git a/docs/api/next/functions/Chevron.mdx b/docs/api/next/functions/Chevron.mdx deleted file mode 100644 index 86caac8102..0000000000 --- a/docs/api/next/functions/Chevron.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: Function -title: Chevron ---- - -# Function: Chevron() - -> **Chevron**(`props`): `Element` - -Render the chevron icon used in the navigation buttons and dropdowns. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.orientation`? | `"up"` \| `"down"` \| `"left"` \| `"right"` | -| `props.size`? | `number` | - -## Returns - -`Element` - -## Source - -[src/components/Chevron.tsx:2](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Chevron.tsx#L2) diff --git a/docs/api/next/functions/DayGridCell.mdx b/docs/api/next/functions/DayGridCell.mdx deleted file mode 100644 index 3c52b34224..0000000000 --- a/docs/api/next/functions/DayGridCell.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: DayGridCell ---- - -# Function: DayGridCell() - -> **DayGridCell**(`props`): `Element` - -Render the gridcell of a day in the calendar. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayGridCellProps`](/docs/api/next/interfaces/DayGridCellProps.mdx) | - -## Returns - -`Element` - -## Source - -[src/components/DayGridCell.tsx:7](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/DayGridCell.tsx#L7) diff --git a/docs/api/next/functions/DayPicker.mdx b/docs/api/next/functions/DayPicker.mdx deleted file mode 100644 index fcc683085b..0000000000 --- a/docs/api/next/functions/DayPicker.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -section: Function -title: DayPicker ---- - -# Function: DayPicker() - -> **DayPicker**\<`T`\>(`props`): `Element` - -Render the date picker component. - -## Type parameters - -| Type parameter | Value | -| :------ | :------ | -| `T` extends [`Mode`](/docs/api/next/type-aliases/Mode.mdx) | `"none"` | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`DayPickerProps`](/docs/api/next/type-aliases/DayPickerProps.mdx)\<`T`\> | - -## Returns - -`Element` - -## Author - -xxx - -## See - -https://react-day-picker.js.org - -## Source - -[src/DayPicker.tsx:38](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/DayPicker.tsx#L38) diff --git a/docs/api/next/functions/DayPickerProvider.mdx b/docs/api/next/functions/DayPickerProvider.mdx deleted file mode 100644 index 3e0f96cf9b..0000000000 --- a/docs/api/next/functions/DayPickerProvider.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -section: Function -title: DayPickerProvider ---- - -# Function: DayPickerProvider() - -> **DayPickerProvider**\<`T`\>(`props`): `Element` - -The provider for the `dayPickerContext`, storing the props and setting its -defaults. Must be the root of all the providers. - -## Type parameters - -| Type parameter | -| :------ | -| `T` extends [`Mode`](/docs/api/next/type-aliases/Mode.mdx) | - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `PropsWithChildren`\<[`DayPickerProps`](/docs/api/next/type-aliases/DayPickerProps.mdx)\<`T`\>\> | - -## Returns - -`Element` - -## Source - -[src/contexts/DayPickerContext/DayPickerContext.tsx:50](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/contexts/DayPickerContext/DayPickerContext.tsx#L50) diff --git a/docs/api/next/functions/Dropdown.mdx b/docs/api/next/functions/Dropdown.mdx deleted file mode 100644 index 854eed9ccd..0000000000 --- a/docs/api/next/functions/Dropdown.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Dropdown ---- - -# Function: Dropdown() - -> **Dropdown**(`props`): `Element` - -Render a dropdown component to use in the navigation bar. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Object` & `Omit`\<`SelectHTMLAttributes`\<`HTMLSelectElement`\>, `"children"`\> | - -## Returns - -`Element` - -## Source - -[src/components/Dropdown.tsx:16](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Dropdown.tsx#L16) diff --git a/docs/api/next/functions/DropdownNav.mdx b/docs/api/next/functions/DropdownNav.mdx deleted file mode 100644 index b76d841239..0000000000 --- a/docs/api/next/functions/DropdownNav.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -section: Function -title: DropdownNav ---- - -# Function: DropdownNav() - -> **DropdownNav**(`props`): `Element` - -Render the dropdowns to navigate between months. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `props` | `Object` | - | -| `props.index` | `number` | The index where this month is displayed. | -| `props.month` | [`Month`](/docs/api/next/classes/Month.mdx) | The month where the dropdown navigation is displayed. | -| `props.showMonths`? | `boolean` | Whether the user can change the month. | -| `props.showYears`? | `boolean` | Whether the user can change the year. | - -## Returns - -`Element` - -## Source - -[src/components/DropdownNav.tsx:7](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/DropdownNav.tsx#L7) diff --git a/docs/api/next/functions/Footer.mdx b/docs/api/next/functions/Footer.mdx deleted file mode 100644 index 1a536a30e2..0000000000 --- a/docs/api/next/functions/Footer.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Footer ---- - -# Function: Footer() - -> **Footer**(`props`): `Element` - -Component wrapping the footer. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Pick`\<`HTMLProps`\<`HTMLElement`\>, `"children"` \| `"className"` \| `"style"`\> | - -## Returns - -`Element` - -## Source - -[src/components/Footer.tsx:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Footer.tsx#L4) diff --git a/docs/api/next/functions/MonthCaption.mdx b/docs/api/next/functions/MonthCaption.mdx deleted file mode 100644 index 4b3e827e12..0000000000 --- a/docs/api/next/functions/MonthCaption.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: MonthCaption ---- - -# Function: MonthCaption() - -> **MonthCaption**(`props`): `Element` - -Render the caption of a month in the calendar. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`MonthCaptionProps`](/docs/api/next/interfaces/MonthCaptionProps.mdx) | - -## Returns - -`Element` - -## Source - -[src/components/MonthCaption.tsx:14](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/MonthCaption.tsx#L14) diff --git a/docs/api/next/functions/MonthGrid.mdx b/docs/api/next/functions/MonthGrid.mdx deleted file mode 100644 index 43ebb57243..0000000000 --- a/docs/api/next/functions/MonthGrid.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -section: Function -title: MonthGrid ---- - -# Function: MonthGrid() - -> **MonthGrid**(`props`): `Element` - -Render the grid with the weekday header row and the weeks for the given -month. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `props` | `Object` | - | -| `props.aria-labelledby`? | `string` | - | -| `props.index` | `number` | The index where this month is displayed. | -| `props.month` | [`Month`](/docs/api/next/classes/Month.mdx) | The month where the grid is displayed. | - -## Returns - -`Element` - -## Source - -[src/components/MonthGrid.tsx:13](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/MonthGrid.tsx#L13) diff --git a/docs/api/next/functions/Months.mdx b/docs/api/next/functions/Months.mdx deleted file mode 100644 index dfed429725..0000000000 --- a/docs/api/next/functions/Months.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Months ---- - -# Function: Months() - -> **Months**(`props`): `Element` - -Component wrapping the month grids. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Pick`\<`HTMLProps`\<`HTMLElement`\>, `"children"` \| `"className"` \| `"style"`\> | - -## Returns - -`Element` - -## Source - -[src/components/Months.tsx:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Months.tsx#L4) diff --git a/docs/api/next/functions/MonthsDropdown.mdx b/docs/api/next/functions/MonthsDropdown.mdx deleted file mode 100644 index d50fa9ab81..0000000000 --- a/docs/api/next/functions/MonthsDropdown.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: MonthsDropdown ---- - -# Function: MonthsDropdown() - -> **MonthsDropdown**(`props`): `Element` - -Render the dropdown to change the month. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `props` | `Object` | - | -| `props.month` | [`Month`](/docs/api/next/classes/Month.mdx) | The month where the dropdown is displayed. | - -## Returns - -`Element` - -## Source - -[src/components/MonthsDropdown.tsx:12](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/MonthsDropdown.tsx#L12) diff --git a/docs/api/next/functions/Nav.mdx b/docs/api/next/functions/Nav.mdx deleted file mode 100644 index 4c53cf5602..0000000000 --- a/docs/api/next/functions/Nav.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Function -title: Nav ---- - -# Function: Nav() - -> **Nav**(): `Element` - -Render the navigation buttons to change the month. - -## Returns - -`Element` - -## Source - -[src/components/Nav.tsx:7](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Nav.tsx#L7) diff --git a/docs/api/next/functions/Option.mdx b/docs/api/next/functions/Option.mdx deleted file mode 100644 index be11dfd354..0000000000 --- a/docs/api/next/functions/Option.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Option ---- - -# Function: Option() - -> **Option**(`props`): `Element` - -Render the `option` element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `OptionHTMLAttributes`\<`HTMLOptionElement`\> | - -## Returns - -`Element` - -## Source - -[src/components/Option.tsx:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Option.tsx#L4) diff --git a/docs/api/next/functions/Select.mdx b/docs/api/next/functions/Select.mdx deleted file mode 100644 index 4a074cccc1..0000000000 --- a/docs/api/next/functions/Select.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: Select ---- - -# Function: Select() - -> **Select**(`props`): `Element` - -Render the `select` element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `SelectHTMLAttributes`\<`HTMLSelectElement`\> | - -## Returns - -`Element` - -## Source - -[src/components/Select.tsx:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/Select.tsx#L4) diff --git a/docs/api/next/functions/WeekNumberRowHeader.mdx b/docs/api/next/functions/WeekNumberRowHeader.mdx deleted file mode 100644 index 9a3672f8a2..0000000000 --- a/docs/api/next/functions/WeekNumberRowHeader.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: WeekNumberRowHeader ---- - -# Function: WeekNumberRowHeader() - -> **WeekNumberRowHeader**(`props`): `Element` - -Render the cell with the number of the week. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.week` | [`Week`](/docs/api/next/classes/Week.mdx) | - -## Returns - -`Element` - -## Source - -[src/components/WeekNumberRowHeader.tsx:5](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/WeekNumberRowHeader.tsx#L5) diff --git a/docs/api/next/functions/WeekRow.mdx b/docs/api/next/functions/WeekRow.mdx deleted file mode 100644 index 70c51b0abf..0000000000 --- a/docs/api/next/functions/WeekRow.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: WeekRow ---- - -# Function: WeekRow() - -> **WeekRow**(`props`): `Element` - -Render a row in the calendar, with the days and the week number. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | [`WeekRowProps`](/docs/api/next/interfaces/WeekRowProps.mdx) | - -## Returns - -`Element` - -## Source - -[src/components/WeekRow.tsx:9](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/WeekRow.tsx#L9) diff --git a/docs/api/next/functions/WeekdayColumnHeader.mdx b/docs/api/next/functions/WeekdayColumnHeader.mdx deleted file mode 100644 index 3000004db6..0000000000 --- a/docs/api/next/functions/WeekdayColumnHeader.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: Function -title: WeekdayColumnHeader ---- - -# Function: WeekdayColumnHeader() - -> **WeekdayColumnHeader**(`props`): `Element` - -Render the column header with the weekday name (e.g. "Mo", "Tu", etc.) - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `props` | `Object` | -| `props.aria-colindex`? | `number` | -| `props.aria-label`? | `string` | -| `props.weekday`? | `Date` | - -## Returns - -`Element` - -## Source - -[src/components/WeekdayColumnHeader.tsx:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/WeekdayColumnHeader.tsx#L4) diff --git a/docs/api/next/functions/WeekdaysRow.mdx b/docs/api/next/functions/WeekdaysRow.mdx deleted file mode 100644 index 69a4c0735b..0000000000 --- a/docs/api/next/functions/WeekdaysRow.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Function -title: WeekdaysRow ---- - -# Function: WeekdaysRow() - -> **WeekdaysRow**(): `Element` - -Render the row with the weekday names. - -## Returns - -`Element` - -## Source - -[src/components/WeekdaysRow.tsx:6](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/WeekdaysRow.tsx#L6) diff --git a/docs/api/next/functions/YearsDropdown.mdx b/docs/api/next/functions/YearsDropdown.mdx deleted file mode 100644 index de21851a66..0000000000 --- a/docs/api/next/functions/YearsDropdown.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: YearsDropdown ---- - -# Function: YearsDropdown() - -> **YearsDropdown**(`props`): `Element` - -Render the dropdown to change the year. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `props` | `Object` | - | -| `props.month` | [`Month`](/docs/api/next/classes/Month.mdx) | The month where the dropdown is displayed. | - -## Returns - -`Element` - -## Source - -[src/components/YearsDropdown.tsx:12](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/components/YearsDropdown.tsx#L12) diff --git a/docs/api/next/functions/formatCaption.mdx b/docs/api/next/functions/formatCaption.mdx deleted file mode 100644 index 6338d6ed6f..0000000000 --- a/docs/api/next/functions/formatCaption.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: formatCaption ---- - -# Function: formatCaption() - -> **formatCaption**(`month`, `options`?): `string` - -The default formatter for the caption element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `month` | `Date` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/formatters/formatCaption.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatCaption.ts#L4) diff --git a/docs/api/next/functions/formatDay.mdx b/docs/api/next/functions/formatDay.mdx deleted file mode 100644 index 365b434699..0000000000 --- a/docs/api/next/functions/formatDay.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: formatDay ---- - -# Function: formatDay() - -> **formatDay**(`date`, `options`?): `string` - -The default formatter for the day grid cell element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `date` | `Date` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/formatters/formatDay.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatDay.ts#L4) diff --git a/docs/api/next/functions/formatMonthCaption.mdx b/docs/api/next/functions/formatMonthCaption.mdx deleted file mode 100644 index cc24f2f6d2..0000000000 --- a/docs/api/next/functions/formatMonthCaption.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -section: Function -title: formatMonthCaption -deprecated: true ---- - -# Function: ~~formatMonthCaption()~~ - -> **formatMonthCaption**(`month`, `options`?): `string` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `month` | `Date` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Deprecated - -Use [formatCaption](/docs/api/next/functions/formatCaption.mdx) instead. - -## Source - -[src/formatters/formatCaption.ts:12](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatCaption.ts#L12) diff --git a/docs/api/next/functions/formatMonthDropdown.mdx b/docs/api/next/functions/formatMonthDropdown.mdx deleted file mode 100644 index f5db70b966..0000000000 --- a/docs/api/next/functions/formatMonthDropdown.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: formatMonthDropdown ---- - -# Function: formatMonthDropdown() - -> **formatMonthDropdown**(`monthNumber`, `locale`): `string` - -The default formatter for the month dropdown value. - -## Parameters - -| Parameter | Type | Default value | -| :------ | :------ | :------ | -| `monthNumber` | `Month` | `undefined` | -| `locale` | `Locale` | `enUS` | - -## Returns - -`string` - -## Source - -[src/formatters/formatMonthDropdown.ts:5](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatMonthDropdown.ts#L5) diff --git a/docs/api/next/functions/formatWeekNumber.mdx b/docs/api/next/functions/formatWeekNumber.mdx deleted file mode 100644 index 73fa380388..0000000000 --- a/docs/api/next/functions/formatWeekNumber.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: formatWeekNumber ---- - -# Function: formatWeekNumber() - -> **formatWeekNumber**(`weekNumber`, `options`?): `string` - -The default formatter for the week numbers. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekNumber` | `number` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/formatters/formatWeekNumber.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatWeekNumber.ts#L4) diff --git a/docs/api/next/functions/formatWeekdayName.mdx b/docs/api/next/functions/formatWeekdayName.mdx deleted file mode 100644 index 7410632324..0000000000 --- a/docs/api/next/functions/formatWeekdayName.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: formatWeekdayName ---- - -# Function: formatWeekdayName() - -> **formatWeekdayName**(`weekday`, `options`?): `string` - -The default formatter for the name of the weekday. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekday` | `Date` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/formatters/formatWeekdayName.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatWeekdayName.ts#L4) diff --git a/docs/api/next/functions/formatYearCaption.mdx b/docs/api/next/functions/formatYearCaption.mdx deleted file mode 100644 index 0ed179d60c..0000000000 --- a/docs/api/next/functions/formatYearCaption.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -section: Function -title: formatYearCaption -deprecated: true ---- - -# Function: ~~formatYearCaption()~~ - -> **formatYearCaption**(`year`): `string` - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `year` | `number` | - -## Returns - -`string` - -## Deprecated - -Use `formatYearDropdown` instead. - -## Source - -[src/formatters/formatYearDropdown.ts:7](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatYearDropdown.ts#L7) diff --git a/docs/api/next/functions/formatYearDropdown.mdx b/docs/api/next/functions/formatYearDropdown.mdx deleted file mode 100644 index 30aa072509..0000000000 --- a/docs/api/next/functions/formatYearDropdown.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: formatYearDropdown ---- - -# Function: formatYearDropdown() - -> **formatYearDropdown**(`year`): `string` - -The default formatter for the Year caption. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `year` | `number` | - -## Returns - -`string` - -## Source - -[src/formatters/formatYearDropdown.ts:2](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/formatters/formatYearDropdown.ts#L2) diff --git a/docs/api/next/functions/labelDay.mdx b/docs/api/next/functions/labelDay.mdx deleted file mode 100644 index 947bd52512..0000000000 --- a/docs/api/next/functions/labelDay.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -section: Function -title: labelDay ---- - -# Function: labelDay() - -> **labelDay**(`date`, `modifiers`, `options`): `string` - -Return the default ARIA label for the day button. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `date` | `Date` | -| `modifiers` | [`Modifiers`](/docs/api/next/type-aliases/Modifiers.mdx) | -| `options` | `undefined` \| `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelDay.ts:6](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelDay.ts#L6) diff --git a/docs/api/next/functions/labelMonthDropdown.mdx b/docs/api/next/functions/labelMonthDropdown.mdx deleted file mode 100644 index c05e431705..0000000000 --- a/docs/api/next/functions/labelMonthDropdown.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: labelMonthDropdown ---- - -# Function: labelMonthDropdown() - -> **labelMonthDropdown**(`options`?): `string` - -Return the default ARIA label for the WeekNumber element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelMonthDropdown.ts:5](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelMonthDropdown.ts#L5) diff --git a/docs/api/next/functions/labelNext.mdx b/docs/api/next/functions/labelNext.mdx deleted file mode 100644 index a04ac6559f..0000000000 --- a/docs/api/next/functions/labelNext.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: labelNext ---- - -# Function: labelNext() - -> **labelNext**(`month`, `options`?): `string` - -Return the default ARIA label for next month button. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `month` | `undefined` \| `Date` | Undefined where there's no next month no navigate to. | -| `options`? | `FormatOptions` | - | - -## Returns - -`string` - -## Source - -[src/labels/labelNext.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelNext.ts#L4) diff --git a/docs/api/next/functions/labelPrevious.mdx b/docs/api/next/functions/labelPrevious.mdx deleted file mode 100644 index 58dfdc3023..0000000000 --- a/docs/api/next/functions/labelPrevious.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: labelPrevious ---- - -# Function: labelPrevious() - -> **labelPrevious**(`month`, `options`?): `string` - -Return the default ARIA label for next month button. - -## Parameters - -| Parameter | Type | Description | -| :------ | :------ | :------ | -| `month` | `undefined` \| `Date` | Undefined where there's no previous month no navigate to. | -| `options`? | `FormatOptions` | - | - -## Returns - -`string` - -## Source - -[src/labels/labelPrevious.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelPrevious.ts#L4) diff --git a/docs/api/next/functions/labelWeekNumber.mdx b/docs/api/next/functions/labelWeekNumber.mdx deleted file mode 100644 index 0f845964dc..0000000000 --- a/docs/api/next/functions/labelWeekNumber.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: labelWeekNumber ---- - -# Function: labelWeekNumber() - -> **labelWeekNumber**(`weekNumber`, `options`?): `string` - -Return the default ARIA label for the week number element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `weekNumber` | `number` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelWeekNumber.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelWeekNumber.ts#L4) diff --git a/docs/api/next/functions/labelWeekNumberHeader.mdx b/docs/api/next/functions/labelWeekNumberHeader.mdx deleted file mode 100644 index 20f90f39b5..0000000000 --- a/docs/api/next/functions/labelWeekNumberHeader.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: labelWeekNumberHeader ---- - -# Function: labelWeekNumberHeader() - -> **labelWeekNumberHeader**(`options`?): `string` - -Return the default ARIA label for the week number header element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelWeekNumberHeader.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelWeekNumberHeader.ts#L4) diff --git a/docs/api/next/functions/labelWeekday.mdx b/docs/api/next/functions/labelWeekday.mdx deleted file mode 100644 index 47ae670088..0000000000 --- a/docs/api/next/functions/labelWeekday.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -section: Function -title: labelWeekday ---- - -# Function: labelWeekday() - -> **labelWeekday**(`date`, `options`?): `string` - -Return he default ARIA label for the Weekday element. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `date` | `Date` | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelWeekday.ts:4](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelWeekday.ts#L4) diff --git a/docs/api/next/functions/labelYearDropdown.mdx b/docs/api/next/functions/labelYearDropdown.mdx deleted file mode 100644 index 4158f9beba..0000000000 --- a/docs/api/next/functions/labelYearDropdown.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -section: Function -title: labelYearDropdown ---- - -# Function: labelYearDropdown() - -> **labelYearDropdown**(`options`?): `string` - -The default ARIA label for the years dropdown. - -## Parameters - -| Parameter | Type | -| :------ | :------ | -| `options`? | `FormatOptions` | - -## Returns - -`string` - -## Source - -[src/labels/labelYearDropdown.ts:5](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/labels/labelYearDropdown.ts#L5) diff --git a/docs/api/next/functions/useCalendar.mdx b/docs/api/next/functions/useCalendar.mdx deleted file mode 100644 index 4043187693..0000000000 --- a/docs/api/next/functions/useCalendar.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: Function -title: useCalendar ---- - -# Function: useCalendar() - -> **useCalendar**(): [`CalendarContext`](/docs/api/next/interfaces/CalendarContext.mdx) - -Use this hook to access the [CalendarContext](/docs/api/next/interfaces/CalendarContext.mdx) from custom components. - -## Returns - -[`CalendarContext`](/docs/api/next/interfaces/CalendarContext.mdx) - -## See - -http://localhost:2001/docs/custom-components - -## Source - -[src/contexts/CalendarContext/CalendarContext.tsx:193](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/contexts/CalendarContext/CalendarContext.tsx#L193) diff --git a/docs/api/next/functions/useDayPicker.mdx b/docs/api/next/functions/useDayPicker.mdx deleted file mode 100644 index 5e9e59b6b6..0000000000 --- a/docs/api/next/functions/useDayPicker.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -section: Function -title: useDayPicker ---- - -# Function: useDayPicker() - -> **useDayPicker**(): [`DayPickerContext`](/docs/api/next/interfaces/DayPickerContext.mdx)\<[`Mode`](/docs/api/next/type-aliases/Mode.mdx)\> - -Use this hook to access to the DayPicker context within Custom Components. - -## Returns - -[`DayPickerContext`](/docs/api/next/interfaces/DayPickerContext.mdx)\<[`Mode`](/docs/api/next/type-aliases/Mode.mdx)\> - -## Source - -[src/contexts/DayPickerContext/DayPickerContext.tsx:91](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/contexts/DayPickerContext/DayPickerContext.tsx#L91) diff --git a/docs/api/next/functions/useSelection.mdx b/docs/api/next/functions/useSelection.mdx deleted file mode 100644 index bb444f6ea4..0000000000 --- a/docs/api/next/functions/useSelection.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -section: Function -title: useSelection ---- - -# Function: useSelection() - -> **useSelection**(): [`SelectionContext`](/docs/api/next/interfaces/SelectionContext.mdx) - -Use this hook to access the [SelectionContext](/docs/api/next/interfaces/SelectionContext.mdx) from custom components. - -## Returns - -[`SelectionContext`](/docs/api/next/interfaces/SelectionContext.mdx) - -## See - -http://localhost:2001/docs/custom-components - -## Source - -[src/contexts/SelectionContext/SelectionContext.tsx:218](https://github.com/gpbl/react-day-picker/blob/854070dd0/src/contexts/SelectionContext/SelectionContext.tsx#L218) diff --git a/docs/api/next/index.mdx b/docs/api/next/index.mdx deleted file mode 100644 index 9bad9184c6..0000000000 --- a/docs/api/next/index.mdx +++ /dev/null @@ -1,117 +0,0 @@ -# API Reference v9.0.0-alpha.1 - -## Enumerations - -| Enumeration | Description | -| :------ | :------ | -| [UI](/docs/api/next/enumerations/UI.mdx) | The UI elements that can be styled. | - -## Classes - -| Class | Description | -| :------ | :------ | -| [CalendarDay](/docs/api/next/classes/CalendarDay.mdx) | A day displayed in a month grid. | -| [Month](/docs/api/next/classes/Month.mdx) | A month displayed in the month grid. Contains the weeks. | -| [Week](/docs/api/next/classes/Week.mdx) | A week displayed in a month grid. Contains the days. | - -## Interfaces - -| Interface | Description | -| :------ | :------ | -| [CalendarContext](/docs/api/next/interfaces/CalendarContext.mdx) | Share the calendar state and navigation methods across the components. | -| [DayGridCellProps](/docs/api/next/interfaces/DayGridCellProps.mdx) | - | -| [DayPickerContext](/docs/api/next/interfaces/DayPickerContext.mdx) | The base props for the [DayPicker](/docs/api/next/functions/DayPicker.mdx) component.

These props are used to change the navigation, the styling and the behavior
of the calendar. | -| [ModeProp](/docs/api/next/interfaces/ModeProp.mdx) | - | -| [ModePropsMap](/docs/api/next/interfaces/ModePropsMap.mdx) | Map of the props supported by selection modes. | -| [MonthCaptionProps](/docs/api/next/interfaces/MonthCaptionProps.mdx) | - | -| [PropsBase](/docs/api/next/interfaces/PropsBase.mdx) | The base props for the [DayPicker](/docs/api/next/functions/DayPicker.mdx) component.

These props are used to change the navigation, the styling and the behavior
of the calendar. | -| [PropsMulti](/docs/api/next/interfaces/PropsMulti.mdx) | The props for the multi selection mode. | -| [PropsRange](/docs/api/next/interfaces/PropsRange.mdx) | The props for the range selection mode. | -| [PropsSingle](/docs/api/next/interfaces/PropsSingle.mdx) | The props for the single selection mode. | -| [SelectionContext](/docs/api/next/interfaces/SelectionContext.mdx) | Share the selected days and the selection methods across the components. | -| [WeekRowProps](/docs/api/next/interfaces/WeekRowProps.mdx) | - | - -## Type Aliases - -| Type alias | Description | -| :------ | :------ | -| [CaptionLayout](/docs/api/next/type-aliases/CaptionLayout.mdx) | Set the layout of the caption. | -| [ClassNames](/docs/api/next/type-aliases/ClassNames.mdx) | - | -| [CustomComponents](/docs/api/next/type-aliases/CustomComponents.mdx) | The components that can be changed using the [PropsBase.components](/docs/api/next/interfaces/PropsBase.mdx)
components prop. | -| [DateAfter](/docs/api/next/type-aliases/DateAfter.mdx) | A matcher to match a day falling after the specified date, with the date not
included. | -| [DateBefore](/docs/api/next/type-aliases/DateBefore.mdx) | A matcher to match a day falling before the specified date, with the date not
included.
`x test ` | -| [DateInterval](/docs/api/next/type-aliases/DateInterval.mdx) | A matcher to match a day falling before and/or after two dates, where the
dates are not included. | -| [DateRange](/docs/api/next/type-aliases/DateRange.mdx) | A matcher to match a range of dates. The range can be open. Differently from
`DateInterval`, the dates here are included. | -| [DayClickEventHandler](/docs/api/next/type-aliases/DayClickEventHandler.mdx) | The event handler when a day is clicked. | -| [DayEventHandler](/docs/api/next/type-aliases/DayEventHandler.mdx) | - | -| [DayFocusEventHandler](/docs/api/next/type-aliases/DayFocusEventHandler.mdx) | The event handler when a day is focused. | -| [DayKeyboardEventHandler](/docs/api/next/type-aliases/DayKeyboardEventHandler.mdx) | The event handler when a day gets a keyboard event. | -| [DayMouseEventHandler](/docs/api/next/type-aliases/DayMouseEventHandler.mdx) | The event handler when a day gets a mouse event. | -| [DayOfWeek](/docs/api/next/type-aliases/DayOfWeek.mdx) | A matcher to match a date being one of the specified days of the week (`0-7`,
where `0` is Sunday). | -| [DayPickerProps](/docs/api/next/type-aliases/DayPickerProps.mdx) | Defines the props accepted by the DayPicker component. | -| [DayPointerEventHandler](/docs/api/next/type-aliases/DayPointerEventHandler.mdx) | The event handler when a day gets a pointer event. | -| [DayTouchEventHandler](/docs/api/next/type-aliases/DayTouchEventHandler.mdx) | The event handler when a day gets a touch event. | -| [DropdownOption](/docs/api/next/type-aliases/DropdownOption.mdx) | An option to use in the dropdown. Maps to the `