withGTConfig()

Überblick

withGTConfig() ist die primäre Methode, um die gt-next Bibliothek zu konfigurieren. Es umschließt direkt ein NextConfig Objekt.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
    // Ihre bestehende next.config.js
}
 
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr'],
});

Es ist nicht erforderlich, withGTConfig() zu verwenden, um die Übersetzungsfunktionalität zu aktivieren, aber es wird empfohlen, die Bibliothek an Ihre Bedürfnisse anzupassen.

Verwenden Sie withGTConfig(), um:

• Unterstützte Sprachen und Standardsprache (auch als Fallback-Sprache bekannt) zu konfigurieren.
• API-Schlüssel und Projekt-IDs für den Zugriff auf GT-Dienste festzulegen.
• Ladeverhalten einzustellen.
• Timeout-Einstellungen zu konfigurieren.
• Benutzerdefinierte Endpunkte einzurichten.
• Übersetzungsverhalten, Caching und Anforderungsbündelung anzupassen.

Referenz

Erforderliche Props

Empfohlene Props

Erweiterte Props

Rückgaben

Eine Funktion (NextConfig) => NextConfig, die das Next.js-Konfigurationsobjekt mit den angegebenen GT-Einstellungen erweitert.

Ausnahmen

Wirft einen Error, wenn die projectId fehlt und Standard-URLs verwendet werden, oder wenn der API-Schlüssel erforderlich und fehlt.

Rendereinstellungen

Rendereinstellungen steuern das Verhalten von Übersetzungen, während sie geladen werden. Dies gilt nur für Übersetzungen, die zur Laufzeit stattfinden. Wenn die Übersetzung zwischengespeichert ist, ist die Antwortzeit zu gering, um das Ladeverhalten zu rechtfertigen.

Render-Methoden

• skeleton: Rendert ein Fragment.
• replace: Rendert Inhalte in der Standardsprache, während gewartet wird.
• default: Für Gebiete mit derselben Sprache (z.B. en-US und en-GB) verhält sich wie replace. Für Gebiete mit unterschiedlichen Sprachen (z.B. en-US und fr) verhält sich wie skeleton.

Timeout

Timeouts gelten nur für Übersetzungen zur Laufzeit oder Übersetzungen, die bei Bedarf durchgeführt werden müssen, da sie nicht zwischengespeichert wurden.

Timeouts sind standardmäßig auf 8 Sekunden eingestellt. Diese Designentscheidung soll Vercel-Nutzern helfen, die einen Standard-Timeout von 10 Sekunden für serverlose Funktionen im kostenlosen Plan haben.

Beispiele

Unterstützte Sprachen

Dieses Beispiel konfiguriert gt-next mit Englisch (en-US) als Standardsprache. Es unterstützt ausschließlich Übersetzungen in Spanisch (es) und Französisch (fr) und bietet eine Beschreibung für kontextbezogene Übersetzungen.

Die Seite wird auf die am besten geeignete Sprache zurückgreifen, wenn keine der Sprachen übereinstimmt. Es wird nach passenden Sprachen suchen (d.h. en-US und en-GB) sowie nach den anderen bevorzugten Sprachen, die der Benutzer in seinem Browser eingestellt hat. Wenn alles andere fehlschlägt, wird auf die Standardsprache zurückgegriffen.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
  // Ihre anderen next.js Konfigurationen
}
 
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  locales: ['en-US', 'es', 'fr'],
  description: 'Ein persönlicher Blog über Technologie und Reisen',
});

Render-Einstellungen

Dieses Beispiel konfiguriert gt-next, um ein Skelett zu rendern, während auf das Laden der Übersetzungen gewartet wird. Wenn die Übersetzung länger als 8 Sekunden dauert, wird die Methode abgebrochen und der Inhalt der Standardsprache gerendert.

import { withGTConfig } from 'gt-next/config';
 
const nextConfig = {
  // Ihre anderen next.js Konfigurationen
};
 
// locales-Feld bleibt leer, sodass diese Konfiguration alle 100+ Sprachen unterstützt
export default withGTConfig(nextConfig, {
  defaultLocale: 'en-US',
  renderSettings: {
    method: 'skeleton',
    timeout: 10000,
  },
});

Notizen

• withGTConfig() integriert die GT-Übersetzungsfunktionalität in Ihre Next.js-App und muss in der Hauptkonfigurationsdatei verwendet werden.
• Parameter wie apiKey und projectId können direkt in der Konfiguration oder als Umgebungsvariablen festgelegt werden.
• Erweiterte Parameter wie renderSettings und _batchInterval ermöglichen eine feinkörnige Kontrolle über das Übersetzungsverhalten und die Leistung.

Nächste Schritte

• Fügen Sie Übersetzung zu Ihrem CD-Prozess hinzu.
• Lesen Sie mehr über i18n-Konfiguration in unserem Referenzhandbuch.