react-day-picker 8.9.1 → 8.10.1

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Giampaolo Bellavite <io@gpbl.dev> and contributors
+Copyright (c) 2014-2024 Giampaolo Bellavite <io@gpbl.dev> and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -4,13 +4,11 @@
 
 ➡️ **[react-day-picker.js.org](http://react-day-picker.js.org)** for guides, examples and API reference.
 
-<a href="http://react-day-picker.js.org">
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcSet="https://user-images.githubusercontent.com/120693/188241991-19d0e8a1-230a-48c8-8477-3c90d4e36197.png"/>
-    <source media="(prefers-color-scheme: light)" srcSet="https://user-images.githubusercontent.com/120693/188238076-311ec6d1-503d-4c21-8ffe-d89faa60e40f.png"/>
-    <img alt="Shows a screenshot of the React DayPicker component in a browser’s window." width="900" />
-  </picture>
-</a>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcSet="https://user-images.githubusercontent.com/120693/188241991-19d0e8a1-230a-48c8-8477-3c90d4e36197.png"/>
+  <source media="(prefers-color-scheme: light)" srcSet="https://user-images.githubusercontent.com/120693/188238076-311ec6d1-503d-4c21-8ffe-d89faa60e40f.png"/>
+  <img alt="Shows a screenshot of the React DayPicker component in a browser’s window." width="900" />
+</picture>
 
 ## Main features
 
@@ -32,15 +30,7 @@ pnpm install react-day-picker date-fns # using pnpm
 yarn add react-day-picker date-fns     # using yarn
 ```
 
-<a href="https://www.npmjs.com/package/react-day-picker">
-  <img src="https://img.shields.io/npm/v/react-day-picker.svg?style=flat-square" alt="npm version"/>
-</a> <a href="http://npm-stat.com/charts.html?package=react-day-picker">
-  <img src="https://img.shields.io/npm/dm/react-day-picker.svg?style=flat-square" alt="npm downloads"/>
-</a> <a href="https://github.com/gpbl/react-day-picker/stargazers">
-<img src="https://img.shields.io/github/stars/gpbl/react-day-picker?style=flat-square" alt="stars"/>
-</a> <a href="https://github.com/sponsors/gpbl">
-  <img src="https://img.shields.io/github/sponsors/gpbl?style=flat-square" alt="sponsors"/>
-</a>
+<a href="https://www.npmjs.com/package/react-day-picker"><img src="https://img.shields.io/npm/v/react-day-picker.svg?style=flat-square" alt="npm version"/></a> <img src="https://img.shields.io/npm/dm/react-day-picker.svg?style=flat-square" alt="npm downloads"/> <img src="https://img.shields.io/bundlephobia/minzip/react-day-picker" alt="Min gzipped size"/>
 
 ## Example
 

package/dist/index.d.ts

@@ -68,12 +68,12 @@ declare function Day(props: DayProps): JSX.Element;
  * 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)];
+ * 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); };
+ * 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); };
+ * const beforeMatcher: DateBefore = { before: new Date(2019, 1, 2) };
  *
  * // will match Sundays
  * const dayOfWeekMatcher: DayOfWeek = {
@@ -82,13 +82,13 @@ declare function Day(props: DayProps): JSX.Element;
  *
  * // will match the included days, except the two dates
  * const intervalMatcher: DateInterval = {
- *    after: new Date(2019, 1, 2);,
+ *    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);,
+ *    from: new Date(2019, 1, 2),
  *    to: new Date(2019, 1, 5)
  * };
  *
@@ -120,7 +120,7 @@ type DateRange = {
     from: Date | undefined;
     to?: Date | undefined;
 };
-/** A matcher to match a date being one of the specified days of the week (`0-7`, where `0` is Sunday). */
+/** A matcher to match a date being one of the specified days of the week (`0-6`, where `0` is Sunday). */
 type DayOfWeek = {
     dayOfWeek: number[];
 };
@@ -626,22 +626,23 @@ interface DayPickerBase {
     /**
      * The index of the first day of the week (0 - Sunday). Overrides the locale's one.
      *
-     * See also {@link ISOWeek}.
+     * @see {@link ISOWeek}.
      */
     weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
     /**
-     * The day of January, which is always in the first week of the year. See also
-     * https://date-fns.org/docs/getWeek and
-     * https://en.wikipedia.org/wiki/Week#Numbering
+     * The day of January, which is always in the first week of the year. Can be
+     * either Monday (`1`) or Thursday (`4`).
      *
-     * See also {@link ISOWeek}.
+     * @see https://date-fns.org/docs/getWeek
+     * @see https://en.wikipedia.org/wiki/Week#Numbering
+     * @see {@link ISOWeek}.
      */
-    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    firstWeekContainsDate?: 1 | 4;
     /**
-     * Use ISO week dates instead of the locale setting. See also
-     * https://en.wikipedia.org/wiki/ISO_week_date.
+     * Use ISO week dates instead of the locale setting. Setting this prop will
+     * ignore {@link weekStartsOn} and {@link firstWeekContainsDate}.
      *
-     * Setting this prop will ignore {@link weekStartsOn} and {@link firstWeekContainsDate}.
+     * @see https://en.wikipedia.org/wiki/ISO_week_date
      */
     ISOWeek?: boolean;
     /**
@@ -791,9 +792,7 @@ interface DayPickerBase {
 /**
  * Map of the components that can be changed using the `components` prop.
  *
- * Look at the [components
- * source](https://github.com/gpbl/react-day-picker/tree/main/src/components)
- * to understand how internal components are built.
+ * @see https://github.com/gpbl/react-day-picker/tree/main/src/components
  */
 interface CustomComponents {
     /** The component for the caption element. */
@@ -1219,10 +1218,11 @@ declare function NavigationProvider(props: {
  */
 declare function useNavigation(): NavigationContextValue;
 
+type RootContextProps = Partial<DayPickerDefaultProps> | Partial<DayPickerSingleProps> | Partial<DayPickerMultipleProps> | Partial<DayPickerRangeProps>;
 /** The props of {@link RootProvider}. */
-interface RootContext {
+type RootContext = RootContextProps & {
     children?: ReactNode;
-}
+};
 /** Provide the value for all the context providers. */
 declare function RootProvider(props: RootContext): JSX.Element;
 
@@ -1360,4 +1360,4 @@ declare function isMatch(day: Date, matchers: Matcher[]): boolean;
  */
 declare function addToRange(day: Date, range?: DateRange): DateRange | undefined;
 
-export { ActiveModifiers, Button, ButtonProps, Caption, CaptionDropdowns, CaptionLabel, CaptionLabelProps, CaptionLayout, CaptionNavigation, CaptionProps, ClassNames, CustomComponents, CustomModifiers, DateAfter, DateBefore, DateFormatter, DateInterval, DateRange, Day, DayClickEventHandler, DayContent, DayContentProps, DayFocusEventHandler, DayKeyboardEventHandler, DayLabel, DayModifiers, DayMouseEventHandler, DayOfWeek, DayPicker, DayPickerBase, DayPickerContext, DayPickerContextValue, DayPickerDefaultProps, DayPickerMultipleProps, DayPickerProps, DayPickerProvider, DayPickerProviderProps, DayPickerRangeProps, DayPickerSingleProps, DayPointerEventHandler, DayProps, DayRender, DaySelectionMode, DayTouchEventHandler, Dropdown, DropdownProps, FocusContext, FocusContextValue, FocusProvider, FocusProviderProps, Footer, FooterProps, Formatters, Head, HeadRow, IconDropdown, IconLeft, IconRight, InputDayPickerProps, InputProps, InternalModifier, InternalModifiers, InternalModifiersElement, Labels, Matcher, Modifier, Modifiers, ModifiersClassNames, ModifiersStyles, MonthChangeEventHandler, Months, MonthsProps, NavButtonLabel, NavigationContext, NavigationContextValue, NavigationProvider, RootContext, RootProvider, Row, RowProps, SelectMultipleContext, SelectMultipleContextValue, SelectMultipleEventHandler, SelectMultipleModifiers, SelectMultipleProvider, SelectMultipleProviderInternal, SelectMultipleProviderInternalProps, SelectMultipleProviderProps, SelectRangeContext, SelectRangeContextValue, SelectRangeEventHandler, SelectRangeModifiers, SelectRangeProvider, SelectRangeProviderInternal, SelectRangeProviderInternalProps, SelectRangeProviderProps, SelectSingleContext, SelectSingleContextValue, SelectSingleEventHandler, SelectSingleProvider, SelectSingleProviderInternal, SelectSingleProviderProps, StyledComponent, StyledElement, Styles, UseInputOptions, UseInputValue, WeekNumber, WeekNumberClickEventHandler, WeekNumberFormatter, WeekNumberLabel, WeekNumberProps, WeekdayLabel, addToRange, isDateAfterType, isDateBeforeType, isDateInterval, isDateRange, isDayOfWeekType, isDayPickerDefault, isDayPickerMultiple, isDayPickerRange, isDayPickerSingle, isMatch, useActiveModifiers, useDayPicker, useDayRender, useFocusContext, useInput, useNavigation, useSelectMultiple, useSelectRange, useSelectSingle };
+export { type ActiveModifiers, Button, type ButtonProps, Caption, CaptionDropdowns, CaptionLabel, type CaptionLabelProps, type CaptionLayout, CaptionNavigation, type CaptionProps, type ClassNames, type CustomComponents, type CustomModifiers, type DateAfter, type DateBefore, type DateFormatter, type DateInterval, type DateRange, Day, type DayClickEventHandler, DayContent, type DayContentProps, type DayFocusEventHandler, type DayKeyboardEventHandler, type DayLabel, type DayModifiers, type DayMouseEventHandler, type DayOfWeek, DayPicker, type DayPickerBase, DayPickerContext, type DayPickerContextValue, type DayPickerDefaultProps, type DayPickerMultipleProps, type DayPickerProps, DayPickerProvider, type DayPickerProviderProps, type DayPickerRangeProps, type DayPickerSingleProps, type DayPointerEventHandler, type DayProps, type DayRender, type DaySelectionMode, type DayTouchEventHandler, Dropdown, type DropdownProps, FocusContext, type FocusContextValue, FocusProvider, type FocusProviderProps, Footer, type FooterProps, type Formatters, Head, HeadRow, IconDropdown, IconLeft, IconRight, type InputDayPickerProps, type InputProps, InternalModifier, type InternalModifiers, type InternalModifiersElement, type Labels, type Matcher, type Modifier, type Modifiers, type ModifiersClassNames, type ModifiersStyles, type MonthChangeEventHandler, Months, type MonthsProps, type NavButtonLabel, NavigationContext, type NavigationContextValue, NavigationProvider, type RootContext, RootProvider, Row, type RowProps, SelectMultipleContext, type SelectMultipleContextValue, type SelectMultipleEventHandler, type SelectMultipleModifiers, SelectMultipleProvider, SelectMultipleProviderInternal, type SelectMultipleProviderInternalProps, type SelectMultipleProviderProps, SelectRangeContext, type SelectRangeContextValue, type SelectRangeEventHandler, type SelectRangeModifiers, SelectRangeProvider, SelectRangeProviderInternal, type SelectRangeProviderInternalProps, type SelectRangeProviderProps, SelectSingleContext, type SelectSingleContextValue, type SelectSingleEventHandler, SelectSingleProvider, SelectSingleProviderInternal, type SelectSingleProviderProps, type StyledComponent, type StyledElement, type Styles, type UseInputOptions, type UseInputValue, WeekNumber, type WeekNumberClickEventHandler, type WeekNumberFormatter, type WeekNumberLabel, type WeekNumberProps, type WeekdayLabel, addToRange, isDateAfterType, isDateBeforeType, isDateInterval, isDateRange, isDayOfWeekType, isDayPickerDefault, isDayPickerMultiple, isDayPickerRange, isDayPickerSingle, isMatch, useActiveModifiers, useDayPicker, useDayRender, useFocusContext, useInput, useNavigation, useSelectMultiple, useSelectRange, useSelectSingle };