@intlayer/docs 5.7.8 → 5.8.0-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (130) hide show
  1. package/blog/ar/intlayer_with_next-i18next.md +3 -4
  2. package/blog/ar/intlayer_with_next-intl.md +3 -4
  3. package/blog/ar/intlayer_with_react-i18next.md +1 -1
  4. package/blog/ar/intlayer_with_react-intl.md +1 -1
  5. package/blog/de/intlayer_with_next-i18next.md +3 -4
  6. package/blog/de/intlayer_with_react-intl.md +1 -1
  7. package/blog/en/intlayer_with_next-i18next.md +3 -4
  8. package/blog/en/intlayer_with_next-intl.md +3 -4
  9. package/blog/en/intlayer_with_react-i18next.md +1 -1
  10. package/blog/en/intlayer_with_react-intl.md +1 -1
  11. package/blog/en-GB/intlayer_with_next-i18next.md +3 -4
  12. package/blog/en-GB/intlayer_with_next-intl.md +3 -4
  13. package/blog/en-GB/intlayer_with_react-i18next.md +1 -1
  14. package/blog/en-GB/intlayer_with_react-intl.md +1 -1
  15. package/blog/es/intlayer_with_next-i18next.md +3 -4
  16. package/blog/es/intlayer_with_next-intl.md +3 -4
  17. package/blog/es/intlayer_with_react-i18next.md +1 -1
  18. package/blog/es/intlayer_with_react-intl.md +1 -1
  19. package/blog/fr/intlayer_with_next-i18next.md +3 -4
  20. package/blog/fr/intlayer_with_next-intl.md +3 -4
  21. package/blog/fr/intlayer_with_react-i18next.md +1 -1
  22. package/blog/fr/intlayer_with_react-intl.md +1 -1
  23. package/blog/hi/intlayer_with_next-i18next.md +3 -4
  24. package/blog/hi/intlayer_with_next-intl.md +3 -4
  25. package/blog/hi/intlayer_with_react-i18next.md +1 -1
  26. package/blog/hi/intlayer_with_react-intl.md +1 -1
  27. package/blog/it/intlayer_with_next-i18next.md +3 -4
  28. package/blog/it/intlayer_with_next-intl.md +3 -4
  29. package/blog/it/intlayer_with_react-i18next.md +1 -1
  30. package/blog/it/intlayer_with_react-intl.md +1 -1
  31. package/blog/ja/intlayer_with_next-i18next.md +3 -4
  32. package/blog/ja/intlayer_with_next-intl.md +3 -4
  33. package/blog/ja/intlayer_with_react-intl.md +1 -1
  34. package/blog/ko/intlayer_with_next-i18next.md +3 -4
  35. package/blog/ko/intlayer_with_next-intl.md +3 -4
  36. package/blog/ko/intlayer_with_react-intl.md +1 -1
  37. package/blog/pt/intlayer_with_next-i18next.md +3 -4
  38. package/blog/pt/intlayer_with_next-intl.md +3 -4
  39. package/blog/pt/intlayer_with_react-intl.md +1 -1
  40. package/blog/ru/intlayer_with_next-i18next.md +3 -4
  41. package/blog/ru/intlayer_with_next-intl.md +3 -4
  42. package/blog/ru/intlayer_with_react-i18next.md +1 -1
  43. package/blog/ru/intlayer_with_react-intl.md +1 -1
  44. package/blog/zh/intlayer_with_next-i18next.md +3 -4
  45. package/blog/zh/intlayer_with_next-intl.md +3 -4
  46. package/blog/zh/intlayer_with_react-i18next.md +1 -1
  47. package/blog/zh/intlayer_with_react-intl.md +1 -1
  48. package/dist/cjs/generated/docs.entry.cjs +41 -0
  49. package/dist/cjs/generated/docs.entry.cjs.map +1 -1
  50. package/dist/esm/generated/docs.entry.mjs +41 -0
  51. package/dist/esm/generated/docs.entry.mjs.map +1 -1
  52. package/dist/types/generated/docs.entry.d.ts +1 -0
  53. package/dist/types/generated/docs.entry.d.ts.map +1 -1
  54. package/docs/ar/formatters.md +239 -0
  55. package/docs/ar/interest_of_intlayer.md +162 -49
  56. package/docs/ar/introduction.md +3 -3
  57. package/docs/ar/packages/intlayer/index.md +3 -3
  58. package/docs/ar/packages/next-intlayer/index.md +3 -3
  59. package/docs/de/formatters.md +239 -0
  60. package/docs/de/interest_of_intlayer.md +161 -47
  61. package/docs/de/introduction.md +3 -3
  62. package/docs/de/packages/intlayer/index.md +3 -3
  63. package/docs/de/packages/next-intlayer/index.md +3 -3
  64. package/docs/de/packages/react-intlayer/index.md +3 -3
  65. package/docs/en/formatters.md +250 -0
  66. package/docs/en/interest_of_intlayer.md +159 -46
  67. package/docs/en/introduction.md +3 -3
  68. package/docs/en/packages/intlayer/index.md +3 -3
  69. package/docs/en/packages/next-intlayer/index.md +3 -3
  70. package/docs/en/packages/react-intlayer/index.md +3 -3
  71. package/docs/en-GB/formatters.md +239 -0
  72. package/docs/en-GB/interest_of_intlayer.md +160 -53
  73. package/docs/en-GB/packages/intlayer/index.md +3 -3
  74. package/docs/en-GB/packages/next-intlayer/index.md +3 -3
  75. package/docs/en-GB/packages/react-intlayer/index.md +3 -3
  76. package/docs/es/formatters.md +239 -0
  77. package/docs/es/interest_of_intlayer.md +159 -47
  78. package/docs/es/introduction.md +3 -3
  79. package/docs/es/packages/intlayer/index.md +3 -3
  80. package/docs/es/packages/next-intlayer/index.md +3 -3
  81. package/docs/fr/formatters.md +239 -0
  82. package/docs/fr/interest_of_intlayer.md +160 -46
  83. package/docs/fr/introduction.md +3 -3
  84. package/docs/fr/packages/intlayer/index.md +3 -3
  85. package/docs/fr/packages/next-intlayer/index.md +3 -3
  86. package/docs/fr/packages/react-intlayer/index.md +3 -3
  87. package/docs/hi/formatters.md +239 -0
  88. package/docs/hi/interest_of_intlayer.md +158 -42
  89. package/docs/hi/introduction.md +3 -3
  90. package/docs/hi/packages/intlayer/index.md +3 -3
  91. package/docs/hi/packages/next-intlayer/index.md +3 -3
  92. package/docs/hi/packages/react-intlayer/index.md +3 -3
  93. package/docs/it/formatters.md +239 -0
  94. package/docs/it/interest_of_intlayer.md +160 -46
  95. package/docs/it/introduction.md +3 -3
  96. package/docs/it/packages/intlayer/index.md +3 -3
  97. package/docs/it/packages/next-intlayer/index.md +3 -3
  98. package/docs/it/packages/react-intlayer/index.md +3 -3
  99. package/docs/ja/formatters.md +261 -0
  100. package/docs/ja/interest_of_intlayer.md +157 -48
  101. package/docs/ja/introduction.md +3 -3
  102. package/docs/ja/packages/intlayer/index.md +3 -3
  103. package/docs/ja/packages/next-intlayer/index.md +3 -3
  104. package/docs/ja/packages/react-intlayer/index.md +3 -3
  105. package/docs/ko/formatters.md +258 -0
  106. package/docs/ko/interest_of_intlayer.md +160 -48
  107. package/docs/ko/introduction.md +3 -3
  108. package/docs/ko/packages/intlayer/index.md +3 -3
  109. package/docs/ko/packages/next-intlayer/index.md +3 -3
  110. package/docs/ko/packages/react-intlayer/index.md +3 -3
  111. package/docs/pt/formatters.md +239 -0
  112. package/docs/pt/interest_of_intlayer.md +162 -47
  113. package/docs/pt/introduction.md +3 -3
  114. package/docs/pt/packages/intlayer/index.md +3 -3
  115. package/docs/pt/packages/next-intlayer/index.md +3 -3
  116. package/docs/pt/packages/react-intlayer/index.md +3 -3
  117. package/docs/ru/formatters.md +239 -0
  118. package/docs/ru/interest_of_intlayer.md +168 -50
  119. package/docs/ru/introduction.md +3 -3
  120. package/docs/ru/packages/intlayer/index.md +3 -3
  121. package/docs/ru/packages/next-intlayer/index.md +3 -3
  122. package/docs/ru/packages/react-intlayer/index.md +3 -3
  123. package/docs/zh/formatters.md +239 -0
  124. package/docs/zh/interest_of_intlayer.md +158 -48
  125. package/docs/zh/introduction.md +3 -3
  126. package/docs/zh/packages/intlayer/index.md +3 -3
  127. package/docs/zh/packages/next-intlayer/index.md +3 -3
  128. package/docs/zh/packages/react-intlayer/index.md +3 -3
  129. package/package.json +12 -12
  130. package/src/generated/docs.entry.ts +41 -0
