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 à ceux qui souhaitent utiliser gt-next comme bibliothèque i18n autonome.

Elle est principalement utilisée pour migrer des projets existants déjà i18n vers General Translation tout en conservant leurs traductions actuelles. Suivez ce guide pour la mettre en place.

S'il existe plusieurs traductions, celles issues des dictionaries chargés par loadDictionary auront toujours priorité sur les autres. loadDictionary ne prend en charge que des files JSON contenant des traductions de chaînes de caractères.

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 aux traductions pour le locale donné.


Configuration

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

Définissez loadDictionary comme export par défaut d’un fichier nommé loadDictionary.js ou loadDictionary.ts, soit dans le répertoire src/, soit à la racine. Assurez-vous que la fonction renvoie une promesse qui se résout 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;
}

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 réseau de diffusion de contenu (CDN), 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 en ligne de commande (CLI), et peu pratiques à modifier.
  • loadDictionary est destiné aux implémentations de gt-next 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 la priorité sur les traductions chargées par loadTranslations.

Prochaines étapes

  • Si vous souhaitez rédiger vos propres traductions, consultez custom translations.
  • Voir loadTranslations pour en savoir plus sur l’écriture d’un chargeur de traductions personnalisé.

Comment trouvez-vous ce guide ?