Types

InlineTranslationOptions

Referencia de API del tipo InlineTranslationOptions

Descripción general

El tipo InlineTranslationOptions se utiliza para pasar variables a traducciones en línea y especificar su comportamiento de renderizado. También puedes añadir contexto y un identificador a la traducción. Se utiliza con useGT, getGT y msg para pasar variables a traducciones de cadenas en línea.

Buildtime Translation: Las variables no se traducen con useGT, getGT y msg, solo la cadena original. Consulta tx para traducir cadenas con contenido dinámico.

Referencias

Parámetros

Prop

Type

Descripción

PropDescripción
variablesObjeto cuyas claves indican dónde se asigna cada valor dentro de la cadena.
$contextPuedes incluir $context como variable en el objeto variables para aportar contexto al contenido (usado para la traducción).
$idPuedes incluir $id como variable en el objeto variables para proporcionar un identificador que se utilizará con el editor de traducciones.

Ejemplos

Contexto

Para agregar contexto a la cadena, usamos la prop $context.

Component.tsx
import { useGT } from 'gt-next';

const Component = () => {
  const t = useGT();
  return <div>{t('Hola, mundo.', { $context: 'un saludo formal' })}</div>;
};

Paso de variables

Para agregar una variable a la cadena, usamos la sintaxis {variable-name}, donde el nombre de la variable va entre llaves.

Component.tsx
import { useGT } from 'gt-next';

const Component = () => {
  const t = useGT();
  return <div>{t('¡Hola, {username}! ¿Cómo va tu día?', { username: 'Brian123' })}</div>;
};

Uso de ICU message format

gt-next es compatible con ICU message format, lo que también te permite dar formato a tus variables.

Component.tsx
import { useGT } from 'gt-next';

const Component = () => {
  const t = useGT();
  return <div>
    { t(
      'Saldo de tu cuenta: {dollars, number, ::currency/USD}.',
      {
        "dollars" : 1000000,
      }
    ) }
  </div>;
};

Consulta la documentación de ICU message format para obtener más información sobre ICU message format.


Notas

  • InlineTranslationOptions se usa para traducciones de cadenas en línea.
  • El objeto variables pasa valores al texto.
  • El objeto variablesOptions define el comportamiento de las variables.

Próximos pasos

  • Consulta useGT y getGT para obtener más información sobre las traducciones de cadenas en línea.
  • Consulta ICU message format para obtener más información sobre las options de formato.

¿Qué te ha parecido esta guía?

InlineTranslationOptions