docs: update for persian calendar

gpbl · Dec 26, 2024 · 5c7a719 · 5c7a719
1 parent 37907fc
commit 5c7a719
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,7 @@ npm install react-day-picker@latest
 ## What’s New
 
 - Moved `date-fns` from peer dependencies to dependencies.
-- Added support for [time zones](https://daypicker.dev/docs/localization#time-zone) and [Jalali Calendar](https://daypicker.dev/docs/localization#jalali-calendar).
+- Added support for [time zones](https://daypicker.dev/docs/localization#time-zone) and [Persian Calendar](https://daypicker.dev/docs/localization#persian-calendar).
 - [Enhanced accessibility](https://daypicker.dev/guides/accessibility) to better comply with [WCAG 2.1](https://www.w3.org/TR/WCAG21/) recommendations.
 - [Simplified styles](https://daypicker.dev/docs/styling) and new CSS variables for easier customization.
 - New `excludeDisabled` prop for [range mode](https://daypicker.dev/docs/selection-modes#exclude-disabled).

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ DayPicker is a [React](https://react.dev) component for creating date pickers, c
 - 🎨 Minimal design that can be [easily styled](https://daypicker.dev/docs/styling) with CSS or any CSS framework.
 - 📅 Supports [selections](https://daypicker.dev/docs/selection-modes) of single days, multiple days, ranges of days, or [custom selections](https://daypicker.dev/guides/custom-selections).
 - 🌍 Can be [localized](https://daypicker.dev/docs/localization) into any language and [time zones](https://daypicker.dev/docs/localization#time-zone).
-- 🌐 Support for [ISO 8601 dates](https://daypicker.dev/docs/localization#iso-week-dates), [Jalali](https://daypicker.dev/docs/localization#jalali-calendar), and [broadcast](https://daypicker.dev/docs/localization#broadcast-calendar) calendar.
+- 🌐 Support for [ISO 8601](https://daypicker.dev/docs/localization#iso-week-dates), [Jalali](https://daypicker.dev/docs/localization#persian-calendar), and [broadcast](https://daypicker.dev/docs/localization#broadcast-calendar) calendar.
 - 🦮 Complies with WCAG 2.1 AA requirements for [accessibility](https://daypicker.dev/guides/accessibility).
 - ⚙️ [Customizable components](https://daypicker.dev/guides/custom-components) to extend the rendered elements.
 - 🔤 Easy integration [with input fields](https://daypicker.dev/guides/input-fields).

diff --git a/src/types/props.ts b/src/types/props.ts
@@ -231,7 +231,8 @@ export interface PropsBase {
   /**
    * Show the outside days (days falling in the next or the previous month).
    *
-   * **Note:** when {@link broadcastCalendar} is set, this prop defaults to true.
+   * **Note:** when a broadcast {@link calendar} is set, this prop defaults to
+   * true.
    *
    * @see https://daypicker.dev/docs/customization#outside-days
    */
@@ -240,9 +241,6 @@ export interface PropsBase {
    * Show the week numbers column. Weeks are numbered according to the local
    * week index.
    *
-   * - To use ISO week numbering, use the `ISOWeek` prop.
-   * - To change how the week numbers are displayed, use the `formatters` prop.
-   *
    * @see https://daypicker.dev/docs/customization#showweeknumber
    */
   showWeekNumber?: boolean;

diff --git a/website/docs/intro.mdx b/website/docs/intro.mdx
@@ -15,7 +15,7 @@ DayPicker is a [React](https://react.dev) component for creating date pickers, c
 - 🎨 Minimal design that can be [easily styled](./docs/styling.mdx) with CSS or any CSS framework.
 - 📅 Supports [selections](./docs/selection-modes.mdx) of single days, multiple days, ranges of days, or [custom selections](./guides/custom-selections.mdx).
 - 🌍 Can be [localized](https://daypicker.dev/docs/localization) into any language and [time zones](https://daypicker.dev/docs/localization#time-zone).
-- 🌐 Support for [ISO 8601 dates](https://daypicker.dev/docs/localization#iso-week-dates), [Jalali](https://daypicker.dev/docs/localization#jalali-calendar), and [broadcast](https://daypicker.dev/docs/localization#broadcast-calendar) calendar.
+- 🌐 Support for [ISO 8601](https://daypicker.dev/docs/localization#iso-week-dates), [Persian](https://daypicker.dev/docs/localization#persian-calendar), and [broadcast](https://daypicker.dev/docs/localization#broadcast-calendar) calendar.
 - 🦮 Complies with WCAG 2.1 AA requirements for [accessibility](./guides/accessibility.mdx).
 - ⚙️ [Customizable components](./guides/custom-components.mdx) to extend the rendered elements.
 - 🔤 Easy integration [with input fields](./guides/input-fields.mdx).