Utility FunctionsLocales
getLocaleEmoji
独立函数 getLocaleEmoji 的 API 参考
概览
独立的 getLocaleEmoji 函数无需 GT class 实例即可为语言代码返回对应的 emoji 旗帜或符号。
它会根据 locale 的区域返回相应的国家/地区旗帜 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 | 可选的 customMapping，用于自定义语言代码与 emoji 的映射覆盖 |
返回值
string - 表示 locale 的表情符号旗帜或符号：
- 对于带有地区的 locales，使用对应国家/地区旗帜表情（如
🇺🇸、🇫🇷、🇯🇵） - 若在映射中定义了自定义表情，则使用自定义表情
- 对于无法识别的 locales，使用默认旗帜表情（
🏳️）
示例
基础表情符号检索
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 区域指示符号返回旗帜 emoji
- 自定义映射的 emoji 优先于基于区域的选择
- 支持所有 ISO 3166-1 alpha-2 地区代码，覆盖范围全面
下一步
- 使用 GT class 方法
getLocaleEmoji - 使用
getLocaleProperties获取 locale 属性 - 使用
getLocaleName获取 locale 名称 - 使用
isValidLocale验证 locales
本指南如何?