@intlayer/docs 5.7.4 → 5.7.6-canary.0

package/docs/de/packages/react-intlayer/useI18n.md

@@ -0,0 +1,250 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: useI18n Hook Dokumentation | react-intlayer
+description: Erfahren Sie, wie Sie den useI18n Hook im react-intlayer Paket verwenden
+keywords:
+  - useI18n
+  - i18n
+  - Übersetzung
+  - Wörterbuch
+  - Intlayer
+  - Internationalisierung
+  - Dokumentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - react-intlayer
+  - useI18n
+---
+
+# React-Integration: `useI18n` Hook Dokumentation
+
+Dieser Abschnitt bietet eine detaillierte Anleitung zur Verwendung des `useI18n` Hooks in React-Anwendungen, um eine effiziente Inhaltslokalisierung zu ermöglichen.
+
+## Importieren von `useI18n` in React
+
+Der `useI18n` Hook kann je nach Kontext wie folgt in React-Anwendungen importiert und integriert werden:
+
+- **Client-Komponenten:**
+
+  ```typescript codeFormat="typescript"
+  import { useI18n } from "react-intlayer"; // Verwendung in clientseitigen React-Komponenten
+  ```
+
+  ```javascript codeFormat="esm"
+  import { useI18n } from "react-intlayer"; // Verwendung in clientseitigen React-Komponenten
+  ```
+
+  ```javascript codeFormat="commonjs"
+  const { useI18n } = require("react-intlayer"); // Verwendung in clientseitigen React-Komponenten
+  ```
+
+- **Server-Komponenten:**
+
+  ```typescript codeFormat="commonjs"
+  import { useI18n } from "react-intlayer/server"; // Verwendung in serverseitigen React-Komponenten
+  ```
+
+  ```javascript codeFormat="esm"
+  import { useI18n } from "react-intlayer/server"; // Verwendung in serverseitigen React-Komponenten
+  ```
+
+  ```javascript codeFormat="commonjs"
+  const { useI18n } = require("react-intlayer/server"); // Verwendung in serverseitigen React-Komponenten
+  ```
+
+## Parameter
+
+Dieser Hook akzeptiert zwei Parameter:
+
+1. **`namespace`**: Ein Wörterbuch-Namespace zur Eingrenzung der Übersetzungsschlüssel.
+2. **`locale`** (optional): Die gewünschte Locale. Wenn nicht angegeben, wird standardmäßig die Locale des Kontexts verwendet.
+
+## Wörterbuch
+
+Alle Wörterbuchschlüssel müssen in Inhaltsdeklarationsdateien deklariert werden, um die Typsicherheit zu erhöhen und Fehler zu vermeiden. [Konfigurationsanweisungen finden Sie hier](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/dictionary/get_started.md).
+
+## Anwendungsbeispiele in React
+
+Beispiele für die Verwendung des `useI18n` Hooks innerhalb von React-Komponenten:
+
+```tsx fileName="src/App.tsx" codeFormat="typescript"
+import type { FC } from "react";
+import { ClientComponentExample, ServerComponentExample } from "@components";
+import { IntlayerProvider } from "react.intlayer";
+import { useI18n, IntlayerServerProvider } from "react-intlayer/server";
+import { Locales } from "intlayer";
+
+const App: FC<{ locale: Locales }> = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```jsx fileName="src/app.jsx" codeFormat="esm"
+import { ClientComponentExample, ServerComponentExample } from "@components";
+import { IntlayerProvider } from "react-intlayer";
+import { IntlayerServerProvider, useI18n } from "react-intlayer/server";
+
+const App = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```jsx fileName="src/app.cjs" codeFormat="commonjs"
+const { IntlayerProvider } = require("react-intlayer");
+const { IntlayerServerProvider, useI18n } = require("react-intlayer/server");
+
+const App = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```tsx fileName="src/components/ComponentExample.tsx" codeFormat="typescript"
+import type { FC } from "react";
+import { useI18n } from "react-intlayer";
+
+const ComponentExample: FC = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Titel anzeigen */}
+      <p>{t("description")}</p> {/* Beschreibung anzeigen */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ComponentExample.jsx" codeFormat="esm"
+import { useI18n } from "react-intlayer";
+
+const ComponentExample = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Titel anzeigen */}
+      <p>{t("description")}</p> {/* Beschreibung anzeigen */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ComponentExample.cjs" codeFormat="commonjs"
+const { useI18n } = require("react-intlayer");
+
+const ComponentExample = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Titel anzeigen */}
+      <p>{t("description")}</p> {/* Beschreibung anzeigen */}
+    </div>
+  );
+};
+```
+
+```tsx fileName="src/components/ServerComponentExample.tsx" codeFormat="typescript"
+import { useI18n } from "react-intlayer/server";
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Titel anzeigen */}
+      <p>{t("description")}</p> {/* Beschreibung anzeigen */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ServerComponentExample.jsx" codeFormat="esm"
+import { useI18n } from "react-intlayer/server";
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Titel anzeigen */}
+      <p>{t("description")}</p> {/* Beschreibung anzeigen */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ServerComponentExample.cjs" codeFormat="commonjs"
+const { useI18n } = require("react-intlayer/server");
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1>
+      <p>{t("description")}</p>
+    </div>
+  );
+};
+```
+
+## Attributbehandlung
+
+Beim Lokalisieren von Attributen greifen Sie entsprechend auf die Übersetzungswerte zu:
+
+```jsx
+<!-- Für Barrierefreiheitsattribute (z. B. aria-label) verwenden Sie .value, da reine Strings erforderlich sind -->
+<button aria-label={t("button.ariaLabel").value}>{t("button.text")}</button>
+```
+
+## Zusätzliche Ressourcen
+
+- **Intlayer Visual Editor**: Für eine intuitivere Verwaltung von Inhalten konsultieren Sie die Dokumentation des visuellen Editors [hier](https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/intlayer_visual_editor.md).
+
+Dieser Abschnitt behandelt speziell die Integration des `useI18n`-Hooks in React-Anwendungen, vereinfacht den Lokalisierungsprozess und gewährleistet Konsistenz der Inhalte über verschiedene Sprachversionen hinweg.
+
+## Dokumentationshistorie
+
+- 6.0.0 - 2025-06-29: Erste Erstellung der Dokumentation zum `useI18n` Hook

package/docs/en/configuration.md

@@ -242,9 +242,9 @@ Defines settings related to the integrated editor, including server port and act
 
   - _Type_: `boolean`
   - _Default_: `false`
-  - _Description_: Indicates if the application should hot reload the locale configurations when a change is detected.
+  - _Description_: Indicates if the application server should hot reload the locale configurations when a change is detected.
   - _Example_: `true`
-  - _Note_: For example, when a new dictionary is added or updated, the application will update the content tu display in the page.
+  - _Note_: For example, when a new dictionary is added or updated, the application will update the content to display in the page.
   - _Note_: Because the hot reloading needs an continuous connection to the server, it is only available for clients of the `enterprise` plan.
 
 - **dictionaryPriorityStrategy**:
@@ -278,10 +278,12 @@ Settings that control middleware behavior, including how the application handles
 - **prefixDefault**:
 
   - _Type_: `boolean`
-  - _Default_: `true`
+  - _Default_: `false`
   - _Description_: Whether to include the default locale in the URL.
-  - _Example_: `false`
-  - _Note_: If `false`, URLs for the default locale will not have a locale prefix.
+  - _Example_: `true`
+  - _Note_:
+    - If `true` and `defaultLocale = 'en'`: path = `/en/dashboard` or `/fr/dashboard`
+    - If `false` and `defaultLocale = 'en'`: path = `/dashboard` or `/fr/dashboard`
 
 - **basePath**:
 
@@ -289,7 +291,11 @@ Settings that control middleware behavior, including how the application handles
   - _Default_: `''`
   - _Description_: The base path for the application URLs.
   - _Example_: `'/my-app'`
-  - _Note_: This affects how URLs are constructed for the application.
+  - _Note_:
+    - If the application is hosted at `https://example.com/my-app`
+    - The base path is `'/my-app'`
+    - The URL will be `https://example.com/my-app/en`
+    - If the base path is not set, the URL will be `https://example.com/en`
 
 - **serverSetCookie**:
 
