Skip to content

Commit

Permalink
docs: update reference.mdx, utilities.mdx, reference.mdx and utilitie…
Browse files Browse the repository at this point in the history
…s.mdx
  • Loading branch information
uvarov-frontend committed Nov 17, 2024
1 parent 0733da7 commit fce4b2b
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/en/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This section provides detailed documentation on working with the **Vanilla Calen
The Vanilla Calendar Pro API documentation is divided into several functional subsections:

1. **Instance Creation** — how and where to create a calendar instance.
2. **Utilities** - functions that allow you to format dates.
2. **Utilities** functions that allow you to format dates.
3. **Methods** — available methods for working with the calendar instance.
4. **Settings** — all options that can be provided to change the behavior and display of the calendar.
5. **Actions** — event handlers that allow you to receive and process various interaction data with the calendar.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/reference/utilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The calendar comes with its utilities, making it easy to work with date formatti

There are 4 utilities in total, and they are functions that can be used anywhere in your code, even without the calendar.

1. **`parseDates(dates: string[])`** - Takes an array of date ranges using a delimiter between dates in the string format `FormatDateString ('YYYY-MM-DD')`. Returns an array of dates in the string format `FormatDateString ('YYYY-MM-DD')`.
1. **`parseDates(dates: string[])`** Takes an array of date ranges using a delimiter between dates in the string format `FormatDateString ('YYYY-MM-DD')`. Returns an array of dates in the string format `FormatDateString ('YYYY-MM-DD')`.
```ts
import { parseDates } from 'vanilla-calendar-pro/utils';
parseDates(['2024-12-12:2024-12-15']) // return: ['2024-12-12', '2024-12-13', '2024-12-14', '2024-12-15']
Expand All @@ -28,7 +28,7 @@ import { getDate } from 'vanilla-calendar-pro/utils';
getDate(new Date('2024-12-12')) // return: Tue Dec 24 2024 00:00:00 GMT
```

4. **`getWeekNumber(date: FormatDateString, weekStartDay: WeekDayID)`** - Takes a date in string format `FormatDateString ('YYYY-MM-DD')` and the week start day, specifically its `id` of type `number` from 0 to 6. Returns an object `{ year: yearNumber, week: weekNumber }` for the date specified in the arguments.
4. **`getWeekNumber(date: FormatDateString, weekStartDay: WeekDayID)`** Takes a date in string format `FormatDateString ('YYYY-MM-DD')` and the week start day, specifically its `id` of type `number` from 0 to 6. Returns an object `{ year: yearNumber, week: weekNumber }` for the date specified in the arguments.
```ts
import { getWeekNumber } from 'vanilla-calendar-pro/utils';
getWeekNumber('2024-12-12', 1) // return: {year: 2024, week: 50}
Expand Down
2 changes: 1 addition & 1 deletion docs/ru/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Обзор справочника по API Vanilla Calendar Pro. У
Документация API Vanilla Calendar Pro разделена на несколько функциональных подразделов:

1. **Создание экземпляра** — как и где создать экземпляр календаря.
2. **Утилиты** - функции которые позволяют форматировать даты.
2. **Утилиты** функции которые позволяют форматировать даты.
3. **Методы** — доступные методы для работы с экземпляром календаря.
4. **Настройки** — все опции, которые можно передать для изменения поведения и отображения календаря.
5. **Действия** — обработчики событий, которые позволяют получать и обрабатывать различные данные взаимодействия с календарем.
Expand Down
4 changes: 2 additions & 2 deletions docs/ru/reference/utilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ section: 2

Всего есть 4 утилиты, они являются функциями и вы можете использовать их в любом месте вашего кода, даже без календаря.

1. **`parseDates(dates: string[])`** - принимает на вход массив диапазонов дат с использованием разделителя между датами в строковом формате типа `FormatDateString ('YYYY-MM-DD')`. Возвращает массив дат в строковом формате типа `FormatDateString ('YYYY-MM-DD')`.
1. **`parseDates(dates: string[])`** принимает на вход массив диапазонов дат с использованием разделителя между датами в строковом формате типа `FormatDateString ('YYYY-MM-DD')`. Возвращает массив дат в строковом формате типа `FormatDateString ('YYYY-MM-DD')`.
```ts
import { parseDates } from 'vanilla-calendar-pro/utils';
parseDates(['2024-12-12:2024-12-15']) // возвращает: ['2024-12-12', '2024-12-13', '2024-12-14', '2024-12-15']
Expand All @@ -28,7 +28,7 @@ import { getDate } from 'vanilla-calendar-pro/utils';
getDate(new Date('2024-12-12')) // возвращает: Tue Dec 24 2024 00:00:00 GMT
```

4. **`getWeekNumber(date: FormatDateString, weekStartDay: WeekDayID)`** - принимает на вход дату в строковом формате типа `FormatDateString ('YYYY-MM-DD')` и день начала недели, а точнее его `id` с типом `number` от 0 до 6. Возвращает объект `{ year: yearNumber, week: weekNumber }` для даты, указанной в аргументах.
4. **`getWeekNumber(date: FormatDateString, weekStartDay: WeekDayID)`** принимает на вход дату в строковом формате типа `FormatDateString ('YYYY-MM-DD')` и день начала недели, а точнее его `id` с типом `number` от 0 до 6. Возвращает объект `{ year: yearNumber, week: weekNumber }` для даты, указанной в аргументах.
```ts
import { getWeekNumber } from 'vanilla-calendar-pro/utils';
getWeekNumber('2024-12-12', 1) // возвращает: {year: 2024, week: 50}
Expand Down

0 comments on commit fce4b2b

Please sign in to comment.