Config

loadDictionary

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

概要

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

この関数は、gt-next をスタンドアロンの i18n ライブラリとして使用したい方向けです。

この関数は主に、既存の翻訳を維持したまま、i18n 対応済みの既存プロジェクトを General Translation に移行する際に使用します。 セットアップ手順はこちらのガイドをご覧ください。

複数の翻訳が存在する場合、loadDictionary で読み込まれた dictionary の翻訳が常に他より優先されます。 loadDictionary は、文字列翻訳のみを含む JSON files にのみ対応しています。

リファレンス

パラメータ

Prop

Type

説明

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

戻り値

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

セットアップ

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

loadDictionary は、src/ ディレクトリまたはプロジェクトルートにある loadDictionary.js もしくは loadDictionary.ts というファイルで、デフォルトエクスポートとして定義してください。 この関数が、指定された 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 で読み込まれた dictionary は、loadTranslations で読み込まれた翻訳よりも優先されます。

次のステップ

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

このガイドはいかがですか?