Config

loadDictionary

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

Aperçu

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

Cette fonction est destinée à celles et 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 existantes.

S’il existe plusieurs traductions, celles provenant des dictionaries chargés par loadDictionary auront toujours la priorité sur les autres. loadDictionary prend uniquement en charge les fichiers JSON contenant des traductions de type chaîne de caractères.

Référence

Paramètres

Prop

Type

Description

TypeDescription
localeLe locale pour lequel les traductions doivent être chargées.

Renvoie

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


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 qui se résout en un objet contenant les traductions pour la locale spécifiée.

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

Ensuite, transmettez-la à 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 (Content Delivery Network), une base de données ou le bundle de votre application. Il s’agit généralement de traductions générées automatiquement, gérées par l’outil CLI, et peu pratiques à modifier manuellement.
  • loadDictionary est conçu pour les utilisations de gt-react 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

Que pensez-vous de ce guide ?

loadDictionary