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
参数说明
| 参数 | 说明 |
|---|---|
region | ISO 3166-1 alpha-2 或 UN M.49 地区代码。若未提供，将使用实例目标 locale 中的地区 |
customMapping | 可选的自定义地区映射，用于覆盖默认的地区名称和 emoji |
返回值
{ code: string; name: string; emoji: string } - 包含以下字段的对象：
code：输入的地区代码name：按目标 locale 语言本地化的地区名称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 区域代码
- 自定义映射可覆盖默认名称和表情符号
- 如未提供参数，将根据目标 locale 自动检测区域
- 若显示名称解析失败，将回退为使用区域代码作为名称
后续步骤
- 使用
getLocaleProperties获取完整的 locale 属性 - 使用
getLocaleEmoji获取 locale 的 emoji
本指南如何?