Auteur:
    Aymeric PINEAU
    Création:2026-01-21Dernière mise à jour:2026-09-19

    Paquet astro-intlayer

    Le paquet astro-intlayer fournit les outils nécessaires pour intégrer Intlayer dans des applications Astro. Il configure le routage basé sur la locale, la gestion des dictionnaires, la réécriture des pages lors du build, le middleware de requête et les hooks pour accéder au contenu multilingue à la fois dans les composants .astro rendus côté serveur et dans les scripts côté client.

    Installation

    bash
    npm install astro-intlayer

    Exports

    Intégration

    Le paquet astro-intlayer fournit une intégration Astro qui configure Intlayer dans votre projet.

    Importation :

    tsx
    import { intlayer } from "astro-intlayer";

    ou importation par défaut dans astro.config.mjs :

    ts
    import { defineConfig } from "astro/config";
import intlayer from "astro-intlayer";

export default defineConfig({
  integrations: [intlayer()],
});
    FonctionDescriptionDocumentation associée
    intlayerIntégration Astro qui prépare les dictionnaires, configure les plugins Vite (alias, proxy de routage, élagage), enregistre automatiquement le middleware de requête et émet des pages pré-rendues aux URL réécrites.intlayer

    Hooks (Serveur et Client)

    Importation :

    tsx
    import { useIntlayer, useDictionary, useLocale } from "astro-intlayer";
    HookDescriptionDocumentation associée
    useIntlayerSélectionne un dictionnaire par sa clé et retourne son contenu localisé. Dans le frontmatter .astro, il lit la locale de requête depuis Astro.locals. Dans <script>, il lit depuis le store client.useIntlayer
    useDictionaryTransforme un objet dictionnaire et retourne le contenu pour la locale résolue. Fonctionne dans le frontmatter et les scripts client.useDictionary
    useLocaleRetourne la locale actuelle, la locale par défaut, les locales disponibles et une fonction pour mettre à jour la locale.useLocale

    Middleware (astro-intlayer/middleware)

    Importation :

    tsx
    import { onRequest } from "astro-intlayer/middleware";
    ExportTypeDescriptionDocumentation associée
    onRequestMiddlewareHandlerMiddleware Astro qui détecte la locale de la requête et attache Astro.locals.intlayer. Enregistré automatiquement par intlayer(), ou importé manuellement pour composer.onRequest

    Utilitaires

    Importation :

    tsx
    import { getIntlayerLocals } from "astro-intlayer";
    FonctionDescriptionDocumentation associée
    getIntlayerLocalsFonction d'aide pour récupérer l'objet IntlayerLocals actuel depuis la portée de stockage de requête hors d'Astro.locals.-

    Utilitaires Client (astro-intlayer/client)

    Importation :

    tsx
    import {
  useIntlayer,
  useDictionary,
  useDictionaryDynamic,
  useLocale,
  useLocaleStorage,
  useLocaleCookie,
  getIntlayer,
  getDictionary,
  installIntlayer,
  setLocaleInStorage,
  setLocaleCookie,
  localeInStorage,
  localeCookie,
} from "astro-intlayer/client";

    Lorsqu'il est importé dans le navigateur ou à l'intérieur de balises client <script>, astro-intlayer bascule automatiquement vers astro-intlayer/client (alimenté par vanilla-intlayer), fournissant les getters de dictionnaire côté client, les abonnements au store et les outils de persistance de locale.

    Formateurs (astro-intlayer/format)

    Importation :

    tsx
    import {
  useIntl,
  useDate,
  useNumber,
  useCurrency,
  usePercentage,
  useRelativeTime,
  useList,
  useUnit,
  useCompact,
} from "astro-intlayer/format";
    HookDescription
    useIntlRetourne une instance Intl liée à la locale de requête ou client avec fonctionnalités de cache et d'abonnement.
    useDateRetourne une fonction de formatage de date pré-liée à la locale actuelle (Intl.DateTimeFormat).
    useNumberRetourne une fonction de formatage de nombre pré-liée à la locale actuelle (Intl.NumberFormat).
    useCurrencyRetourne une fonction de formatage de devise pré-liée à la locale actuelle.
    usePercentageRetourne une fonction de formatage de pourcentage pré-liée à la locale actuelle.
    useRelativeTimeRetourne une fonction de formatage de temps relatif pré-liée à la locale actuelle (Intl.RelativeTimeFormat).
    useListRetourne une fonction de formatage de liste pré-liée à la locale actuelle (Intl.ListFormat).
    useUnitRetourne une fonction de formatage d'unité pré-liée à la locale actuelle.
    useCompactRetourne une fonction de formatage de nombre compact pré-liée à la locale actuelle (ex. 1.5K).

    Utilitaires HTML (astro-intlayer/html)

    Importation :

    tsx
    import { renderHTML, useHTML, useHTMLRenderer } from "astro-intlayer/html";
    ExportTypeDescription
    renderHTMLFunctionFonction utilitaire autonome pour rendre les nœuds HTML.
    useHTMLHookHook pour obtenir le contexte du fournisseur HTML et sa configuration.
    useHTMLRendererHookHook pour obtenir une fonction de rendu HTML préconfigurée.

    Utilitaires Markdown (astro-intlayer/markdown)

    Importation :

    tsx
    import {
  compileMarkdown,
  renderMarkdown,
  parseMarkdown,
  useMarkdown,
  useMarkdownRenderer,
} from "astro-intlayer/markdown";
    ExportTypeDescription
    compileMarkdownFunctionCompile des chaînes markdown en représentation structurée.
    renderMarkdownFunctionRend le contenu markdown en nœuds de sortie.
    parseMarkdownFunctionAnalyse le contenu markdown brut en un AST.
    useMarkdownHookHook pour obtenir le contexte du fournisseur markdown.
    useMarkdownRendererHookHook pour obtenir une fonction de rendu Markdown préconfigurée.

    Types

    Importation :

    tsx
    import type {
  IntlayerLocals,
  UseLocaleProps,
  UseLocaleResult,
} from "astro-intlayer";
    TypeDescription
    IntlayerLocalsL'objet attaché à Astro.locals.intlayer contenant locale, defaultLocale et availableLocales.
    UseLocalePropsPropriétés de configuration facultatives acceptées par useLocale().
    UseLocaleResultLe type de retour de useLocale(), fournissant les propriétés de locale et les méthodes de mise à jour.
    lynx-intlayerintlayer