React Schnellstart

Internationalisieren Sie Ihre React-App in 5 Minuten mit gt-react

Überblick

Dieser Leitfaden beschreibt, wie ein bestehendes React Projekt internationalisiert wird.

Wir werden 4 einfache Schritte behandeln:

Installation der erforderlichen Bibliotheken

Sprachen auswählen

Hinzufügen der <T> Komponente

Hinzufügen Ihrer Umgebungsvariablen

Dieser gesamte Prozess sollte weniger als 5 Minuten dauern.


Einrichtung

1. Bibliotheken installieren

Installieren Sie die Bibliotheken gt-react und gtx-cli.

npm i gt-react
npm i gtx-cli --save-dev

2. Sprachen auswählen

<GTProvider> wird verwendet, um das Verhalten von gt-react zu konfigurieren. Es sollte so weit oben wie möglich in Ihrer App platziert werden, idealerweise an der Wurzel.

Übergeben Sie einfach eine Liste von Sprachcodes, um sie zu Ihrer App hinzuzufügen.

App.js
import { GTProvider } from "gt-react";
import MyApp from "./MyApp";
 
export default function App() {
  return (
    // Unterstützung für Französisch und Chinesisch 
    <GTProvider locales={['fr', 'zh']}> 
      <MyApp />
    </GTProvider> 
  );
}

Für eine vollständige Liste der <GTProvider>-Props und erweiterte Dokumentation siehe die API-Referenz.

3. Fügen Sie die <T>-Komponente hinzu

Umwickeln Sie jeden verschachtelten JSX-Inhalt in der <T>-Komponente, um ihn übersetzbar zu machen. Für weitere Informationen lesen Sie den Leitfaden zur Verwendung von <T>-Komponenten.

Example.js
import { T } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Dies wird übersetzt.
      </p>
    </T>  
  );
}

Verwenden Sie die <Var>-Komponente, um JSX-Inhalte zu kennzeichnen, die nicht übersetzt werden sollen.

Example.js
import { T, Var } from "gt-react";
 
export default function Example() {
  return (
    <T>
      <p>
        Dies wird übersetzt. <Var>Dies nicht.</Var>
      </p>
    </T>  
  );
}

Tipp: Um Zeit zu sparen, führen Sie den Setup-Befehl aus. Dieser scannt Ihren Code für übersetzbare JSX und fügt die <T>-Tags für Sie ein.

shell
npx gtx-cli setup

Für Zeichenfolgen können Sie useGT() zur Übersetzung verwenden. Für weitere Informationen lesen Sie diesen Leitfaden.

Example.js
import { useGT } from "gt-react";
 
export default function Example() {
  const t = useGT(); 
  return (
    <p>
      {t("Dies wird übersetzt.")}
    </p>
  );
}

4. Fügen Sie Ihre Umgebungsvariablen hinzu

Fügen Sie Ihren API-Schlüssel und Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu.

Navigieren Sie zum Dashboard.

  • Navigieren Sie zur Seite Developer Keys in der Seitenleiste.

Klicken Sie auf Create Dev API Key und kopieren Sie dann den API-Schlüssel und die Projekt-ID in Ihre Zwischenablage.

Fügen Sie die Projekt-ID und den API-Schlüssel zu Ihren Umgebungsvariablen hinzu. Abhängig von Ihrem React-Framework können die Umgebungsvariablen leicht unterschiedlich aussehen. Diese Anweisungen sind NUR FÜR ENTWICKLUNGSUMGEBUNGEN.

VITE_GT_API_KEY="YOUR_GT_DEV_API_KEY"
VITE_GT_PROJECT_ID="YOUR_GT_PROJECT_ID"

Schützen Sie Ihre API-Schlüssel!

React-Umgebungsvariablen werden oft zur Build-Zeit in Ihre Anwendung gebündelt und sind im clientseitigen Code öffentlich sichtbar. Aus Sicherheitsgründen sollten Sie:

  • Nur Entwicklungs-API-Schlüssel während der lokalen Entwicklung verwenden
  • Nur Produktions-API-Schlüssel mit dem CLI-Tool für die Bereitstellung verwenden
  • Niemals API-Schlüssel als Umgebungsvariablen in der Produktion einfügen

Lass es uns ausprobieren!

Herzlichen Glückwunsch! 🥳 Deine App ist jetzt mehrsprachig! Lass uns sehen, wie es funktioniert.

Sieh dir deine App in einer anderen Sprache an

Füge die Komponente <LocaleSelector> zu deiner App hinzu. Dies ermöglicht es dir, eine andere Sprache für deine App auszuwählen.

Tipp: Du kannst auch die Sprache in deinen Browsereinstellungen ändern.

Starte deine React-App im Entwicklungsmodus.

npm run dev 

Öffne deine App in deinem bevorzugten Browser (normalerweise unter http://localhost:3000).

Fehlerbehebung


Versand in die Produktion

Folgen Sie unserem Leitfaden zum Versand in die Produktion.


Nächste Schritte

  • Siehe unsere React API-Referenz für detaillierte Informationen über die <T> Komponente und andere verfügbare Komponenten.
  • Erstellen Sie eine Liste genehmigter Sprachen für Ihre App mit dem React-Plugin.

Auf dieser Seite