DictionaryTranslationOptions
Référence API pour le type DictionaryTranslationOptions
Aperçu
Le type DictionaryTranslationOptions
est utilisé pour transmettre des variables aux entrées du dictionnaire et spécifier leur comportement d'affichage.
Il est utilisé avec useDict()
et getDict()
pour passer des variables aux entrées du dictionnaire.
Référence
Paramètres
Prop | Type | Default |
---|---|---|
variablesOptions?? | Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions> | undefined |
variables?? | Record<string, any> | undefined |
Description
Prop | Description |
---|---|
variables | Un objet où les clés identifient où chaque valeur est associée dans l'entrée du dictionnaire. |
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
Passage de variables
Pour passer une variable à l'entrée du dictionnaire, nous devons faire deux choses : (1) ajouter une variable à l'entrée et (2) référencer cette variable dans l'appel à d()
.
Tout d'abord, nous ajoutons une variable à l'entrée du dictionnaire avec la syntaxe suivante : {username}
.
username
est le nom de la variable.
const dictionary = {
greeting: {
hello: 'Hello, {username}!',
},
};
export default dictionary;
Ensuite, nous référencions la variable :
import { useDict } from 'gt-next/client';
const Component = () => {
const d = useDict();
return <div>{d('greeting.hello', { variables: { username : 'Brian123' } })}</div>;
};
Ajout d'options de variable
Les options de variable vous permettent de personnaliser la façon dont une variable est affichée.
Elles utilisent la même syntaxe que l'objet variables
.
const dictionary = {
account: {
balance: 'Your account balance: {account-balance}!',
},
};
export default dictionary;
Ensuite, nous référencions la variable :
import { useDict } from 'gt-next/client';
const Component = () => {
const d = useDict();
return <div>
{ d(
'account.balance',
{
variables: { "account-balance" : 1000000 },
variableOptions: { "account-balance": { style: 'currency', currency: 'USD' } }
}
) }
</div>;
};
Notes
- L'objet
variables
transmet des valeurs à une entrée du dictionnaire. - L'objet
variablesOptions
définit le comportement des variables.
Prochaines étapes
- Consultez la page dictionaries pour plus d'informations sur les dictionnaires et les pratiques courantes.
- Consultez
useDict()
ougetDict()
pour plus d'informations sur l'interface des dictionnaires. - Consultez
Intl.NumberFormatOptions
etIntl.DateTimeFormatOptions
pour plus d'informations sur les options de formatage.
Comment trouvez-vous ce guide ?