Présentation

La fonction tx est une fonction côté serveur destinée à traduire des chaînes de caractères.

await tx('Hello, world!'); // retourne '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 original si aucune traduction n’est nécessaire.

Comportement

La fonction tx traduit des chaînes au moment de l’exécution. Autrement dit, les traductions s’effectuent en temps réel, ce qui vous permet de traduire du contenu uniquement connu à l’exécution. La contrepartie est un délai : le chargement d’une traduction à la demande est sensiblement plus lent.

Nous vous conseillons de traduire un maximum d’éléments au moment du build en utilisant 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.

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

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

Ajout de contexte

Vous pouvez affiner la traduction en fournissant un contexte à prendre en compte lors du processus de traduction.

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

export default async function TranslateWithOptions() {
    return await tx("Hello, world!", {
      $context: 'Traduire de façon informelle'
    });
}

Utilisation des variables

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

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

export default async function translateWithVariables() {
  return await tx("Le prix est de {price, number, ::currency/USD}", {
    price: 29.99,
  });
}

Spécifier un locale

Vous pouvez spécifier un locale à utiliser pour la traduction. Par défaut, le locale est défini sur la langue préférée de l’utilisateur.

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

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

Notes

• tx est réservé à 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 nettement plus lent que des traductions effectuées lors de la phase de build.

Prochaines étapes

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