tx
API Reference für die tx-Stringübersetzungsfunktion
Übersicht
Die Funktion tx ist eine serverseitige Funktion zum Übersetzen von Strings.
await tx('Hallo, Welt!'); // gibt 'Hola, mundo!' zurückLaufzeitübersetzung:
tx-Übersetzungen erfolgen zur Laufzeit.
Das bedeutet, die Übersetzung findet live statt, sodass Sie Inhalte übersetzen können, die erst zur Laufzeit vorliegen.
Referenzen
Parameter
Prop
Type
| Name | Beschreibung |
|---|---|
content | Die zu übersetzende Zeichenfolge. |
options | Übersetzungsoptionen zur Anpassung des Verhaltens von tx. Siehe RuntimeTranslationOptions. |
Rückgabewert
Ein Promise, das zu einer Zeichenfolge mit dem übersetzten Inhalt aufgelöst wird – oder zum ursprünglichen Inhalt, wenn keine Übersetzung erforderlich ist.
Verhalten
Die Funktion tx übersetzt Zeichenketten zur Laufzeit.
Das bedeutet, dass Übersetzungen live erfolgen und Sie Inhalte übersetzen können, die erst zur Laufzeit vorliegen.
Der Nachteil: Es kommt zu einer Verzögerung, da eine On-Demand-Übersetzung zunächst geladen werden muss, was deutlich langsamer ist.
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.
Befolgen Sie unbedingt die Deployment-Anleitung.
Beispiel
Grundlegende Verwendung
Sie können tx verwenden, um Zeichenfolgen zu übersetzen.
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.
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.
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,
});
}Eine Locale festlegen
Sie können eine Locale angeben, die für die Übersetzung verwendet wird. Standardmäßig ist die Locale auf die bevorzugte Sprache des Nutzers eingestellt.
import { tx } from 'gt-next/server';
export default async function translateWithLocale() {
return await tx("Hallo, Welt!", { $locale: 'fr' });
}Hinweise
txist ausschließlich für die serverseitige Nutzung vorgesehen und kann nicht in clientseitigen Komponenten verwendet werden.- Übersetzungen mit
txerfolgen zur Laufzeit, das heißt, sie werden live übersetzt. Das ist deutlich langsamer als Übersetzungen zur Build‑Zeit.
Nächste Schritte
- Siehe
useGTundgetGTzum Übersetzen von Strings vor der Bereitstellung. - Zum Übersetzen von JSX siehe
<T>und<Tx>. - Weitere Informationen zur Anpassung von Übersetzungen findest du unter
RuntimeTranslationOptions.
Wie ist diese Anleitung?