Stellen Sie Ihre Frage und erhalten Sie einen Resümee des Dokuments, indem Sie diese Seite und den AI-Anbieter Ihrer Wahl referenzieren
Versionshistorie
- "Statische, dynamische und gecachte dynamische Auflösung von Metadaten-Dictionaries in head-Funktionen von Routen vergleichen"v9.4.025.8.2026
- "Aktualisieren der Solid useIntlayer API-Nutzung auf direkten Eigenschaftszugriff"v8.9.04.5.2026
- "Init-Befehl hinzufügen"v7.5.930.12.2025
- "Einführung von validatePrefix und Hinzufügen von Schritt 14: Behandlung von 404-Seiten mit lokalisierten Routen."v7.4.011.12.2025
- "Schritt 13 hinzugefügt: Abrufen der Locale in Ihren Serveraktionen (Optional)"v7.3.95.12.2025
- "Schritt 13 hinzugefügt: Nitro anpassen"v7.2.318.11.2025
- "Präfix-Standard durch Hinzufügen der getPrefix-Funktion, useLocalizedNavigate, LocaleSwitcher und LocalizedLink korrigiert."v7.1.017.11.2025
- "Dokumentation aktualisiert"v6.5.23.10.2025
- "Für Tanstack Start hinzugefügt"v5.8.19.9.2025
Der Inhalt dieser Seite wurde mit einer KI übersetzt.
Den englischen Originaltext ansehenWenn Sie eine Idee haben, um diese Dokumentation zu verbessern, zögern Sie bitte nicht, durch das Einreichen eines Pull-Requests auf GitHub beizutragen.
GitHub-Link zur DokumentationMarkdown des Dokuments in die Zwischenablage kopieren
Übersetzen Sie Ihre Tanstack Start-Website mit Intlayer | Internationalisierung (i18n)
Inhaltsverzeichnis
Diese Anleitung zeigt, wie Sie Intlayer für eine nahtlose Internationalisierung in Tanstack Start-Projekten mit lokalisierungsbewusstem Routing, TypeScript-Unterstützung und modernen Entwicklungspraktiken integrieren.
Warum Intlayer gegenüber Alternativen?
Im Vergleich zu Hauptlösungen wie „react-i18next“ oder „use-intl“ oder „paraglide“ ist Intlayer eine Lösung, die über integrierte Optimierungen verfügt wie:
Intlayer ist vollständig für TanStack Start optimiert und bietet mehrsprachiges Routing, Cookie-Verwaltung, Sitemap-Generierung, dynamisches Laden von Inhalten und alle Funktionen, die Sie zur Skalierung Ihrer Internationalisierungsbemühungen (i18n) benötigen.
Anstatt riesige JSON-Dateien in Ihre Seiten zu laden, laden Sie nur den erforderlichen Inhalt. Intlayer hilft Ihre Bundle- und Seitengröße um bis zu 50 % zu reduzieren.
Durch die Festlegung des Inhaltsbereichs Ihrer Anwendung wird die Wartung für umfangreiche Anwendungen erleichtert. Sie können einen einzelnen Feature-Ordner duplizieren oder löschen, ohne die mentale Belastung durch die Überprüfung Ihrer gesamten Inhaltscodebasis auf sich nehmen zu müssen. Darüber hinaus ist Intlayer vollständig typisiert (fully typed), um die Genauigkeit Ihrer Inhalte sicherzustellen.
Durch die gemeinsame Platzierung von Inhalten reduziert sich der von Large Language Models (LLMs) benötigte Kontext. Intlayer verfügt außerdem über eine Reihe von Tools, wie zum Beispiel eine CLI zum Testen auf fehlende Übersetzungen,LSP, MCP und agent skills, um die Entwicklererfahrung (DX) für KI-Agenten noch reibungsloser zu gestalten.
Nutzen Sie die Automatisierung, um Ihre CI/CD-Pipeline mit dem LLM Ihrer Wahl auf Kosten Ihres KI-Anbieters zu übersetzen. Intlayer bietet außerdem einen Compiler zur Automatisierung der Inhaltsextraktion sowie eine Webplattform zur Unterstützung der Übersetzung im Hintergrund.
Das Verbinden großer JSON-Dateien mit Komponenten kann zu Leistungs- und Reaktivitätsproblemen führen. Intlayer optimiert das Laden Ihrer Inhalte zur Erstellungszeit.
Intlayer ist mehr als nur eine i18n-Lösung. Es bietet einen selbstgehosteten visuellen Editor und ein vollständiges CMS, um Ihnen zu helfen Verwalten Sie Ihre mehrsprachigen Inhalte in Echtzeit und gestalten Sie die Zusammenarbeit mit Übersetzern, Textern und anderen Teammitgliedern reibungslos. Inhalte können lokal und/oder remote gespeichert werden.
Schritt-für-Schritt-Anleitung zur Einrichtung von Intlayer in einer Tanstack Start-Anwendung
Siehe Anwendungsvorlage auf GitHub.
Projekt erstellen
Beginnen Sie mit der Erstellung eines neuen TanStack Start-Projekts, indem Sie der Anleitung Neues Projekt starten auf der TanStack Start-Website folgen.
Intlayer-Pakete installieren
Installieren Sie die erforderlichen Pakete mit Ihrem bevorzugten Paketmanager:
Kopieren Sie den Code in die Zwischenablage
Das Flag--interactiveist optional. Verwenden Sieintlayer-cli init, wenn Sie ein KI-Agent sind.
Dieser Befehl erkennt Ihre Umgebung und installiert die erforderlichen Pakete. Zum Beispiel:
Kopieren Sie den Code in die Zwischenablage
intlayer
Das Kernpaket, das Internationalisierungswerkzeuge für Konfigurationsmanagement, Übersetzung, Inhaltsdeklaration, Transpilation und CLI-Befehle bereitstellt.
react-intlayer Das Paket, das Intlayer in die React-Anwendung integriert. Es bietet Kontextanbieter und Hooks für die Internationalisierung in React.
vite-intlayer Enthält das Vite-Plugin zur Integration von Intlayer mit dem Vite-Bundler sowie Middleware zur Erkennung der bevorzugten Sprache des Benutzers, zur Verwaltung von Cookies und zur Handhabung von URL-Weiterleitungen.
Konfiguration Ihres Projekts
Erstellen Sie eine Konfigurationsdatei, um die Sprachen Ihrer Anwendung zu konfigurieren:
Kopieren Sie den Code in die Zwischenablage
Über diese Konfigurationsdatei können Sie lokalisierte URLs, Middleware-Weiterleitungen, Cookie-Namen, den Speicherort und die Erweiterung Ihrer Inhaltsdeklarationen festlegen, Intlayer-Protokolle in der Konsole deaktivieren und vieles mehr. Eine vollständige Liste der verfügbaren Parameter finden Sie in der Konfigurationsdokumentation.
Intlayer in Ihre Vite-Konfiguration integrieren
Fügen Sie das Intlayer-Plugin zu Ihrer Konfiguration hinzu:
Kopieren Sie den Code in die Zwischenablage
Das intlayer() Vite-Plugin wird verwendet, um Intlayer mit Vite zu integrieren. Es stellt die Erstellung von Inhaltsdeklarationsdateien sicher und überwacht diese im Entwicklungsmodus. Es definiert Intlayer-Umgebungsvariablen innerhalb der Vite-Anwendung. Darüber hinaus bietet es Aliase zur Leistungsoptimierung.
Root-Layout erstellen
Konfigurieren Sie Ihr Root-Layout zur Unterstützung der Internationalisierung, indem Sie useParams verwenden, um die aktuelle Locale zu erkennen und die Attribute lang und dir für das html-Tag festzulegen.
Kopieren Sie den Code in die Zwischenablage
Locale-Layout erstellen
Erstellen Sie ein Layout, das das Locale-Präfix verarbeitet und eine Validierung durchführt.
Kopieren Sie den Code in die Zwischenablage
Hier ist{-$locale}ein dynamischer Routenparameter, der durch die aktuelle Locale ersetzt wird. Diese Notation macht den Platzhalter optional, sodass er mit Routing-Modi wie'prefix-no-default'usw. funktioniert.
Beachten Sie, dass dieser Platzhalter Probleme verursachen kann, wenn Sie mehrere dynamische Segmente in derselben Route verwenden (z. B.
/{-$locale}/anderer-pfad/$einWeitererDynamischerPfad/...). Für den Modus'prefix-all'sollten Sie stattdessen den Platzhalter$localeverwenden. Für den Modus'no-prefix'oder'search-params'können Sie den Platzhalter ganz entfernen.
Inhalte deklarieren
Erstellen und verwalten Sie Ihre Inhaltsdeklarationen, um Übersetzungen zu speichern:
Kopieren Sie den Code in die Zwischenablage
Ihre Inhaltsdeklarationen können überall in Ihrer Anwendung definiert werden, solange sie im VerzeichniscontentDir(standardmäßig./app) enthalten sind. Und sie müssen der Dateierweiterung für Inhaltsdeklarationen entsprechen (standardmäßig.content.{json,ts,tsx,js,jsx,mjs,cjs,md,mdx,yaml,yml}).
Weitere Einzelheiten finden Sie in der Dokumentation zur Inhaltsdeklaration.
Lokalisierungsbewusste Komponenten und Hooks erstellen
Erstellen Sie eine LocalizedLink-Komponente für lokalisierungsbewusste Navigation:
Kopieren Sie den Code in die Zwischenablage
Diese Komponente verfolgt zwei Ziele:
- Entfernen des unnötigen
{-$locale}-Präfixes aus der URL. - Einfügen des Locale-Parameters in die URL, um sicherzustellen, dass der Benutzer direkt auf die lokalisierte Route weitergeleitet wird.
Dann können wir einen useLocalizedNavigate-Hook für die programmatische Navigation erstellen:
Kopieren Sie den Code in die Zwischenablage
Intlayer in Ihren Seiten nutzen
Verwenden Sie standardmäßiguseIntlayer: Es ist der empfohlene Weg, Inhalte innerhalb von Komponenten zu lesen, und der Compiler löst den Aufruf auf die gerenderte Locale auf. Greifen Sie nur außerhalb des React-Baums zugetIntlayer/getIntlayerAsync: imheadvon Routen, in Loadern und Server Functions.
Greifen Sie in Ihrer gesamten Anwendung auf Ihre Inhaltswörterbücher zu:
Lokalisierte Homepage
Kopieren Sie den Code in die Zwischenablage
Wenn Sie Ihren Inhalt in einem
string-Attribut verwenden möchten, wie z. B.alt,title,href,aria-label, usw., können Sie den Wert der Funktion verwenden, wie:htmlCode kopierenKopieren Sie den Code in die Zwischenablage
Weitere Informationen zum Hook useIntlayer finden Sie in der Dokumentation.
Locale Switcher Component erstellen
Erstellen Sie eine Komponente, die es Benutzern ermöglicht, Sprachen zu wechseln:
Kopieren Sie den Code in die Zwischenablage
Weitere Informationen zum Hook useLocale finden Sie in der Dokumentation.
HTML-Attribute verwalten
Wie in Schritt 5 beschrieben, können Sie die Attribute lang und dir des html-Tags mit useParams in Ihrer Root-Komponente verwalten. Dies stellt sicher, dass die korrekten Attribute auf dem Server und dem Client gesetzt werden.
Kopieren Sie den Code in die Zwischenablage
Middleware hinzufügen
Sie können auch intlayerProxy verwenden, um serverseitiges Routing zu Ihrer Anwendung hinzuzufügen. Dieses Plugin erkennt automatisch die aktuelle Locale basierend auf der URL und setzt das entsprechende Locale-Cookie. Wenn keine Locale angegeben ist, bestimmt das Plugin die am besten geeignete Locale basierend auf den Spracheinstellungen des Browsers des Benutzers. Wenn keine Locale erkannt wird, wird es zur Standard-Locale weitergeleitet.
Beachten Sie, dass Sie zum Verwenden vonintlayerProxyin der Produktion das Packagevite-intlayervondevDependencieszudependenciesverschieben müssen.
Seit Intlayer v9 istintlayerProxy()direkt imintlayer()-Plugin gebündelt und standardmäßig über die Optionrouting.enableProxyaktiviert (standardmäßigtrue). Die separate Registrierung wie unten gezeigt ist jetzt optional: Sie wird aus Gründen der Rückwärtskompatibilität und für Setups beibehalten, die die Plugin-Reihenfolge steuern müssen. Setzen Sierouting.enableProxy: false, um sich abzumelden. Siehe v9 Release Notes.
Kopieren Sie den Code in die Zwischenablage
Metadaten internationalisieren
getIntlayer wird synchron gegen das zusammengeführte Wörterbuch aufgelöst, das jede deklarierte Locale enthält. head bleibt synchron und nichts wird abgewartet, aber das gesamte mehrsprachige Wörterbuch wird in den an den Browser gesendeten Route-Chunk gezogen.
Kopieren Sie den Code in die Zwischenablage
Am besten für kleine Metadaten-Wörterbücher, eine Handvoll Locales oder während des Prototyping.
getIntlayerAsync (verfügbar ab v9.4) verhält sich wie getIntlayer, aber das Build-Plugin verweist auf den Locale-spezifischen Chunk in .intlayer/dynamic_dictionaries/ statt auf das zusammengeführte Wörterbuch. Eine Seite wird daher nur mit der Locale versendet, die sie rendert. Da dieser Chunk bei Bedarf geladen wird, wird head zu async:
Kopieren Sie den Code in die Zwischenablage
Wenn einheadmehrere Wörterbücher liest, lösen Sie diese mitPromise.allauf: Das Abwarten jedesgetIntlayerAsyncauf seiner eigenen Zeile verkettet die Anforderungen, anstatt sie parallel zu verarbeiten.
Der Kompromiss: Der dynamische Import wird aufgelöst, während head auf dem kritischen Pfad des Document-Rendering läuft. Auf einer kalten Route verzögert dies den head um einige Millisekunden und kann LCP leicht verschlechtern.
Lösen Sie das Wörterbuch im Route-loader auf und lesen Sie es in head aus loaderData zurück. Loader der übereinstimmenden Routes werden parallel ausgeführt, und staleTime: Infinity teilt TanStack Router mit, dass das Ergebnis nie veraltet, daher wird der Locale-spezifische Chunk einmal aufgelöst und anschließend aus dem Router-Cache bereitgestellt, wobei head synchron bleibt.
Kopieren Sie den Code in die Zwischenablage
headkann aufgerufen werden, bevor sich der loader abgewickelt hat, sodassloaderDatamöglicherweise alsundefinedeingegeben wird. Behalten Sie das optionale Chaining bei oder geben Sie einen Fallback-Titel zurück.
Sie behalten den Locale-spezifischen Chunk, ohne seine Kosten auf dem head-kritischen Pfad zu zahlen. Der Preis ist die Entwickler-Experience: Der Inhalt muss explizit vom loader zum head durch loaderData geleitet werden.
Welche Auflösung sollte ich wählen?
Tabelle in einem Modal öffnen, um alle Daten übersichtlich anzuzeigen
| Statische Auflösung | Dynamische Auflösung | Zwischengespeicherte dynamische Auflösung | |
|---|---|---|---|
| API | getIntlayer | getIntlayerAsync (v9.4+) | getIntlayerAsync in loader (v9.4+) |
head Signatur | synchron | async | synchron, liest loaderData |
| Locales versendet | jedes deklarierte Locale | angeforderte Locale nur | angeforderte Locale nur |
| Client-Navigationen | nichts zu lösen | bei jedem Match erneut eingegeben | aus dem Router-Cache bereitgestellt |
| Entwicklererlebnis | am einfachsten | ein await | Inhalte über loaderData verkettet |
Rufen Sie das Locale in Ihren Server-Aktionen ab
Möglicherweise möchten Sie auf das aktuelle Locale von Ihren Server-Aktionen oder API-Endpunkten aus zugreifen.
Sie können dies mit dem getLocale-Helfer von intlayer tun.
Hier ist ein Beispiel mit den Server-Funktionen von TanStack Start:
Kopieren Sie den Code in die Zwischenablage
Verwalten Sie Seiten, die nicht gefunden wurden
Wenn ein Benutzer eine nicht vorhandene Seite besucht, können Sie eine benutzerdefinierte Seite anzeigen, die nicht gefunden wurde, und das Locale-Präfix kann beeinflussen, wie die Seite ausgelöst wird, die nicht gefunden wurde.
Lokalisierte Startseite
Wenn Sie Ihren Inhalt in einem
string-Attribut verwenden möchten, wie z. B.alt,title,href,aria-label, usw., können Sie den Wert der Funktion wie folgt verwenden:htmlCode kopierenKopieren Sie den Code in die Zwischenablage
Um mehr über den useIntlayer-Hook zu erfahren, lesen Sie die Dokumentation.
Kopieren Sie den Code in die Zwischenablage
Um mehr über den useLocale-Hook zu erfahren, lesen Sie die Dokumentation.
</Step>
HTML-Attribute-Verwaltung
return ( {/* ... _/} ); } {/_ ... */} </html> ); }
export const Route = createFileRoute("/{-$locale}/")({ component: RouteComponent, head: async ({ params }) => { const { locale = defaultLocale } = params; const path = "/"; // The path for this route
Kopieren Sie den Code in die Zwischenablage
Kopieren Sie den Code in die Zwischenablage
Nicht gefundene Seiten verwalten
Wenn ein Benutzer eine nicht existierende Seite besucht, können Sie eine benutzerdefinierte 404-Seite anzeigen. Das Locale-Präfix kann beeinflussen, wie die 404-Seite ausgelöst wird.
Verständnis der 404-Behandlung von TanStack Router mit Locale-Präfixen
In TanStack Router erfordert die Behandlung von 404-Seiten mit lokalisierten Routen einen mehrschichtigen Ansatz:
- Dedizierte 404-Route: Eine spezifische Route zur Anzeige der 404-UI
- Validierung auf Routenebene: Validiert Locale-Präfixe und leitet ungültige auf 404 weiter
- Catch-all-Route: Erfasst alle nicht übereinstimmenden Pfade innerhalb des Locale-Segments
Kopieren Sie den Code in die Zwischenablage
Kopieren Sie den Code in die Zwischenablage
Kopieren Sie den Code in die Zwischenablage
Inhalt Ihrer Komponenten extrahieren
OptionalWenn Sie eine bestehende Codebasis haben, kann die Transformation von Tausenden von Dateien zeitaufwendig sein.
Um diesen Prozess zu erleichtern, bietet Intlayer einen Compiler / Extractor an, um Ihre Komponenten zu transformieren und den Inhalt zu extrahieren.
Um es einzurichten, können Sie einen compiler-Abschnitt in Ihrer intlayer.config.ts-Datei hinzufügen:
Kopieren Sie den Code in die Zwischenablage
import { type IntlayerConfig } from "intlayer";
/**
* Definiert den Pfad der Ausgabedateien
*/
output: ({ fileName, extension }) => `./${fileName}${extension}`,
/**
* Präfix für Wörterbuchschlüssel
*/
dictionaryKeyPrefix: "",
},
};
export default config;
Führen Sie den Extractor aus, um Ihre Komponenten zu transformieren und den Inhalt zu extrahieren
Kopieren Sie den Code in die Zwischenablage
bun x intlayer extract import { defineConfig } from "vite"; import { intlayer, intlayerCompiler } from "vite-intlayer";
export default defineConfig({ plugins: [
Kopieren Sie den Code in die Zwischenablage
], });
Kopieren Sie den Code in die Zwischenablage
bash packageManager="npm" npm run build # Oder npm run dev
Kopieren Sie den Code in die Zwischenablage
bash packageManager="pnpm" pnpm run build # Oder pnpm run dev
Kopieren Sie den Code in die Zwischenablage
bash packageManager="yarn" yarn build # Oder yarn dev
Kopieren Sie den Code in die Zwischenablage
bash packageManager="bun"
bun run build # Or bun run dev import { localeFlatMap } from "intlayer"; // ... andere Imports
export const pathList = ["", "/about", "/404"];
const localizedPages = localeFlatMap(({ urlPrefix }) => pathList.map((path) => ({
Kopieren Sie den Code in die Zwischenablage
})) );
export default defineConfig({ plugins: [
Kopieren Sie den Code in die Zwischenablage
], });
Kopieren Sie den Code in die Zwischenablage
`typescript fileName="src/routes/sitemap[.]xml.ts"
export const Route = createFileRoute("/sitemap.xml")({ server: {
Kopieren Sie den Code in die Zwischenablage
}, }); { // ... Ihre bestehenden Konfigurationen include: [
Kopieren Sie den Code in die Zwischenablage
], }
Git-Konfiguration
Es wird empfohlen, die von Intlayer generierten Dateien zu ignorieren. Dies ermöglicht es dir, sie nicht in dein Git-Repository zu committen.
Um dies zu tun, kannst du die folgenden Anweisungen zu deiner .gitignore-Datei hinzufügen:
Kopieren Sie den Code in die Zwischenablage
`
VS Code Extension
Um dein Entwicklungserlebnis mit Intlayer zu verbessern, kannst du die offizielle Intlayer VS Code Extension installieren.
Installieren vom VS Code Marketplace
Diese Extension bietet:
- Autocompletion für Übersetzungsschlüssel.
- Echtzeit-Fehlererkennung für fehlende Übersetzungen.
- Inline-Vorschau von übersetztem Inhalt.
- Schnellaktionen zum einfachen Erstellen und Aktualisieren von Übersetzungen.
Für weitere Details zur Verwendung der Extension, siehe die Intlayer VS Code Extension Dokumentation.
Weiter geht's
Um weiter zu gehen, können Sie den visuellen Editor implementieren oder Ihren Inhalt mit dem CMS externalisieren.
