RuntimeTranslationOptions
Referencia de API del tipo RuntimeTranslationOptions
Descripción general
El tipo RuntimeTranslationOptions se usa para pasar variables a traducciones inline y definir su comportamiento de renderizado.
También puedes agregar un locale para indicar un idioma distinto para la traducción.
Se utiliza con la función tx.
Traducción en tiempo de ejecución:
Para traducir una Variable bajo demanda, inclúyela directamente en la cadena que se pasa a tx.
Las variables pasadas a tx mediante el objeto options no se traducen.
Referencia
Parámetros
Prop
Type
Descripción
| Prop | Descripción |
|---|---|
variables | Un objeto en el que las claves indican a qué parte de la cadena se asigna cada value. |
$locale | Opcionalmente, incluye $locale como una Variable en el objeto variables para especificar un locale para la traducción. Por defecto, usará el locale más preferido del navegador que sea compatible con tu app. |
Ejemplos
Pasar variables
Para agregar una variable a la cadena, usamos la sintaxis {variable-name}, donde las llaves envuelven el nombre de la variable.
import { tx } from 'gt-next/server';
const Component = () => {
return <div>
{tx(`¡Hola, {username}!`, { username: 'Brian123' })}
</div>;
};Uso del ICU message format
gt-next es compatible con el ICU message format, lo que también te permite formatear tus variables.
import { tx } from 'gt-next/server';
const Component = () => {
return <div>
{ tx(
'Saldo de la cuenta: {dollars, number, ::currency/USD}!',
{
"dollars" : 1000000,
}
) }
</div>;
};Traducción de variables
Para traducir una variable, inclúyela directamente en la cadena que se le pasa a tx.
import { tx } from 'gt-next/server';
const Component = ({ hairColor }: { hairColor: string }) => {
return <div>{tx(
`¡Hola, {username}! Tu color de cabello es ${hairColor}`,
{ username: 'Brian123' }
)}</div>;
};Ten en cuenta que la variable hairColor se traduce, pero username no.
Especificar un locale
Puedes especificar un locale para la traducción.
import { tx } from 'gt-next/server';
const Component = () => {
return <div>{tx('¡Hola, mundo!', { $locale: 'fr' })}</div>;
};Esto siempre se traducirá al francés.
Notas
RuntimeTranslationOptionsse utiliza para traducir cadenas en tiempo de ejecución.- El objeto
variablesenvía valores al texto. - El objeto
variablesOptionsdefine el comportamiento de las variables.
Próximos pasos
- Consulta
txpara obtener más información sobre traducciones de cadenas en línea. - Consulta
ICU message formatpara obtener más información sobre las opciones de formato.
¿Qué te parece esta guía?