@@ -0,0 +1,239 @@
1
+ ---
2
+ createdAt: 2024-08-13
3
+ updatedAt: 2025-08-20
4
+ title: Форматтеры
5
+ description: Утилиты для форматирования с учетом локали на основе Intl для чисел, процентов, валюты, дат, относительного времени, единиц измерения и компактной записи. Включает кешированный помощник Intl.
6
+ keywords:
7
+ - Форматтеры
8
+ - Intl
9
+ - Число
10
+ - Валюта
11
+ - Процент
12
+ - Дата
13
+ - Относительное время
14
+ - Единицы измерения
15
+ - Компактный формат
16
+ - Интернационализация
17
+ slugs:
18
+ - doc
19
+ - formatters
20
+ ---
21
+
22
+ # Форматтеры Intlayer
23
+
24
+ ## Обзор
25
+
26
+ Intlayer предоставляет набор легковесных помощников, построенных поверх нативных API `Intl`, а также кешированный обертку `Intl`, чтобы избежать повторного создания тяжелых форматтеров. Эти утилиты полностью учитывают локаль и могут использоваться из основного пакета `intlayer`.
27
+
28
+ ### Импорт
29
+
30
+ ```ts
31
+ import {
32
+ Intl,
33
+ number,
34
+ percentage,
35
+ currency,
36
+ date,
37
+ relativeTime,
38
+ units,
39
+ compact,
40
+ } from "intlayer";
41
+ ```
42
+
43
+ Если вы используете React, хуки также доступны; смотрите `react-intlayer/format`.
44
+
45
+ ## Кешированный Intl
46
+
47
+ Экспортируемый `Intl` — это тонкая кешированная обертка вокруг глобального `Intl`. Она мемоизирует экземпляры `NumberFormat`, `DateTimeFormat`, `RelativeTimeFormat`, что позволяет избежать повторного создания одного и того же форматтера.
48
+
49
+ Поскольку создание форматтера относительно дорогостоящее, такое кеширование улучшает производительность без изменения поведения. Обертка предоставляет тот же API, что и нативный `Intl`, поэтому использование идентично.
50
+
51
+ - Кеширование происходит на уровне процесса и прозрачно для вызывающих.
52
+
53
+ > Если `Intl.DisplayNames` недоступен в среде, выводится одно предупреждение только для разработчиков (рекомендуется использовать полифилл).
54
+
55
+ Пример:
56
+
57
+ ```ts
58
+ import { Intl } from "intlayer";
59
+
60
+ const numberFormat = new Intl.NumberFormat("en-GB", {
61
+ style: "currency",
62
+ currency: "GBP",
63
+ });
64
+ numberFormat.format(1234.5); // "£1,234.50"
65
+ ```
66
+
67
+ ## Форматтеры
68
+
69
+ Все приведённые ниже помощники экспортируются из `intlayer`.
70
+
71
+ ### `number(value, options?)`
72
+
73
+ Форматирует числовое значение с учётом локальных правил группировки и десятичных знаков.
74
+
75
+ - **value**: `number | string`
76
+ - **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
77
+
78
+ Примеры:
79
+
80
+ ```ts
81
+ import { number } from "intlayer";
82
+
83
+ number(123456.789); // "123,456.789" (в en-US)
84
+ number("1000000", { locale: "fr" }); // "1 000 000"
85
+ number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
86
+ ```
87
+
88
+ ### `percentage(value, options?)`
89
+
90
+ Форматирует число в строку с процентами.
91
+
92
+ Поведение: значения больше 1 интерпретируются как целые проценты и нормализуются (например, `25` → `25%`, `0.25` → `25%`).
93
+
94
+ - **value**: `number | string`
95
+ - **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
96
+
97
+ Примеры:
98
+
99
+ ```ts
100
+ import { percentage } from "intlayer";
101
+
102
+ percentage(0.25); // "25%"
103
+ percentage(25); // "25%"
104
+ percentage(0.237, { minimumFractionDigits: 1 }); // "23.7%"
105
+ ```
106
+
107
+ ### `currency(value, options?)`
108
+
109
+ Форматирует значение как локализованную валюту. По умолчанию используется `USD` с двумя десятичными знаками.
110
+
111
+ - **value**: `number | string`
112
+ - **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
113
+ - Общие поля: `currency` (например, `"EUR"`), `currencyDisplay` (`"symbol" | "code" | "name"`)
114
+
115
+ Примеры:
116
+
117
+ ```ts
118
+ import { currency } from "intlayer";
119
+
120
+ currency(1234.5, { currency: "EUR" }); // "€1,234.50"
121
+ currency("5000", { locale: "fr", currency: "CAD", currencyDisplay: "code" }); // "5 000,00 CAD"
122
+ ```
123
+
124
+ ### `date(date, optionsOrPreset?)`
125
+
126
+ Форматирует значение даты/времени с помощью `Intl.DateTimeFormat`.
127
+
128
+ - **date**: `Date | string | number`
129
+ - **optionsOrPreset**: `Intl.DateTimeFormatOptions & { locale?: LocalesValues }` или один из предустановленных вариантов:
130
+ - Предустановки: `"short" | "long" | "dateOnly" | "timeOnly" | "full"`
131
+
132
+ Примеры:
133
+
134
+ ```ts
135
+ import { date } from "intlayer";
136
+
137
+ date(new Date(), "short"); // например, "08/02/25, 14:30"
138
+ date("2025-08-02T14:30:00Z", { locale: "fr", month: "long", day: "numeric" }); // "2 août"
139
+ ```
140
+
141
+ ### `relativeTime(from, to = new Date(), options?)`
142
+
143
+ Форматирует относительное время между двумя моментами с помощью `Intl.RelativeTimeFormat`.
144
+
145
+ - Передайте "now" в качестве первого аргумента, а целевое время — вторым, чтобы получить естественную формулировку.
146
+ - **from**: `Date | string | number`
147
+ - **to**: `Date | string | number` (по умолчанию `new Date()`)
148
+ - **options**: `{ locale?: LocalesValues; unit?: Intl.RelativeTimeFormatUnit; numeric?: Intl.RelativeTimeFormatNumeric; style?: Intl.RelativeTimeFormatStyle }`
149
+ - По умолчанию `unit` — `"second"`.
150
+
151
+ Примеры:
152
+
153
+ ```ts
154
+ import { relativeTime } from "intlayer";
155
+
156
+ const now = new Date();
157
+ const in3Days = new Date(now.getTime() + 3 * 864e5);
158
+ relativeTime(now, in3Days, { unit: "day" }); // "через 3 дня"
159
+
160
+ const twoHoursAgo = new Date(now.getTime() - 2 * 3600e3);
161
+ relativeTime(now, twoHoursAgo, { unit: "hour", numeric: "auto" }); // "2 часа назад"
162
+ ```
163
+
164
+ ### `units(value, options?)`
165
+
166
+ Форматирует числовое значение как локализованную строку с единицей измерения, используя `Intl.NumberFormat` с `style: 'unit'`.
167
+
168
+ - **value**: `number | string`
169
+ - **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
170
+ - Общие поля: `unit` (например, `"kilometer"`, `"byte"`), `unitDisplay` (`"short" | "narrow" | "long"`)
171
+ - Значения по умолчанию: `unit: 'day'`, `unitDisplay: 'short'`, `useGrouping: false`
172
+
173
+ Примеры:
174
+
175
+ ```ts
176
+ import { units } from "intlayer";
177
+
178
+ units(5, { unit: "kilometer", unitDisplay: "long", locale: "en-GB" }); // "5 kilometers"
179
+ units(1024, { unit: "byte", unitDisplay: "narrow" }); // "1,024B" (зависит от локали)
180
+ ```
181
+
182
+ ### `compact(value, options?)`
183
+
184
+ Форматирует число, используя компактную нотацию (например, `1.2K`, `1M`).
185
+
186
+ - **value**: `number | string`
187
+ - **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }` (использует `notation: 'compact'` под капотом)
188
+
189
+ Примеры:
190
+
191
+ ```ts
192
+ import { compact } from "intlayer";
193
+
194
+ compact(1200); // "1.2K"
195
+ compact("1000000", { locale: "fr", compactDisplay: "long" }); // "1 миллион"
196
+ ```
197
+
198
+ ## Примечания
199
+
200
+ - Все вспомогательные функции принимают входные данные в виде `string`; они внутренне приводятся к числам или датам.
201
+ - Локаль по умолчанию берется из вашей настройки `internationalization.defaultLocale`, если не указана явно.
202
+ - Эти утилиты являются тонкими обертками; для расширенного форматирования используйте стандартные опции `Intl`.
203
+
204
+ ## Точки входа и реэкспорты (`@index.ts`)
205
+
206
+ Форматтеры находятся в основном пакете и реэкспортируются из пакетов более высокого уровня для удобства импорта в разных средах выполнения:
207
+
208
+ Примеры:
209
+
210
+ ```ts
211
+ // Код приложения (рекомендуется)
212
+ import { number, currency, date, Intl } from "intlayer";
213
+ ```
214
+
215
+ ### React
216
+
217
+ Клиентские компоненты:
218
+
219
+ ```ts
220
+ import { useNumber, useCurrency, useDate } from "react-intlayer/format";
221
+ // или в приложениях Next.js
222
+ import { useNumber, useCurrency, useDate } from "next-intlayer/client/format";
223
+ ```
224
+
225
+ Серверные компоненты (или React Server runtime):
226
+
227
+ ```ts
228
+ import { useNumber, useCurrency, useDate } from "intlayer/server/format";
229
+ // или в приложениях Next.js
230
+ import { useNumber, useCurrency, useDate } from "next-intlayer/server/format";
231
+ ```
232
+
233
+ > Эти хуки будут учитывать локаль из `IntlayerProvider` или `IntlayerServerProvider`
234
+
235
+ ## История документации
236
+
237
+ | Версия | Дата | Изменения |
238
+ | ------ | ---------- | ------------------------------------- |
239
+ | 5.8.0 | 2025-08-18 | Добавлена документация по форматтерам |
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  createdAt: 2024-08-14
3
- updatedAt: 2025-06-29
3
+ updatedAt: 2025-08-20
4
4
  title: Преимущества Intlayer
5
5
  description: Узнайте о преимуществах и достоинствах использования Intlayer в ваших проектах. Поймите, почему Intlayer выделяется среди других фреймворков.
6
6
  keywords:
@@ -11,58 +11,122 @@ keywords:
11
11
  - Сравнение
12
12
  slugs:
13
13
  - doc
14
- - concept
15
- - interest
14
+ - why
16
15
  ---
17
16
 
18
- # Intlayer: Индивидуальный способ перевода вашего сайта
17
+ # Почему стоит рассмотреть Intlayer?
19
18
 
20
- **Intlayer** это библиотека интернационализации, разработанная специально для разработчиков на JavaScript. Она позволяет объявлять ваш контент в любом месте вашего кода. Она преобразует объявления многоязычного контента в структурированные словари для легкой интеграции в ваш код. Используя TypeScript, **Intlayer** делает вашу разработку более надежной и эффективной.
19
+ ## Что такое Intlayer?
21
20
 
22
- ## Пример использования
21
+ **Intlayer** это библиотека интернационализации, разработанная специально для JavaScript-разработчиков. Она позволяет объявлять ваш контент в любом месте вашего кода. Она преобразует объявления многоязычного контента в структурированные словари для легкой интеграции в ваш код. Используя TypeScript, **Intlayer** делает вашу разработку более надежной и эффективной.
22
+
23
+ ## Почему был создан Intlayer?
24
+
25
+ Intlayer был создан для решения общей проблемы, которая затрагивает все популярные библиотеки i18n, такие как `next-intl`, `react-i18next`, `react-intl`, `next-i18next`, `react-intl` и `vue-i18n`.
26
+
27
+ Все эти решения используют централизованный подход для перечисления и управления вашим контентом. Например:
28
+
29
+ ```bash
30
+ .
31
+ ├── locales
32
+ │ ├── en.json
33
+ │ ├── fr.json
34
+ │ └── es.json
35
+ ├── i18n.ts
36
+ └── src
37
+ └── components
38
+ └── MyComponent
39
+ └── index.tsx
40
+ ```
41
+
42
+ Или здесь с использованием пространств имён:
43
+
44
+ ```bash
45
+ .
46
+ ├── locales
47
+ │ ├── en
48
+ │ │ ├── footer.json
49
+ │ │ └── navbar.json
50
+ │ ├── fr
51
+ │ │ ├── footer.json
52
+ │ │ └── navbar.json
53
+ │ └── es
54
+ │ ├── footer.json
55
+ │ └── navbar.json
56
+ ├── i18n.ts
57
+ └── src
58
+ └── components
59
+ └── MyComponent
60
+ └── index.tsx
61
+ ```
62
+
63
+ Такой тип архитектуры замедляет процесс разработки и усложняет поддержку кода по нескольким причинам:
64
+
65
+ 1. **Для каждого нового созданного компонента необходимо:**
66
+ - Создать новый ресурс/пространство имён в папке `locales`
67
+ - Не забыть импортировать новое пространство имён на вашей странице
68
+ - Перевести ваш контент (часто выполняется вручную путём копирования/вставки из AI-сервисов)
69
+
70
+ 2. **Для любых изменений в ваших компонентах необходимо:**
71
+ - Найти соответствующий ресурс/пространство имён (которое находится далеко от компонента)
72
+ - Перевести ваш контент
73
+ - Убедиться, что ваш контент актуален для всех локалей
74
+ - Проверить, что в вашем пространстве имён нет неиспользуемых ключей/значений
75
+ - Убедиться, что структура ваших JSON-файлов одинакова для всех локалей
76
+
77
+ В профессиональных проектах, использующих эти решения, часто применяются платформы локализации для управления переводом вашего контента. Однако для крупных проектов это может быстро стать дорогостоящим.
78
+
79
+ Для решения этой проблемы Intlayer использует подход, при котором контент ограничивается областью компонента и хранится рядом с вашим компонентом, как это часто делается с CSS (`styled-components`), типами, документацией (`storybook`) или модульными тестами (`jest`).
23
80
 
24
81
  ```bash codeFormat="typescript"
