Démarrage avec l'internationalisation (i18n) avec Intlayer et React Create App
Qu'est-ce qu'Intlayer ?
Intlayer est une bibliothèque open-source innovante d'internationalisation (i18n) 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 locale.
Guide étape par étape pour configurer Intlayer dans une application React
Étape 1 : Installer les dépendances
Installez les packages nécessaires en utilisant npm :
npm install intlayer react-intlayer react-scripts-intlayer
intlayer
Le package principal qui fournit des outils d'internationalisation pour la gestion de configuration, la traduction, 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.
react-scripts-intlayer
Inclut les commandes et plugins react-scripts-intlayer pour intégrer Intlayer avec une application basée sur Create React App. Ces plugins sont basés sur craco et incluent une configuration supplémentaire pour le bundler Webpack.
É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 = { internationalisation: { locales: [ Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH, // Vos autres locales ], defaultLocale: Locales.ENGLISH, },};export default config;
Grâce à ce fichier de configuration, vous pouvez configurer des URL localisées, des redirections middleware, des 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 CRA
Modifiez vos scripts pour utiliser react-intlayer
"scripts": { "build": "react-scripts-intlayer build", "start": "react-scripts-intlayer start", "transpile": "intlayer build" },
Les scripts react-scripts-intlayer sont basés sur CRACO. Vous pouvez également implémenter votre propre configuration basée sur le plugin craco d'intlayer. Voir un exemple ici.
É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 React, { type ReactNode } from "react";const appContent = { key: "app", content: { getStarted: t<ReactNode>({ en: ( <> Edit <code>src/App.tsx</code> and save to reload </> ), fr: ( <> Éditez <code>src/App.tsx</code> et enregistrez pour recharger </> ), es: ( <> Edita <code>src/App.tsx</code> y guarda para recargar </> ), }), reactLink: { href: "https://reactjs.org", content: t({ en: "Learn React", fr: "Apprendre React", es: "Aprender React", }), }, },} 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 logo from "./logo.svg";import "./App.css";import type { FC } from "react";import { IntlayerProvider, useIntlayer } from "react-intlayer";const AppContent: FC = () => { const content = useIntlayer("app"); return ( <div className="App"> <img src={logo} className="App-logo" alt="logo" /> {content.getStarted} <a className="App-link" href={content.reactLink.href.value} target="_blank" rel="noopener noreferrer" > {content.reactLink.content} </a> </div> );};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
Remarque : 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 : 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.
import { Locales } from "intlayer";import { useLocale } from "react-intlayer";const LocaleSwitcher = () => { 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 les URL conviviales pour les moteurs de recherche. 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 locale par défaut. Si vous souhaitez préfixer la locale 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 locale. Voici un exemple utilisant React Router:
// Importation des dépendances nécessaires et des fonctionsimport { Locales, getConfiguration, getPathWithoutLocale } from "intlayer"; // Fonctions utilitaires et types d'intlayerimport { 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 { internationalisation, middleware } = getConfiguration();const { locales, defaultLocale } = internationalisation;/** * 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 basées sur l'URL. */const AppLocalized: FC<PropsWithChildren<{ locale: Locales }>> = ({ children, locale,}) => { const { pathname, search } = useLocation(); // Obtenez le chemin URL actuel // Déterminez la locale actuelle, en revenant à la locale par défaut si elle n'est pas fournie const currentLocale = locale ?? defaultLocale; // Supprimez le préfixe de 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) { // Validez la locale if (!locale || !locales.includes(locale)) { // Redirigez vers la locale par défaut avec le chemin mis à jour return ( <Navigate to={`/${defaultLocale}/${pathWithoutLocale}${search}`} replace // Remplacez l'entrée actuelle de l'historique par la nouvelle /> ); } // Enveloppez les enfants avec le fournisseur Intlayer et définissez 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() // Excluez la locale par défaut ) .includes(currentLocale) // Vérifiez si la locale actuelle est dans la liste des locales valides ) { // Redirigez vers le chemin sans préfixe de locale return <Navigate to={`${pathWithoutLocale}${search}`} replace />; } // Enveloppez les enfants avec le fournisseur Intlayer et définissez la locale actuelle return ( <IntlayerProvider locale={currentLocale}>{children}</IntlayerProvider> ); }};/** * Un composant de routage qui configure des routes spécifiques à la 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 ex., /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 locale /> ))} { // Si le préfixage de la locale par défaut est désactivé, rendez les enfants directement à la racine !middleware.prefixDefault && ( <Route path="*" element={ <AppLocalized locale={defaultLocale}>{children}</AppLocalized> } // Enveloppe les enfants avec la gestion de locale /> ) } </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>);
(Optionnel) Étape 8 : Modifier l'URL lorsque la locale change
Pour modifier l'URL lorsque la locale 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 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(); // Obtenez le chemin URL actuel. Exemple : /fr/about?foo=bar const navigate = useNavigate(); const { availableLocales, setLocale } = useLocale({ onLocaleChange: (locale) => { // Construisez l'URL avec la locale mise à jour // Exemple : /es/about?foo=bar const pathWithLocale = getLocalizedUrl(`${pathname}${search}`, locale); // Mettez à jour le chemin 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 : Modifier les attributs de langue et de direction HTML
Lorsque votre application prend en charge plusieurs langues, il est essentiel 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 pour prononcer et interpréter correctement le contenu.
- Rendu du texte : L'attribut dir (direction) garantit que le texte est rendu 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 à 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` : Garantit 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(() => { // Mettez à jour l'attribut de langue à la locale actuelle. document.documentElement.lang = locale; // Définissez 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 fois que la locale change :
import { 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(); // ... Reste de votre composant};const App: FC = () => ( <IntlayerProvider> <AppContent /> </IntlayerProvider>);export default App;
En appliquant ces modifications, votre application :
- Garantira que l'attribut langue (lang) reflète correctement la locale actuelle, ce qui est important pour le SEO et le comportement du navigateur.
- Ajustera la direction du texte (dir) en fonction de la locale, améliorant 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.
Configurer TypeScript
Intlayer utilise l'augmentation de module pour bénéficier 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