Types

InlineTranslationOptions

Referencia de API del tipo InlineTranslationOptions

Descripción general

El tipo InlineTranslationOptions se usa 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 ni msg, solo la cadena original. Consulta tx para traducir cadenas con contenido dinámico.

Referencia

Parámetros

Prop

Type

Descripción

PropDescripción
variablesUn objeto en el que las claves indican a qué lugar se asigna cada value dentro de la cadena.
$contextOpcionalmente incluye $context como una Variable en el objeto variables para proporcionar contexto del contenido (usado para la traducción).
$idOpcionalmente incluye $id como una Variable en el objeto variables para proporcionar un identificador para usar con el editor de traducción.

Ejemplos

Contexto

Para añadir contexto a la cadena, usamos la prop $context.

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

const Component = () => {
  const t = useGT();
  return <div>{t('Hello, world!', { $context: 'saludo formal' })}</div>;
};

Pasar variables

Para añadir una variable a la cadena, usamos la sintaxis {variable-name}, donde las llaves rodean el nombre de la variable.

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 del ICU message format

gt-next es compatible con el ICU message format, lo que también te permite formatear 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 del ICU message format para obtener más información sobre el ICU message format.


Notas

  • InlineTranslationOptions se utiliza para traducciones de cadenas en línea.
  • El objeto variables pasa value 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 traducciones de cadenas en línea.
  • Consulta ICU message format para obtener más información sobre las options de formato.

¿Qué te parece esta guía?