react-day-picker 8.0.0-beta.38 → 8.0.0-beta.39

package/CHANGELOG.md

@@ -18,6 +18,13 @@ See the preview website at https://react-day-picker-next.netlify.app.
 
 ---
 
+### v8.0.0-beta.39
+
+- chore: cleaned up icon components
+- chore: exported `isMatch` function
+- fix: useNavigation not setting the start of the month
+- chore: completed unit tests
+
 ### v8.0.0-beta.38
 
 - fix(regression): restore missing `Caption` component

package/dist/DayPicker.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { DayPickerProps } from './types/DayPicker';
 import { DayPickerCustomProps } from './types/DayPickerCustom';
 import { DayPickerMultipleProps } from './types/DayPickerMultiple';

package/dist/components/Caption/Caption.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /** Represent the props of the [[Caption]] component. */
 export interface CaptionProps {
     /** The ID for the heading element. Must be the same as the labelled-by in Table. */

package/dist/components/CaptionLabel/CaptionLabel.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /** The props for the [[CaptionLabel]] component. */
 export interface CaptionLabelProps {
     /** The ID for the heading element. Must be the same as the labelled-by in Table. */

package/dist/components/Day/Day.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /** Represent the props used by the [[Day]] component. */
 export interface DayProps {
     /** The month where the date is displayed. */

package/dist/components/DayContent/DayContent.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { ActiveModifiers } from '../../types/Modifiers';
 /** Represent the props for the [[DayContent]] component. */
 export interface DayContentProps {

package/dist/components/Footer/Footer.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 /** Render the Footer component (empty as default).*/
 export declare function Footer(): JSX.Element;

package/dist/components/Head/Head.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * Render the Head component - i.e. the table head with the weekday names.
  */

package/dist/components/IconDropdown/IconDropdown.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { StyledComponent } from '../../types/Styles';
 /**
  * Render the icon in the styled drop-down.

package/dist/components/IconLeft/IconLeft.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { StyledComponent } from '../../types/Styles';
 /**
  * Render the "previous month" button in the navigation.

package/dist/components/IconRight/IconRight.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { StyledComponent } from '../../types/Styles';
 /**
  * Render the "next month" button in the navigation.

package/dist/components/Month/Month.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /** The props for the [[Month]] component. */
 export interface MonthProps {
     displayIndex: number;

package/dist/components/MonthsDropdown/MonthsDropdown.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { MonthChangeEventHandler } from '../../types/EventHandlers';
 /** The props for the [[MonthsDropdown]] component. */
 export interface MonthsDropdownProps {

package/dist/components/Root/Root.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 /** Render the container with the months according to the number of months to display. */
 export declare function Root(): JSX.Element;

package/dist/components/Row/Row.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * The props for the [[Row]] component.
  */

package/dist/components/Table/Table.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /** The props for the [[Table]] component. */
 export interface TableProps {
     /** The ID of the label of the table (the same given to the Caption). */

package/dist/components/Table/utils/daysToMonthWeeks.d.ts

@@ -0,0 +1,8 @@
+import { Locale } from 'date-fns';
+import { MonthWeek } from './getMonthWeeks';
+/** Return the weeks between two dates.  */
+export declare function daysToMonthWeeks(fromDate: Date, toDate: Date, options?: {
+    locale?: Locale;
+    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+}): MonthWeek[];

package/dist/components/Table/utils/getMonthWeeks.d.ts

@@ -0,0 +1,21 @@
+import { Locale } from 'date-fns';
+/** Represents a week in the month.*/
+export declare type MonthWeek = {
+    /** The week number from the start of the year. */
+    weekNumber: number;
+    /** The dates in the week. */
+    dates: Date[];
+};
+/**
+ * Return the weeks belonging to the given month, adding the "outside days" to
+ * the first and last week.
+ */
+export declare function getMonthWeeks(
+/** The month to get the weeks from */
+month: Date, options: {
+    locale: Locale;
+    /** Add extra weeks up to 6 weeks */
+    useFixedWeeks?: boolean;
+    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+}): MonthWeek[];

package/dist/components/WeekNumber/WeekNumber.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * The props for the [[WeekNumber]] component.
  */

package/dist/components/YearsDropdown/YearsDropdown.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { MonthChangeEventHandler } from '../../types/EventHandlers';
 /**
  * The props for the [[YearsDropdown]] component.

package/dist/contexts/Modifiers/utils/isMatch.d.ts

@@ -1,3 +1,19 @@
 import { Matcher } from '../../../types/Matchers';
-/** Returns `true` whether the day matches against the given matchers. */
+/**
+ * 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.
+ * ```
+ * */
 export declare function isMatch(day: Date, matchers: Matcher[]): boolean;

package/dist/contexts/Navigation/NavigationContext.d.ts

@@ -1,8 +1,8 @@
 import React, { ReactNode } from 'react';
 /** Represents the value of the [[NavigationContext]]. */
 export interface NavigationContextValue {
-    /** The current month. Note that when `numberOfMonths > 1` represent the first month in the displayed months. */
-    month: Date;
+    /** The month to display in the calendar. Note that when `numberOfMonths > 1` represent the first month in the displayed months. */
+    currentMonth: Date;
     /** The months rendered by DayPicker. DayPicker can render one than one month via `numberOfMonths`. */
     displayMonths: Date[];
     /** Navigate to the specified month. */
@@ -13,7 +13,7 @@ export interface NavigationContextValue {
     nextMonth?: Date;
     /** The previous month to display. `undefined` if no months left */
     previousMonth?: Date;
-    /** Return true if the day is displayed in the calendar. */
+    /** Return true if the day is currently included in the months displayed in the calendar. */
     isDateDisplayed: (day: Date) => boolean;
 }
 /**

package/dist/index.d.ts

@@ -33,3 +33,4 @@ export * from './types/Labels';
 export * from './types/Matchers';
 export * from './types/Modifiers';
 export * from './types/Styles';
+export * from './contexts/Modifiers/utils/isMatch';