Types
OptionsDeTraductionEnLigne
Référence API pour le type OptionsDeTraductionEnLigne
Aperçu
Le type InlineTranslationOptions
est utilisé pour passer des variables aux traductions en ligne et spécifier leur comportement de rendu.
Vous pouvez également ajouter un contexte et un identifiant à la traduction.
Il est utilisé avec useGT()
et getGT()
pour passer des variables aux traductions de chaînes en ligne.
Référence
Paramètres
Prop | Type | Default |
---|---|---|
variablesOptions?? | Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions> | undefined |
variables?? | Record<string, any> | undefined |
id?? | string | undefined |
context?? | string | undefined |
Description
Prop | Description |
---|---|
context | Le contexte du contenu (utilisé pour la traduction). |
id | Un identifiant optionnel à utiliser avec l'éditeur de traduction. |
variables | Un objet où les clés identifient où chaque valeur est mappée dans la chaîne. |
variablesOptions | Un objet où les clés identifient la variable et les valeurs définissent le comportement des variables. Voir Intl.NumberFormatOptions et Intl.DateTimeFormatOptions pour plus d'informations. |
Exemples
Contexte
Afin d'ajouter du contexte à la chaîne, nous utilisons la prop context
.
import { useGT } from 'gt-next/client';
const Component = () => {
const t = useGT();
return <div>{t('Bonjour, le monde!', { context: 'une salutation formelle' })}</div>;
};
Passage de variables
Afin d'ajouter une variable à la chaîne, nous utilisons la syntaxe {variable-name}
, où les accolades entourent le nom de la variable.
import { useGT } from 'gt-next/client';
const Component = () => {
const t = useGT();
return <div>{t('Bonjour, {username}! Comment se passe ta journée?', { variables: { 'username' : 'Brian123' } })}</div>;
};
Ajout d'options de variables
Vous pouvez également personnaliser la façon dont vos variables s'affichent avec la prop variablesOptions
.
import { useGT } from 'gt-next/client';
const Component = () => {
const t = useGT();
return <div>
{ t(
'Solde de votre compte : {account-balance}!',
{
variables: { "account-balance" : 1000000 },
variableOptions: { "account-balance": { style: 'currency', currency: 'USD' } }
}
) }
</div>;
};
Notes
InlineTranslationOptions
est utilisé pour les traductions de chaînes.- L'objet
variables
passe des valeurs au texte. - L'objet
variablesOptions
définit le comportement des variables.
Prochaines étapes
- Voir
useGT()
etgetGT()
pour plus d'informations sur les traductions de chaînes en ligne. - Voir
Intl.NumberFormatOptions
etIntl.DateTimeFormatOptions
pour plus d'informations sur les options de formatage.
Comment trouvez-vous ce guide ?