Overview

loadDictionary loads a translation JSON file for a given locale.

This function is intended for those who wish to use gt-next as a standalone i18n library.

It’s primarily used to migrate existing i18n projects to General Translation while keeping their existing translations. Follow this guide to set this up.

If multiple translations exist, those from dictionaries loaded by loadDictionary always take precedence over others. loadDictionary only supports JSON files with string translations.

Reference

Parameters

Description

Returns

A Promise<any> that resolves to a dictionary mapping IDs to translations for the given locale.

Setup

Generally, you’ll load the dictionary from the ./public/locales directory.

Define loadDictionary as the default export of a file named loadDictionary.js or loadDictionary.ts, either in the src/ directory or at the project root. Ensure the function returns a promise that resolves to an object containing translations for the given locale.

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

Notes

• loadDictionary is used to load custom translations for your app.
• Dictionaries loaded by loadDictionary will take precedence over translations loaded by loadTranslations.

Next steps

• If you want to write your own translations, check out custom translations.
• See loadTranslations for more information on writing a custom translation loader.