@intlayer/use-intl 9.0.0-canary.2

package/README.md

@@ -0,0 +1,330 @@
+<p align="center">
+  <a href="https://intlayer.org" rel="">
+    <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.png" width="60%" alt="Intlayer Logo" />
+  </a>
+</p>
+
+<h1 align="center">
+  <strong>Per-component i18n</strong>
+</h1>
+
+<h2 align="center">
+  <strong>AI-powered translation. Visual Editor. Multilingual CMS.</strong>
+</h2>
+
+<br />
+
+<p align="center">
+  <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
+  <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
+  <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
+  <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
+  <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
+</p>
+<p align="center" style="margin-top:15px;">
+  <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>
+  <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>
+  <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>
+  <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>
+  <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"/>
+  </a>
+</p>
+
+![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+## What is Intlayer?
+
+Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
+
+Intlayer is a **modern i18n solution** for web and mobile apps.  
+It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
+
+With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
+
+## Keys benefits of Intlayer:
+
+| Feature                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <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.                                                                                                                                                                                                                                                                                                |
+| <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)                                                                                                                                                                                                                                                            |
+| <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)                                                                                                                                                                                                                                          |
+| <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)                                                                                                                                                                                                                                                                                  |
+| <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)                                                                                                                                                                                              |
+| <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)                                                                                                                                                                                                      |
+| <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)                                                                                                                                                                                                                           |
+| <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)                                                                                                                    |
+| <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)                                                                                                                                                                                |
+| <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)                                                                                                                                                                                                                                 |
+| <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)                                                                                                                                                                               |
+| <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)                                                                                          |
+| <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)                                                                                                                         |
+| <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)                                                                                                                                                                                                                                                                                                                                   |
+| <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)                                                                              |
+| <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)                                                                                                                                                            |
+| <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)                                                                                                                                                                                                                |
+| <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) |
+| <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)                                                                                                                                                                                                                                              |
+
+---
+
+## 📦 Installation
+
+Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+```bash
+npm install intlayer react-intlayer
+```
+
+⚡ Quick Start (Next.js)
+
+```ts
+// intlayer.config.ts
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```ts
+// app/home.content.ts
+import { t, type Dictionary } from "intlayer";
+
+const content = {
+  key: "home",
+  content: {
+    title: t({
+      en: "Home",
+      fr: "Accueil",
+      es: "Inicio",
+    }),
+  },
+} satisfies Dictionary;
+
+export default content;
+```
+
+```tsx
+// app/page.tsx
+import { useIntlayer } from "react-intlayer";
+
+const HomePage = () => {
+  const { title } = useIntlayer("home");
+
+  return <h1>{title}</h1>;
+};
+```
+
+<a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
+
+## 🎥 Live tutorial on YouTube
+
+[![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)
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+## Table of Contents
+
+Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
+  <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
+  <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
+  <li><a href="https://intlayer.org/doc/compiler" rel=''>Compiler</a></li>
+
+  <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
+  <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/concept/content/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
+    </ul>
+  </li>
+</ul>
+</details>
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 16</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/15" rel=''>Next.js 15</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-Page-Router" rel=''>Next.js Page Router</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/compiler" rel=''>Next.js using Compiler</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React using Compiler</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react/compiler" rel=''>React-router-v7</a></li>
+  <li><a href="https://intlayer.org/doc/environment/tanstack-start" rel=''>Tanstack start</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/tanstack-start/solid" rel=''>Solid</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/astro" rel=''>Astro</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/astro/react" rel=''>React</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/vue" rel=''>Vue</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/svelte" rel=''>Svelte</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/solid" rel=''>Solid</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/vanilla" rel=''>Vanilla JS</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/lit" rel=''>Lit</a></li>
+    </ul>
+  </li>
+
+  <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
+  <li><a href="https://intlayer.org/doc/environment/sveltekit" rel=''>SvelteKit</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
+  <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
+  <li>
+     <a href="https://intlayer.org/doc/environment/express" rel=''>Backend</a>
+     <ul>
+      <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
+      <li><a href="https://intlayer.org/doc/environment/fastify" rel=''>Fastify</a></li>
+      <li><a href="https://intlayer.org/doc/environment/adonisjs" rel=''>AdonisJS</a></li>
+      <li><a href="https://intlayer.org/doc/environment/hono" rel=''>Hono</a></li>
+    </ul>
+  </li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">📊 Benchmark</summary>
+<ul>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/nextjs.md" rel=''>Next.js</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md" rel=''>TanStack Start</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/vue.md" rel=''>Vue</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/solid.md" rel=''>Solid</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md" rel=''>Svelte</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
+<ul>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
+  <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
+</ul>
+</details>
+
+## Multilingual content management system
+
+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).
+
+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:
+
+- i18n solutions (e.g. `i18next`, `next-intl`, `vue-i18n`)
+- TMSs (Translation Management Systems) (e.g. Crowdin, Phrase, Lokalise)
+- Feature flags
+- Headless CMSs (e.g. Contentful, Strapi, Sanity)
+
+![CMS Preview](https://github.com/aymericzip/intlayer/blob/main/docs/assets/CMS.png?raw=true)
+
+## 🌐 Readme in other languages
+
+<p align="center">
+  <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
+</p>
+
+## 🤝 Community
+
+Intlayer is built with and for the community and we’d love your input!
+
+- Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
+- Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
+- Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
+
+You can also follow us on :
+
+  <div>
+    <br/>
+    <p align="center">
+      <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
+         alt="Intlayer Discord" height="30"/></a>
+      <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
+         alt="Intlayer LinkedIn" height="30"/></a>
+      <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
+         alt="Intlayer Instagram" height="30"/></a>
+      <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
+         alt="Intlayer X" height="30"/></a>
+      <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
+         alt="Intlayer YouTube" height="30"/></a>
+      <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
+         alt="Intlayer TikTok" height="30"/></a>
+      <br>
+    </p>
+</div>
+
+### Contribution
+
+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!
+
+Contribute on [GitHub](https://github.com/aymericzip/intlayer), [GitLab](https://gitlab.com/ay.pineau/intlayer), or [Bitbucket](https://bitbucket.org/intlayer/intlayer/).
+
+### Thank You for the Support
+
+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-).
+
+[![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)

package/dist/cjs/_virtual/_rolldown/runtime.cjs

@@ -0,0 +1,29 @@
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/dist/cjs/core/createFormatter.cjs

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_shared_intlFormatter = require('../shared/intlFormatter.cjs');
+
+//#region src/core/createFormatter.ts
+/**
+* Drop-in for use-intl's `createFormatter`.
+*
+* Returns locale-aware formatters backed by the native `Intl.*` APIs:
+* `dateTime`, `number`, `dateTimeRange`, `relativeTime`, `list`, and
+* `displayName`. `now`, `timeZone`, `formats`, and `onError` are accepted for
+* API compatibility but only `locale` influences the output.
+*
+* @example
+* ```ts
+* const format = createFormatter({ locale: 'en' });
+* format.number(1234.5, { style: 'currency', currency: 'USD' });
+* ```
+*/
+const createFormatter = ({ locale }) => require_shared_intlFormatter.buildIntlFormatter(locale);
+
+//#endregion
+exports.createFormatter = createFormatter;
+//# sourceMappingURL=createFormatter.cjs.map

package/dist/cjs/core/createFormatter.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFormatter.cjs","names":["buildIntlFormatter"],"sources":["../../../src/core/createFormatter.ts"],"sourcesContent":["import type { createFormatter as _createFormatter } from 'use-intl';\nimport { buildIntlFormatter } from '../shared/intlFormatter';\n\n/**\n * Drop-in for use-intl's `createFormatter`.\n *\n * Returns locale-aware formatters backed by the native `Intl.*` APIs:\n * `dateTime`, `number`, `dateTimeRange`, `relativeTime`, `list`, and\n * `displayName`. `now`, `timeZone`, `formats`, and `onError` are accepted for\n * API compatibility but only `locale` influences the output.\n *\n * @example\n * ```ts\n * const format = createFormatter({ locale: 'en' });\n * format.number(1234.5, { style: 'currency', currency: 'USD' });\n * ```\n */\nexport const createFormatter: typeof _createFormatter = ({ locale }) =>\n  buildIntlFormatter(locale);\n"],"mappings":";;;;;;;;;;;;;;;;;;AAiBA,MAAa,mBAA4C,EAAE,aACzDA,gDAAmB,OAAO"}

package/dist/cjs/core/createTranslator.cjs

@@ -0,0 +1,30 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_shared_namespaceTranslator = require('../shared/namespaceTranslator.cjs');
+let _intlayer_config_built = require("@intlayer/config/built");
+let _intlayer_config_colors = require("@intlayer/config/colors");
+let _intlayer_config_logger = require("@intlayer/config/logger");
+
+//#region src/core/createTranslator.ts
+/**
+* Drop-in for use-intl's `createTranslator`.
+*
+* Returns a translate function (with `rich`, `markup`, `raw`, `has`) that
+* resolves messages from Intlayer's compiled dictionaries for the given
+* `locale`. Messages support ICU MessageFormat syntax.
+*
+* @example
+* ```ts
+* const t = createTranslator({ locale: 'en', namespace: 'about' });
+* t('counter.label'); // ✓ typed
+* t('items', { count: 3 }); // ICU plural
+* ```
+*/
+const createTranslator = (({ locale, namespace, messages: _messages }) => {
+	if (process.env.NODE_ENV === "development" && _messages !== void 0) (0, _intlayer_config_logger.getAppLogger)({ log: _intlayer_config_built.log })(`${(0, _intlayer_config_logger.colorize)("createTranslator", _intlayer_config_colors.CYAN)} do not pass the messages option with intlayer. Messages are loaded automatically under the hood for bundle optimization reason`);
+	return require_shared_namespaceTranslator.createNamespaceTranslator(locale, namespace);
+});
+
+//#endregion
+exports.createTranslator = createTranslator;
+//# sourceMappingURL=createTranslator.cjs.map

package/dist/cjs/core/createTranslator.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTranslator.cjs","names":["CYAN","createNamespaceTranslator"],"sources":["../../../src/core/createTranslator.ts"],"sourcesContent":["import { log } from '@intlayer/config/built';\nimport { CYAN } from '@intlayer/config/colors';\nimport { colorize, getAppLogger } from '@intlayer/config/logger';\nimport type {\n  DictionaryKeys,\n  LocalesValues,\n} from '@intlayer/types/module_augmentation';\nimport { createNamespaceTranslator } from '../shared/namespaceTranslator';\nimport type {\n  LooseTranslateFunction,\n  TranslateFunction,\n} from '../shared/translateFunctionTypes';\n\n/**\n * Configuration accepted by {@link createTranslator}.\n *\n * Mirrors use-intl's `IntlConfig`, but `messages`, `formats`, `now`,\n * `timeZone`, `onError`, and `getMessageFallback` have no effect — Intlayer\n * resolves content from its own compiled dictionaries.\n */\nexport type CreateTranslatorConfig<N extends DictionaryKeys> = {\n  /** The locale dictionaries are resolved for. */\n  locale: LocalesValues;\n  /** A bare dictionary key, or a nested `'dictionary.scope'` namespace. */\n  namespace?: N | (string & {});\n  /**\n   * @deprecated has no use case with intlayer. Messages are loaded\n   * automatically under the hood for bundle optimization reason.\n   */\n  messages?: never;\n} & Record<string, unknown>;\n\n/**\n * Overload set for {@link createTranslator}:\n *\n * 1. A bare dictionary key → fully-typed `t()` (autocompleted dot-paths).\n * 2. A nested namespace `'dictionary.sub.scope'` → `t()` accepts relative\n *    `string` paths, matching use-intl's scoped-namespace behaviour.\n * 3. No namespace → root scope; the first segment of each key designates\n *    the dictionary (`t('about.title')`).\n */\ntype CreateTranslator = {\n  <N extends DictionaryKeys>(\n    config: CreateTranslatorConfig<N> & { namespace: N }\n  ): TranslateFunction<N>;\n  (\n    config: CreateTranslatorConfig<DictionaryKeys> & {\n      namespace: `${string}.${string}`;\n    }\n  ): LooseTranslateFunction;\n  (config: CreateTranslatorConfig<DictionaryKeys>): LooseTranslateFunction;\n};\n\n/**\n * Drop-in for use-intl's `createTranslator`.\n *\n * Returns a translate function (with `rich`, `markup`, `raw`, `has`) that\n * resolves messages from Intlayer's compiled dictionaries for the given\n * `locale`. Messages support ICU MessageFormat syntax.\n *\n * @example\n * ```ts\n * const t = createTranslator({ locale: 'en', namespace: 'about' });\n * t('counter.label'); // ✓ typed\n * t('items', { count: 3 }); // ICU plural\n * ```\n */\nexport const createTranslator = (({\n  locale,\n  namespace,\n  messages: _messages,\n}: CreateTranslatorConfig<DictionaryKeys>) => {\n  if (process.env.NODE_ENV === 'development' && _messages !== undefined) {\n    const appLogger = getAppLogger({ log });\n    appLogger(\n      `${colorize('createTranslator', CYAN)} do not pass the messages option with intlayer. Messages are loaded automatically under the hood for bundle optimization reason`\n    );\n  }\n\n  return createNamespaceTranslator(locale, namespace);\n}) as CreateTranslator;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAmEA,MAAa,qBAAqB,EAChC,QACA,WACA,UAAU,gBACkC;AAC5C,KAAI,QAAQ,IAAI,aAAa,iBAAiB,cAAc,OAE1D,2CAD+B,EAAE,iCAAK,CAC7B,CACP,yCAAY,oBAAoBA,6BAAK,CAAC,iIACvC;AAGH,QAAOC,6DAA0B,QAAQ,UAAU"}