@@ -301,11 +307,42 @@ Settings that control middleware behavior, including how the application handles
   - _Note_: Controls whether the locale cookie is set on every request or never.
 
 - **noPrefix**:
+
   - _Type_: `boolean`
   - _Default_: `false`
   - _Description_: Whether to omit the locale prefix from URLs.
   - _Example_: `true`
-  - _Note_: If `true`, URLs will not contain locale information.
+  - _Note_:
+    - If `true`: No prefix in the URL
+    - If `false`: Prefix in the URL
+    - Example with `basePath = '/my-app'`:
+      - If `noPrefix = false`: URL will be `https://example.com/my-app/en`
+      - If `noPrefix = true`: URL will be `https://example.com`
+
+- **detectLocaleOnPrefetchNoPrefix**:
+
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Controls whether locale detection occurs during Next.js prefetch requests.
+  - _Example_: `true`
+  - _Note_: This setting affects how Next.js handles locale prefetching:
+    - **Example scenario:**
+      - User's browser language is `'fr'`
+      - Current page is `/fr/about`
+      - Link prefetches `/about`
+    - **With `detectLocaleOnPrefetchNoPrefix: true`:**
+      - Prefetch detects `'fr'` locale from browser
+      - Redirects prefetch to `/fr/about`
+    - **With `detectLocaleOnPrefetchNoPrefix: false` (default):**
+      - Prefetch uses default locale
+      - Redirects prefetch to `/en/about` (assuming `'en'` is default)
+    - **When to use `true`:**
+      - Your app uses non-localized internal links (e.g. `<a href="/about">`)
+      - You want consistent locale detection behavior between regular and prefetch requests
+    - **When to use `false` (default):**
+      - Your app uses locale-prefixed links (e.g. `<a href="/fr/about">`)
+      - You want to optimize prefetching performance
+      - You want to avoid potential redirect loops
 
 ---
 

