DictionaryTranslationOptions
Referencia de API para el tipo DictionaryTranslationOptions
Descripción general
El tipo DictionaryTranslationOptions
se utiliza para pasar variables a las entradas del diccionario y especificar su comportamiento de renderizado.
Se usa con useTranslations()
para pasar variables a las entradas del diccionario.
Traducción en tiempo de construcción:
Las traducciones de useTranslations()
ocurren en tiempo de construcción; sin embargo, las variables nunca se traducen.
En su lugar, se insertan en la traducción con formato.
Asegúrate de seguir la guía de despliegue aquí.
Referencia
Parámetros
Prop | Type | Default |
---|---|---|
variablesOptions?? | Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions> | undefined |
variables?? | Record<string, any> | undefined |
Descripción
Prop | Descripción |
---|---|
variables | Un objeto donde las claves identifican a dónde se asigna cada valor en la entrada del diccionario. |
variablesOptions | Un objeto donde las claves identifican la variable y los valores definen el comportamiento de las variables. Consulta Intl.NumberFormatOptions y Intl.DateTimeFormatOptions para más información. |
Ejemplos
Pasando variables
Para pasar una variable a la entrada del diccionario, necesitamos hacer dos cosas: (1) agregar una variable a la entrada y (2) referenciar dicha variable en la invocación de d()
.
Primero, agregamos una variable a la entrada del diccionario con la siguiente sintaxis: {username}
.
username
es el nombre de la variable.
const dictionary = {
greeting: {
hello: 'Hello, {username}!',
},
};
export default dictionary;
A continuación, referenciamos la variable:
import { useTranslations } from 'gt-react';
const Component = () => {
const d = useTranslations();
return <div>{d('greeting.hello', { variables: { username : 'Brian123' } })}</div>;
};
Agregando opciones de variables
Las opciones de variables te permiten personalizar cómo se renderiza una variable.
Utiliza la misma sintaxis que el objeto variables
.
const dictionary = {
account: {
balance: 'Your account balance: {account-balance}!',
},
};
export default dictionary;
A continuación, referenciamos la variable:
import { useTranslations } from 'gt-react';
const Component = () => {
const d = useTranslations();
return <div>
{ d(
'account.balance',
{
variables: { "account-balance" : 1000000 },
variableOptions: { "account-balance": { style: 'currency', currency: 'USD' } }
}
) }
</div>;
};
Notas
- El objeto
variables
pasa valores a una entrada del diccionario. - El objeto
variablesOptions
define el comportamiento de las variables.
Próximos pasos
- Consulta diccionarios para obtener más información sobre diccionarios y prácticas comunes.
- Consulta
useTranslations()
para obtener más información sobre la interfaz de diccionarios. - Consulta
Intl.NumberFormatOptions
eIntl.DateTimeFormatOptions
para obtener más información sobre las opciones de formato.
¿Qué te parece esta guía?