@intlayer/i18next 8.12.5-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.
package/README.md ADDED
@@ -0,0 +1,330 @@
1
+ <p align="center">
2
+ <a href="https://intlayer.org" rel="">
3
+ <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.png" width="60%" alt="Intlayer Logo" />
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">
8
+ <strong>Per-component i18n</strong>
9
+ </h1>
10
+
11
+ <h2 align="center">
12
+ <strong>AI-powered translation. Visual Editor. Multilingual CMS.</strong>
13
+ </h2>
14
+
15
+ <br />
16
+
17
+ <p align="center">
18
+ <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
19
+ <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
20
+ <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
21
+ <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
22
+ <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
23
+ </p>
24
+ <p align="center" style="margin-top:15px;">
25
+ <a href="https://www.npmjs.com/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/intlayer?style=for-the-badge&labelColor=FFFFFF&color=000000&logoColor=FFFFFF" alt="npm version" height="24"/></a>
26
+ <a href="https://github.com/aymericzip/intlayer/stargazers" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/stars/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logo=github&logoColor=FFD700" alt="GitHub Stars" height="24"/></a>
27
+ <a href="https://www.npmjs.org/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="monthly downloads" height="24"/></a>
28
+ <a href="https://github.com/aymericzip/intlayer/blob/main/LICENSE" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/license/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="license"/></a>
29
+ <a href="https://github.com/aymericzip/intlayer/commits/main" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/last-commit/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="last commit"/>
30
+ </a>
31
+ </p>
32
+
33
+ ![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
34
+
35
+ <a href="https://intlayer.org/doc/concept/content" rel="">
36
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
37
+ </a>
38
+
39
+ ## What is Intlayer?
40
+
41
+ Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
42
+
43
+ Intlayer is a **modern i18n solution** for web and mobile apps.
44
+ It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
45
+
46
+ With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
47
+
48
+ ## Keys benefits of Intlayer:
49
+
50
+ | Feature | Description |
51
+ | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
52
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true" alt="Feature" width="700"> | **Cross-Frameworks Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more. |
53
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.jpg?raw=true" alt="Feature" width="700"> | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content) |
54
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true" alt="Feature" width="700"> | **Per-Locale Content Declaration File**<br><br>Speed up your development by declaring your content once, before auto generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file) |
55
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/compiler.jpg?raw=true" alt="Feature" width="700"> | **Compiler**<br><br>The Intlayer Compiler extract automatically the content from the components and generate the dictionary files.<br><br> - [Compiler](https://intlayer.org/doc/compiler) |
56
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700"> | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
57
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true" alt="Feature" width="700"> | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalization, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
58
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true" alt="Feature" width="700"> | **Simplified Content Retrieval**<br><br>No need to call your `t` function for each piece of content. Retrieve all your content directly using a single hook.<br><br> - [React integration](https://intlayer.org/doc/environment/create-react-app) |
59
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true" alt="Feature" width="700"> | **Consistent Server Component Implementation**<br><br>Perfectly suited for Next.js server components, use the same implementation for both client and server components, no need to pass your `t` function across each server component. <br><br> - [Server Components](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code) |
60
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true" alt="Feature" width="700"> | **Organized Codebase**<br><br>Keep your codebase more organized: 1 component = 1 dictionary in the same folder. Translations close to their respective components, enhance maintainability and clarity. <br><br> - [How Intlayer works](https://intlayer.org/doc/concept/how-works-intlayer) |
61
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true" alt="Feature" width="700"> | **Enhanced Routing**<br><br>Full support of app routing, adapting seamlessly to complex application structures, for Next.js, React, Vite, Vue.js, etc.<br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
62
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true" alt="Feature" width="700"> | **Markdown Support**<br><br>Import and interpret, locale files and remote Markdown for multilingual content like privacy policies, documentation, etc. Interpret and make Markdown metadata accessible in your code.<br><br> - [Content files](https://intlayer.org/doc/concept/content/file) |
63
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.png?raw=true" alt="Feature" width="700"> | **Free Visual Editor & CMS**<br><br>A free visual editor and CMS are available for content writers, removing the need for a localization platform. Keep your content synchronized using Git, or externalize it totally or partially with the CMS.<br><br> - [Intlayer Editor](https://intlayer.org/doc/concept/editor) <br> - [Intlayer CMS](https://intlayer.org/doc/concept/cms) |
64
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.png?raw=true" alt="Feature" width="700"> | **Tree-shakable Content**<br><br>Tree-shakable content, reducing the size of the final bundle. Loads content per component, excluding any unused content from your bundle. Supports lazy loading to enhance app loading efficiency. <br><br> - [App build optimization](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization) |
65
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.png?raw=true" alt="Feature" width="700"> | **Static Rendering**<br><br>Doesn't block Static Rendering. <br><br> - [Next.js integration](https://intlayer.org/doc/environment/nextjs) |
66
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true" alt="Feature" width="700"> | **AI-Powered Translation**<br><br>Transform your website into 231 languages with just one click using Intlayer's advanced AI-powered translation tools using your own AI provider / API key. <br><br> - [CI/CD integration](https://intlayer.org/doc/concept/ci-cd) <br> - [Intlayer CLI](https://intlayer.org/doc/concept/cli) <br> - [Auto fill](https://intlayer.org/doc/concept/auto-fill) |
67
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true" alt="Feature" width="700"> | **MCP Server Integration**<br><br>Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. <br><br> - [MCP Server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md) |
68
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.png?raw=true" alt="Feature" width="700"> | **VSCode Extension**<br><br>Intlayer provides a VSCode extension to help you manage your content and translations, building your dictionaries, translating your content, and more. <br><br> - [VSCode Extension](https://intlayer.org/doc/vs-code-extension) |
69
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true" alt="Feature" width="700"> | **Interoperability**<br><br>Allow interoperability with react-i18next, next-i18next, next-intl, react-intl, vue-i18n. <br><br> - [Intlayer and react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer and next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer and next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next) <br> - [Intlayer and vue-i18n](https://intlayer.org/blog/intlayer-with-vue-i18n) |
70
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/benchmark.png?raw=true" alt="Feature" width="700"> | **Performances & Benchmark**<br><br>Uses advanced tree-shaking and dynamic loading to boost performances and keep the solution as light as possible. <br><br> - [Performances & Benchmark](https://intlayer.org/doc/benchmark) |
71
+
72
+ ---
73
+
74
+ ## 📦 Installation
75
+
76
+ Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
77
+
78
+ <a href="https://intlayer.org/doc/concept/content" rel="">
79
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
80
+ </a>
81
+
82
+ ```bash
83
+ npm install intlayer react-intlayer
84
+ ```
85
+
86
+ ⚡ Quick Start (Next.js)
87
+
88
+ ```ts
89
+ // intlayer.config.ts
90
+ import { Locales, type IntlayerConfig } from "intlayer";
91
+
92
+ const config: IntlayerConfig = {
93
+ internationalization: {
94
+ locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
95
+ defaultLocale: Locales.ENGLISH,
96
+ },
97
+ };
98
+
99
+ export default config;
100
+ ```
101
+
102
+ ```ts
103
+ // app/home.content.ts
104
+ import { t, type Dictionary } from "intlayer";
105
+
106
+ const content = {
107
+ key: "home",
108
+ content: {
109
+ title: t({
110
+ en: "Home",
111
+ fr: "Accueil",
112
+ es: "Inicio",
113
+ }),
114
+ },
115
+ } satisfies Dictionary;
116
+
117
+ export default content;
118
+ ```
119
+
120
+ ```tsx
121
+ // app/page.tsx
122
+ import { useIntlayer } from "react-intlayer";
123
+
124
+ const HomePage = () => {
125
+ const { title } = useIntlayer("home");
126
+
127
+ return <h1>{title}</h1>;
128
+ };
129
+ ```
130
+
131
+ <a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
132
+
133
+ ## 🎥 Live tutorial on YouTube
134
+
135
+ [![How to Internationalize your application using Intlayer](https://i.ytimg.com/vi/e_PPG7PTqGU/hqdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLDtyJ4uYotEjl12nZ_gZKZ_kjEgOQ)](https://youtu.be/e_PPG7PTqGU?si=GyU_KpVhr61razRw)
136
+
137
+ <a href="https://intlayer.org/doc/concept/content" rel="">
138
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
139
+ </a>
140
+
141
+ ## Table of Contents
142
+
143
+ Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
144
+
145
+ <details open>
146
+ <summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
147
+ <ul>
148
+ <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
149
+ <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
150
+ </ul>
151
+ </details>
152
+
153
+ <details>
154
+ <summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
155
+ <ul>
156
+ <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
157
+ <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
158
+ <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
159
+ <li><a href="https://intlayer.org/doc/compiler" rel=''>Compiler</a></li>
160
+
161
+ <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
162
+ <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
163
+ <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
164
+ <ul>
165
+ <li><a href="https://intlayer.org/doc/concept/content/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
166
+ <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
167
+ <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
168
+ <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
169
+ <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
170
+ <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
171
+ <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
172
+ <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
173
+ <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
174
+ </ul>
175
+ </li>
176
+ </ul>
177
+ </details>
178
+
179
+ <details open>
180
+ <summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
181
+ <ul>
182
+ <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 16</a>
183
+ <ul>
184
+ <li><a href="https://intlayer.org/doc/environment/nextjs/15" rel=''>Next.js 15</a></li>
185
+ <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
186
+ <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-Page-Router" rel=''>Next.js Page Router</a></li>
187
+ <li><a href="https://intlayer.org/doc/environment/nextjs/compiler" rel=''>Next.js using Compiler</a></li>
188
+ </ul>
189
+ </li>
190
+ <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
191
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a></li>
192
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React using Compiler</a></li>
193
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react/compiler" rel=''>React-router-v7</a></li>
194
+ <li><a href="https://intlayer.org/doc/environment/tanstack-start" rel=''>Tanstack start</a>
195
+ <ul>
196
+ <li><a href="https://intlayer.org/doc/environment/tanstack-start/solid" rel=''>Solid</a></li>
197
+ </ul>
198
+ </li>
199
+ <li><a href="https://intlayer.org/doc/environment/astro" rel=''>Astro</a>
200
+ <ul>
201
+ <li><a href="https://intlayer.org/doc/environment/astro/react" rel=''>React</a></li>
202
+ <li><a href="https://intlayer.org/doc/environment/astro/vue" rel=''>Vue</a></li>
203
+ <li><a href="https://intlayer.org/doc/environment/astro/svelte" rel=''>Svelte</a></li>
204
+ <li><a href="https://intlayer.org/doc/environment/astro/solid" rel=''>Solid</a></li>
205
+ <li><a href="https://intlayer.org/doc/environment/astro/vanilla" rel=''>Vanilla JS</a></li>
206
+ <li><a href="https://intlayer.org/doc/environment/astro/lit" rel=''>Lit</a></li>
207
+ </ul>
208
+ </li>
209
+
210
+ <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
211
+ <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
212
+ <li><a href="https://intlayer.org/doc/environment/sveltekit" rel=''>SvelteKit</a></li>
213
+ <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
214
+ <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
215
+ <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
216
+ <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
217
+ <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
218
+ <li>
219
+ <a href="https://intlayer.org/doc/environment/express" rel=''>Backend</a>
220
+ <ul>
221
+ <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
222
+ <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
223
+ <li><a href="https://intlayer.org/doc/environment/fastify" rel=''>Fastify</a></li>
224
+ <li><a href="https://intlayer.org/doc/environment/adonisjs" rel=''>AdonisJS</a></li>
225
+ <li><a href="https://intlayer.org/doc/environment/hono" rel=''>Hono</a></li>
226
+ </ul>
227
+ </li>
228
+ </ul>
229
+ </details>
230
+
231
+ <details>
232
+ <summary style="font-size:16px; font-weight:bold;">📊 Benchmark</summary>
233
+ <ul>
234
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/nextjs.md" rel=''>Next.js</a></li>
235
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md" rel=''>TanStack Start</a></li>
236
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/vue.md" rel=''>Vue</a></li>
237
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/solid.md" rel=''>Solid</a></li>
238
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md" rel=''>Svelte</a></li>
239
+ </ul>
240
+ </details>
241
+
242
+ <details>
243
+ <summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
244
+ <ul>
245
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
246
+ <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
247
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
248
+ <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
249
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
250
+ </ul>
251
+ </details>
252
+
253
+ ## Multilingual content management system
254
+
255
+ More than an i18n library, Intlayer is a complete **multilingual content management system**. A full CMS is available for free at [app.intlayer.org](https://app.intlayer.org).
256
+
257
+ Intlayer connects **developers**, **copywriters**, and **AI agents** in one workflow for creating and maintaining multilingual websites effortlessly.Intlayer replaces the following stack in a single solution:
258
+
259
+ - i18n solutions (e.g. `i18next`, `next-intl`, `vue-i18n`)
260
+ - TMSs (Translation Management Systems) (e.g. Crowdin, Phrase, Lokalise)
261
+ - Feature flags
262
+ - Headless CMSs (e.g. Contentful, Strapi, Sanity)
263
+
264
+ ![CMS Preview](https://github.com/aymericzip/intlayer/blob/main/docs/assets/CMS.png?raw=true)
265
+
266
+ ## 🌐 Readme in other languages
267
+
268
+ <p align="center">
269
+ <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
270
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
271
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
272
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
273
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
274
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
275
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
276
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
277
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
278
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
279
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
280
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
281
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
282
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
283
+ </p>
284
+
285
+ ## 🤝 Community
286
+
287
+ Intlayer is built with and for the community and we’d love your input!
288
+
289
+ - Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
290
+ - Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
291
+ - Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
292
+
293
+ You can also follow us on :
294
+
295
+ <div>
296
+ <br/>
297
+ <p align="center">
298
+ <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
299
+ src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
300
+ alt="Intlayer Discord" height="30"/></a>
301
+ <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
302
+ src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
303
+ alt="Intlayer LinkedIn" height="30"/></a>
304
+ <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
305
+ src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
306
+ alt="Intlayer Instagram" height="30"/></a>
307
+ <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
308
+ src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
309
+ alt="Intlayer X" height="30"/></a>
310
+ <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
311
+ src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
312
+ alt="Intlayer YouTube" height="30"/></a>
313
+ <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
314
+ src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
315
+ alt="Intlayer TikTok" height="30"/></a>
316
+ <br>
317
+ </p>
318
+ </div>
319
+
320
+ ### Contribution
321
+
322
+ For more detailed guidelines on contributing to this project, please refer to the [`CONTRIBUTING.md`](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md) file. It contains essential information on our development process, commit message conventions, and release procedures. Your contributions are valuable to us, and we appreciate your efforts in making this project better!
323
+
324
+ Contribute on [GitHub](https://github.com/aymericzip/intlayer), [GitLab](https://gitlab.com/ay.pineau/intlayer), or [Bitbucket](https://bitbucket.org/intlayer/intlayer/).
325
+
326
+ ### Thank You for the Support
327
+
328
+ If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project! [See why GitHub Stars matter](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md#why-github-stars-matter-).
329
+
330
+ [![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)
@@ -0,0 +1,29 @@
1
+ //#region \0rolldown/runtime.js
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __copyProps = (to, from, except, desc) => {
9
+ if (from && typeof from === "object" || typeof from === "function") {
10
+ for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
11
+ key = keys[i];
12
+ if (!__hasOwnProp.call(to, key) && key !== except) {
13
+ __defProp(to, key, {
14
+ get: ((k) => from[k]).bind(null, key),
15
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
16
+ });
17
+ }
18
+ }
19
+ }
20
+ return to;
21
+ };
22
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
23
+ value: mod,
24
+ enumerable: true
25
+ }) : target, mod));
26
+
27
+ //#endregion
28
+
29
+ exports.__toESM = __toESM;
@@ -0,0 +1,240 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
2
+ const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
3
+ const require_resolveTranslation = require('./resolveTranslation.cjs');
4
+ let _intlayer_config_built = require("@intlayer/config/built");
5
+ let _intlayer_config_colors = require("@intlayer/config/colors");
6
+ _intlayer_config_colors = require_runtime.__toESM(_intlayer_config_colors);
7
+ let _intlayer_config_logger = require("@intlayer/config/logger");
8
+ let _intlayer_core_interpreter = require("@intlayer/core/interpreter");
9
+ let _intlayer_core_messageFormat = require("@intlayer/core/messageFormat");
10
+
11
+ //#region src/createInstance.ts
12
+ const navigatePath = (obj, path) => {
13
+ if (!path) return obj;
14
+ let current = obj;
15
+ for (const part of path.split(".")) {
16
+ if (current === null || current === void 0 || typeof current !== "object") return;
17
+ current = current[part];
18
+ }
19
+ return current;
20
+ };
21
+ const warnIgnoredResources = (location) => {
22
+ (0, _intlayer_config_logger.getAppLogger)({ log: _intlayer_config_built.log })(`${(0, _intlayer_config_logger.colorize)(location, _intlayer_config_colors.CYAN)}: the ${(0, _intlayer_config_logger.colorize)("`resources`", _intlayer_config_colors.CYAN)} option is ignored when using ${(0, _intlayer_config_logger.colorize)("@intlayer/i18next", _intlayer_config_colors.MAGENTA)} — translations are served from the compiled intlayer dictionaries instead. Remove the resource imports and the ${(0, _intlayer_config_logger.colorize)("`resources`", _intlayer_config_colors.CYAN)} option to reduce your bundle size.`);
23
+ };
24
+ const createInstance = (instanceOptions = {}) => {
25
+ if (instanceOptions.resources !== void 0) warnIgnoredResources("createInstance");
26
+ const config = _intlayer_config_built.internationalization;
27
+ let currentLanguage = instanceOptions.lng ?? config?.defaultLocale ?? "en";
28
+ let defaultNS = instanceOptions.defaultNS ?? (Array.isArray(instanceOptions.ns) ? instanceOptions.ns[0] : instanceOptions.ns) ?? "translation";
29
+ const listeners = /* @__PURE__ */ new Map();
30
+ let initialized = false;
31
+ const emit = (event, ...args) => {
32
+ listeners.get(event)?.forEach((h) => {
33
+ h(...args);
34
+ });
35
+ };
36
+ const getSeparators = () => ({
37
+ keySeparator: instanceOptions.keySeparator ?? ".",
38
+ nsSeparator: instanceOptions.nsSeparator ?? ":"
39
+ });
40
+ /**
41
+ * Resolves a key through the full i18next pipeline (namespace prefix,
42
+ * `ns` option, plural/context suffixes, `$t()` nesting, interpolation).
43
+ * Falls back to the interpolated `defaultValue`, then to the key itself.
44
+ */
45
+ const resolveKey = (lang, ns, key, opts) => {
46
+ const options = typeof opts === "string" ? { defaultValue: opts } : opts;
47
+ const resolved = require_resolveTranslation.resolveTranslation({
48
+ locale: lang,
49
+ namespace: ns,
50
+ key,
51
+ options,
52
+ ...getSeparators()
53
+ });
54
+ if (resolved !== void 0) return resolved;
55
+ const defaultValue = options?.defaultValue;
56
+ if (typeof defaultValue === "string") return (0, _intlayer_core_messageFormat.resolveMessage)(defaultValue, require_resolveTranslation.getInterpolationValues(options), lang, "i18next");
57
+ return key;
58
+ };
59
+ const instance = {
60
+ get language() {
61
+ return currentLanguage;
62
+ },
63
+ get languages() {
64
+ return config?.locales?.map(String) ?? [currentLanguage];
65
+ },
66
+ get resolvedLanguage() {
67
+ return currentLanguage;
68
+ },
69
+ get isInitialized() {
70
+ return initialized;
71
+ },
72
+ isInitializing: false,
73
+ initializedStoreOnce: false,
74
+ initializedLanguageOnce: false,
75
+ options: instanceOptions,
76
+ modules: {},
77
+ services: {},
78
+ store: {},
79
+ format: ((value) => String(value)),
80
+ async init(optionsOrCb, cb) {
81
+ const opts = typeof optionsOrCb === "function" ? {} : optionsOrCb ?? {};
82
+ if (opts.resources !== void 0) warnIgnoredResources("i18next.init");
83
+ if (opts.lng) currentLanguage = opts.lng;
84
+ if (opts.defaultNS) defaultNS = opts.defaultNS;
85
+ else if (opts.ns) defaultNS = Array.isArray(opts.ns) ? opts.ns[0] : opts.ns;
86
+ initialized = true;
87
+ emit("initialized", opts);
88
+ const t = instance.t.bind(instance);
89
+ (typeof optionsOrCb === "function" ? optionsOrCb : cb)?.(null, t);
90
+ return t;
91
+ },
92
+ t(key, optionsOrDefaultValue, extraOpts) {
93
+ const options = typeof optionsOrDefaultValue === "string" ? {
94
+ defaultValue: optionsOrDefaultValue,
95
+ ...extraOpts ?? {}
96
+ } : optionsOrDefaultValue;
97
+ const keys = Array.isArray(key) ? key : [String(key)];
98
+ for (const candidateKey of keys) {
99
+ const result = require_resolveTranslation.resolveTranslation({
100
+ locale: currentLanguage,
101
+ namespace: defaultNS,
102
+ key: candidateKey,
103
+ options,
104
+ ...getSeparators()
105
+ });
106
+ if (result !== void 0) return result;
107
+ }
108
+ const defaultValue = options?.defaultValue;
109
+ if (typeof defaultValue === "string") return (0, _intlayer_core_messageFormat.resolveMessage)(defaultValue, require_resolveTranslation.getInterpolationValues(options), currentLanguage, "i18next");
110
+ return defaultValue ?? (Array.isArray(key) ? key[key.length - 1] : key);
111
+ },
112
+ async changeLanguage(lng, cb) {
113
+ const prev = currentLanguage;
114
+ if (lng) currentLanguage = lng;
115
+ emit("languageChanged", currentLanguage, prev);
116
+ const t = instance.t.bind(instance);
117
+ cb?.(null, t);
118
+ return t;
119
+ },
120
+ exists(key, options) {
121
+ return require_resolveTranslation.resolveTranslation({
122
+ locale: currentLanguage,
123
+ namespace: defaultNS,
124
+ key,
125
+ options,
126
+ ...getSeparators()
127
+ }) !== void 0;
128
+ },
129
+ /**
130
+ * Returns a `t()` function bound to a fixed locale and namespace.
131
+ * When `ns` matches a registered intlayer dictionary key, the returned
132
+ * function's `key` parameter is typed to only accept valid dot-notation
133
+ * paths for that dictionary.
134
+ *
135
+ * @example
136
+ * ```ts
137
+ * const tAbout = i18n.getFixedT(null, 'about');
138
+ * tAbout('counter.label'); // ✓ typed
139
+ * ```
140
+ */
141
+ getFixedT(lng, ns, keyPrefix) {
142
+ const fixedLng = Array.isArray(lng) ? lng[0] ?? currentLanguage : lng ?? currentLanguage;
143
+ const fixedNS = ns ?? defaultNS;
144
+ return (key, opts) => {
145
+ return resolveKey(fixedLng, fixedNS, keyPrefix ? `${keyPrefix}.${String(key)}` : String(key), opts);
146
+ };
147
+ },
148
+ use(module) {
149
+ module?.init?.(instance);
150
+ return instance;
151
+ },
152
+ on(event, handler) {
153
+ if (!listeners.has(event)) listeners.set(event, /* @__PURE__ */ new Set());
154
+ listeners.get(event).add(handler);
155
+ return instance;
156
+ },
157
+ once(event, handler) {
158
+ const wrapper = (...args) => {
159
+ handler(...args);
160
+ instance.off(event, wrapper);
161
+ };
162
+ instance.on(event, wrapper);
163
+ return instance;
164
+ },
165
+ off(event, handler) {
166
+ if (!handler) listeners.delete(event);
167
+ else listeners.get(event)?.delete(handler);
168
+ },
169
+ emit(eventName, ...args) {
170
+ emit(eventName, ...args);
171
+ },
172
+ createInstance(opts, _cb) {
173
+ return createInstance({
174
+ ...instanceOptions,
175
+ ...opts
176
+ });
177
+ },
178
+ cloneInstance(opts, _cb) {
179
+ return createInstance({
180
+ ...instanceOptions,
181
+ ...opts
182
+ });
183
+ },
184
+ dir(lng) {
185
+ return [
186
+ "ar",
187
+ "he",
188
+ "fa",
189
+ "ur",
190
+ "ps",
191
+ "yi",
192
+ "dv",
193
+ "ug"
194
+ ].some((l) => (lng ?? currentLanguage).startsWith(l)) ? "rtl" : "ltr";
195
+ },
196
+ setDefaultNamespace(ns) {
197
+ defaultNS = ns;
198
+ },
199
+ hasLoadedNamespace(ns) {
200
+ try {
201
+ (0, _intlayer_core_interpreter.getIntlayer)(Array.isArray(ns) ? ns[0] : ns, currentLanguage);
202
+ return true;
203
+ } catch {
204
+ return false;
205
+ }
206
+ },
207
+ async loadNamespaces(_ns) {},
208
+ async loadLanguages(_lngs) {},
209
+ loadResources(_cb) {},
210
+ async reloadResources() {},
211
+ getDataByLanguage(_lng) {},
212
+ getResource(lng, ns, key) {
213
+ try {
214
+ return navigatePath((0, _intlayer_core_interpreter.getIntlayer)(ns, lng), key);
215
+ } catch {
216
+ return;
217
+ }
218
+ },
219
+ addResource: () => instance,
220
+ addResources: () => instance,
221
+ addResourceBundle: () => instance,
222
+ hasResourceBundle: () => false,
223
+ getResourceBundle: () => void 0,
224
+ removeResourceBundle: () => instance,
225
+ toJSON() {
226
+ return {
227
+ options: instanceOptions,
228
+ store: {},
229
+ language: currentLanguage,
230
+ languages: config?.locales?.map(String) ?? [currentLanguage],
231
+ resolvedLanguage: currentLanguage
232
+ };
233
+ }
234
+ };
235
+ return instance;
236
+ };
237
+
238
+ //#endregion
239
+ exports.createInstance = createInstance;
240
+ //# sourceMappingURL=createInstance.cjs.map