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

Retours

Une promesse qui se résout en une chaîne 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 direct, 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 pour qu'une traduction à la demande se charge, ce qui est considérablement plus lent.

Notre conseil est de traduire tout ce que vous pouvez au moment de la construction en utilisant getGT(), useGT(), ou <T>, et n'utiliser les traductions à la demande, comme tx() et <Tx>, que 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!"); 
}

Ajout de 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: 'Traduire de manière informelle'
    });
}

Utilisation de variables

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

import { tx } from 'gt-next/server';
 
export default async function translateWithVariables() {
    return await tx("The cost is {price}", {
        variables: { price : 29.99 },
        variableOptions: { price : { style: 'currency', currency: 'MXN' } }
    });
}

Spécification d'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() est exclusivement destiné à une utilisation 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 direct. Cela est considérablement plus lent que les traductions au moment de la construction.

Prochaines étapes

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