package/docs/en/packages/react-intlayer/useI18n.md

@@ -0,0 +1,250 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: useI18n Hook Documentation | react-intlayer
+description: Learn how to use the useI18n hook in the react-intlayer package
+keywords:
+  - useI18n
+  - i18n
+  - translation
+  - dictionary
+  - Intlayer
+  - internationalization
+  - documentation
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - react-intlayer
+  - useI18n
+---
+
+# React Integration: `useI18n` Hook Documentation
+
+This section provides detailed guidance on how to use the `useI18n` hook within React applications, enabling efficient content localization.
+
+## Importing `useI18n` in React
+
+The `useI18n` hook can be imported and integrated into React applications according to the context as follows:
+
+- **Client Components:**
+
+  ```typescript codeFormat="typescript"
+  import { useI18n } from "react-intlayer"; // Use in client-side React components
+  ```
+
+  ```javascript codeFormat="esm"
+  import { useI18n } from "react-intlayer"; // Use in client-side React components
+  ```
+
+  ```javascript codeFormat="commonjs"
+  const { useI18n } = require("react-intlayer"); // Use in client-side React components
+  ```
+
+- **Server Components:**
+
+  ```typescript codeFormat="commonjs"
+  import { useI18n } from "react-intlayer/server"; // Use in server-side React components
+  ```
+
+  ```javascript codeFormat="esm"
+  import { useI18n } from "react-intlayer/server"; // Use in server-side React components
+  ```
+
+  ```javascript codeFormat="commonjs"
+  const { useI18n } = require("react-intlayer/server"); // Use in server-side React components
+  ```
+
+## Parameters
+
+This hook accepts two parameters:
+
+1. **`namespace`**: A dictionary namespace to scope the translation keys.
+2. **`locale`** (optional): The desired locale. If not specified, the context's locale will be used as default.
+
+## Dictionary
+
+All dictionary keys must be declared within content declaration files to enhance type safety and prevent errors. [Configuration instructions can be found here](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/dictionary/get_started.md).
+
+## Usage Examples in React
+
+Examples of using the `useI18n` hook within React components:
+
+```tsx fileName="src/App.tsx" codeFormat="typescript"
+import type { FC } from "react";
+import { ClientComponentExample, ServerComponentExample } from "@components";
+import { IntlayerProvider } from "react-intlayer";
+import { useI18n, IntlayerServerProvider } from "react-intlayer/server";
+import { Locales } from "intlayer";
+
+const App: FC<{ locale: Locales }> = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```jsx fileName="src/app.jsx" codeFormat="esm"
+import { ClientComponentExample, ServerComponentExample } from "@components";
+import { IntlayerProvider } from "react-intlayer";
+import { IntlayerServerProvider, useI18n } from "react-intlayer/server";
+
+const App = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```jsx fileName="src/app.cjs" codeFormat="commonjs"
+const { IntlayerProvider } = require("react-intlayer");
+const { IntlayerServerProvider, useI18n } = require("react-intlayer/server");
+
+const App = ({ locale }) => {
+  const t = useI18n("home-page", locale);
+
+  return (
+    <>
+      <p>{t("introduction")}</p>
+      <IntlayerProvider locale={locale}>
+        <ClientComponentExample />
+      </IntlayerProvider>
+      <IntlayerServerProvider locale={locale}>
+        <ServerComponentExample />
+      </IntlayerServerProvider>
+    </>
+  );
+};
+```
+
+```tsx fileName="src/components/ComponentExample.tsx" codeFormat="typescript"
+import type { FC } from "react";
+import { useI18n } from "react-intlayer";
+
+const ComponentExample: FC = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Display the title */}
+      <p>{t("description")}</p> {/* Display the description */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ComponentExample.jsx" codeFormat="esm"
+import { useI18n } from "react-intlayer";
+
+const ComponentExample = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Display the title */}
+      <p>{t("description")}</p> {/* Display the description */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ComponentExample.cjs" codeFormat="commonjs"
+const { useI18n } = require("react-intlayer");
+
+const ComponentExample = () => {
+  const t = useI18n("component-example");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Display the title */}
+      <p>{t("description")}</p> {/* Display the description */}
+    </div>
+  );
+};
+```
+
+```tsx fileName="src/components/ServerComponentExample.tsx" codeFormat="typescript"
+import { useI18n } from "react-intlayer/server";
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Display the title */}
+      <p>{t("description")}</p> {/* Display the description */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ServerComponentExample.jsx" codeFormat="esm"
+import { useI18n } from "react-intlayer/server";
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1> {/* Display the title */}
+      <p>{t("description")}</p> {/* Display the description */}
+    </div>
+  );
+};
+```
+
+```jsx fileName="src/components/ServerComponentExample.cjs" codeFormat="commonjs"
+const { useI18n } = require("react-intlayer/server");
+
+const ServerComponentExample = () => {
+  const t = useI18n("server-component");
+
+  return (
+    <div>
+      <h1>{t("title")}</h1>
+      <p>{t("description")}</p>
+    </div>
+  );
+};
+```
+
+## Attribute Handling
+
+When localizing attributes, access the translation values appropriately:
+
+```jsx
+<!-- For accessibility attributes (e.g., aria-label), use .value since pure strings are required -->
+<button aria-label={t("button.ariaLabel").value}>{t("button.text")}</button>
+```
+
+## Additional Resources
+
+- **Intlayer Visual Editor**: For a more intuitive content management experience, refer to the visual editor documentation [here](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_visual_editor.md).
+
+This section specifically covers the integration of the `useI18n` hook in React applications, simplifying the localization process and ensuring content consistency across different locales.
+
+## Documentation History
+
+- 6.0.0 - 2025-06-29: Initial writing of `useI18n` hook documentation

