<T>
Referencia de API para el componente <T>
Resumen
El componente <T>
es el método principal de traducción en gt-react
.
El componente <T>
admite la traducción de texto plano así como estructuras JSX complejas.
Además, proporciona características para manejar variables, plurales y traducciones específicas de contexto.
Traducción en tiempo de compilación:
Las traducciones de <T>
ocurren en tiempo de compilación.
Esto significa que la traducción ocurre antes del despliegue para reducir la latencia.
Asegúrate de seguir la guía de despliegue aquí.
Referencia
Props
Prop | Type | Default |
---|---|---|
children? | any | - |
id? | string | - |
context?? | string | undefined |
Descripciones
Prop | Descripción |
---|---|
children | El contenido a traducir. Esto puede incluir texto plano o estructuras JSX. |
id | Un identificador único para la cadena de traducción. Esto asegura una traducción consistente en toda tu aplicación. |
context | Contexto adicional para refinar la traducción. Útil para resolver frases ambiguas. |
Retornos
React.JSX.Element|undefined
que contiene la traducción renderizada o contenido alternativo basado en la configuración proporcionada.
Comportamiento
Producción
Durante el proceso de CD, cualquier hijo dentro de un <T>
será traducido antes de que tu aplicación sea desplegada.
Esto asegura tiempos de carga rápidos para todos los locales, pero solo puede traducir contenido conocido en el momento de la construcción.
Una vez generadas, las traducciones se almacenan (1) en el CDN o (2) en la salida de construcción de tu aplicación, según tu configuración. Desde allí, el contenido traducido se sirve a tus usuarios. Si no se encuentra una traducción, se recurrirá al contenido original.
Asegúrate de seguir la guía de despliegue aquí.
Desarrollo
Durante el desarrollo, la función <T>
traducirá el contenido bajo demanda.
Esto es útil para prototipar cómo se verá tu aplicación en diferentes idiomas.
Recuerda agregar una clave de API de desarrollo a tu entorno para habilitar este comportamiento.
Mientras se carga, <T>
devolverá undefined a menos que los idiomas sean similares (en-US vs en-GB), aunque este comportamiento se puede personalizar con configuraciones de renderizado.
Si ocurre un error, <T>
devolverá el contenido original.
Verás un retraso durante la traducción bajo demanda en desarrollo. Este retraso no ocurrirá durante las construcciones de producción ya que todo ya estará traducido.
Ejemplos
Uso básico
El componente <T>
puede traducir cadenas simples usando un id
y sus hijos.
Recuerda, el componente <T>
debe usarse dentro de un <GTProvider>
para acceder a las traducciones.
Con variables
El componente <T>
puede incluir variables para contenido dinámico dentro de las traducciones.
Con plurales
El componente <T>
también soporta pluralización usando el componente <Plural>
.
Limitaciones
El componente <T>
no traduce contenido que es dinámico.
La función <T>
traduce sus descendientes.
Nota: Una buena regla general es que cualquier contenido que esté literalmente entre los dos <T>
en el archivo será traducido.
Siempre puedes agregar otro <T>
para traducir el contenido que no está siendo traducido, aunque no se recomienda anidar componentes <T>
.
Notas
- El componente
<T>
está diseñado para traducir contenido en tu aplicación. Es el método principal para la localización engt-react
. - Usa el componente
<T>
para traducir texto plano o estructuras JSX, incluyendo variables y pluralización. - Asegúrate de que el componente
<T>
esté envuelto en un<GTProvider>
para acceder al contexto de traducción.
Próximos pasos
- Para explorar características más avanzadas como la traducción bajo demanda, variables, contexto y manejo de plurales, consulta la documentación de
<T>
Design Patterns. - Para traducir cadenas, consulta
useGT()
. - Revisa el uso de componentes de variable y el uso de componentes de ramificación para patrones de traducción más avanzados.