Übersicht

withGTConfig ist der wichtigste Weg, die Bibliothek gt-next zu konfigurieren. Es umschließt direkt ein NextConfig-Objekt.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
    // Ihre vorhandene next.config.js
}

export default withGTConfig(nextConfig, {
  // Weitere Konfigurationsoptionen
});

Verwenden Sie withGTConfig, um:

• Unterstützte Sprachen und die Standard-locale zu konfigurieren (Fallback-Sprache).
• API-Schlüssel und Projekt-IDs für den Zugriff auf GT-Dienste festzulegen.
• Das Ladeverhalten festzulegen.
• Zeitüberschreitungen zu konfigurieren.
• Benutzerdefinierte Endpunkte einzurichten.
• Übersetzungsverhalten, Caching und Request-Batching anzupassen.
• Build-Time-Validierung über das SWC-Plugin zu konfigurieren.

Referenz

Standardmäßig sucht withGTConfig nach einer gt.config.json-Datei im selben Verzeichnis wie Ihre next.config.js.

Diese JSON-Datei wird geladen und mit der an withGTConfig übergebenen Konfiguration zusammengeführt.

Weitere Informationen zur Konfigurationsdatei finden Sie in der Referenz zu gt.config.json.

Erforderliche Props

Empfohlene Props

Erweiterte Props

Rückgabe

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

Ausnahmen

Löst eine Error aus, wenn die projectId fehlt und Standard-URLs verwendet werden, oder wenn ein API-Schlüssel erforderlich ist und fehlt.

Render-Einstellungen

Die Render-Einstellungen steuern das Verhalten von Übersetzungen während des Ladens. Dies gilt nur für Übersetzungen, die zur Laufzeit erfolgen. Wenn die Übersetzung aus dem Cache kommt, ist die Reaktionszeit so kurz, dass ein spezielles Ladeverhalten nicht erforderlich ist.

Render-Methoden

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

Zeitüberschreitung

Zeitüberschreitungen gelten nur für Übersetzungen zur Laufzeit, also für Übersetzungen, die bei Bedarf ausgeführt werden müssen, weil sie nicht im Cache liegen.

Standardmäßig beträgt die Zeitüberschreitung 8 Sekunden. Diese Designentscheidung kommt Vercel-Nutzerinnen und -Nutzern entgegen, die im kostenlosen Tarif eine Standard-Zeitüberschreitung von 10 Sekunden für serverlose Funktionen haben.

Beispiele

Rendereinstellungen

Dieses Beispiel konfiguriert gt-next, sodass während des Ladens der Übersetzungen ein Skeleton angezeigt wird. Wenn das Laden der Übersetzungen länger als 8 Sekunden dauert, läuft die Methode in ein Timeout und rendert den Inhalt in der Standardsprache.

{
  "defaultLocale": "en-US",
  "locales": ["en-US", "es", "fr"],
}

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Ihre anderen Next.js-Konfigurationen
};

export default withGTConfig(nextConfig, {
  renderSettings: {
    method: 'skeleton',
    timeout: 10000,
  },
});

Validierung zur Build-Zeit

Dieses Beispiel konfiguriert das SWC-Plugin so, dass Verstöße gegen dynamische Inhalte als Build-Fehler statt als Warnungen behandelt werden.

import { withGTConfig } from 'gt-next/config';

const nextConfig = {
  // Ihre anderen Next.js-Konfigurationen
};

export default withGTConfig(nextConfig, {
  // Builds bei dynamischen JSX-Verstößen fehlschlagen lassen
  dynamicJsxCheckLogLevel: 'error',
  // Bei dynamischen String-Verstößen warnen  
  dynamicStringCheckLogLevel: 'warn',
});

Hinweise

• withGTConfig integriert die GT-Übersetzungsfunktionen in deine Next.js-App und muss in der Root-Konfigurationsdatei 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 fein granulare Steuerung des Übersetzungsverhaltens und der Performance.

Nächste Schritte

• Fügen Sie Übersetzungen in Ihren CD-Prozess ein.