Posez votre question et obtenez un résumé du document en referencant cette page et le Provider AI de votre choix
Historique des versions
- "Mettre à jour l'utilisation de l'API useIntlayer de Solid pour un accès direct aux propriétés"v8.9.004/05/2026
- "Ajouter la commande init"v7.5.930/12/2025
- "Introduction de validatePrefix et ajout de l'étape 14 ; Gestion des pages 404 avec des routes localisées."v7.4.011/12/2025
- "Ajout de l'étape 13 ; Récupérer la locale dans vos server actions (Optionnel)"v7.3.905/12/2025
- "Ajout de l'étape 13 ; Adapter Nitro"v7.2.318/11/2025
- "Correction du préfixe par défaut en ajoutant la fonction getPrefix, useLocalizedNavigate, LocaleSwitcher et LocalizedLink."v7.1.017/11/2025
- "Mise à jour de la documentation"v6.5.203/10/2025
- "Ajouté pour Tanstack Start"v5.8.109/09/2025
Le contenu de cette page a été traduit à l'aide d'une IA.
Voir la dernière version du contenu original en anglaisSi 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 documentationCopier le Markdown du doc dans le presse-papiers
Traduisez votre site Tanstack Start avec Intlayer | Internationalisation (i18n)
Table des matières
Ce guide montre comment intégrer Intlayer pour une internationalisation transparente dans les projets Tanstack Start avec un routage tenant compte de la locale, un support TypeScript et des pratiques de développement modernes.
Pourquoi Intlayer plutôt que des alternatives ?
Par rapport aux solutions principales telles que react-i18next ou next-intl, ou paraglide, Intlayer est une solution qui vient avec des optimisations intégrées telles que :
Intlayer est entièrement optimisé pour TanStack Start, offrant un routage multilingue, la gestion des cookies, la génération de sitemap, le chargement dynamique de contenu et toutes les fonctionnalités nécessaires pour mettre à l'échelle votre internationalisation (i18n).
Au lieu de charger de lourds fichiers JSON dans vos pages, ne chargez que le contenu strictement nécessaire. Intlayer vous aide à réduire la taille de votre bundle et de vos pages jusqu'à 50 %.
Déclarer le contenu directement au plus près de vos composants facilite la maintenance des applications de grande envergure. Vous pouvez dupliquer ou supprimer le dossier d'une fonctionnalité sans le fardeau mental de devoir passer en revue toute votre base de code de contenu. De plus, Intlayer est entièrement typé pour garantir l'exactitude de vos traductions.
La colocalisation du contenu réduit le contexte nécessaire aux grands modèles de langage (LLM). Intlayer est également livré avec une suite d'outils, tels qu'une CLI pour vérifier les traductions manquantes, un LSP, un MCP et des agent skills, afin de rendre l'expérience développeur (DX) encore plus fluide pour les agents IA.
Automatisez les traductions dans votre pipeline CI/CD en utilisant le LLM de votre choix au coût de votre propre fournisseur d'IA. Intlayer propose également un compilateur pour automatiser l'extraction de contenu, ainsi qu'une plateforme web pour vous aider à traduire en arrière-plan.
Associer de gros fichiers JSON à vos composants peut ralentir les performances et impacter la réactivité. Intlayer optimise le chargement du contenu directement au moment du build.
Bien plus qu'une simple solution i18n, Intlayer propose un éditeur visuel auto-hébergé et un CMS complet pour gérer votre contenu multilingue en temps réel. Cela rend la collaboration avec les traducteurs, concepteurs-rédacteurs et autres membres de l'équipe extrêmement simple. Le contenu peut être stocké localement et/ou à distance.
Guide étape par étape pour configurer Intlayer dans une application Tanstack Start
Voir le Modèle d'Application sur GitHub.
Créer le projet
Commencez par créer un nouveau projet TanStack Start en suivant le guide Démarrer un nouveau projet sur le site de TanStack Start.
Installer les paquets Intlayer
Installez les paquets nécessaires en utilisant votre gestionnaire de paquets préféré :
bashCopier le codeCopier le code dans le presse-papiers
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 l'application React. Il fournit des fournisseurs de contexte et des hooks pour l'internationalisation React.
vite-intlayer Comprend le plugin Vite pour intégrer Intlayer avec le bundler Vite, ainsi qu'un middleware pour détecter la locale préférée de l'utilisateur, gérer les cookies et gérer la redirection d'URL.
Configuration de votre projet
Créez un fichier de configuration pour configurer les langues de votre application :
intlayer.config.tsCopier le codeCopier le code dans le presse-papiers
Via ce fichier de configuration, vous pouvez configurer les URL localisées, la redirection du 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 plus encore. Pour une liste complète des paramètres disponibles, reportez-vous à la documentation de configuration.
Intégrer Intlayer dans votre configuration Vite
Ajoutez le plugin intlayer dans votre configuration :
vite.config.tsCopier le codeCopier le code dans le presse-papiers
Le plugin Vite
intlayer()est utilisé pour intégrer Intlayer avec Vite. Il assure la construction 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.Créer le Layout Racine
Configurez votre layout racine pour supporter l'internationalisation en utilisant
useParamspour détecter la locale actuelle et en définissant les attributslangetdirsur la balisehtml.src/routes/__root.tsxCopier le codeCopier le code dans le presse-papiers
Créer le Layout de Locale
Créez un layout qui gère le préfixe de locale et effectue la validation.
src/routes/{-$locale}/route.tsxCopier le codeCopier le code dans le presse-papiers
Ici,
{-$locale}est un paramètre de route dynamique qui est remplacé par la locale actuelle. Cette notation rend le slot optionnel, lui permettant de fonctionner avec des modes de routage tels que'prefix-no-default', etc.Soyez conscient que ce slot peut causer des problèmes si vous utilisez plusieurs segments dynamiques dans la même route (ex:
/{-$locale}/other-path/$anotherDynamicPath/...). Pour le mode'prefix-all', vous préférerez peut-être passer le slot en$localeà la place. Pour les modes'no-prefix'ou'search-params', vous pouvez supprimer complètement le slot.Déclarer votre contenu
Créez et gérez vos déclarations de contenu pour stocker les traductions :
src/contents/page.content.tsCopier le codeCopier le code dans le presse-papiers
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,./app). Et correspondent à l'extension de fichier de déclaration de contenu (par défaut,.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}).Pour plus de détails, reportez-vous à la documentation sur la déclaration de contenu.
Créer des composants et hooks tenant compte de la locale
Créez un composant
LocalizedLinkpour une navigation tenant compte de la locale :src/components/localized-link.tsxCopier le codeCopier le code dans le presse-papiers
Ce composant a deux objectifs :
- Supprimer le préfixe inutile
{-$locale}de l'URL. - Injecter le paramètre de locale dans l'URL pour s'assurer que l'utilisateur est directement redirigé vers la route localisée.
Ensuite, nous pouvons créer un hook
useLocalizedNavigatepour la navigation programmatique :src/hooks/useLocalizedNavigate.tsxCopier le codeCopier le code dans le presse-papiers
- Supprimer le préfixe inutile
Utiliser Intlayer dans vos pages
Accédez à vos dictionnaires de contenu dans toute votre application :
Page d'accueil localisée
src/routes/{-$locale}/index.tsxCopier le codeCopier le code dans le presse-papiers
Si vous souhaitez utiliser votre contenu dans un attribut de type
string, tel quealt,title,href,aria-label, etc., vous devez appeler la valeur de la fonction, comme ceci :htmlCopier le codeCopier le code dans le presse-papiers
Pour en savoir plus sur le hook
useIntlayer, reportez-vous à la documentation.Créer un composant sélecteur de langue
Créez un composant pour permettre aux utilisateurs de changer de langue :
src/components/locale-switcher.tsxCopier le codeCopier le code dans le presse-papiers
Pour en savoir plus sur le hook
useLocale, reportez-vous à la documentation.Gestion des attributs HTML
Comme vu à l'étape 5, vous pouvez gérer les attributs
langetdirde la balisehtmlen utilisantuseParamsdans votre composant racine. Cela garantit que les attributs corrects sont définis sur le serveur et le client.src/routes/__root.tsxCopier le codeCopier le code dans le presse-papiers
Ajouter un middleware
Vous pouvez également utiliser
intlayerProxypour 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.Notez que pour utiliser
intlayerProxyen production, vous devez déplacer le paquetvite-intlayerdedevDependenciesversdependencies.vite.config.tsCopier le codeCopier le code dans le presse-papiers
Internationaliser vos métadonnées
Vous pouvez également utiliser le hook
getIntlayerpour accéder à vos dictionnaires de contenu dans toute votre application :src/routes/{-$locale}/index.tsxCopier le codeCopier le code dans le presse-papiers
Récupérer la locale dans vos server actions
Vous pouvez vouloir accéder à la locale actuelle depuis l'intérieur de vos server actions ou de vos points de terminaison d'API. Vous pouvez le faire en utilisant l'utilitaire
getLocaled'Intlayer.Voici un exemple utilisant les fonctions serveur de TanStack Start :
src/routes/{-$locale}/index.tsxCopier le codeCopier le code dans le presse-papiers
Gérer les pages non trouvées
Lorsqu'un utilisateur visite une page inexistante, vous pouvez afficher une page 404 personnalisée et le préfixe de locale peut impacter la façon dont la page 404 est déclenchée.
Comprendre la gestion 404 de TanStack Router avec les préfixes de locale
Dans TanStack Router, la gestion des pages 404 avec des routes localisées nécessite une approche à plusieurs niveaux :
- Route 404 dédiée : Une route spécifique pour afficher l'UI 404
- Validation au niveau de la route : Valide les préfixes de locale et redirige les invalides vers 404
- Route fourre-tout (catch-all) : Capture tous les chemins non correspondants au sein du segment de locale
src/routes/{-$locale}/404.tsxCopier le codeCopier le code dans le presse-papiers
src/routes/{-$locale}/route.tsxCopier le codeCopier le code dans le presse-papiers
src/routes/{-$locale}/$.tsxCopier le codeCopier le code dans le presse-papiers
Extracter le contenu de vos composants
FacultatifSi vous avez une base de code existante, transformer des milliers de fichiers peut prendre beaucoup de temps.
Pour faciliter ce processus, Intlayer propose un compilateur / extracteur pour transformer vos composants et extraire le contenu.
Pour le configurer, vous pouvez ajouter une section
compilerdans votre fichierintlayer.config.ts:intlayer.config.tsCopier le codeCopier le code dans le presse-papiers
import { type IntlayerConfig } from "intlayer"; const config: IntlayerConfig = { // ... Reste de votre configuration compiler: { /** * Indique si le compilateur doit être activé. */ enabled: true, /** * Définit le chemin des fichiers de sortie */ output: ({ fileName, extension }) => `./${fileName}${extension}`, /** * Indique si les composants doivent être sauvegardés après avoir été transformés. De cette façon, le compilateur peut être exécuté une seule fois pour transformer l'application, puis il peut être supprimé. */ saveComponents: false, /** * Préfixe de clé de dictionnaire */ dictionaryKeyPrefix: "", }, }; export default config;Exécutez l'extracteur pour transformer vos composants et extraire le contenu
bashCopier le codeCopier le code dans le presse-papiers
Générer un Sitemap
Intlayer est livré avec un générateur de sitemap intégré pour vous aider à créer facilement un sitemap pour votre application. Il gère les routes localisées et ajoute les métadonnées nécessaires pour les moteurs de recherche.
Le sitemap généré par Intlayer prend en charge l'espace de noms
xhtml:link(Hreflang XML Extensions). Contrairement aux générateurs de sitemap par défaut qui ne répertorient que les URL brutes, Intlayer crée automatiquement les liens bidirectionnels requis entre toutes les versions linguistiques d'une page (par exemple,/about,/about?lang=fret/about?lang=es). Cela garantit que les moteurs de recherche indexent et servent correctement la bonne version linguistique au bon public.Pour l'utiliser, vous devez d'abord configurer votre fichier
vite.config.tspour activer le pré-rendu de vos routes localisées et désactiver la génération de sitemap par défaut de TanStack Start.vite.config.tsCopier le codeCopier le code dans le presse-papiers
Ensuite, créez une route
src/routes/sitemap[.]xml.tsqui utilise la fonctiongenerateSitemap:src/routes/sitemap[.]xml.tsCopier le codeCopier le code dans le presse-papiers
Configurer TypeScript
Intlayer utilise l'augmentation de module pour bénéficier des avantages de TypeScript et rendre votre codebase plus robuste.
Assurez-vous que votre configuration TypeScript inclut les types autogénérés :
tsconfig.jsonCopier le codeCopier le code dans le presse-papiers
Configuration Git
Il est recommandé d'ignorer les fichiers générés par Intlayer. Cela vous permet d'éviter de les committer dans votre dépôt Git.
Pour ce faire, vous pouvez ajouter les instructions suivantes à votre fichier .gitignore :
Copier le code dans le presse-papiers
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 VS Code Marketplace
Cette extension fournit :
- 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, reportez-vous à la documentation de l'extension Intlayer VS Code.
Aller plus loin
Pour aller plus loin, vous pouvez implémenter l'éditeur visuel ou externaliser votre contenu en utilisant le CMS.