react-day-picker 10.0.0-next.2 → 10.0.0-next.4

package/README.md

@@ -31,6 +31,13 @@ DayPicker is written in TypeScript and compiled to CommonJS and ESM. It relies o
 npm install react-day-picker
 ```
 
+If you are trying the v10 prereleases with one of the alternative calendar
+integrations, install both packages together. For example:
+
+```bash
+npm install react-day-picker@next @daypicker/persian@next
+```
+
 <a href="https://www.npmjs.com/package/react-day-picker"><img src="https://img.shields.io/npm/v/react-day-picker" alt="npm version"/></a> <img src="https://img.shields.io/npm/dm/react-day-picker.svg" alt="npm downloads"/> <img src="https://img.shields.io/bundlephobia/minzip/react-day-picker" alt="Min gzipped size"/>
 
 ## Example

package/dist/cjs/UI.d.ts

@@ -79,8 +79,8 @@ export declare enum DayFlag {
     today = "today"
 }
 /**
- * Enum representing selection states that can be applied to the {@link UI | UI.Day}
- * element in selection mode.
+ * Enum representing selection states that can be applied to the
+ * {@link UI | UI.Day} element in selection mode.
  */
 export declare enum SelectionState {
     /** The day is at the end of a selected range. */

package/dist/cjs/UI.js

@@ -84,8 +84,8 @@ var DayFlag;
     DayFlag["today"] = "today";
 })(DayFlag || (exports.DayFlag = DayFlag = {}));
 /**
- * Enum representing selection states that can be applied to the {@link UI | UI.Day}
- * element in selection mode.
+ * Enum representing selection states that can be applied to the
+ * {@link UI | UI.Day} element in selection mode.
  */
 var SelectionState;
 (function (SelectionState) {

package/dist/cjs/types/props.d.ts

@@ -356,8 +356,8 @@ export interface PropsBase {
     /**
      * Add the language tag to the container element.
      *
-     * When omitted, DayPicker uses the active locale code (`locale.code`).
-     * Set this prop to override the language tag.
+     * When omitted, DayPicker uses the active locale code (`locale.code`). Set
+     * this prop to override the language tag.
      */
     lang?: HTMLDivElement["lang"];
     /**

package/dist/cjs/useCalendar.d.ts

@@ -1,18 +1,18 @@
 import type { CalendarDay, CalendarMonth, CalendarWeek, DateLib } from "./classes/index.js";
 import type { DayPickerProps } from "./types/props.js";
 /**
- * Return the calendar object to work with the calendar in custom components.
+ * Returns the calendar object used by DayPicker custom components.
  *
  * @see https://daypicker.dev/guides/custom-components
  */
 export interface Calendar {
     /**
-     * All the days displayed in the calendar. As opposite from
-     * {@link CalendarContext.dates}, it may return duplicated dates when shown
+     * All the days displayed in the calendar. Unlike
+     * {@link CalendarContext.dates}, it may contain duplicated dates when shown
      * outside the month.
      */
     days: CalendarDay[];
-    /** The months displayed in the calendar. */
+    /** The weeks displayed in the calendar. */
     weeks: CalendarWeek[];
     /** The months displayed in the calendar. */
     months: CalendarMonth[];
@@ -27,19 +27,16 @@ export interface Calendar {
     navStart: Date | undefined;
     /**
      * The month where the navigation ends. `undefined` if the calendar can be
-     * navigated indefinitely to the past.
+     * navigated indefinitely to the future.
      */
     navEnd: Date | undefined;
     /** Navigate to the specified month. Will fire the `onMonthChange` callback. */
     goToMonth: (month: Date) => void;
     /**
-     * Navigate to the specified date. If the second parameter (refDate) is
-     * provided and the date is before the refDate, then the month is set to one
-     * month before the date.
+     * Navigate to the month containing the specified day when it falls outside
+     * the currently displayed calendar.
      *
      * @param day - The date to navigate to.
-     * @param dateToCompare - Optional. If `date` is before `dateToCompare`, the
-     *   month is set to one month before the date.
      */
     goToDay: (day: CalendarDay) => void;
 }

package/dist/esm/UI.d.ts

@@ -79,8 +79,8 @@ export declare enum DayFlag {
     today = "today"
 }
 /**
- * Enum representing selection states that can be applied to the {@link UI | UI.Day}
- * element in selection mode.
+ * Enum representing selection states that can be applied to the
+ * {@link UI | UI.Day} element in selection mode.
  */
 export declare enum SelectionState {
     /** The day is at the end of a selected range. */

package/dist/esm/UI.js

@@ -81,8 +81,8 @@ export var DayFlag;
     DayFlag["today"] = "today";
 })(DayFlag || (DayFlag = {}));
 /**
- * Enum representing selection states that can be applied to the {@link UI | UI.Day}
- * element in selection mode.
+ * Enum representing selection states that can be applied to the
+ * {@link UI | UI.Day} element in selection mode.
  */
 export var SelectionState;
 (function (SelectionState) {

package/dist/esm/types/props.d.ts

@@ -356,8 +356,8 @@ export interface PropsBase {
     /**
      * Add the language tag to the container element.
      *
-     * When omitted, DayPicker uses the active locale code (`locale.code`).
-     * Set this prop to override the language tag.
+     * When omitted, DayPicker uses the active locale code (`locale.code`). Set
+     * this prop to override the language tag.
      */
     lang?: HTMLDivElement["lang"];
     /**

package/dist/esm/useCalendar.d.ts

@@ -1,18 +1,18 @@
 import type { CalendarDay, CalendarMonth, CalendarWeek, DateLib } from "./classes/index.js";
 import type { DayPickerProps } from "./types/props.js";
 /**
- * Return the calendar object to work with the calendar in custom components.
+ * Returns the calendar object used by DayPicker custom components.
  *
  * @see https://daypicker.dev/guides/custom-components
  */
 export interface Calendar {
     /**
-     * All the days displayed in the calendar. As opposite from
-     * {@link CalendarContext.dates}, it may return duplicated dates when shown
+     * All the days displayed in the calendar. Unlike
+     * {@link CalendarContext.dates}, it may contain duplicated dates when shown
      * outside the month.
      */
     days: CalendarDay[];
-    /** The months displayed in the calendar. */
+    /** The weeks displayed in the calendar. */
     weeks: CalendarWeek[];
     /** The months displayed in the calendar. */
     months: CalendarMonth[];
@@ -27,19 +27,16 @@ export interface Calendar {
     navStart: Date | undefined;
     /**
      * The month where the navigation ends. `undefined` if the calendar can be
-     * navigated indefinitely to the past.
+     * navigated indefinitely to the future.
      */
     navEnd: Date | undefined;
     /** Navigate to the specified month. Will fire the `onMonthChange` callback. */
     goToMonth: (month: Date) => void;
     /**
-     * Navigate to the specified date. If the second parameter (refDate) is
-     * provided and the date is before the refDate, then the month is set to one
-     * month before the date.
+     * Navigate to the month containing the specified day when it falls outside
+     * the currently displayed calendar.
      *
      * @param day - The date to navigate to.
-     * @param dateToCompare - Optional. If `date` is before `dateToCompare`, the
-     *   month is set to one month before the date.
      */
     goToDay: (day: CalendarDay) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-day-picker",
-  "version": "10.0.0-next.2",
+  "version": "10.0.0-next.4",
   "description": "Customizable Date Picker for React",
   "author": "Giampaolo Bellavite <io@gpbl.dev>",
   "homepage": "https://daypicker.dev",