Aperçu

La fonction tx est une fonction exécutée côté serveur pour traduire des chaînes.

await tx('Bonjour, monde !'); // returns 'Hola, mundo !'

Références

Paramètres

Renvoie

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

Comportement

La fonction tx traduit les chaînes à l’exécution. Autrement dit, les traductions sont effectuées en temps réel, ce qui permet de traduire du contenu uniquement connu au runtime. L’inconvénient est qu’il y a un délai d’attente : le chargement d’une traduction à la demande est sensiblement plus lent.

Nous vous recommandons de traduire tout ce qui peut l’être à la compilation à l’aide de getGT, useGT ou <T>, et de n’utiliser les traductions à la demande, comme tx et <Tx>, qu’en cas de nécessité.

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

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("Bonjour, le monde !"); 
}

Ajout de contexte

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

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

export default async function TranslateWithOptions() {
    return await tx("Salut, le monde !", {
      $context: 'Traduire sur un registre informel'
    });
}

Utiliser des variables

Pour passer des valeurs à votre chaîne, vous devez (1) attribuer un identifiant et (2) le référencer dans l’objet transmis.

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

export default async function translateWithVariables() {
  return await tx("Le coût est {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 correspond à la langue préférée de l’utilisateur.

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

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

Notes

• tx est exclusivement destiné à une utilisation côté serveur et ne peut pas être utilisé dans des composants côté client.
• Les traductions avec tx s'effectuent à l'exécution, c’est‑à‑dire en temps réel. C’est sensiblement plus lent que les traductions effectuées au moment de la build.

Prochaines étapes

• Consultez useGT et getGT pour traduire des chaînes avant le déploiement.
• Pour traduire du JSX, voir <T> et <Tx>.
• Voir RuntimeTranslationOptions pour en savoir plus sur la personnalisation des traductions.