package/dist/cjs/core/errors.cjs

@@ -0,0 +1,42 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/core/errors.ts
+/**
+* Drop-in for use-intl's `IntlErrorCode` enum.
+*
+* Re-implemented locally (rather than re-exported) because `use-intl` is
+* aliased to this package at build time, so importing its runtime value would
+* be circular.
+*/
+let IntlErrorCode = /* @__PURE__ */ function(IntlErrorCode) {
+	IntlErrorCode["MISSING_MESSAGE"] = "MISSING_MESSAGE";
+	IntlErrorCode["MISSING_FORMAT"] = "MISSING_FORMAT";
+	IntlErrorCode["ENVIRONMENT_FALLBACK"] = "ENVIRONMENT_FALLBACK";
+	IntlErrorCode["INSUFFICIENT_PATH"] = "INSUFFICIENT_PATH";
+	IntlErrorCode["INVALID_MESSAGE"] = "INVALID_MESSAGE";
+	IntlErrorCode["INVALID_KEY"] = "INVALID_KEY";
+	IntlErrorCode["FORMATTING_ERROR"] = "FORMATTING_ERROR";
+	return IntlErrorCode;
+}({});
+/**
+* Drop-in for use-intl's `IntlError`.
+*
+* Carries the {@link IntlErrorCode} and the original message, matching
+* use-intl's error shape so consumer `onError` handlers keep working.
+*/
+var IntlError = class extends Error {
+	code;
+	originalMessage;
+	constructor(code, originalMessage) {
+		let message = code;
+		if (originalMessage) message += `: ${originalMessage}`;
+		super(message);
+		this.code = code;
+		if (originalMessage) this.originalMessage = originalMessage;
+	}
+};
+
+//#endregion
+exports.IntlError = IntlError;
+exports.IntlErrorCode = IntlErrorCode;
+//# sourceMappingURL=errors.cjs.map

