Config

loadDictionary

Référence de l’API pour la fonction loadDictionary().

Vue d’ensemble

loadDictionary charge un fichier JSON de traduction pour une locale donnée.

Cette fonction est destinée à ceux qui souhaitent utiliser gt-react comme bibliothèque i18n autonome.

Elle est principalement utilisée pour migrer des projets existants avec i18n vers General Translation tout en conservant leurs traductions actuelles.

S’il existe plusieurs traductions, celles provenant des dictionaries chargés par loadDictionary auront toujours la priorité sur les autres. loadDictionary ne prend en charge que l’utilisation de files JSON avec des traductions de type chaîne.

Références

Paramètres

Prop

Type

Description

TypeDescription
localeLe locale pour lequel charger les traductions.

Renvoie

Une Promise<any> qui se résout en un dictionary associant des ids à des traductions pour le locale donné.


Configuration

En général, vous chargerez le dictionary depuis le répertoire ./public/locales.

Définissez votre loadDictionary dans un fichier. Assurez-vous que la fonction renvoie une promesse résolue avec un objet contenant les traductions pour le locale donné.

src/loadDictionary.js
export default async function loadDictionary(locale) {
  const translations = await import(`../public/locales/${locale}.json`);
  return translations.default;
}

Ensuite, passez‑le à votre composant <GTProvider> :

src/App.js
import { GTProvider } from 'gt-react';
import loadDictionary from './loadDictionary';

<GTProvider loadDictionary={loadDictionary}>
  <App />
</GTProvider>

Question : Quelle est la différence entre loadTranslations et loadDictionary ?

  • loadTranslations sert à définir un comportement de chargement personnalisé pour récupérer les traductions de votre application. Cela peut consister à obtenir des traductions depuis un CDN (réseau de distribution de contenu), une base de données ou le bundle de votre application. Il s’agit en général de traductions générées automatiquement, gérées par l’outil CLI, et peu pratiques à modifier.
  • loadDictionary est destiné aux intégrations de gt-react utilisées comme bibliothèque autonome. Les utilisateurs fournissent leurs propres traductions et aucune infrastructure de traduction n’est utilisée.

Notes

  • loadDictionary est utilisé pour charger des traductions personnalisées pour votre application.
  • Les dictionaries chargés par loadDictionary auront priorité sur les traductions chargées par loadTranslations.

Prochaines étapes

Comment trouvez-vous ce guide ?