Commencer avec l'internationalisation (i18n) avec Intlayer, Vite et React
Qu'est-ce qu'Intlayer ?
Intlayer est une bibliothèque d'internationalisation (i18n) innovante et open-source conçue pour simplifier la prise en charge multilingue dans les applications web modernes.
Avec Intlayer, vous pouvez :
- Gérer facilement les traductions en utilisant des dictionnaires déclaratifs au niveau des composants.
- Localiser dynamiquement les métadonnées, les routes et le contenu.
- Assurer la prise en charge de TypeScript avec des types générés automatiquement, améliorant l'autocomplétion et la détection des erreurs.
- Bénéficier de fonctionnalités avancées, comme la détection et le changement dynamiques de langue.
Guide étape par étape pour configurer Intlayer dans une application Vite et React
Étape 1 : Installer les dépendances
Installez les packages nécessaires avec npm :
npm install intlayer react-intlayer vite-intlayer
intlayer
Le package principal qui fournit des outils d'internationalisation pour la gestion des configurations, les traductions, la déclaration de contenu, la transpilation et les commandes CLI.
react-intlayer Le package 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 langue préférée de l'utilisateur, gérer les cookies et rediriger les URL.
Étape 2 : Configuration de votre projet
Créez un fichier de configuration pour configurer les langues de votre application :
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 les URL localisées, la redirection via middleware, les noms de cookies, l'emplacement et l'extension de vos déclarations de contenu, désactiver les logs Intlayer dans la console, et 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.
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 intlayerPlugin() pour Vite est utilisé pour intégrer Intlayer avec Vite. Il garantit la construction des fichiers de déclaration de contenu et les surveille en mode développement. Il définit les variables d'environnement Intlayer dans 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 :
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>({ // N'oubliez pas d'importer React si vous utilisez un React node dans votre contenu en: ( <> Edit <code>src/App.tsx</code> and save to test 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: "Click on the Vite and React logos to learn more", 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 tant 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.{ts,tsx,js,jsx,mjs,cjs}). Pour plus de détails, consultez la documentation sur les déclarations 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 :
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 string, tel que alt, title, href, aria-label, etc., vous devez appeler la valeur de la fonction, comme :
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 : Changez 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.
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)}> Change Language to English </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 les URL conviviales pour le référencement. Exemple :
- 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 langue par défaut. Si vous souhaitez préfixer la langue par défaut, vous pouvez définir l'option middleware.prefixDefault sur 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 langue. Voici un exemple utilisant React Router :
// Importation des dépendances et fonctions nécessairesimport { Locales, getConfiguration, getPathWithoutLocale } from "intlayer"; // Fonctions utilitaires et types de 'intlayer'import { FC, PropsWithChildren } from "react"; // Types React pour les composants fonctionnels et les propsimport { IntlayerProvider } from "react-intlayer"; // Fournisseur pour le contexte d'internationalisationimport { BrowserRouter, Routes, Route, Navigate, useLocation,} from "react-router-dom"; // Composants de routage pour gérer la navigation// Déstructuration de la configuration depuis Intlayerconst { internationalization, middleware } = getConfiguration();const { locales, defaultLocale } = internationalization;/** * Un composant qui gère la localisation et enveloppe les enfants avec le contexte de langue approprié. * Il gère la détection et la validation de la langue basée sur l'URL. */const AppLocalized: FC<PropsWithChildren<{ locale: Locales }>> = ({ children, locale,}) => { const { pathname, search } = useLocation(); // Obtenir le chemin actuel de l'URL // Déterminer la langue actuelle, en revenant à la langue par défaut si non fournie const currentLocale = locale ?? defaultLocale; // Supprimer le préfixe de langue du chemin pour construire un chemin de base const pathWithoutLocale = getPathWithoutLocale( pathname // Chemin actuel de l'URL ); /** * Si middleware.prefixDefault est vrai, la langue par défaut doit toujours être préfixée. */ if (middleware.prefixDefault) { // Valider la langue if (!locale || !locales.includes(locale)) { // Rediriger vers la langue par défaut avec le chemin mis à jour return ( <Navigate to={`/${defaultLocale}/${pathWithoutLocale}${search}`} replace // Remplacer l'entrée actuelle de l'historique par la nouvelle /> ); } // Envelopper les enfants avec le IntlayerProvider et définir la langue actuelle return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); } else { /** * Lorsque middleware.prefixDefault est faux, la langue par défaut n'est pas préfixée. * Assurez-vous que la langue actuelle est valide et n'est pas la langue par défaut. */ if ( currentLocale.toString() !== defaultLocale.toString() && !locales .filter( (locale) => locale.toString() !== defaultLocale.toString() // Exclure la langue par défaut ) .includes(currentLocale) // Vérifier si la langue actuelle est dans la liste des langues valides ) { // Rediriger vers le chemin sans préfixe de langue return <Navigate to={`${pathWithoutLocale}${search}`} replace />; } // Envelopper les enfants avec le IntlayerProvider et définir la langue actuelle return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); }};/** * Un composant de routage qui configure des routes spécifiques à la langue. * 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 langue (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 langue /> ))} { // Si le préfixage de la langue 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 langue /> ) } </Routes> </BrowserRouter>);
Ensuite, vous pouvez utiliser le composant LocaleRouter dans votre application :
import { LocaleRouter } from "./components/LocaleRouter";import { 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 langue actuelle en fonction de l'URL et définira le cookie de langue approprié. Si aucune langue n'est spécifiée, le plugin déterminera la langue la plus appropriée en fonction des préférences linguistiques du navigateur de l'utilisateur. Si aucune langue n'est détectée, il redirigera vers la langue par défaut.
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 prop onLocaleChange fournie par le hook useLocale. En parallèle, vous pouvez utiliser les hooks useLocation et useNavigate de react-router-dom pour mettre à jour le chemin de l'URL.
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(); // Obtenir le chemin actuel de l'URL. Exemple : /fr/about?foo=bar const navigate = useNavigate(); const { 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 - par ex. FR */} {localeItem} </span> <span> {/* Langue dans sa propre locale - par ex. Français */} {getLocaleName(localeItem, locale)} </span> <span dir={getHTMLTextDir(localeItem)} lang={localeItem}> {/* Langue dans la locale actuelle - par ex. Francés avec la locale actuelle définie sur Locales.SPANISH */} {getLocaleName(localeItem)} </span> <span dir="ltr" lang={Locales.ENGLISH}> {/* Langue en anglais - par ex. French */} {getLocaleName(localeItem, Locales.ENGLISH)} </span> </a> ))} </div> </div> );};
Références de documentation :
(Optionnel) Étape 9 : Changer les attributs de langue et de direction 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 correspondre à 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) garantit que le texte est rendu dans le bon ordre (par ex. 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 à fournir le bon contenu localisé dans les résultats de recherche.
En mettant à jour ces attributs dynamiquement 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 :
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 l'ordre de lecture correct (par exemple, 'ltr' pour l'anglais, 'rtl' pour l'arabe). * * Cette mise à jour dynamique est essentielle pour un rendu de texte correct, l'accessibilité et le SEO. */export const useI18nHTMLAttributes = () => { const { locale } = useLocale(); useEffect(() => { // Met à jour l'attribut de langue à 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 :
import { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";import { useI18nHTMLAttributes } from "./hooks/useI18nHTMLAttributes";import "./App.css";const AppContent: FC = () => { // Applique le hook pour mettre à jour les attributs lang et dir de la balise <html> en fonction de la locale. useI18nHTMLAttributes(); // ... Reste de votre composant};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
En appliquant ces modifications, votre application :
- Assurera que l'attribut langue (lang) reflète correctement la locale actuelle, ce qui est important pour le SEO et le comportement des navigateurs.
- Ajustera la direction du texte (dir) en fonction de la locale, améliorant ainsi la lisibilité et l'utilisabilité pour les langues avec des ordres de lecture différents.
- Fournira 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éation d'un composant de lien localisé
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 actuelle, de sorte que, 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 un 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 se développe.
Voici l'implémentation d'un composant Link localisé en TypeScript :
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, obtient 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 de localisation.Récupération de la langue actuelle :
Le hook useLocale fournit la langue 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 langue actuelle. 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 langue.
En intégrant ce composant Link dans votre application, vous maintenez une expérience utilisateur cohérente et adaptée à la langue tout en bénéficiant d'un meilleur 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.
Assurez-vous que votre configuration TypeScript inclut les types générés automatiquement.
{ // votre configuration personnalisée "include": [ "src", "types", // <- Inclure les types générés automatiquement ],}
Configurer TypeScript
Intlayer utilise l'augmentation de module pour tirer parti de TypeScript et renforcer votre base de code.
Assurez-vous que votre configuration TypeScript inclut les types générés automatiquement.
{ // ... 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 ajouter à votre dépôt Git.
Pour ce faire, vous pouvez ajouter les instructions suivantes à votre fichier .gitignore :
# Ignorer les fichiers générés par Intlayer.intlayer
Aller plus loin
Pour aller plus loin, vous pouvez implémenter l'éditeur visuel ou externaliser votre contenu en utilisant le CMS.
Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.
Lien GitHub de la documentation