react-day-picker 9.6.7 → 9.7.0

package/dist/esm/components/Week.d.ts

@@ -1,12 +1,13 @@
 import React, { type HTMLAttributes } from "react";
 import type { CalendarWeek } from "../classes/index.js";
 /**
- * Render a row in the calendar, with the days and the week number.
+ * Render a table row representing a week in the calendar.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components
  */
 export declare function Week(props: {
+    /** The week to render. */
     week: CalendarWeek;
 } & HTMLAttributes<HTMLTableRowElement>): React.JSX.Element;
 export type WeekProps = Parameters<typeof Week>[0];

package/dist/esm/components/Week.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render a row in the calendar, with the days and the week number.
+ * Render a table row representing a week in the calendar.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Week.js.map

@@ -1 +1 @@
-{"version":3,"file":"Week.js","sourceRoot":"","sources":["../../../src/components/Week.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAInD;;;;;GAKG;AACH,MAAM,UAAU,IAAI,CAClB,KAEuC;IAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;IACnC,OAAO,+BAAQ,OAAO,GAAI,CAAC;AAC7B,CAAC"}
+{"version":3,"file":"Week.js","sourceRoot":"","sources":["../../../src/components/Week.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAInD;;;;;GAKG;AACH,MAAM,UAAU,IAAI,CAClB,KAGuC;IAEvC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;IACnC,OAAO,+BAAQ,OAAO,GAAI,CAAC;AAC7B,CAAC"}

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

@@ -1,13 +1,13 @@
 import React, { type ThHTMLAttributes } from "react";
 import type { CalendarWeek } from "../classes/index.js";
 /**
- * Render the cell with the number of the week.
+ * Render a table cell displaying the number of the week.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components
  */
 export declare function WeekNumber(props: {
-    /** The week to render. */
+    /** The week to display. */
     week: CalendarWeek;
 } & ThHTMLAttributes<HTMLTableCellElement>): React.JSX.Element;
 export type WeekNumberProps = Parameters<typeof WeekNumber>[0];

package/dist/esm/components/WeekNumber.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render the cell with the number of the week.
+ * Render a table cell displaying the number of the week.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/WeekNumberHeader.d.ts

@@ -1,6 +1,6 @@
 import React, { type ThHTMLAttributes } from "react";
 /**
- * Render the column header for the week numbers.
+ * Render the header cell for the week numbers column.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/WeekNumberHeader.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render the column header for the week numbers.
+ * Render the header cell for the week numbers column.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weekday.d.ts

@@ -1,6 +1,6 @@
 import React, { type ThHTMLAttributes } from "react";
 /**
- * Render the column header with the weekday name (e.g. "Mo", "Tu", etc.).
+ * Render a table header cell with the name of a weekday (e.g., "Mo", "Tu").
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weekday.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render the column header with the weekday name (e.g. "Mo", "Tu", etc.).
+ * Render a table header cell with the name of a weekday (e.g., "Mo", "Tu").
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weekdays.d.ts

@@ -1,6 +1,6 @@
 import React, { type HTMLAttributes } from "react";
 /**
- * Render the row with the weekday names.
+ * Render the table row containing the weekday names.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weekdays.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render the row with the weekday names.
+ * Render the table row containing the weekday names.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weeks.d.ts

@@ -1,6 +1,6 @@
 import React, { type HTMLAttributes } from "react";
 /**
- * Render the weeks in the month grid.
+ * Render the container for the weeks in the month grid.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/Weeks.js

@@ -1,6 +1,6 @@
 import React from "react";
 /**
- * Render the weeks in the month grid.
+ * Render the container for the weeks in the month grid.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

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

@@ -1,7 +1,7 @@
 import React from "react";
 import { DropdownProps } from "./Dropdown.js";
 /**
- * Render the dropdown to navigate between years.
+ * Render a dropdown to navigate between years in the calendar.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/components/YearsDropdown.js

@@ -1,7 +1,7 @@
 import React from "react";
 import { useDayPicker } from "../useDayPicker.js";
 /**
- * Render the dropdown to navigate between years.
+ * Render a dropdown to navigate between years in the calendar.
  *
  * @group Components
  * @see https://daypicker.dev/guides/custom-components

package/dist/esm/formatters/formatCaption.d.ts

@@ -1,8 +1,13 @@
 import { DateLib, type DateLibOptions } from "../classes/DateLib.js";
 /**
- * Format the caption of the month.
+ * Formats the caption of the month.
  *
- * @defaultValue `LLLL y` (e.g. "November 2022")
+ * @defaultValue `LLLL y` (e.g., "November 2022").
+ * @param month The date representing the month.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted caption as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatCaption.js

@@ -1,8 +1,13 @@
 import { DateLib } from "../classes/DateLib.js";
 /**
- * Format the caption of the month.
+ * Formats the caption of the month.
  *
- * @defaultValue `LLLL y` (e.g. "November 2022")
+ * @defaultValue `LLLL y` (e.g., "November 2022").
+ * @param month The date representing the month.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted caption as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatCaption.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatCaption.js","sourceRoot":"","sources":["../../../src/formatters/formatCaption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAW,EACX,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC"}
+{"version":3,"file":"formatCaption.js","sourceRoot":"","sources":["../../../src/formatters/formatCaption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAC3B,KAAW,EACX,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,aAAa,CAAC"}

package/dist/esm/formatters/formatDay.d.ts

@@ -1,8 +1,13 @@
 import { DateLib, type DateLibOptions } from "../classes/DateLib.js";
 /**
- * Format the day date shown in the day cell.
+ * Formats the day date shown in the day cell.
  *
- * @defaultValue `d` (e.g. "1")
+ * @defaultValue `d` (e.g., "1").
+ * @param date The date to format.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted day as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatDay.js

@@ -1,8 +1,13 @@
 import { DateLib } from "../classes/DateLib.js";
 /**
- * Format the day date shown in the day cell.
+ * Formats the day date shown in the day cell.
  *
- * @defaultValue `d` (e.g. "1")
+ * @defaultValue `d` (e.g., "1").
+ * @param date The date to format.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted day as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatDay.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatDay.js","sourceRoot":"","sources":["../../../src/formatters/formatDay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,IAAU,EACV,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC7D,CAAC"}
+{"version":3,"file":"formatDay.js","sourceRoot":"","sources":["../../../src/formatters/formatDay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,SAAS,CACvB,IAAU,EACV,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAC7D,CAAC"}

package/dist/esm/formatters/formatMonthDropdown.d.ts

@@ -1,8 +1,12 @@
 import { type DateLib } from "../classes/DateLib.js";
 /**
- * Format the month number for the dropdown option label.
+ * Formats the month for the dropdown option label.
  *
- * @defaultValue The localized month name
+ * @defaultValue The localized full month name.
+ * @param month The date representing the month.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted month name as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatMonthDropdown.js

@@ -1,8 +1,12 @@
 import { defaultDateLib } from "../classes/DateLib.js";
 /**
- * Format the month number for the dropdown option label.
+ * Formats the month for the dropdown option label.
  *
- * @defaultValue The localized month name
+ * @defaultValue The localized full month name.
+ * @param month The date representing the month.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted month name as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatMonthDropdown.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatMonthDropdown.js","sourceRoot":"","sources":["../../../src/formatters/formatMonthDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAW,EACX,UAAmB,cAAc;IAEjC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC"}
+{"version":3,"file":"formatMonthDropdown.js","sourceRoot":"","sources":["../../../src/formatters/formatMonthDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAErE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAW,EACX,UAAmB,cAAc;IAEjC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC"}

package/dist/esm/formatters/formatWeekNumber.d.ts

@@ -1,8 +1,12 @@
 /**
- * Format the week number.
+ * Formats the week number.
  *
- * @defaultValue `weekNumber.toLocaleString()` with a leading zero for single-digit numbers
+ * @defaultValue The week number as a string, with a leading zero for single-digit numbers.
+ * @param weekNumber The week number to format.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted week number as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */
-export declare function formatWeekNumber(weekNumber: number): string;
+export declare function formatWeekNumber(weekNumber: number, dateLib?: import("../classes/DateLib.js").DateLib): string;

package/dist/esm/formatters/formatWeekNumber.js

@@ -1,14 +1,19 @@
+import { defaultDateLib } from "../classes/DateLib.js";
 /**
- * Format the week number.
+ * Formats the week number.
  *
- * @defaultValue `weekNumber.toLocaleString()` with a leading zero for single-digit numbers
+ * @defaultValue The week number as a string, with a leading zero for single-digit numbers.
+ * @param weekNumber The week number to format.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted week number as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */
-export function formatWeekNumber(weekNumber) {
+export function formatWeekNumber(weekNumber, dateLib = defaultDateLib) {
     if (weekNumber < 10) {
-        return `0${weekNumber.toLocaleString()}`;
+        return dateLib.formatNumber(`0${weekNumber.toLocaleString()}`);
     }
-    return `${weekNumber.toLocaleString()}`;
+    return dateLib.formatNumber(`${weekNumber.toLocaleString()}`);
 }
 //# sourceMappingURL=formatWeekNumber.js.map

package/dist/esm/formatters/formatWeekNumber.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatWeekNumber.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekNumber.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkB;IACjD,IAAI,UAAU,GAAG,EAAE,EAAE,CAAC;QACpB,OAAO,IAAI,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC;IAC3C,CAAC;IACD,OAAO,GAAG,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"formatWeekNumber.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkB,EAAE,OAAO,GAAG,cAAc;IAC3E,IAAI,UAAU,GAAG,EAAE,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;AAChE,CAAC"}

package/dist/esm/formatters/formatWeekNumberHeader.d.ts

@@ -1,7 +1,8 @@
 /**
- * Format the week number header.
+ * Formats the header for the week number column.
  *
- * @defaultValue `""`
+ * @defaultValue An empty string `""`.
+ * @returns The formatted week number header as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatWeekNumberHeader.js

@@ -1,7 +1,8 @@
 /**
- * Format the week number header.
+ * Formats the header for the week number column.
  *
- * @defaultValue `""`
+ * @defaultValue An empty string `""`.
+ * @returns The formatted week number header as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatWeekNumberHeader.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatWeekNumberHeader.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekNumberHeader.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,EAAE,CAAC;AACZ,CAAC"}
+{"version":3,"file":"formatWeekNumberHeader.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekNumberHeader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/dist/esm/formatters/formatWeekdayName.d.ts

@@ -1,8 +1,13 @@
 import { DateLib, type DateLibOptions } from "../classes/DateLib.js";
 /**
- * Format the weekday name to be displayed in the weekdays header.
+ * Formats the name of a weekday to be displayed in the weekdays header.
  *
- * @defaultValue `cccccc` (e.g. "Mo" for Monday)
+ * @defaultValue `cccccc` (e.g., "Mo" for Monday).
+ * @param weekday The date representing the weekday.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted weekday name as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatWeekdayName.js

@@ -1,8 +1,13 @@
 import { DateLib } from "../classes/DateLib.js";
 /**
- * Format the weekday name to be displayed in the weekdays header.
+ * Formats the name of a weekday to be displayed in the weekdays header.
  *
- * @defaultValue `cccccc` (e.g. "Mo" for Monday)
+ * @defaultValue `cccccc` (e.g., "Mo" for Monday).
+ * @param weekday The date representing the weekday.
+ * @param options Configuration options for the date library.
+ * @param dateLib The date library to use for formatting. If not provided, a new
+ *   instance is created.
+ * @returns The formatted weekday name as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatWeekdayName.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatWeekdayName.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekdayName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAa,EACb,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACrE,CAAC"}
+{"version":3,"file":"formatWeekdayName.js","sourceRoot":"","sources":["../../../src/formatters/formatWeekdayName.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAuB,MAAM,uBAAuB,CAAC;AAErE;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAa,EACb,OAAwB,EACxB,OAAiB;IAEjB,OAAO,CAAC,OAAO,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AACrE,CAAC"}

package/dist/esm/formatters/formatYearDropdown.d.ts

@@ -1,7 +1,11 @@
 import { type DateLib } from "../classes/DateLib.js";
 /**
- * Format the years for the dropdown option label.
+ * Formats the year for the dropdown option label.
  *
+ * @param year The year to format.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted year as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatYearDropdown.js

@@ -1,7 +1,11 @@
 import { defaultDateLib } from "../classes/DateLib.js";
 /**
- * Format the years for the dropdown option label.
+ * Formats the year for the dropdown option label.
  *
+ * @param year The year to format.
+ * @param dateLib The date library to use for formatting. Defaults to
+ *   `defaultDateLib`.
+ * @returns The formatted year as a string.
  * @group Formatters
  * @see https://daypicker.dev/docs/translation#custom-formatters
  */

package/dist/esm/formatters/formatYearDropdown.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatYearDropdown.js","sourceRoot":"","sources":["../../../src/formatters/formatYearDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAErE;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAU,EACV,UAAmB,cAAc;IAEjC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,kBAAkB,CAAC"}
+{"version":3,"file":"formatYearDropdown.js","sourceRoot":"","sources":["../../../src/formatters/formatYearDropdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAgB,MAAM,uBAAuB,CAAC;AAErE;;;;;;;;;GASG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAU,EACV,UAAmB,cAAc;IAEjC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,kBAAkB,CAAC"}

package/dist/esm/helpers/calculateFocusTarget.d.ts

@@ -1,3 +1,17 @@
 import type { CalendarDay } from "../classes/index.js";
 import type { Modifiers } from "../types/index.js";
+/**
+ * Calculates the focus target day based on priority.
+ *
+ * This function determines the day that should receive focus in the calendar,
+ * prioritizing days with specific modifiers (e.g., "focused", "today") or
+ * selection states.
+ *
+ * @param days The array of `CalendarDay` objects to evaluate.
+ * @param getModifiers A function to retrieve the modifiers for a given day.
+ * @param isSelected A function to determine if a day is selected.
+ * @param lastFocused The last focused day, if any.
+ * @returns The `CalendarDay` that should receive focus, or `undefined` if no
+ *   focusable day is found.
+ */
 export declare function calculateFocusTarget(days: CalendarDay[], getModifiers: (day: CalendarDay) => Modifiers, isSelected: (date: Date) => boolean, lastFocused: CalendarDay | undefined): CalendarDay | undefined;

package/dist/esm/helpers/calculateFocusTarget.js

@@ -6,11 +6,34 @@ var FocusTargetPriority;
     FocusTargetPriority[FocusTargetPriority["LastFocused"] = 2] = "LastFocused";
     FocusTargetPriority[FocusTargetPriority["FocusedModifier"] = 3] = "FocusedModifier";
 })(FocusTargetPriority || (FocusTargetPriority = {}));
+/**
+ * Determines if a day is focusable based on its modifiers.
+ *
+ * A day is considered focusable if it is not disabled, hidden, or outside the
+ * displayed month.
+ *
+ * @param modifiers The modifiers applied to the day.
+ * @returns `true` if the day is focusable, otherwise `false`.
+ */
 function isFocusableDay(modifiers) {
     return (!modifiers[DayFlag.disabled] &&
         !modifiers[DayFlag.hidden] &&
         !modifiers[DayFlag.outside]);
 }
+/**
+ * Calculates the focus target day based on priority.
+ *
+ * This function determines the day that should receive focus in the calendar,
+ * prioritizing days with specific modifiers (e.g., "focused", "today") or
+ * selection states.
+ *
+ * @param days The array of `CalendarDay` objects to evaluate.
+ * @param getModifiers A function to retrieve the modifiers for a given day.
+ * @param isSelected A function to determine if a day is selected.
+ * @param lastFocused The last focused day, if any.
+ * @returns The `CalendarDay` that should receive focus, or `undefined` if no
+ *   focusable day is found.
+ */
 export function calculateFocusTarget(days, getModifiers, isSelected, lastFocused) {
     let focusTarget;
     let foundFocusTargetPriority = -1;
@@ -40,7 +63,7 @@ export function calculateFocusTarget(days, getModifiers, isSelected, lastFocused
         }
     }
     if (!focusTarget) {
-        // return the first day that is focusable
+        // Return the first day that is focusable
         focusTarget = days.find((day) => isFocusableDay(getModifiers(day)));
     }
     return focusTarget;

package/dist/esm/helpers/calculateFocusTarget.js.map

@@ -1 +1 @@
-{"version":3,"file":"calculateFocusTarget.js","sourceRoot":"","sources":["../../../src/helpers/calculateFocusTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAInC,IAAK,mBAKJ;AALD,WAAK,mBAAmB;IACtB,+DAAS,CAAA;IACT,qEAAQ,CAAA;IACR,2EAAW,CAAA;IACX,mFAAe,CAAA;AACjB,CAAC,EALI,mBAAmB,KAAnB,mBAAmB,QAKvB;AAED,SAAS,cAAc,CAAC,SAAoB;IAC1C,OAAO,CACL,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5B,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAC5B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,IAAmB,EACnB,YAA6C,EAC7C,UAAmC,EACnC,WAAoC;IAEpC,IAAI,WAAoC,CAAC;IAEzC,IAAI,wBAAwB,GAA6B,CAAC,CAAC,CAAC;IAC5D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAEpC,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IACE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC;gBAC1B,wBAAwB,GAAG,mBAAmB,CAAC,eAAe,EAC9D,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,eAAe,CAAC;YACjE,CAAC;iBAAM,IACL,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC;gBAC3B,wBAAwB,GAAG,mBAAmB,CAAC,WAAW,EAC1D,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,WAAW,CAAC;YAC7D,CAAC;iBAAM,IACL,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,wBAAwB,GAAG,mBAAmB,CAAC,QAAQ,EACvD,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,QAAQ,CAAC;YAC1D,CAAC;iBAAM,IACL,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;gBACxB,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,EACpD,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,CAAC;YACvD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,yCAAyC;QACzC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}
+{"version":3,"file":"calculateFocusTarget.js","sourceRoot":"","sources":["../../../src/helpers/calculateFocusTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAInC,IAAK,mBAKJ;AALD,WAAK,mBAAmB;IACtB,+DAAS,CAAA;IACT,qEAAQ,CAAA;IACR,2EAAW,CAAA;IACX,mFAAe,CAAA;AACjB,CAAC,EALI,mBAAmB,KAAnB,mBAAmB,QAKvB;AAED;;;;;;;;GAQG;AACH,SAAS,cAAc,CAAC,SAAoB;IAC1C,OAAO,CACL,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5B,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAC5B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAmB,EACnB,YAA6C,EAC7C,UAAmC,EACnC,WAAoC;IAEpC,IAAI,WAAoC,CAAC;IAEzC,IAAI,wBAAwB,GAA6B,CAAC,CAAC,CAAC;IAC5D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAEpC,IAAI,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,IACE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC;gBAC1B,wBAAwB,GAAG,mBAAmB,CAAC,eAAe,EAC9D,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,eAAe,CAAC;YACjE,CAAC;iBAAM,IACL,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC;gBAC3B,wBAAwB,GAAG,mBAAmB,CAAC,WAAW,EAC1D,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,WAAW,CAAC;YAC7D,CAAC;iBAAM,IACL,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;gBACpB,wBAAwB,GAAG,mBAAmB,CAAC,QAAQ,EACvD,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,QAAQ,CAAC;YAC1D,CAAC;iBAAM,IACL,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;gBACxB,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,EACpD,CAAC;gBACD,WAAW,GAAG,GAAG,CAAC;gBAClB,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,CAAC;YACvD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,yCAAyC;QACzC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,cAAc,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/esm/helpers/createGetModifiers.d.ts

@@ -0,0 +1,16 @@
+import type { CalendarDay, DateLib } from "../classes/index.js";
+import type { DayPickerProps, Modifiers } from "../types/index.js";
+/**
+ * Creates a function to retrieve the modifiers for a given day.
+ *
+ * This function calculates both internal and custom modifiers for each day
+ * based on the provided calendar days and DayPicker props.
+ *
+ * @private
+ * @param days The array of `CalendarDay` objects to process.
+ * @param props The DayPicker props, including modifiers and configuration
+ *   options.
+ * @param dateLib The date library to use for date manipulation.
+ * @returns A function that retrieves the modifiers for a given `CalendarDay`.
+ */
+export declare function createGetModifiers(days: CalendarDay[], props: DayPickerProps, dateLib: DateLib): (day: CalendarDay) => Modifiers;

package/dist/esm/{useGetModifiers.js → helpers/createGetModifiers.js}

@@ -1,13 +1,19 @@
-import { DayFlag } from "./UI.js";
-import { dateMatchModifiers } from "./utils/dateMatchModifiers.js";
+import { DayFlag } from "../UI.js";
+import { dateMatchModifiers } from "../utils/dateMatchModifiers.js";
 /**
- * Return a function to get the modifiers for a given day.
+ * Creates a function to retrieve the modifiers for a given day.
  *
- * NOTE: this is not an hook, but a factory for `getModifiers`.
+ * This function calculates both internal and custom modifiers for each day
+ * based on the provided calendar days and DayPicker props.
  *
  * @private
+ * @param days The array of `CalendarDay` objects to process.
+ * @param props The DayPicker props, including modifiers and configuration
+ *   options.
+ * @param dateLib The date library to use for date manipulation.
+ * @returns A function that retrieves the modifiers for a given `CalendarDay`.
  */
-export function useGetModifiers(days, props, dateLib) {
+export function createGetModifiers(days, props, dateLib) {
     const { disabled, hidden, modifiers, showOutsideDays, broadcastCalendar, today } = props;
     const { isSameDay, isSameMonth, startOfMonth, isBefore, endOfMonth, isAfter } = dateLib;
     const startMonth = props.startMonth && startOfMonth(props.startMonth);
@@ -84,4 +90,4 @@ export function useGetModifiers(days, props, dateLib) {
         };
     };
 }
-//# sourceMappingURL=useGetModifiers.js.map
+//# sourceMappingURL=createGetModifiers.js.map

package/dist/esm/helpers/createGetModifiers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createGetModifiers.js","sourceRoot":"","sources":["../../../src/helpers/createGetModifiers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAmB,EACnB,KAAqB,EACrB,OAAgB;IAEhB,MAAM,EACJ,QAAQ,EACR,MAAM,EACN,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,KAAK,EACN,GAAG,KAAK,CAAC;IAEV,MAAM,EACJ,SAAS,EACT,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,OAAO,EACR,GAAG,OAAO,CAAC;IAEZ,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtE,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE9D,MAAM,oBAAoB,GAAmC;QAC3D,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE;QACrB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE;QACrB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE;QACtB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE;QACpB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE;KACpB,CAAC;IAEF,MAAM,kBAAkB,GAAkC,EAAE,CAAC;IAE7D,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC;QAEnC,MAAM,SAAS,GAAG,OAAO,CAAC,YAAY,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;QAE5E,MAAM,kBAAkB,GAAG,OAAO,CAChC,UAAU,IAAI,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CACzC,CAAC;QAEF,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;QAErE,MAAM,UAAU,GAAG,OAAO,CACxB,QAAQ,IAAI,kBAAkB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CACxD,CAAC;QAEF,MAAM,QAAQ,GACZ,OAAO,CAAC,MAAM,IAAI,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YAC5D,kBAAkB;YAClB,eAAe;YACf,uDAAuD;YACvD,CAAC,CAAC,iBAAiB,IAAI,CAAC,eAAe,IAAI,SAAS,CAAC;YACrD,CAAC,iBAAiB,IAAI,eAAe,KAAK,KAAK,IAAI,SAAS,CAAC,CAAC;QAEhE,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAE1D,IAAI,SAAS;YAAE,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,UAAU;YAAE,oBAAoB,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,QAAQ;YAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpD,IAAI,OAAO;YAAE,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAElD,uBAAuB;QACvB,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACtC,MAAM,aAAa,GAAG,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC;gBACxC,MAAM,OAAO,GAAG,aAAa;oBAC3B,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC;oBAClD,CAAC,CAAC,KAAK,CAAC;gBACV,IAAI,CAAC,OAAO;oBAAE,OAAO;gBACrB,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7B,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrC,CAAC;qBAAM,CAAC;oBACN,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAgB,EAAa,EAAE;QACrC,wCAAwC;QACxC,MAAM,QAAQ,GAA6B;YACzC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK;YACxB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,KAAK;YACzB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK;YACvB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK;YACxB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK;SACvB,CAAC;QACF,MAAM,eAAe,GAAc,EAAE,CAAC;QAEtC,uCAAuC;QACvC,KAAK,MAAM,IAAI,IAAI,oBAAoB,EAAE,CAAC;YACxC,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAe,CAAC,CAAC;YACnD,QAAQ,CAAC,IAAe,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QAC1D,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;YACtC,eAAe,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO;YACL,GAAG,QAAQ;YACX,yDAAyD;YACzD,GAAG,eAAe;SACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/dist/esm/helpers/endOfBroadcastWeek.d.ts

@@ -1,7 +1,13 @@
 import type { DateLib } from "../classes/index.js";
 /**
- * Return the end date of the week in the broadcast calendar.
+ * Returns the end date of the week in the broadcast calendar.
+ *
+ * The broadcast week ends on the last day of the last broadcast week for the
+ * given date.
  *
  * @since 9.4.0
+ * @param date The date for which to calculate the end of the broadcast week.
+ * @param dateLib The date library to use for date manipulation.
+ * @returns The end date of the broadcast week.
  */
 export declare function endOfBroadcastWeek(date: Date, dateLib: DateLib): Date;

package/dist/esm/helpers/endOfBroadcastWeek.js

@@ -1,9 +1,15 @@
 import { getBroadcastWeeksInMonth } from "./getBroadcastWeeksInMonth.js";
 import { startOfBroadcastWeek } from "./startOfBroadcastWeek.js";
 /**
- * Return the end date of the week in the broadcast calendar.
+ * Returns the end date of the week in the broadcast calendar.
+ *
+ * The broadcast week ends on the last day of the last broadcast week for the
+ * given date.
  *
  * @since 9.4.0
+ * @param date The date for which to calculate the end of the broadcast week.
+ * @param dateLib The date library to use for date manipulation.
+ * @returns The end date of the broadcast week.
  */
 export function endOfBroadcastWeek(date, dateLib) {
     const startDate = startOfBroadcastWeek(date, dateLib);

package/dist/esm/helpers/endOfBroadcastWeek.js.map

@@ -1 +1 @@
-{"version":3,"file":"endOfBroadcastWeek.js","sourceRoot":"","sources":["../../../src/helpers/endOfBroadcastWeek.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAU,EAAE,OAAgB;IAC7D,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,aAAa,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"endOfBroadcastWeek.js","sourceRoot":"","sources":["../../../src/helpers/endOfBroadcastWeek.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAU,EAAE,OAAgB;IAC7D,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtD,MAAM,aAAa,GAAG,wBAAwB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/esm/helpers/getBroadcastWeeksInMonth.d.ts

@@ -1,7 +1,14 @@
 import { DateLib } from "../classes/index.js";
 /**
- * Return the number of weeks to display in the broadcast calendar.
+ * Returns the number of weeks to display in the broadcast calendar for a given
+ * month.
+ *
+ * The broadcast calendar may have either 4 or 5 weeks in a month, depending on
+ * the start and end dates of the broadcast weeks.
  *
  * @since 9.4.0
+ * @param month The month for which to calculate the number of weeks.
+ * @param dateLib The date library to use for date manipulation.
+ * @returns The number of weeks in the broadcast calendar (4 or 5).
  */
 export declare function getBroadcastWeeksInMonth(month: Date, dateLib: DateLib): 4 | 5;