Skip to content

Commit

Permalink
docs: update documentation for new v3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding committed Nov 8, 2024
1 parent f7b98a9 commit cc386b9
Show file tree
Hide file tree
Showing 32 changed files with 453 additions and 766 deletions.
2 changes: 1 addition & 1 deletion docs/en/learn/action-handlers/change-of-time.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Handling Time Changes

By activating the `settings.selection.time` parameter, you gain the ability to automatically retrieve the required data whenever the time changes.
By activating the `selectionTimeMode` parameter, you gain the ability to automatically retrieve the required data whenever the time changes.

Usage example in the sandbox:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/action-handlers/click-on-the-week-number.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Handling Click on the Week Number

In some countries, week numbers are used to denote dates. You can display week numbers in the calendar using the `settings.visibility.weekNumbers` parameter and handle clicks on them.
In some countries, week numbers are used to denote dates. You can display week numbers in the calendar using the `enableWeekNumbers` parameter and handle clicks on them.

<Sandbox example="action-handlers-click-on-the-week-number" />

Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/customization-and-modification/themes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The calendar supports both light and dark theme designs.

If the `settings.visibility.themeDetect` parameter is set to `false`, the theme will be determined by the user's system settings or the `settings.visibility.theme` parameter.
If the `themeAttrDetect` parameter is set to `false`, the theme will be determined by the user's system settings or the `selectedTheme` parameter.

The calendar can automatically detect and track the site's theme based on the set tag and attribute. Additional information about this parameter can be found in the <a href="/docs/reference/additionally/settings#visibility-themeDetect">reference</a>.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/date-range/enable-or-disable-days.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Sometimes you may need to disable specific days so they are not available for selection. The examples below show how this can be done.

<Info>
It's important to understand that in the examples below, the parameters `settings.selected.year` and `settings.selected.month` are only specified for the demonstration of a particular month.
It's important to understand that in the examples below, the parameters `selectedYear` and `selectedMonth` are only specified for the demonstration of a particular month.
</Info>

The example below demonstrates the disabling of specific days.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Maximum and Minimum Date for Display

The parameters `settings.range.min` and `settings.range.max define the range of dates that can be displayed in the calendar, but they do not affect the calendar's lifecycle. They simply specify which dates are allowed for display and selection.
The parameters `displayDateMin` and `displayDateMax define the range of dates that can be displayed in the calendar, but they do not affect the calendar's lifecycle. They simply specify which dates are allowed for display and selection.

For example, if the parameter `settings.visibility.disabled` is set to `true`, the minimum and maximum years available for user viewing will be determined by the values of the `date.min` and `date.max` parameters.
For example, if the parameter `displayDisabledDates` is set to `true`, the minimum and maximum years available for user viewing will be determined by the values of the `dateMin` and `dateMax` parameters.

<Sandbox example="date-range-maximum-and-minimum-date-to-display" />

Changing the `settings.visibility.disabled` parameter allows you to control the available dates for viewing and selection in the calendar.
Changing the `displayDisabledDates` parameter allows you to control the available dates for viewing and selection in the calendar.
4 changes: 2 additions & 2 deletions docs/en/learn/date-range/start-and-end-of-existing-dates.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Start and End Dates of Existing Dates

The date range in the calendar can be set using the `date.min` and `date.max` parameters. These parameters specify the permissible date range in the calendar.
The date range in the calendar can be set using the `dateMin` and `dateMax` parameters. These parameters specify the permissible date range in the calendar.

By default, the minimum date is `'1970-01-01'`, which corresponds to the beginning of <a href="https://en.wikipedia.org/wiki/Unix_time" rel="noreferrer" target="_blank">UNIX</a> time.
The default maximum date is set to `'2470-12-31'`, and it is chosen arbitrarily.

If you need to set a specific date range, replace the values of the `date.min` and `date.max` parameters with the dates you require. Note that the calendar will not process dates outside the specified range.
If you need to set a specific date range, replace the values of the `dateMin` and `dateMax` parameters with the dates you require. Note that the calendar will not process dates outside the specified range.

The example below demonstrates how you can set your own start and end dates for the range.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/internationalization/assign-manually.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Manual Localization

You can manually localize the calendar if the `settings.lang` parameter does not meet your needs. Only the month and day labels in the calendar need to be localized, so you need to provide the corresponding arrays of strings and set `settings.lang` to `'define'`.
You can manually localize the calendar if the `locale` parameter does not meet your needs. Only the month and day labels in the calendar need to be localized, so you need to provide the corresponding arrays of strings and set `locale` to `'define'`.

<Info>
Please note that the week array should start with Sunday; this does not affect **ISO 8601**.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/internationalization/locale.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Automatic Localization

If your locale is supported by the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString" rel="noreferrer" target="_blank">`.toLocaleString()`</a> method, you can simply pass it to the `settings.lang` parameter for calendar localization.
If your locale is supported by the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString" rel="noreferrer" target="_blank">`.toLocaleString()`</a> method, you can simply pass it to the `locale` parameter for calendar localization.

<Sandbox example="internationalization-locale" />

Expand Down
2 changes: 1 addition & 1 deletion docs/en/learn/internationalization/week-numbers.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Week Numbers

For example, in Norway, it's very common to denote dates using week numbers.
You can enable the display of week numbers in the calendar by setting the `settings.visibility.weekNumbers` parameter to `true`.
You can enable the display of week numbers in the calendar by setting the `enableWeekNumbers` parameter to `true`.

<Sandbox example="internationalization-week-numbers" />
4 changes: 2 additions & 2 deletions docs/en/learn/types-of-calendars/multiple.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Multiple

The calendar type `'multiple'` displays multiple months, allowing you to select days in each of them. This calendar type is useful when a user needs to choose multiple dates in different months, but for this, you need to use the `settings.selection.day` parameter and set its value to `'multiple'`.
The calendar type `'multiple'` displays multiple months, allowing you to select days in each of them. This calendar type is useful when a user needs to choose multiple dates in different months, but for this, you need to use the `selectionDatesMode` parameter and set its value to `'multiple'`.

Example code for creating a calendar with the type `'multiple'`.

<Sandbox example="type-of-calendar-multiple" vertically={false} height={680} />

If you need to select date ranges in each month, you can use the `settings.selection.day` parameter and set its value to `'multiple-ranged'`. This allows you to select date ranges, not just individual days.
If you need to select date ranges in each month, you can use the `selectionDatesMode` parameter and set its value to `'multiple-ranged'`. This allows you to select date ranges, not just individual days.

<Sandbox example="type-of-calendar-multiple-ranged" vertically={false} height={680} />
Loading

0 comments on commit cc386b9

Please sign in to comment.