25
82
  .
26
- └── Components
83
+ └── components
27
84
  └── MyComponent
28
85
  ├── index.content.ts
86
+ ├── index.test.tsx
87
+ ├── index.stories.tsx
29
88
  └── index.tsx
30
89
  ```
31
90
 
32
91
  ```bash codeFormat="commonjs"
33
92
  .
34
- └── Components
93
+ └── components
35
94
  └── MyComponent
36
95
  ├── index.content.cjs
37
- └── index.mjs
96
+ ├── index.test.mjs
97
+ ├── index.stories.mjs
98
+ └── index.tsx
38
99
  ```
39
100
 
40
101
  ```bash codeFormat="esm"
41
102
  .
42
- └── Components
103
+ └── components
43
104
  └── MyComponent
44
105
  ├── index.content.mjs
45
- └── index.js
106
+ ├── index.test.mjs
107
+ ├── index.stories.mjs
108
+ └── index.tsx
46
109
  ```
47
110
 
48
- ```tsx fileName="./Components/MyComponent/index.content.ts" codeFormat="typescript"
111
+ ```tsx fileName="./components/MyComponent/index.content.ts" codeFormat="typescript"
49
112
  import { t, type Dictionary } from "intlayer";
50
113
 
51
114
  const componentExampleContent = {
52
115
  key: "component-example",
53
116
  content: {
54
117
  myTranslatedContent: t({
55
- en: "Hello World", // английский
56
- fr: "Bonjour le monde", // французский
57
- es: "Hola Mundo", // испанский
118
+ en: "Hello World",
119
+ es: "Hola Mundo",
120
+ fr: "Bonjour le monde",
58
121
  }),
59
122
  },
60
123
  } satisfies Dictionary;
61
124
 
125
+ // Экспортируем контент компонента по умолчанию
62
126
  export default componentExampleContent;
63
127
  ```
