Utility FunctionsLocales
getLocaleEmoji
スタンドアロン関数 getLocaleEmoji のAPIリファレンス
概要
スタンドアロンの getLocaleEmoji 関数は、GT クラスのインスタンスなしで、ロケールコードに対応する旗や記号のemojiを取得します。
ロケールの地域情報に基づいて国・地域の適切な旗emojiを返し、カスタムemojiマッピングにも対応します。
import { getLocaleEmoji } from 'generaltranslation';
const emoji = getLocaleEmoji('fr-CA');
console.log(emoji); // "🇨🇦"（カナダ国旗）
const usEmoji = getLocaleEmoji('en-US');
console.log(usEmoji); // "🇺🇸"（米国旗）リファレンス
パラメータ
Prop
Type
パラメーターの説明
| パラメーター | 説明 |
|---|---|
locale | 対応する emoji を取得するための BCP-47 ロケールコード |
customMapping | ロケールコードと emoji を上書きするための任意のカスタムマッピング |
返り値
string - locale を表す旗の絵文字または記号:
- 地域を含む locale の場合は国/地域の旗の emoji（例:
🇺🇸,🇫🇷,🇯🇵） - マッピングで定義されている場合はカスタム emoji
- 未認識の locale の場合はデフォルトの旗の emoji（
🏳️）
例
基本的なemojiの取得
import { getLocaleEmoji } from 'generaltranslation';
// 代表的な国旗
console.log(getLocaleEmoji('en-US')); // "🇺🇸"
console.log(getLocaleEmoji('fr-FR')); // "🇫🇷"
console.log(getLocaleEmoji('de-DE')); // "🇩🇪"
console.log(getLocaleEmoji('ja-JP')); // "🇯🇵"
console.log(getLocaleEmoji('zh-CN')); // "🇨🇳"
// 多言語を使用する地域
console.log(getLocaleEmoji('en-CA')); // "🇨🇦"
console.log(getLocaleEmoji('fr-CA')); // "🇨🇦"
console.log(getLocaleEmoji('de-CH')); // "🇨🇭"
console.log(getLocaleEmoji('fr-CH')); // "🇨🇭"注意事項
- Unicode の Regional Indicator Symbols を用いて国旗の emoji を返します
- カスタムのマッピング emoji は、地域ベースの選択よりも優先されます
- 包括的なカバレッジのため、ISO 3166-1 alpha-2 のすべての地域コードに対応しています
次のステップ
- GT クラスのメソッド
getLocaleEmojiを使用する getLocalePropertiesでロケールのプロパティを取得するgetLocaleNameでロケール名を取得するisValidLocaleでロケールを検証する
このガイドはどうでしたか？