package/docs/en-GB/configuration.md

@@ -268,10 +268,12 @@ Settings that control middleware behaviour, including how the application handle
 - **prefixDefault**:
 
   - _Type_: `boolean`
-  - _Default_: `true`
+  - _Default_: `false`
   - _Description_: Whether to include the default locale in the URL.
-  - _Example_: `false`
-  - _Note_: If `false`, URLs for the default locale will not have a locale prefix.
+  - _Example_: `true`
+  - _Note_:
+    - If `true` and `defaultLocale = 'en'`: path = `/en/dashboard` or `/fr/dashboard`
+    - If `false` and `defaultLocale = 'en'`: path = `/dashboard` or `/fr/dashboard`
 
 - **basePath**:
 
@@ -279,7 +281,11 @@ Settings that control middleware behaviour, including how the application handle
   - _Default_: `''`
   - _Description_: The base path for the application URLs.
   - _Example_: `'/my-app'`
-  - _Note_: This affects how URLs are constructed for the application.
+  - _Note_:
+    - If the application is hosted at `https://example.com/my-app`
+    - The base path is `'/my-app'`
+    - The URL will be `https://example.com/my-app/en`
+    - If the base path is not set, the URL will be `https://example.com/en`
 
 - **serverSetCookie**:
 
@@ -291,11 +297,42 @@ Settings that control middleware behaviour, including how the application handle
   - _Note_: Controls whether the locale cookie is set on every request or never.
 
 - **noPrefix**:
+
   - _Type_: `boolean`
   - _Default_: `false`
   - _Description_: Whether to omit the locale prefix from URLs.
   - _Example_: `true`
-  - _Note_: If `true`, URLs will not contain locale information.
+  - _Note_:
+    - If `true`: No prefix in the URL
+    - If `false`: Prefix in the URL
+    - Example with `basePath = '/my-app'`:
+      - If `noPrefix = false`: URL will be `https://example.com/my-app/en`
+      - If `noPrefix = true`: URL will be `https://example.com`
+
+- **detectLocaleOnPrefetchNoPrefix**:
+
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Controls whether locale detection occurs during Next.js prefetch requests.
+  - _Example_: `true`
+  - _Note_: This setting affects how Next.js handles locale prefetching:
+    - **Example scenario:**
+      - User's browser language is `'fr'`
+      - Current page is `/fr/about`
+      - Link prefetches `/about`
+    - **With `detectLocaleOnPrefetchNoPrefix: true`:**
+      - Prefetch detects `'fr'` locale from browser
+      - Redirects prefetch to `/fr/about`
+    - **With `detectLocaleOnPrefetchNoPrefix: false` (default):**
+      - Prefetch uses default locale
+      - Redirects prefetch to `/en/about` (assuming `'en'` is default)
+    - **When to use `true`:**
+      - Your app uses non-localised internal links (e.g. `<a href="/about">`)
+      - You want consistent locale detection behaviour between regular and prefetch requests
+    - **When to use `false` (default):**
+      - Your app uses locale-prefixed links (e.g. `<a href="/fr/about">`)
+      - You want to optimise prefetching performance
+      - You want to avoid potential redirect loops
 
 ---