64
128
 
65
- ```jsx fileName="./Components/MyComponent/index.mjx" codeFormat="esm"
129
+ ```jsx fileName="./components/MyComponent/index.mjx" codeFormat="esm"
66
130
  import { t } from "intlayer";
67
131
 
68
132
  /** @type {import('intlayer').Dictionary} */
@@ -70,9 +134,9 @@ const componentExampleContent = {
70
134
  key: "component-example",
71
135
  content: {
72
136
  myTranslatedContent: t({
73
- en: "Hello World", // английский
74
- fr: "Bonjour le monde", // французский
75
- es: "Hola Mundo", // испанский
137
+ en: "Hello World",
138
+ es: "Hola Mundo",
139
+ fr: "Bonjour le monde",
76
140
  }),
77
141
  },
78
142
  };
@@ -80,25 +144,27 @@ const componentExampleContent = {
80
144
  export default componentExampleContent;
81
145
  ```
82
146
 
83
- ```jsx fileName="./Components/MyComponent/index.csx" codeFormat="commonjs"
147
+ ```jsx fileName="./components/MyComponent/index.csx" codeFormat="commonjs"
84
148
  const { t } = require("intlayer");
85
149
 
86
150
  /** @type {import('intlayer').Dictionary} */
151
+ // Определение контента компонента с переводами
87
152
  const componentExampleContent = {
88
153
  key: "component-example",
89
154
  content: {
90
155
  myTranslatedContent: t({
91
- en: "Hello World", // английский
92
- fr: "Bonjour le monde", // французский
93
- es: "Hola Mundo", // испанский
156
+ en: "Hello World",
157
+ es: "Hola Mundo",
158
+ fr: "Bonjour le monde",
94
159
  }),
95
160
  },
96
161
  };
97
162
 
163
+ // Экспортируем контент компонента для CommonJS
98
164
  module.exports = componentExampleContent;
99
165
  ```
100
166
 
101
- ```tsx fileName="./Components/MyComponent/index.tsx" codeFormat="typescript"
167
+ ```tsx fileName="./components/MyComponent/index.tsx" codeFormat="typescript"
102
168
  import { useIntlayer } from "react-intlayer";
103
169
 
104
170
  export const ComponentExample = () => {
@@ -108,7 +174,7 @@ export const ComponentExample = () => {
108
174
  };
109
175
  ```
110
176
 
111
- ```jsx fileName="./Components/MyComponent/index.mjx" codeFormat="esm"
177
+ ```jsx fileName="./components/MyComponent/index.mjx" codeFormat="esm"
112
178
  import { useIntlayer } from "react-intlayer";
113
179
 
114
180
  const ComponentExample = () => {
@@ -118,7 +184,7 @@ const ComponentExample = () => {
118
184
  };
119
185
  ```
120
186
 
121
- ```jsx fileName="./Components/MyComponent/index.csx" codeFormat="commonjs"
187
+ ```jsx fileName="./components/MyComponent/index.csx" codeFormat="commonjs"
122
188
  const { useIntlayer } = require("react-intlayer");
123
189
 
124
190
  const ComponentExample = () => {
@@ -128,27 +194,79 @@ const ComponentExample = () => {
128
194
  };
129
195
  ```
130
196
 
131
- ## Почему стоит выбрать Intlayer?
132
-
133
- | Особенность | Описание |
134
- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
135
- | **Управление контентом на базе JavaScript** | Используйте гибкость JavaScript для эффективного определения и управления вашим контентом. |
136
- | **Типобезопасная среда** | Используйте TypeScript, чтобы гарантировать точность и отсутствие ошибок во всех ваших определениях контента. |
137
- | **Интегрированные файлы контента** | Держите ваши переводы рядом с соответствующими компонентами, что повышает удобство поддержки и ясность. |
138
- | **Упрощённая настройка** | Быстрый запуск с минимальной конфигурацией, особенно оптимизирован для проектов на Next.js. |
139
- | **Поддержка серверных компонентов** | Идеально подходит для серверных компонентов Next.js, обеспечивая плавный рендеринг на стороне сервера. |
140
- | **Расширенная маршрутизация** | Полная поддержка маршрутизации приложений Next.js, плавно адаптирующаяся к сложным структурам приложений. |
141
- | **Организованная кодовая база** | Поддерживайте вашу кодовую базу более организованной: 1 компонент = 1 словарь в той же папке. |
142
- | **Автоматический перевод в CI** | Автоматически заполняйте ваши переводы в CI, используя собственный API-ключ OpenAI, исключая необходимость в платформе локализации (L10n). |
143
- | **Интеграция MCP сервера** | Обеспечивает MCP (Model Context Protocol) сервер для автоматизации IDE, позволяя бесшовно управлять контентом и рабочими процессами интернационализации (i18n) непосредственно в вашей среде разработки. [Узнать больше](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/mcp_server.md). |
144
- | **Поддержка Markdown** | Импорт и интерпретация файлов markdown для многоязычного контента, такого как политики конфиденциальности. |
145
- | **Бесплатный визуальный редактор и CMS** | Бесплатный визуальный редактор и CMS доступны, если вам нужно работать с авторами контента для ваших переводов, что вновь устраняет необходимость в платформе локализации и позволяет вынести контент за пределы кодовой базы. |
146
- | **Упрощённый доступ к контенту** | Нет необходимости вызывать функцию `t` для каждого элемента контента; получите весь ваш контент напрямую, используя один хук. |
147
- | **Последовательная реализация** | Одинаковая реализация как для клиентских, так и для серверных компонентов, нет необходимости передавать функцию `t` через каждый серверный компонент. |
148
- | **Контент с возможностью tree-shaking** | Контент поддерживает tree-shaking, что уменьшает размер итогового бандла. |
149
- | **Неблокирующий статический рендеринг** | Intlayer не блокирует статический рендеринг, в отличие от `next-intl`. |
150
- | **Взаимодействие** | Обеспечивает взаимодействие с [react-i18next](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_react-i18next.md), [next-i18next](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_next-i18next.md), [next-intl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_next-intl.md) и [react-intl](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/intlayer_with_react-intl.md). |
151
-
152
- ## История документации
153
-
154
- - 5.5.10 - 2025-06-29: Инициализация истории
197
+ Этот подход позволяет вам:
198
+
199
+ 1. **Увеличить скорость разработки**
200
+ - Файлы `.content.{{ts|mjs|cjs|json}}` можно создавать с помощью расширения для VSCode
201
+ - Инструменты автозаполнения на базе ИИ в вашей IDE (например, GitHub Copilot) могут помочь вам объявлять ваш контент, уменьшая необходимость копирования/вставки
202
+
203
+ 2. **Снизить сложность вашей кодовой базы**
204
+
205
+ 3. **Повысить поддерживаемость вашей кодовой базы**
206
+
207
+ 4. **Проще дублировать ваши компоненты и связанный с ними контент (например: компоненты входа/регистрации и т.д.)**
208
+ - Ограничивая риск влияния на контент других компонентов
209
+ - Копируя и вставляя ваш контент из одного приложения в другое без внешних зависимостей
210
+
211
+ 5. **Избегать загрязнения кодовой базы неиспользуемыми ключами/значениями для неиспользуемых компонентов**
212
+ - Если вы не используете компонент, вам не нужно импортировать его контент
213
+ - Если вы удаляете компонент, вам будет проще не забыть удалить связанный с ним контент, так как он будет находиться в той же папке
214
+
215
+ 6. **Снизить затраты на размышления для ИИ-агентов при объявлении вашего многоязычного контента**
216
+ - ИИ-агенту не нужно сканировать всю вашу кодовую базу, чтобы понять, где реализовать ваш контент
217
+ - Переводы легко выполняются с помощью инструментов автозаполнения на базе ИИ в вашей IDE (например, GitHub Copilot)
218
+
219
+ 7. **Оптимизировать производительность загрузки**
220
+ - Если компонент загружается лениво, связанный с ним контент будет загружен одновременно
221
+
222
+ ## Дополнительные возможности Intlayer
223
+
224
+ | Функция | Описание |
225
+ | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
226
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true) | **Поддержка нескольких фреймворков**<br><br>Intlayer совместим со всеми основными фреймворками и библиотеками, включая Next.js, React, Vite, Vue.js, Nuxt, Preact, Express и другие. |
227
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.png?raw=true) | **Управление контентом на основе JavaScript**<br><br>Используйте гибкость JavaScript для эффективного определения и управления вашим контентом. <br><br> - [Объявление контента](https://intlayer.org/doc/concept/content) |
228
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true) | **Файл объявления контента для каждого локалитета**<br><br>Ускорьте разработку, объявляя ваш контент один раз, до автоматической генерации.<br><br> - [Файл объявления контента для каждого локалитета](https://intlayer.org/doc/concept/per-locale-file) |
229
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true) | **Типобезопасная среда**<br><br>Используйте TypeScript, чтобы гарантировать отсутствие ошибок в определениях контента и коде, а также получать преимущества автозаполнения в IDE.<br><br> - [Настройка TypeScript](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
230
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true) | **Упрощённая настройка**<br><br>Быстрый старт с минимальной конфигурацией. Легко настраивайте параметры интернационализации, маршрутизации, ИИ, сборки и обработки контента.<br><br> - [Изучите интеграцию с Next.js](https://intlayer.org/doc/environment/nextjs) |
231
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true) | **Упрощённый доступ к контенту**<br><br>Нет необходимости вызывать функцию `t` для каждого элемента контента. Получайте весь ваш контент напрямую с помощью одного хука.<br><br> - [Интеграция с React](https://intlayer.org/doc/environment/create-react-app) |
232
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true) | **Единообразная реализация серверных компонентов**<br><br>Идеально подходит для серверных компонентов Next.js, используйте одну и ту же реализацию как для клиентских, так и для серверных компонентов, нет необходимости передавать функцию `t` через каждый серверный компонент. <br><br> - [Серверные компоненты](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code) |
233
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true) | **Организованная кодовая база**<br><br>Поддерживайте вашу кодовую базу более организованной: 1 компонент = 1 словарь в той же папке. Переводы, расположенные рядом с соответствующими компонентами, повышают удобство сопровождения и ясность. <br><br> - [Как работает Intlayer](https://intlayer.org/doc/concept/how-works-intlayer) |
234
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true) | **Расширенная маршрутизация**<br><br>Полная поддержка маршрутизации приложений, плавно адаптирующаяся к сложным структурам приложений для Next.js, React, Vite, Vue.js и других.<br><br> - [Изучите интеграцию с Next.js](https://intlayer.org/doc/environment/nextjs) |
235
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true) | **Поддержка Markdown**<br><br>Импортируйте и интерпретируйте локализационные файлы и удалённый Markdown для многоязычного контента, такого как политики конфиденциальности, документация и др. Интерпретируйте и делайте метаданные Markdown доступными в вашем коде.<br><br> - [Файлы контента](https://intlayer.org/doc/concept/content/file) |
236
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.png?raw=true) | **Бесплатный визуальный редактор и CMS**<br><br>Для авторов контента доступен бесплатный визуальный редактор и CMS, что устраняет необходимость в платформе локализации. Сохраняйте синхронизацию контента с помощью Git или полностью/частично внешне управляйте им через CMS.<br><br> - [Редактор Intlayer](https://intlayer.org/doc/concept/editor) <br> - [CMS Intlayer](https://intlayer.org/doc/concept/cms) |
237
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.png?raw=true) | **Контент с поддержкой tree-shaking**<br><br>Контент с поддержкой tree-shaking, уменьшающий размер итогового бандла. Загружает контент по компонентам, исключая неиспользуемый контент из вашего бандла. Поддерживает ленивую загрузку для повышения эффективности загрузки приложения. <br><br> - [Оптимизация сборки приложения](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization) |
238
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.png?raw=true) | **Статическая отрисовка**<br><br>Не блокирует статическую отрисовку. <br><br> - [Интеграция с Next.js](https://intlayer.org/doc/environment/nextjs) |
239
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true) | **Перевод с использованием ИИ**<br><br>Преобразуйте ваш сайт на 231 язык всего одним кликом с помощью продвинутых инструментов перевода на базе ИИ от Intlayer, используя вашего собственного поставщика ИИ/ключ API. <br><br> - [Интеграция CI/CD](https://intlayer.org/doc/concept/ci-cd) <br> - [CLI Intlayer](https://intlayer.org/doc/concept/cli) <br> - [Автозаполнение](https://intlayer.org/doc/concept/auto-fill) |
240
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true) | **Интеграция сервера MCP**<br><br>Обеспечивает сервер MCP (Model Context Protocol) для автоматизации IDE, позволяя бесшовно управлять контентом и процессами интернационализации (i18n) непосредственно в вашей среде разработки. <br><br> - [Сервер MCP](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/mcp_server.md) |
241
+ | ![Функция](https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.png?raw=true) | **Расширение VSCode**<br><br>Intlayer предоставляет расширение для VSCode, которое поможет вам управлять вашим контентом и переводами, создавать словари, переводить ваш контент и многое другое. <br><br> - [Расширение VSCode](https://intlayer.org/doc/vs-code-extension) |
242
+ | ![Feature](https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true) | **Взаимодействие**<br><br>Обеспечивает взаимодействие с react-i18next, next-i18next, next-intl и react-intl. <br><br> - [Intlayer и react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer и next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer и next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next) |
243
+
244
+ ## Сравнение Intlayer с другими решениями
245
+
246
+ | Функция | Intlayer | React-i18next / i18next | React-Intl (FormatJS) | LinguiJS | next-intl | next-i18next | vue-i18n |
247
+ | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | ------------------------------------------------------------------- |
248
+ | **Переводы рядом с компонентами** | Да, контент расположен рядом с каждым компонентом | Нет | Нет | Нет | Нет | Нет | Да - с использованием `Single File Components` (SFCs) |
249
+ | **Интеграция с TypeScript** | Продвинутая, автоматически сгенерированные строгие типы | Базовая; дополнительная конфигурация для безопасности | Хорошая, но менее строгая | Типы, требуется конфигурация | Хорошая | Базовая | Хорошая (типы доступны; требуется настройка безопасности ключей) |
250
+ | **Обнаружение отсутствующих переводов** | Ошибка/предупреждение во время сборки | В основном строки-заменители во время выполнения | Строки-заменители | Требуется дополнительная настройка | Строки-заменители во время выполнения | Строки-заменители во время выполнения | Строки-заменители/предупреждения во время выполнения (настраиваемо) |
251
+ | **Обогащённый контент (JSX/Markdown/компоненты)** | Прямая поддержка, включая React-узлы | Ограничено / только интерполяция | Синтаксис ICU, не настоящий JSX | Ограничено | Не предназначено для сложных узлов | Ограничено | Ограничено (компоненты через `<i18n-t>`, Markdown через плагины) |
252
+ | **Перевод с использованием ИИ** | Да, поддерживает нескольких поставщиков ИИ. Можно использовать с собственными API-ключами. Учитывает контекст вашего приложения и объем контента | Нет | Нет | Нет | Нет | Нет | Нет |
253
+ | **Визуальный редактор** | Да, локальный визуальный редактор + опциональная CMS; может вынести содержимое кодовой базы; встраиваемый | Нет / доступно через внешние платформы локализации | Нет / доступно через внешние платформы локализации | Нет / доступно через внешние платформы локализации | Нет / доступно через внешние платформы локализации | Нет / доступно через внешние платформы локализации | Нет / доступно через внешние платформы локализации |
254
+ | **Локализованная маршрутизация** | Встроенная, поддержка middleware | Плагины или ручная настройка | Не встроена | Плагин/ручная настройка | Встроена | Встроена | Вручную через Vue Router (обрабатывается Nuxt i18n) |
255
+ | **Динамическая генерация маршрутов** | Да | Плагин/экосистема или ручная настройка | Не предоставляется | Плагин/ручная настройка | Да | Да | Не предоставляется (предоставляется Nuxt i18n) |
256
+ | **Множественное число** | Шаблоны на основе перечислений; см. документацию | Настраиваемо (плагины, такие как i18next-icu) | Продвинутое (ICU) | Продвинутое (ICU/messageformat) | Хорошо | Хорошо | Продвинутое (встроенные правила множественного числа) |
257
+ | **Форматирование (даты, числа, валюты)** | Оптимизированные форматтеры (Intl под капотом) | Через плагины или пользовательское использование Intl | Продвинутые ICU форматтеры | Помощники ICU/CLI | Хорошо (помощники Intl) | Хорошо (помощники Intl) | Встроенные форматтеры даты/числа (Intl) |
258
+ | **Формат содержимого** | .tsx, .ts, .js, .json, .md, .txt | .json | .json, .js | .po, .json | .json, .js, .ts | .json | .json, .js |
259
+ | **Поддержка ICU** | В разработке (родной ICU) | Через плагин (i18next-icu) | Да | Да | Да | Через плагин (i18next-icu) | Через пользовательский форматтер/компилятор |
260
+ | **SEO помощники (hreflang, sitemap)** | Встроенные инструменты: помощники для sitemap, **robots.txt**, метаданные | Плагины сообщества/ручное управление | Не является ядром | Не является ядром | Хорошо | Хорошо | Не является ядром (Nuxt i18n предоставляет помощники) |
261
+ | **Экосистема / Сообщество** | Меньше, но быстро растет и активно реагирует | Самое большое и зрелое | Большое, корпоративное | Растущее, меньше | Среднего размера, ориентировано на Next.js | Среднего размера, ориентировано на Next.js | Большое в экосистеме Vue |
262
+ | **Серверный рендеринг и серверные компоненты** | Да, оптимизировано для SSR / React Server Components | Поддерживается, требуется некоторая настройка | Поддерживается в Next.js | Поддерживается | Полная поддержка | Полная поддержка | SSR через Nuxt/Vue SSR (без RSC) |
263
+ | **Tree-shaking (загрузка только используемого контента)** | Да, на уровне компонентов во время сборки с помощью плагинов Babel/SWC | Обычно загружает всё (можно улучшить с помощью пространств имён/разделения кода) | Обычно загружает всё | Не по умолчанию | Частично | Частично | Частично (с разделением кода/ручной настройкой) |
264
+ | **Ленивая загрузка** | Да, по локалям/по компонентам | Да (например, бэкенды/пространства имён по требованию) | Да (разделение пакетов локалей) | Да (динамический импорт каталогов) | Да (по маршрутам/локалям) | Да (по маршрутам/локалям) | Да (асинхронные сообщения локалей) |
265
+ | **Управление крупными проектами** | Поощряет модульность, подходит для дизайн-систем | Требует хорошей дисциплины в работе с файлами | Центральные каталоги могут стать большими | Может стать сложным | Модульный с настройкой | Модульный с настройкой | Модульный с настройкой Vue Router/Nuxt i18n |
266
+
267
+ ## История документа
268
+
269
+ | Версия | Дата | Изменения |
270
+ | ------ | ---------- | -------------------------------- |
271
+ | 5.8.0 | 2025-08-19 | Обновление сравнительной таблицы |
272
+ | 5.5.10 | 2025-06-29 | Инициализация истории |