Inline Translations

tx

API-Referenz zur String-Übersetzungsfunktion tx

Übersicht

Die Funktion tx ist eine serverseitige Funktion zum Übersetzen von Strings.

await tx('Hello, world!'); // gibt 'Hallo, Welt!' zurück

Übersetzung zur Laufzeit: tx-Übersetzungen erfolgen zur Laufzeit. Das bedeutet, die Übersetzung wird in Echtzeit durchgeführt, sodass Sie Inhalte übersetzen können, die erst zur Laufzeit vorliegen.

Referenz

Parameter

Prop

Type

NameBeschreibung
contentDie zu übersetzende Zeichenfolge.
optionsÜbersetzungsoptionen zur Anpassung des Verhaltens von tx. Siehe RuntimeTranslationOptions.

Rückgabewert

Ein Promise, das sich zu einer Zeichenkette mit dem übersetzten Inhalt auflöst – oder zum Originalinhalt, wenn keine Übersetzung erforderlich ist.


Verhalten

Die Funktion tx übersetzt Strings zur Laufzeit. Das bedeutet, Übersetzungen erfolgen live, sodass Sie Inhalte übersetzen können, die erst zur Laufzeit vorliegen. Der Nachteil: Es kommt zu einer Verzögerung, weil das Laden einer On-Demand-Übersetzung spürbar länger dauert.

Unsere Empfehlung: Übersetzen Sie so viel wie möglich zur Build-Zeit mit getGT, useGT oder <T> und verwenden Sie On-Demand-Übersetzungen wie tx und <Tx> nur bei Bedarf.

Stellen Sie sicher, dass Sie der Bereitstellungsanleitung folgen.


Beispiel

Grundlegende Verwendung

Sie können tx verwenden, um Strings zu übersetzen.

src/components/translateGreeting.jsx
import { tx } from 'gt-next/server';

export default async function translateGreeting() {
    return await tx("Hallo, Welt!"); 
}

Kontext hinzufügen

Sie können die Übersetzung anpassen, indem Sie einen Kontext angeben, der beim Übersetzen berücksichtigt wird.

TranslateWithOptions.jsx
import { tx } from 'gt-next/server';

export default async function TranslateWithOptions() {
    return await tx("Hallo, Welt!", {
      $context: 'Informell übersetzen'
    });
}

Verwendung von Variablen

Um Werte an Ihre Zeichenfolge zu übergeben, müssen Sie (1) eine Kennung vergeben und (2) diese Kennung im übergebenen Objekt referenzieren.

translateWithVariables.js
import { tx } from 'gt-next/server';

export default async function translateWithVariables() {
  return await tx("Der Preis beträgt {price, number, ::currency/USD}", {
    price: 29.99,
  });
}

Festlegen einer Locale

Sie können eine Locale angeben, die für die Übersetzung verwendet wird. Standardmäßig ist die Locale auf die bevorzugte Sprache des Nutzers festgelegt.

translateWithLocale.js
import { tx } from 'gt-next/server';

export default async function translateWithLocale() {
    return await tx("Hello, world!", { $locale: 'fr' }); 
}

Hinweise

  • tx ist ausschließlich für die serverseitige Verwendung und kann nicht in clientseitigen Komponenten eingesetzt werden.
  • Übersetzungen mit tx erfolgen zur Laufzeit, d. h. sie werden live übersetzt. Das ist deutlich langsamer als Übersetzungen zur Build‑Zeit.

Nächste Schritte

  • Siehe useGT und getGT, um Strings vor dem Deployment zu übersetzen.
  • Für die Übersetzung von JSX siehe <T> und <Tx>.
  • Weitere Informationen zur Anpassung von Übersetzungen finden Sie unter RuntimeTranslationOptions.

Wie ist dieser Leitfaden?

tx