GT ClassMethodsLocales
getRegionProperties
GT の getRegionProperties メソッドのAPIリファレンス
概要
getRegionProperties メソッドは、地域コードに関する詳細情報（ローカライズされた名称や対応するemojiの旗を含む）を取得します。
国際化対応のユーザーインターフェースを構築する際に、地域固有の表示情報を手軽に取得するための便利な手段です。
const gt = new GT({
sourceLocale: 'en-US',
targetLocale: 'fr-FR'
});
// 地域プロパティを取得
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'United States', emoji: '🇺🇸' }
const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
// 現在のlocaleから自動検出
const currentRegion = gt.getRegionProperties(); // targetLocaleの地域を使用
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }リファレンス
パラメータ
Prop
Type
パラメーターの説明
| Parameter | 説明 |
|---|---|
region | ISO 3166-1 alpha-2 または UN M.49 の地域コード。未指定の場合は、インスタンスの対象localeに設定された地域を使用します |
customMapping | 既定の地域名やemojiを上書きできる任意のカスタム地域マッピング |
返り値
{ code: string; name: string; emoji: string } - 次を含むオブジェクト:
code: 入力された地域コードname: 対象localeの言語でローカライズされた地域名emoji: 対応するemojiの旗またはシンボル
例
基本的なリージョン情報
const gt = new GT({
sourceLocale: 'en-US',
targetLocale: 'en-US'
});
// 一般的な地域コード
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'アメリカ合衆国', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'イギリス', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'ドイツ', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: '日本', emoji: '🇯🇵' }メモ
- 地域名のローカライズに
Intl.DisplayNamesAPI を使用します - ISO 3166-1 alpha-2 と UN M.49 の地域コードの両方をサポートします
- カスタムマッピングは既定の名称と emoji を上書きします
- パラメータが指定されていない場合は、対象の locale から地域を自動検出します
- 表示名の解決に失敗した場合は、名称として地域コードにフォールバックします
次のステップ
getLocalePropertiesを使って locale の完全なプロパティを取得するgetLocaleEmojiを使って locale の emoji を取得する
このガイドはどうでしたか？