@intlayer/docs 9.0.0-canary.7 → 9.0.0-canary.8

package/docs/en/dynamic_dictionaries/dynamic_content.md

@@ -1,271 +0,0 @@
----
-createdAt: 2026-06-12
-updatedAt: 2026-06-12
-title: Dynamic Records
-description: Use the meta field in Intlayer content files to declare CMS-managed records fetched at runtime by an opaque ID, enabling strongly-typed dynamic content without build-time enumeration.
-keywords:
-  - Dynamic Records
-  - Dynamic Content
-  - CMS
-  - Runtime Content
-  - Intlayer
-  - Internationalization
-slugs:
-  - doc
-  - concept
-  - dynamic-records
-history:
-  - version: 9.0.0
-    date: 2026-06-12
-    changes: "Release of the dynamic content feature"
-author: aymericzip
----
-
-# Dynamic Records
-
-A **dynamic record** is a content file whose identity is not a sequential index or a named variant, but an arbitrary set of key-value pairs declared in a `meta` field. Intlayer uses those fields as the selector at runtime, making it possible to address CMS records, user-specific copy, or any content whose keys are not known at build time.
-
-## Declaring dynamic records
-
-```ts fileName="product-copy.abc.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-import { t, type Dictionary } from "intlayer";
-
-const dictionary = {
-  key: "product-copy",
-  meta: {
-    id: "prod_abc",
-    userId: "user_123",
-  },
-  content: {
-    name: t({ en: "Widget Pro", fr: "Widget Pro" }),
-    description: t({ en: "The best widget.", fr: "Le meilleur widget." }),
-  },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-```ts fileName="product-copy.abcd.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-import { t, type Dictionary } from "intlayer";
-
-const dictionary = {
-  key: "product-copy",
-  meta: {
-    id: "prod_abcd",
-    userId: "user_123",
-  },
-  content: {
-    name: t({ en: "Widget Lite", fr: "Widget Lite" }),
-    description: t({ en: "A lighter option.", fr: "Une option plus légère." }),
-  },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-## Consuming dynamic records
-
-All `meta` fields are **required** in the selector. Omitting any field returns `null` and is a TypeScript error.
-
-<Tabs group="framework">
-  <Tab label="React" value="react">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "react-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Next.js" value="nextjs">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "next-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Vue" value="vue">
-    ```vue fileName="ProductCopy.vue" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    <script setup>
-    import { useIntlayer } from "vue-intlayer";
-
-    const props = defineProps({
-      productId: String,
-      userId: String,
-    });
-
-    const content = useIntlayer("product-copy", { id: props.productId, userId: props.userId });
-    </script>
-
-    <template>
-      <p v-if="content">{{ content.description }}</p>
-    </template>
-    ```
-
-  </Tab>
-  <Tab label="Svelte" value="svelte">
-    ```svelte fileName="ProductCopy.svelte" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    <script lang="ts">
-    import { useIntlayer } from "svelte-intlayer";
-
-    export let productId: string;
-    export let userId: string;
-
-    const content = useIntlayer("product-copy", { id: productId, userId });
-    </script>
-
-    {#if $content}
-      <p>{$content.description}</p>
-    {/if}
-    ```
-
-  </Tab>
-  <Tab label="Preact" value="preact">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "preact-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Solid" value="solid">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "solid-intlayer";
-
-    export const ProductCopy = (props: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: props.productId, userId: props.userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      return (
-        <>
-          {content() && <p>{content().description}</p>}
-        </>
-      );
-    };
-    ```
-
-  </Tab>
-  <Tab label="Angular" value="angular">
-    ```typescript fileName="product-copy.component.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { Component, Input, OnInit } from "@angular/core";
-    import { useIntlayer } from "angular-intlayer";
-
-    @Component({
-      selector: "app-product-copy",
-      template: `
-        @if (content()) {
-          <p>{{ content().description }}</p>
-        }
-      `,
-    })
-    export class ProductCopyComponent implements OnInit {
-      @Input() productId!: string;
-      @Input() userId!: string;
-
-      content: any;
-
-      ngOnInit() {
-        this.content = useIntlayer("product-copy", { id: this.productId, userId: this.userId });
-      }
-    }
-    ```
-
-  </Tab>
-  <Tab label="Vanilla JS" value="vanilla">
-    ```javascript fileName="product-copy.js"
-    import { useIntlayer } from "vanilla-intlayer";
-
-    const content = useIntlayer("product-copy", {
-      id: "prod_abcd",
-      userId: "user_123"
-    });
-
-    if (content) {
-      document.body.innerHTML = `<p>${content.description}</p>`;
-    }
-    ```
-
-  </Tab>
-</Tabs>
-
-### With explicit locale
-
-```tsx
-const content = useIntlayer("product-copy", {
-  id: "prod_abc",
-  userId: "user_123",
-  locale: "fr",
-});
-```
-
-### Missing meta field — compile-time error
-
-```ts
-// Type error: `userId` is missing
-const content = useIntlayer("product-copy", { id: "prod_abc" });
-```
-
-## Loading mode
-
-Dynamic records are typically loaded lazily. Set `importMode` on the dictionary to control this:
-
-```ts contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-const dictionary = {
-  key: "product-copy",
-  importMode: "fetch", // or "dynamic"
-  meta: { id: "prod_abc", userId: "user_123" },
-  content: { … },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-See [bundle optimization](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/bundle_optimization.md) for details on `static`, `dynamic`, and `fetch` modes.
-
-## Typical use-cases
-
-- Per-product marketing copy managed in a CMS
-- User-specific or account-specific content
-- Any content keyed by an opaque runtime ID

package/docs/en-GB/dynamic_dictionaries/dynamic_content.md

@@ -1,271 +0,0 @@
----
-createdAt: 2026-06-12
-updatedAt: 2026-06-12
-title: Dynamic Records
-description: Use the meta field in Intlayer content files to declare CMS-managed records fetched at runtime by an opaque ID, enabling strongly-typed dynamic content without build-time enumeration.
-keywords:
-  - Dynamic Records
-  - Dynamic Content
-  - CMS
-  - Runtime Content
-  - Intlayer
-  - Internationalisation
-slugs:
-  - doc
-  - concept
-  - dynamic-records
-history:
-  - version: 9.0.0
-    date: 2026-06-12
-    changes: "Release of the dynamic content feature"
-author: aymericzip
----
-
-# Dynamic Records
-
-A **dynamic record** is a content file whose identity is not a sequential index or a named variant, but an arbitrary set of key-value pairs declared in a `meta` field. Intlayer uses those fields as the selector at runtime, making it possible to address CMS records, user-specific copy, or any content whose keys are not known at build time.
-
-## Declaring dynamic records
-
-```ts fileName="product-copy.abc.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-import { t, type Dictionary } from "intlayer";
-
-const dictionary = {
-  key: "product-copy",
-  meta: {
-    id: "prod_abc",
-    userId: "user_123",
-  },
-  content: {
-    name: t({ en: "Widget Pro", fr: "Widget Pro" }),
-    description: t({ en: "The best widget.", fr: "Le meilleur widget." }),
-  },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-```ts fileName="product-copy.abcd.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-import { t, type Dictionary } from "intlayer";
-
-const dictionary = {
-  key: "product-copy",
-  meta: {
-    id: "prod_abcd",
-    userId: "user_123",
-  },
-  content: {
-    name: t({ en: "Widget Lite", fr: "Widget Lite" }),
-    description: t({ en: "A lighter option.", fr: "Une option plus légère." }),
-  },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-## Consuming dynamic records
-
-All `meta` fields are **required** in the selector. Omitting any field returns `null` and is a TypeScript error.
-
-<Tabs group="framework">
-  <Tab label="React" value="react">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "react-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Next.js" value="nextjs">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "next-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Vue" value="vue">
-    ```vue fileName="ProductCopy.vue" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    <script setup>
-    import { useIntlayer } from "vue-intlayer";
-
-    const props = defineProps({
-      productId: String,
-      userId: String,
-    });
-
-    const content = useIntlayer("product-copy", { id: props.productId, userId: props.userId });
-    </script>
-
-    <template>
-      <p v-if="content">{{ content.description }}</p>
-    </template>
-    ```
-
-  </Tab>
-  <Tab label="Svelte" value="svelte">
-    ```svelte fileName="ProductCopy.svelte" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    <script lang="ts">
-    import { useIntlayer } from "svelte-intlayer";
-
-    export let productId: string;
-    export let userId: string;
-
-    const content = useIntlayer("product-copy", { id: productId, userId });
-    </script>
-
-    {#if $content}
-      <p>{$content.description}</p>
-    {/if}
-    ```
-
-  </Tab>
-  <Tab label="Preact" value="preact">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "preact-intlayer";
-
-    export const ProductCopy = ({
-      productId,
-      userId,
-    }: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: productId, userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      if (!content) return null;
-
-      return <p>{content.description}</p>;
-    };
-    ```
-
-  </Tab>
-  <Tab label="Solid" value="solid">
-    ```tsx fileName="ProductCopy.tsx" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { useIntlayer } from "solid-intlayer";
-
-    export const ProductCopy = (props: {
-      productId: string;
-      userId: string;
-    }) => {
-      const content = useIntlayer("product-copy", { id: props.productId, userId: props.userId });
-      // TypeScript enforces that both `id` and `userId` are provided.
-
-      return (
-        <>
-          {content() && <p>{content().description}</p>}
-        </>
-      );
-    };
-    ```
-
-  </Tab>
-  <Tab label="Angular" value="angular">
-    ```typescript fileName="product-copy.component.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-    import { Component, Input, OnInit } from "@angular/core";
-    import { useIntlayer } from "angular-intlayer";
-
-    @Component({
-      selector: "app-product-copy",
-      template: `
-        @if (content()) {
-          <p>{{ content().description }}</p>
-        }
-      `,
-    })
-    export class ProductCopyComponent implements OnInit {
-      @Input() productId!: string;
-      @Input() userId!: string;
-
-      content: any;
-
-      ngOnInit() {
-        this.content = useIntlayer("product-copy", { id: this.productId, userId: this.userId });
-      }
-    }
-    ```
-
-  </Tab>
-  <Tab label="Vanilla JS" value="vanilla">
-    ```javascript fileName="product-copy.js"
-    import { useIntlayer } from "vanilla-intlayer";
-
-    const content = useIntlayer("product-copy", {
-      id: "prod_abcd",
-      userId: "user_123"
-    });
-
-    if (content) {
-      document.body.innerHTML = `<p>${content.description}</p>`;
-    }
-    ```
-
-  </Tab>
-</Tabs>
-
-### With explicit locale
-
-```tsx
-const content = useIntlayer("product-copy", {
-  id: "prod_abc",
-  userId: "user_123",
-  locale: "fr",
-});
-```
-
-### Missing meta field — compile-time error
-
-```ts
-// Type error: `userId` is missing
-const content = useIntlayer("product-copy", { id: "prod_abc" });
-```
-
-## Loading mode
-
-Dynamic records are typically loaded lazily. Set `importMode` on the dictionary to control this:
-
-```ts contentDeclarationFormat={["typescript", "esm", "commonjs"]}
-const dictionary = {
-  key: "product-copy",
-  importMode: "fetch", // or "dynamic"
-  meta: { id: "prod_abc", userId: "user_123" },
-  content: { … },
-} satisfies Dictionary;
-
-export default dictionary;
-```
-
-See [bundle optimisation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/bundle_optimization.md) for details on `static`, `dynamic`, and `fetch` modes.
-
-## Typical use-cases
-
-- Per-product marketing copy managed in a CMS
-- User-specific or account-specific content
-- Any content keyed by an opaque runtime ID