Config

loadDictionary

loadDictionary() 関数のAPIリファレンス

概要

loadDictionary は、指定した locale の翻訳用 JSON ファイルを読み込みます。

この関数は、gt-next を単体の i18n ライブラリとして使用したい方向けです。

この関数は主に、既存の i18n プロジェクトを既存の翻訳を保ったまま General Translation へ移行する際に使用します。 セットアップ方法はこのガイドを参照してください。

複数の翻訳が存在する場合は、loadDictionary で読み込まれた dictionaries の翻訳が常に他より優先されます。 loadDictionary は、文字列の翻訳を含む JSON ファイルのみをサポートします。

リファレンス

パラメータ

Prop

Type

説明

種別説明
locale翻訳を読み込む対象のlocale。

戻り値

指定された locale に対して、id を翻訳にマッピングした dictionary を返す Promise<any>

セットアップ

通常、dictionary は ./public/locales ディレクトリから読み込みます。

src/ ディレクトリまたはプロジェクトのルートにある loadDictionary.js または loadDictionary.ts というファイルで、loadDictionary をデフォルトエクスポートとして定義してください。 関数が、指定された locale の翻訳を含むオブジェクトで解決される Promise を返すようにしてください。

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

質問: loadTranslationsloadDictionary の違いは何ですか?

  • loadTranslations は、アプリの翻訳データを取得するためのカスタム読み込みロジックを定義するために使用します。 取得先は CDN(コンテンツ配信ネットワーク)、データベース、またはアプリのバンドルなどが考えられます。 これらの翻訳は通常、CLI ツールで機械生成・管理され、手作業での編集には向きません。
  • loadDictionary は、gt-next をスタンドアロンのライブラリとして利用する実装向けです。 利用者が自前の翻訳を用意し、翻訳インフラは使用しません。

注意事項

  • loadDictionary は、アプリのカスタム翻訳を読み込むために使用します。
  • loadDictionary で読み込まれた dictionaries は、loadTranslations で読み込まれた翻訳よりも優先されます。

次のステップ

  • 独自の翻訳を用意したい場合は、カスタム翻訳を参照してください。
  • カスタム翻訳ローダーの作成方法については、loadTranslationsを参照してください。

このガイドはどうでしたか?

loadDictionary