tx()

Aperçu

La fonction tx() est une fonction côté serveur pour traduire des chaînes de caractères.

await tx('Hello, world!'); // returns 'Hola, mundo!'

Référence

Paramètres

Retour

Une promesse qui se résout en une chaîne de caractères contenant le contenu traduit, ou le contenu original si aucune traduction n'est nécessaire.

Comportement

La fonction tx() traduit les chaînes de caractères à l'exécution. Cela signifie que les traductions sont effectuées en temps réel, vous pouvez donc traduire du contenu qui n'est connu qu'à l'exécution. Le compromis est qu'il y a un délai d'attente pendant le chargement d'une traduction à la demande qui est considérablement plus lent.

Notre conseil est de traduire tout ce que vous pouvez au moment de la compilation en utilisant getGT(), useGT(), ou <T>, et d'utiliser les traductions à la demande, comme tx() et <Tx>, uniquement lorsque c'est nécessaire.

Assurez-vous de suivre le guide de déploiement ici.

Exemple

Utilisation de base

Vous pouvez utiliser tx() pour traduire des chaînes de caractères.

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

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

Ajouter du contexte

Vous pouvez personnaliser la traduction en fournissant un contexte à prendre en compte lors de la traduction.

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

export default async function TranslateWithOptions() {
    return await tx("Hello, world!", {
      $context: 'Translate informally'
    });
}

Utiliser des variables

Pour passer des valeurs à votre chaîne de caractères, vous devez (1) assigner un identifiant et (2) référencer l'identifiant dans l'objet passé.

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

export default async function translateWithVariables() {
  return await tx("The cost is {price, number, ::currency/USD}", {
    price: 29.99,
  });
}

Spécifier une locale

Vous pouvez spécifier une locale à utiliser pour la traduction. Par défaut, la locale est définie sur la langue préférée de l'utilisateur.

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

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

Notes

• tx() exclusivement pour un usage côté serveur et ne peut pas être utilisé dans les composants côté client.
• Les traductions avec tx() se produisent à l'exécution, ce qui signifie qu'elles sont traduites en temps réel. Ceci est significativement plus lent que les traductions au moment de la compilation.

Prochaines étapes

• Voir useGT() et getGT() pour traduire les chaînes de caractères avant le déploiement.
• Pour traduire du jsx, voir <T> et <Tx>.
• Voir RuntimeTranslationOptions pour plus d'informations sur la personnalisation des traductions.