Recevez des notifications en avant-première sur les prochains lancements de Intlayer
    Création:2024-03-07Dernière mise à jour:2024-03-07

    Guide étape par étape pour configurer Intlayer dans une application Vite et React

    Étape 1 : Installer les dépendances

    Installez les paquets nécessaires en utilisant npm :

    bash
    npm install intlayer react-intlayernpm install vite-intlayer --save-dev
    • intlayer

      Le paquet principal qui fournit des outils d'internationalisation pour la gestion de la configuration, la traduction, la déclaration de contenu, la transpilation, et les commandes CLI.

    • react-intlayer Le paquet qui intègre Intlayer avec une application React. Il fournit des fournisseurs de contexte et des hooks pour l'internationalisation dans React.

    • vite-intlayer Inclut le plugin Vite pour intégrer Intlayer avec le bundler Vite, ainsi que des middlewares pour détecter la locale préférée de l'utilisateur, gérer les cookies, et gérer la redirection des URL.

    Étape 2 : Configuration de votre projet

    Créez un fichier de configuration pour configurer les langues de votre application :

    intlayer.config.ts
    import { Locales, type IntlayerConfig } from "intlayer";const config: IntlayerConfig = {  internationalization: {    locales: [      Locales.ENGLISH,      Locales.FRENCH,      Locales.SPANISH,      // Vos autres langues    ],    defaultLocale: Locales.ENGLISH,  },};export default config;

    Grâce à ce fichier de configuration, vous pouvez configurer des URLs localisées, la redirection via middleware, les noms des cookies, l'emplacement et l'extension de vos déclarations de contenu, désactiver les logs Intlayer dans la console, et bien plus encore. Pour une liste complète des paramètres disponibles, consultez la documentation de configuration.

    Étape 3 : Intégrer Intlayer dans votre configuration Vite

    Ajoutez le plugin intlayer dans votre configuration.

    vite.config.ts
    import { defineConfig } from "vite";import react from "@vitejs/plugin-react-swc";import { intlayerPlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [react(), intlayerPlugin()],});

    Le plugin Vite intlayerPlugin() est utilisé pour intégrer Intlayer avec Vite. Il assure la génération des fichiers de déclaration de contenu et les surveille en mode développement. Il définit les variables d'environnement Intlayer au sein de l'application Vite. De plus, il fournit des alias pour optimiser les performances.

    Étape 4 : Déclarez Votre Contenu

    Créez et gérez vos déclarations de contenu pour stocker les traductions :

    src/app.content.tsx
    import { t, type Dictionary } from "intlayer";import type { ReactNode } from "react";const appContent = {  key: "app",  content: {    viteLogo: t({      en: "Vite logo",      fr: "Logo Vite",      es: "Logo Vite",    }),    reactLogo: t({      en: "React logo",      fr: "Logo React",      es: "Logo React",    }),    title: "Vite + React",    count: t({      en: "count is ",      fr: "le compte est ",      es: "el recuento es ",    }),    edit: t<ReactNode>({      en: (        <>          Éditez <code>src/App.tsx</code> et enregistrez pour tester HMR        </>      ),      fr: (        <>          Éditez <code>src/App.tsx</code> et enregistrez pour tester HMR        </>      ),      es: (        <>          Edita <code>src/App.tsx</code> y guarda para probar HMR        </>      ),    }),    readTheDocs: t({      en: "Cliquez sur les logos Vite et React pour en savoir plus",      fr: "Cliquez sur les logos Vite et React pour en savoir plus",      es: "Haga clic en los logotipos de Vite y React para obtener más información",    }),  },} satisfies Dictionary;export default appContent;

    Vos déclarations de contenu peuvent être définies n'importe où dans votre application dès qu'elles sont incluses dans le répertoire contentDir (par défaut, ./src). Et correspondent à l'extension de fichier de déclaration de contenu (par défaut, .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}).

    Pour plus de détails, consultez la documentation sur la déclaration de contenu.

    Si votre fichier de contenu inclut du code TSX, vous devriez envisager d'importer import React from "react"; dans votre fichier de contenu.

    Étape 5 : Utilisez Intlayer dans votre code

    Accédez à vos dictionnaires de contenu dans toute votre application :

    src/App.tsx
    import { useState, type FC } from "react";import reactLogo from "./assets/react.svg";import viteLogo from "/vite.svg";import "./App.css";import { IntlayerProvider, useIntlayer } from "react-intlayer";const AppContent: FC = () => {  const [count, setCount] = useState(0);  const content = useIntlayer("app");  return (    <>      <div>        <a href="https://vitejs.dev" target="_blank">          <img src={viteLogo} className="logo" alt={content.viteLogo.value} />        </a>        <a href="https://react.dev" target="_blank">          <img            src={reactLogo}            className="logo react"            alt={content.reactLogo.value}          />        </a>      </div>      <h1>{content.title}</h1>      <div className="card">        <button onClick={() => setCount((count) => count + 1)}>          {content.count}          {count}        </button>        <p>{content.edit}</p>      </div>      <p className="read-the-docs">{content.readTheDocs}</p>    </>  );};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

    Si vous souhaitez utiliser votre contenu dans un attribut de type string, tel que alt, title, href, aria-label, etc., vous devez appeler la valeur de la fonction, comme ceci :

    jsx
    <img src={content.image.src.value} alt={content.image.value} />

    Pour en savoir plus sur le hook useIntlayer, consultez la documentation.

    (Optionnel) Étape 6 : Changer la langue de votre contenu

    Pour changer la langue de votre contenu, vous pouvez utiliser la fonction setLocale fournie par le hook useLocale. Cette fonction vous permet de définir la locale de l'application et de mettre à jour le contenu en conséquence.

    src/components/LocaleSwitcher.tsx
    import type { FC } from "react";import { Locales } from "intlayer";import { useLocale } from "react-intlayer";const LocaleSwitcher: FC = () => {  const { setLocale } = useLocale();  return (    <button onClick={() => setLocale(Locales.English)}>      Changer la langue en anglais    </button>  );};

    Pour en savoir plus sur le hook useLocale, consultez la documentation.

    (Optionnel) Étape 7 : Ajouter un routage localisé à votre application

    L'objectif de cette étape est de créer des routes uniques pour chaque langue. Cela est utile pour le SEO et pour des URLs optimisées pour le référencement. Exemple :

    plaintext
    - https://example.com/about- https://example.com/es/about- https://example.com/fr/about

    Par défaut, les routes ne sont pas préfixées pour la locale par défaut. Si vous souhaitez préfixer la locale par défaut, vous pouvez définir l'option middleware.prefixDefault à true dans votre configuration. Consultez la documentation de configuration pour plus d'informations.

    Pour ajouter un routage localisé à votre application, vous pouvez créer un composant LocaleRouter qui enveloppe les routes de votre application et gère le routage basé sur la locale. Voici un exemple utilisant React Router :

    src/components/LocaleRouter.tsx
    // Importation des dépendances et fonctions nécessairesimport { type Locales, configuration, getPathWithoutLocale } from "intlayer"; // Fonctions utilitaires et types provenant de 'intlayer'import type { FC, PropsWithChildren } from "react"; // Types React pour composants fonctionnels et propsimport { IntlayerProvider } from "react-intlayer"; // Fournisseur pour le contexte d'internationalisationimport {  BrowserRouter,  Routes,  Route,  Navigate,  useLocation,} from "react-router-dom"; // Composants du routeur pour gérer la navigation// Déstructuration de la configuration depuis Intlayerconst { internationalization, middleware } = configuration;const { locales, defaultLocale } = internationalization;/** * Un composant qui gère la localisation et enveloppe les enfants avec le contexte de locale approprié. * Il gère la détection et la validation de la locale basée sur l'URL. */const AppLocalized: FC<PropsWithChildren<{ locale: Locales }>> = ({  children,  locale,}) => {  const { pathname, search } = useLocation(); // Obtenir le chemin URL actuel  // Déterminer la locale actuelle, en revenant à la locale par défaut si non fournie  const currentLocale = locale ?? defaultLocale;  // Supprimer le préfixe de la locale du chemin pour construire un chemin de base  const pathWithoutLocale = getPathWithoutLocale(    pathname // Chemin URL actuel  );  /**   * Si middleware.prefixDefault est vrai, la locale par défaut doit toujours être préfixée.   */  if (middleware.prefixDefault) {    // Valider la locale    if (!locale || !locales.includes(locale)) {      // Rediriger vers la locale par défaut avec le chemin mis à jour      return (        <Navigate          to={`/${defaultLocale}/${pathWithoutLocale}${search}`}          replace // Remplace l'entrée actuelle de l'historique par la nouvelle        />      );    }    // Envelopper les enfants avec IntlayerProvider et définir la locale actuelle    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  } else {    /**     * Lorsque middleware.prefixDefault est faux, la locale par défaut n'est pas préfixée.     * Assurez-vous que la locale actuelle est valide et n'est pas la locale par défaut.     */    if (      currentLocale.toString() !== defaultLocale.toString() &&      !locales        .filter(          (locale) => locale.toString() !== defaultLocale.toString() // Exclure la locale par défaut        )        .includes(currentLocale) // Vérifie si la locale actuelle fait partie de la liste des locales valides    ) {      // Redirige vers le chemin sans préfixe de locale      return <Navigate to={`${pathWithoutLocale}${search}`} replace />;    }    // Enveloppe les enfants avec IntlayerProvider et définit la locale actuelle    return (      <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider>    );  }};/** * Un composant de routeur qui configure les routes spécifiques à chaque locale. * Il utilise React Router pour gérer la navigation et rendre les composants localisés. */export const LocaleRouter: FC<PropsWithChildren> = ({ children }) => (  <BrowserRouter>    <Routes>      {locales        .filter(          (locale) => middleware.prefixDefault || locale !== defaultLocale        )        .map((locale) => (          <Route            // Modèle de route pour capturer la locale (par exemple, /en/, /fr/) et correspondre à tous les chemins suivants            path={`/${locale}/*`}            key={locale}            element={<AppLocalized locale={locale}>{children}</AppLocalized>} // Enveloppe les enfants avec la gestion de la locale          />        ))}      {        // Si le préfixe de la locale par défaut est désactivé, rendre les enfants directement à la racine        !middleware.prefixDefault && (          <Route            path="*"            element={              <AppLocalized locale={defaultLocale}>{children}</AppLocalized>            } // Enveloppe les enfants avec la gestion de la locale          />        )      }    </Routes>  </BrowserRouter>);

    Ensuite, vous pouvez utiliser le composant LocaleRouter dans votre application :

    src/App.tsx
    import { LocaleRouter } from "./components/LocaleRouter";import type { FC } from "react";// ... Votre composant AppContentconst App: FC = () => (  <LocaleRouter>    <AppContent />  </LocaleRouter>);

    En parallèle, vous pouvez également utiliser le intLayerMiddlewarePlugin pour ajouter un routage côté serveur à votre application. Ce plugin détectera automatiquement la locale actuelle en fonction de l'URL et définira le cookie de locale approprié. Si aucune locale n'est spécifiée, le plugin déterminera la locale la plus appropriée en fonction des préférences linguistiques du navigateur de l'utilisateur. Si aucune locale n'est détectée, il redirigera vers la locale par défaut.

    vite.config.ts
    import { defineConfig } from "vite";import react from "@vitejs/plugin-react-swc";import { intlayerPlugin, intLayerMiddlewarePlugin } from "vite-intlayer";// https://vitejs.dev/config/export default defineConfig({  plugins: [react(), intlayerPlugin(), intLayerMiddlewarePlugin()],});

    (Optionnel) Étape 8 : Modifier l'URL lorsque la langue change

    Pour modifier l'URL lorsque la langue change, vous pouvez utiliser la propriété onLocaleChange fournie par le hook useLocale. Parallèlement, vous pouvez utiliser les hooks useLocation et useNavigate de react-router-dom pour mettre à jour le chemin de l'URL.

    src/components/LocaleSwitcher.tsx
    import { useLocation, useNavigate } from "react-router-dom";import {  Locales,  getHTMLTextDir,  getLocaleName,  getLocalizedUrl,} from "intlayer";import { useLocale } from "react-intlayer";import { type FC } from "react";const LocaleSwitcher: FC = () => {  const { pathname, search } = useLocation(); // Récupère le chemin URL actuel. Exemple : /fr/about?foo=bar  const navigate = useNavigate();  const { locale, availableLocales, setLocale } = useLocale({    onLocaleChange: (locale) => {      // Construire l'URL avec la locale mise à jour      // Exemple : /es/about?foo=bar      const pathWithLocale = getLocalizedUrl(`${pathname}${search}`, locale);      // Mettre à jour le chemin de l'URL      navigate(pathWithLocale);    },  });  return (    <div>      <button popoverTarget="localePopover">{getLocaleName(locale)}</button>      <div id="localePopover" popover="auto">        {availableLocales.map((localeItem) => (          <a            href={getLocalizedUrl(location.pathname, localeItem)}            hrefLang={localeItem}            aria-current={locale === localeItem ? "page" : undefined}            onClick={(e) => {              e.preventDefault();              setLocale(localeItem);            }}            key={localeItem}          >            <span>              {/* Locale - ex. FR */}              {localeItem}            </span>            <span>              {/* Langue dans sa propre locale - ex. Français */}              {getLocaleName(localeItem, locale)}            </span>            <span dir={getHTMLTextDir(localeItem)} lang={localeItem}>              {/* Langue dans la locale courante - ex. Francés avec la locale courante définie sur Locales.SPANISH */}              {getLocaleName(localeItem)}            </span>            <span dir="ltr" lang={Locales.ENGLISH}>              {/* Langue en anglais - ex. French */}              {getLocaleName(localeItem, Locales.ENGLISH)}            </span>          </a>        ))}      </div>    </div>  );};

    Références de la documentation :

    Voici la Étape 9 mise à jour avec des explications supplémentaires et des exemples de code affinés :


    (Optionnel) Étape 9 : Modifier les attributs de langue et de direction du HTML

    Lorsque votre application prend en charge plusieurs langues, il est crucial de mettre à jour les attributs lang et dir de la balise <html> pour qu'ils correspondent à la locale actuelle. Cela garantit :

    • Accessibilité : Les lecteurs d'écran et les technologies d'assistance s'appuient sur l'attribut lang correct pour prononcer et interpréter le contenu avec précision.
    • Rendu du texte : L'attribut dir (direction) assure que le texte est affiché dans le bon ordre (par exemple, de gauche à droite pour l'anglais, de droite à gauche pour l'arabe ou l'hébreu), ce qui est essentiel pour la lisibilité.
    • SEO : Les moteurs de recherche utilisent l'attribut lang pour déterminer la langue de votre page, aidant ainsi à diffuser le contenu localisé approprié dans les résultats de recherche.

    En mettant à jour ces attributs de manière dynamique lorsque la locale change, vous garantissez une expérience cohérente et accessible pour les utilisateurs dans toutes les langues prises en charge.

    Implémentation du Hook

    Créez un hook personnalisé pour gérer les attributs HTML. Le hook écoute les changements de locale et met à jour les attributs en conséquence :

    src/hooks/useI18nHTMLAttributes.tsx
    import { useEffect } from "react";import { useLocale } from "react-intlayer";import { getHTMLTextDir } from "intlayer";/** * Met à jour les attributs `lang` et `dir` de l'élément HTML <html> en fonction de la locale actuelle. * - `lang` : Informe les navigateurs et les moteurs de recherche de la langue de la page. * - `dir` : Assure le bon ordre de lecture (par exemple, 'ltr' pour l'anglais, 'rtl' pour l'arabe). * * Cette mise à jour dynamique est essentielle pour un rendu correct du texte, l'accessibilité et le référencement SEO. */export const useI18nHTMLAttributes = () => {  const { locale } = useLocale();  useEffect(() => {    // Met à jour l'attribut de langue avec la locale actuelle.    document.documentElement.lang = locale;    // Définit la direction du texte en fonction de la locale actuelle.    document.documentElement.dir = getHTMLTextDir(locale);  }, [locale]);};

    Utilisation du Hook dans Votre Application

    Intégrez le hook dans votre composant principal afin que les attributs HTML soient mis à jour à chaque changement de locale :

    src/App.tsx
    import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => {  // Appliquez le hook pour mettre à jour les attributs lang et dir de la balise <html> en fonction de la locale.  useI18nHTMLAttributes();  // ... Le reste de votre composant};const App: FC = () => (  <IntlayerProvider>    <AppContent />  </IntlayerProvider>);export default App;

    En appliquant ces modifications, votre application va :

    • Assurer que l'attribut langue (lang) reflète correctement la locale actuelle, ce qui est important pour le SEO et le comportement du navigateur.
    • Ajuster la direction du texte (dir) selon la locale, améliorant la lisibilité et l'utilisabilité pour les langues avec des ordres de lecture différents.
    • Fournir une expérience plus accessible, car les technologies d'assistance dépendent de ces attributs pour fonctionner de manière optimale.

    (Optionnel) Étape 10 : Créer un composant de lien localisé

    src/App.tsx
    // Appliquer le hook pour mettre à jour les attributs lang et dir de la balise <html> en fonction de la locale.useI18nHTMLAttributes();// ... Le reste de votre composant};const App = () => (<IntlayerProvider><AppContent /></IntlayerProvider>);module.exports = App;

    En appliquant ces modifications, votre application va :

    • S'assurer que l'attribut lang reflète correctement la locale actuelle, ce qui est important pour le SEO et le comportement des navigateurs.
    • Ajuster la direction du texte (dir) selon la locale, améliorant la lisibilité et l'utilisabilité pour les langues avec des ordres de lecture différents.
    • Offrir une expérience plus accessible, car les technologies d'assistance dépendent de ces attributs pour fonctionner de manière optimale.

    Pour garantir que la navigation de votre application respecte la locale actuelle, vous pouvez créer un composant Link personnalisé. Ce composant préfixe automatiquement les URL internes avec la langue courante. Par exemple, lorsqu’un utilisateur francophone clique sur un lien vers la page "À propos", il est redirigé vers /fr/about au lieu de /about.

    Ce comportement est utile pour plusieurs raisons :

    • SEO et expérience utilisateur : Les URL localisées aident les moteurs de recherche à indexer correctement les pages spécifiques à une langue et fournissent aux utilisateurs du contenu dans leur langue préférée.
    • Cohérence : En utilisant un lien localisé dans toute votre application, vous garantissez que la navigation reste dans la locale actuelle, évitant ainsi des changements de langue inattendus.
    • Maintenabilité : Centraliser la logique de localisation dans un seul composant simplifie la gestion des URL, rendant votre base de code plus facile à maintenir et à étendre à mesure que votre application grandit.

    Voici l'implémentation d'un composant Link localisé en TypeScript :

    src/components/Link.tsx
    import { getLocalizedUrl } from "intlayer";import {  forwardRef,  type DetailedHTMLProps,  type AnchorHTMLAttributes,} from "react";import { useLocale } from "react-intlayer";export interface LinkProps  extends DetailedHTMLProps<    AnchorHTMLAttributes<HTMLAnchorElement>,    HTMLAnchorElement  > {}/** * Fonction utilitaire pour vérifier si une URL donnée est externe. * Si l'URL commence par http:// ou https://, elle est considérée comme externe. */export const checkIsExternalLink = (href?: string): boolean =>  /^https?:\/\//.test(href ?? "");/** * Un composant Link personnalisé qui adapte l'attribut href en fonction de la locale actuelle. * Pour les liens internes, il utilise `getLocalizedUrl` pour préfixer l'URL avec la locale (par exemple, /fr/about). * Cela garantit que la navigation reste dans le même contexte de locale. */export const Link = forwardRef<HTMLAnchorElement, LinkProps>(  ({ href, children, ...props }, ref) => {    const { locale } = useLocale();    const isExternalLink = checkIsExternalLink(href);    // Si le lien est interne et qu'un href valide est fourni, obtenir l'URL localisée.    const hrefI18n =      href && !isExternalLink ? getLocalizedUrl(href, locale) : href;    return (      <a href={hrefI18n} ref={ref} {...props}>        {children}      </a>    );  });Link.displayName = "Link";

    Comment ça fonctionne

    • Détection des liens externes :
      La fonction utilitaire checkIsExternalLink détermine si une URL est externe. Les liens externes restent inchangés car ils n'ont pas besoin d'être localisés.

    • Récupération de la locale courante :
      Le hook useLocale fournit la locale actuelle (par exemple, fr pour le français).

    • Localisation de l'URL :
      Pour les liens internes (c’est-à-dire non externes), getLocalizedUrl est utilisé pour préfixer automatiquement l'URL avec la locale courante. Cela signifie que si votre utilisateur est en français, passer /about comme href le transformera en /fr/about.

    • Retour du lien :
      Le composant retourne un élément <a> avec l’URL localisée, garantissant que la navigation est cohérente avec la locale.

    En intégrant ce composant Link dans toute votre application, vous maintenez une expérience utilisateur cohérente et adaptée à la langue tout en bénéficiant d’une meilleure SEO et d’une meilleure utilisabilité.

    Configurer TypeScript

    Intlayer utilise l’augmentation de module pour tirer parti de TypeScript et renforcer votre base de code.

    texte alternatif

    texte alternatif

    Assurez-vous que votre configuration TypeScript inclut les types générés automatiquement.

    tsconfig.json
    {  // ... Vos configurations TypeScript existantes  "include": [    // ... Vos configurations TypeScript existantes    ".intlayer/**/*.ts", // Inclure les types générés automatiquement  ],}

    Configuration Git

    Il est recommandé d'ignorer les fichiers générés par Intlayer. Cela vous permet d'éviter de les commettre dans votre dépôt Git.

    Pour ce faire, vous pouvez ajouter les instructions suivantes dans votre fichier .gitignore :

    plaintext
    # Ignorer les fichiers générés par Intlayer.intlayer

    Extension VS Code

    Pour améliorer votre expérience de développement avec Intlayer, vous pouvez installer l'extension officielle Intlayer VS Code Extension.

    Installer depuis le Marketplace VS Code

    Cette extension offre :

    • Autocomplétion pour les clés de traduction.
    • Détection d'erreurs en temps réel pour les traductions manquantes.
    • Aperçus en ligne du contenu traduit.
    • Actions rapides pour créer et mettre à jour facilement les traductions.

    Pour plus de détails sur l'utilisation de l'extension, consultez la documentation de l'extension Intlayer pour VS Code.


    Aller plus loin

    Pour aller plus loin, vous pouvez implémenter l’éditeur visuel ou externaliser votre contenu en utilisant le CMS.


    Historique du document

    • 5.5.10 - 2025-06-29 : Historique initial
    Recevez des notifications en avant-première sur les prochains lancements de Intlayer