Components
GTProvider
Référence de l’API du composant <GTProvider>
Aperçu
Le composant <GTProvider> fournit le contexte General Translation (GT) à ses children, leur permettant d’accéder au contenu traduit.
Il est requis pour toute traduction côté client dans votre application.
Quand l’utiliser
- Enveloppez toute votre application dans
<GTProvider>pour activer les traductions côté client. - Lorsque vous travaillez avec des dictionary, vous pouvez indiquer un
idpour limiter les données du dictionary envoyées au client, ce qui optimise les performances pour les dictionary volumineux. - Le composant
<GTProvider>est utilisé à la fois pour le<T>inline et les dictionaries.
Références
Props
Prop
Type
Description
| Prop | Description |
|---|---|
children | Tout composant, ainsi que les parents de tout composant, qui doivent traduire ou accéder aux informations de traduction côté client. Cela inclut tout composant utilisant <T>, useGT ou d'autres utilitaires de traduction. |
id? | L’ID d’un dictionary imbriqué pour limiter les données envoyées au client. Utile pour les grands projets avec des dictionaries volumineux. |
Renvoie
JSX.Element|undefined contenant les children transmis à ce composant.
Exemple
Utilisation de base
Encapsulez votre application dans <GTProvider> pour lui fournir le contexte de traduction.
import { GTProvider } from 'gt-next';
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>
<GTProvider> // [!code highlight]
{children}
</GTProvider> // [!code highlight]
</body>
</html>
);
}Utilisation de la prop id pour des sous‑ensembles
Spécifiez la prop id pour optimiser les performances en n’envoyant au client qu’un sous‑ensemble du dictionary.
import { GTProvider } from 'gt-next';
export default function RootLayout({ children }) {
return (
<html lang="en">
<body>
<GTProvider id="nested.dictionary.key"> // [!code highlight]
{children}
</GTProvider>
</body>
</html>
);
}Notes
- Le
<GTProvider>doit envelopper tous les composants<T>et les autres composants liés à la traduction au sein des composants client. En savoir plus ici. - Pour les traductions côté serveur,
<GTProvider>n’est pas requis mais peut tout de même être utilisé.
Prochaines étapes
- Découvrez le composant
<T>pour traduire du texte et des composants.
Comment trouvez-vous ce guide ?