ドキュメント: intlayer の getLocaleName 関数

説明

getLocaleName 関数は、指定されたロケール（targetLocale）の名前を表示ロケール（displayLocale）でローカライズした名前を返します。targetLocale が指定されていない場合は、displayLocale 自身の言語での名前を返します。

パラメーター

• displayLocale: Locales

  • 説明: 対象ロケールの名前が表示されるロケール。
  • 型: 有効なロケールを表す列挙型または文字列。

• targetLocale?: Locales

  • 説明: 名前をローカライズする対象のロケール。
  • 型: 任意。 有効なロケールを表す列挙型または文字列。

戻り値

• 型: string
• 説明: targetLocale の名前を displayLocale でローカライズした名前、または targetLocale が指定されていない場合は displayLocale 自身の名前を返します。翻訳が見つからない場合は "Unknown locale" を返します。

使用例

import { Locales, getLocaleName } from "intlayer";

getLocaleName(Locales.ENGLISH); // 出力: "English"
getLocaleName(Locales.ENGLISH, Locales.FRENCH); // 出力: "Anglais"
getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // 出力: "Inglés"
getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // 出力: "English"

getLocaleName(Locales.FRENCH); // 出力: "Français"
getLocaleName(Locales.FRENCH, Locales.FRENCH); // 出力: "Français"
getLocaleName(Locales.FRENCH, Locales.ESPANOL); // 出力: "Francés"
getLocaleName(Locales.FRENCH, Locales.ENGLISH); // 出力: "French"

getLocaleName(Locales.CHINESE); // 出力: "中文"
getLocaleName(Locales.CHINESE, Locales.FRENCH); // 出力: "Chinois"
getLocaleName(Locales.CHINESE, Locales.ESPANOL); // 出力: "Chino"
getLocaleName(Locales.CHINESE, Locales.ENGLISH); // 出力: "Chinese"

getLocaleName("unknown-locale"); // 出力: "Unknown locale"

エッジケース

• targetLocale が指定されていない場合:
  • 関数はデフォルトで displayLocale 自身の名前を返します。
• 翻訳が見つからない場合:
  • localeNameTranslations に targetLocale または特定の displayLocale のエントリが存在しない場合、関数は ownLocalesName にフォールバックするか、 "Unknown locale" を返します。

React Native と古い環境用の Polyfills

getLocaleName 関数は Intl.DisplayNames API に依存しており、この API は React Native や古い JavaScript 環境では利用できません。これらの環境で getLocaleName を使用する場合は、polyfills を追加する必要があります。

アプリケーションの早期に polyfills をインポートしてください。理想的には、エントリポイントファイル（例：index.js、App.tsx、または main.tsx）で行います：

import "intl";import "@formatjs/intl-locale/polyfill";import "@formatjs/intl-displaynames/polyfill";

詳細については、FormatJS polyfills ドキュメントを参照してください。