loadDictionary()

Aperçu

loadDictionary() chargera un fichier json de traduction pour une locale donnée.

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

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

Si plusieurs traductions existent, les traductions provenant des dictionnaires chargés par loadDictionary() auront toujours la priorité sur les autres. loadDictionary() prend uniquement en charge l'utilisation de fichiers JSON avec des traductions de chaînes de caractères.

Référence

Paramètres

Prop	Type	Default
`locale?`	`string`	-

Description

Type	Description
`locale`	La locale pour laquelle les traductions doivent être chargées.

Retourne

Une Promise<any> qui se résout en un dictionnaire associant des identifiants aux traductions pour la locale donnée.

Configuration

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

Définissez votre fonction loadDictionary() dans un fichier. Assurez-vous que la fonction retourne une promesse qui se résout en un objet contenant les traductions pour la locale donnée.

src/loadDictionary.js

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

Ensuite, passez-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() est utilisée pour définir un comportement de chargement personnalisé afin de récupérer les traductions pour votre application. Cela peut consister à obtenir des traductions depuis un 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 cli, et qui ne sont pas très faciles à éditer pour les utilisateurs.
loadDictionary() est destinée aux implémentations de gt-react en tant que bibliothèque autonome. Les utilisateurs apportent 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 dictionnaires chargés par loadDictionary() auront la priorité sur les traductions chargées par loadTranslations().

Prochaines étapes

Si vous souhaitez écrire vos propres traductions, consultez traductions personnalisées.
Consultez loadTranslations() pour plus d'informations sur la création d'un chargeur de traductions personnalisé.

loadDictionary()

Sur cette page