# generaltranslation: General Translation Core SDK: getLocaleEmoji
URL: https://generaltranslation.com/zh/docs/core/class/methods/locales/get-locale-emoji.mdx
---
title: getLocaleEmoji
description: GT getLocaleEmoji 方法的 API 参考文档
---

## 概述

`getLocaleEmoji` 方法会根据区域设置代码对应的区域，返回相应的旗帜表情符号或其他符号。
它会为国家和地区返回合适的旗帜表情；对于没有特定区域的语言，则提供回退方案，并支持通过映射自定义表情。

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr-CA'
});

const emoji = gt.getLocaleEmoji('fr-CA');
console.log(emoji); // "🇨🇦" (加拿大国旗)

const usEmoji = gt.getLocaleEmoji('en-US');
console.log(usEmoji); // "🇺🇸" (美国国旗)

const enEmoji = gt.getLocaleEmoji('en');
console.log(enEmoji); // "🇺🇸" (美国国旗)
```

***


## 参考

### 参数

<TypeTable
  type={{
  "locale?": {
    type: 'string',
    optional: true,
    default: 'this.targetLocale',
  }
}}
/>

### 参数说明

| 参数       | 说明                                                      |
| -------- | ------------------------------------------------------- |
| `locale` | 要获取对应 emoji 的 BCP-47 区域设置代码。若未提供，则使用该实例的 `targetLocale` |

### 返回值

`string` - 表示区域设置的旗帜 emoji 或符号：

* 对于带区域的区域设置，返回对应国家/地区的旗帜 emoji (例如：`🇺🇸`、`🇫🇷`、`🇯🇵`) 
* 对于某些不带区域的语言，返回对应语言的 emoji
* 对于无法识别的区域设置，返回默认旗帜 emoji (`🏳️`)

### 抛出

* `Error` - 如果未提供区域设置，且该实例也未配置 `targetLocale`

***

## 示例

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

// 获取目标区域设置的表情符号
console.log(gt.getLocaleEmoji()); // "🇪🇸"（使用 targetLocale 'es'）

// 获取不同区域设置的表情符号
console.log(gt.getLocaleEmoji('en-US')); // "🇺🇸"
console.log(gt.getLocaleEmoji('fr-FR')); // "🇫🇷"
console.log(gt.getLocaleEmoji('de-DE')); // "🇩🇪"
console.log(gt.getLocaleEmoji('ja-JP')); // "🇯🇵"
console.log(gt.getLocaleEmoji('zh-CN')); // "🇨🇳"
```

***


## 注意事项

* 可用时，会根据区域设置中的区域代码返回对应的旗帜表情符号
* 自定义映射的表情符号优先于基于区域的选择结果
* 使用 Unicode 区域指示符生成旗帜
* 对于无法识别或无效的区域设置，默认使用 `🏳️` (白旗) 
* 兼容所有支持 Unicode 表情符号的现代浏览器和操作系统

## 后续步骤

* 使用 [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties) 获取区域设置属性
* 使用 [`getLocaleName`](/docs/core/class/methods/locales/get-locale-name) 获取区域设置名称
* 使用 [`isValidLocale`](/docs/core/class/methods/locales/is-valid-locale) 验证区域设置
* [了解 CustomMapping 类型](/docs/core/types/custom-mapping)