package/dist/cjs/core/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs","names":[],"sources":["../../../src/core/errors.ts"],"sourcesContent":["/**\n * Drop-in for use-intl's `IntlErrorCode` enum.\n *\n * Re-implemented locally (rather than re-exported) because `use-intl` is\n * aliased to this package at build time, so importing its runtime value would\n * be circular.\n */\nexport enum IntlErrorCode {\n  MISSING_MESSAGE = 'MISSING_MESSAGE',\n  MISSING_FORMAT = 'MISSING_FORMAT',\n  ENVIRONMENT_FALLBACK = 'ENVIRONMENT_FALLBACK',\n  INSUFFICIENT_PATH = 'INSUFFICIENT_PATH',\n  INVALID_MESSAGE = 'INVALID_MESSAGE',\n  INVALID_KEY = 'INVALID_KEY',\n  FORMATTING_ERROR = 'FORMATTING_ERROR',\n}\n\n/**\n * Drop-in for use-intl's `IntlError`.\n *\n * Carries the {@link IntlErrorCode} and the original message, matching\n * use-intl's error shape so consumer `onError` handlers keep working.\n */\nexport class IntlError extends Error {\n  public readonly code: IntlErrorCode;\n  public readonly originalMessage: string | undefined;\n\n  constructor(code: IntlErrorCode, originalMessage?: string) {\n    let message: string = code;\n    if (originalMessage) {\n      message += `: ${originalMessage}`;\n    }\n    super(message);\n\n    this.code = code;\n    if (originalMessage) {\n      this.originalMessage = originalMessage;\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;AAOA,IAAY,gBAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;;KACD;;;;;;;AAQD,IAAa,YAAb,cAA+B,MAAM;CACnC,AAAgB;CAChB,AAAgB;CAEhB,YAAY,MAAqB,iBAA0B;EACzD,IAAI,UAAkB;AACtB,MAAI,gBACF,YAAW,KAAK;AAElB,QAAM,QAAQ;AAEd,OAAK,OAAO;AACZ,MAAI,gBACF,MAAK,kBAAkB"}

package/dist/cjs/core/hasLocale.cjs

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+let _intlayer_config_built = require("@intlayer/config/built");
+
+//#region src/core/hasLocale.ts
+/**
+* Drop-in for use-intl's `hasLocale`.
+*
+* Narrows a locale candidate to the given locales list. When the list is
+* omitted, the locales configured in intlayer are used.
+*
+* @example
+* ```ts
+* if (hasLocale(['en', 'fr'], requested)) { … }
+* ```
+*/
+const hasLocale = ((locales, candidate) => {
+	return (locales ?? _intlayer_config_built.internationalization?.locales?.map(String) ?? []).includes(candidate);
+});
+
+//#endregion
+exports.hasLocale = hasLocale;
+//# sourceMappingURL=hasLocale.cjs.map

package/dist/cjs/core/hasLocale.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasLocale.cjs","names":["internationalization"],"sources":["../../../src/core/hasLocale.ts"],"sourcesContent":["import { internationalization } from '@intlayer/config/built';\nimport type { hasLocale as _hasLocale } from 'use-intl';\n\n/**\n * Drop-in for use-intl's `hasLocale`.\n *\n * Narrows a locale candidate to the given locales list. When the list is\n * omitted, the locales configured in intlayer are used.\n *\n * @example\n * ```ts\n * if (hasLocale(['en', 'fr'], requested)) { … }\n * ```\n */\nexport const hasLocale: typeof _hasLocale = ((\n  locales: readonly string[],\n  candidate: unknown\n): boolean => {\n  const availableLocales =\n    locales ?? internationalization?.locales?.map(String) ?? [];\n  return availableLocales.includes(candidate as string);\n}) as typeof _hasLocale;\n"],"mappings":";;;;;;;;;;;;;;;;AAcA,MAAa,cACX,SACA,cACY;AAGZ,SADE,WAAWA,6CAAsB,SAAS,IAAI,OAAO,IAAI,EAAE,EACrC,SAAS,UAAoB"}

package/dist/cjs/core/index.cjs

@@ -0,0 +1,13 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_core_createFormatter = require('./createFormatter.cjs');
+const require_core_createTranslator = require('./createTranslator.cjs');
+const require_core_errors = require('./errors.cjs');
+const require_core_hasLocale = require('./hasLocale.cjs');
+const require_core_initializeConfig = require('./initializeConfig.cjs');
+
+exports.IntlError = require_core_errors.IntlError;
+exports.IntlErrorCode = require_core_errors.IntlErrorCode;
+exports.createFormatter = require_core_createFormatter.createFormatter;
+exports.createTranslator = require_core_createTranslator.createTranslator;
+exports.hasLocale = require_core_hasLocale.hasLocale;
+exports.initializeConfig = require_core_initializeConfig.initializeConfig;

package/dist/cjs/core/initializeConfig.cjs

@@ -0,0 +1,25 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/core/initializeConfig.ts
+/**
+* Drop-in for use-intl's `initializeConfig`.
+*
+* Enhances an incoming config with defaults. With intlayer, `messages` and
+* `formats` are not consumed at runtime (content comes from compiled
+* dictionaries) but the shape is preserved so callers keep type-checking.
+*/
+const initializeConfig = ({ formats, getMessageFallback, messages, onError, ...rest }) => {
+	const finalOnError = onError ?? ((error) => error);
+	const finalGetMessageFallback = getMessageFallback ?? (({ key, namespace }) => [namespace, key].filter(Boolean).join("."));
+	return {
+		...rest,
+		formats: formats || void 0,
+		messages: messages || void 0,
+		onError: finalOnError,
+		getMessageFallback: finalGetMessageFallback
+	};
+};
+
+//#endregion
+exports.initializeConfig = initializeConfig;
+//# sourceMappingURL=initializeConfig.cjs.map

package/dist/cjs/core/initializeConfig.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"initializeConfig.cjs","names":[],"sources":["../../../src/core/initializeConfig.ts"],"sourcesContent":["import type { initializeConfig as _initializeConfig } from 'use-intl';\n\n/**\n * Drop-in for use-intl's `initializeConfig`.\n *\n * Enhances an incoming config with defaults. With intlayer, `messages` and\n * `formats` are not consumed at runtime (content comes from compiled\n * dictionaries) but the shape is preserved so callers keep type-checking.\n */\nexport const initializeConfig: typeof _initializeConfig = ({\n  formats,\n  getMessageFallback,\n  messages,\n  onError,\n  ...rest\n}) => {\n  const finalOnError = onError ?? ((error) => error);\n  const finalGetMessageFallback =\n    getMessageFallback ?? (({ key, namespace }) => [namespace, key]\n      .filter(Boolean)\n      .join('.'));\n\n  return {\n    ...rest,\n    formats: formats || undefined,\n    messages: messages || undefined,\n    onError: finalOnError,\n    getMessageFallback: finalGetMessageFallback,\n  };\n};\n"],"mappings":";;;;;;;;;;AASA,MAAa,oBAA8C,EACzD,SACA,oBACA,UACA,SACA,GAAG,WACC;CACJ,MAAM,eAAe,aAAa,UAAU;CAC5C,MAAM,0BACJ,wBAAwB,EAAE,KAAK,gBAAgB,CAAC,WAAW,IAAI,CAC5D,OAAO,QAAQ,CACf,KAAK,IAAI;AAEd,QAAO;EACL,GAAG;EACH,SAAS,WAAW;EACpB,UAAU,YAAY;EACtB,SAAS;EACT,oBAAoB;EACrB"}

package/dist/cjs/index.cjs

@@ -0,0 +1,30 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_useDictionaryDynamic = require('./useDictionaryDynamic.cjs');
+const require_core_createFormatter = require('./core/createFormatter.cjs');
+const require_core_createTranslator = require('./core/createTranslator.cjs');
+const require_core_errors = require('./core/errors.cjs');
+const require_core_hasLocale = require('./core/hasLocale.cjs');
+const require_core_initializeConfig = require('./core/initializeConfig.cjs');
+const require_react_IntlProvider = require('./react/IntlProvider.cjs');
+const require_react_helpers = require('./react/helpers.cjs');
+const require_react_useLocale = require('./react/useLocale.cjs');
+const require_react_useTranslations = require('./react/useTranslations.cjs');
+const require_useDictionary = require('./useDictionary.cjs');
+const require_react_index = require('./react/index.cjs');
+
+exports.IntlError = require_core_errors.IntlError;
+exports.IntlErrorCode = require_core_errors.IntlErrorCode;
+exports.IntlProvider = require_react_IntlProvider.IntlProvider;
+exports._useExtracted = require_react_index._useExtracted;
+exports.createFormatter = require_core_createFormatter.createFormatter;
+exports.createTranslator = require_core_createTranslator.createTranslator;
+exports.hasLocale = require_core_hasLocale.hasLocale;
+exports.initializeConfig = require_core_initializeConfig.initializeConfig;
+exports.useDictionary = require_useDictionary.useDictionary;
+exports.useDictionaryDynamic = require_useDictionaryDynamic.useDictionaryDynamic;
+exports.useFormatter = require_react_helpers.useFormatter;
+exports.useLocale = require_react_useLocale.useLocale;
+exports.useMessages = require_react_helpers.useMessages;
+exports.useNow = require_react_helpers.useNow;
+exports.useTimeZone = require_react_helpers.useTimeZone;
+exports.useTranslations = require_react_useTranslations.useTranslations;