Components
GTProvider
Referencia de API del componente <GTProvider>
Descripción general
El componente <GTProvider> proporciona el contexto de General Translation (GT) a sus children, lo que les permite acceder al contenido traducido.
Es necesario para cualquier traducción que se ejecute del lado del cliente en tu aplicación.
Cuándo usarlo
- Envuelve toda tu aplicación con
<GTProvider>para habilitar las traducciones en el cliente. - Al trabajar con diccionarios, puedes especificar un
idpara limitar los datos del diccionario enviados al cliente y optimizar el rendimiento en diccionarios grandes. - El componente
<GTProvider>se usa tanto con<T>en línea como con diccionarios.
Referencias
Props
Prop
Type
Descripción
| Prop | Descripción |
|---|---|
children | Cualquier componente, o los componentes ascendentes de cualquier componente, que necesite traducir o acceder a información de traducción en el cliente. Deben incluirse todos los componentes que usen <T>, useGT u otras utilidades de traducción. |
id? | El id de un diccionario anidado para limitar los datos enviados al cliente. Es útil para proyectos grandes con diccionarios extensos. |
Devuelve
JSX.Element|undefined que contiene los children que se pasaron a este componente.
Ejemplo
Uso básico
Envuelve tu aplicación en <GTProvider> para proporcionar el contexto de traducción a tu app.
import { GTProvider } from 'gt-next';
export default function RootLayout({ children }) {
return (
<html lang="es">
<body>
<GTProvider> // [!code highlight]
{children}
</GTProvider> // [!code highlight]
</body>
</html>
);
}Uso de la prop id para subconjuntos
Especifica la prop id para optimizar el rendimiento enviando solo un subconjunto del diccionario al cliente.
import { GTProvider } from 'gt-next';
export default function RootLayout({ children }) {
return (
<html lang="es">
<body>
<GTProvider id="nested.dictionary.key"> // [!code highlight]
{children}
</GTProvider>
</body>
</html>
);
}Notas
<GTProvider>debe envolver todos los componentes<T>y demás componentes relacionados con la traducción dentro de los componentes de cliente. Más información aquí.- Para traducciones del lado del servidor,
<GTProvider>no es obligatorio, pero puede usarse igualmente.
Próximos pasos
- Más información sobre el
<T>component para traducir texto y componentes.
¿Qué te ha parecido esta guía?