# General Translation Platform: getLocaleEmoji
URL: https://generaltranslation.com/zh/docs/platform/core/reference/utility-functions/locales/get-locale-emoji.mdx
---

title: getLocaleEmoji
description: 在没有 GT 实例的情况下，为区域设置或地区返回 emoji 标记。getLocaleEmoji 的 API 参考。

---

[`getLocaleEmoji`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-emoji) 是 General Translation 核心库提供的一个独立实用函数，用于根据区域设置代码返回对应的 emoji 旗帜或符号。它会根据区域设置中的地区选择相应的国家或地区旗帜，并支持自定义 emoji 映射。

## 概览 [#overview]

直接从 `generaltranslation` 导入 `getLocaleEmoji`，并向其传入区域设置代码。它不需要 API Key，也不需要 [`GT`](/docs/platform/core/reference/gt-class/constructor) 实例。若要使用对应的实例版本，请改用 [`GT`](/docs/platform/core/reference/gt-class/constructor) 实例上的 [`getLocaleEmoji`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-emoji) 方法。

```typescript
import { getLocaleEmoji } from 'generaltranslation';

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

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

签名：

```typescript
getLocaleEmoji(locale: string, customMapping?: CustomMapping): string
```

## 工作原理 [#how-it-works]

* **基于区域的选择。** 使用区域设置中的地区 (如果有) 通过 Unicode 区域指示符号选择旗帜表情符号。对于某些语言，则回退到默认表情符号。
* **自定义映射优先级。** 在 [`customMapping`](/docs/platform/core/reference/types/custom-mapping) 中定义的表情符号优先于基于区域的选择。
* **后备内容。** 对于无法识别的区域设置，返回默认的地球表情符号 (`🌍`) 。

## 参数 [#parameters]

| 参数                                 | 描述                            | 类型                                                                    | 可选 | 默认值 |
| ---------------------------------- | ----------------------------- | --------------------------------------------------------------------- | -- | --- |
| [`locale`](#locale)                | 要获取其对应 emoji 的 BCP-47 区域设置代码。 | `string`                                                              | 否  | —   |
| [`customMapping`](#custom-mapping) | 用于区域设置代码和 emoji 覆盖的自定义映射。     | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | 是  | —   |

### `locale` [#locale]

**类型** `string` · **必填**

要获取其表情符号的 BCP-47 区域设置代码。

### `customMapping` [#custom-mapping]

**类型** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **可选**

用于区域设置代码和 emoji 覆盖项的可选自定义映射。

## 返回值 [#returns]

**类型** `string`

表示区域设置的旗帜 emoji 或其他符号：

* 对于包含 地区 的区域设置，返回对应的国家/地区旗帜 emoji (例如 `🇺🇸`、`🇫🇷`、`🇯🇵`) 。
* 如果在 mapping 中定义了自定义 emoji，则返回该 emoji。
* 对于无法识别的区域设置，返回默认的地球 emoji (`🌍`) 。

## 示例 [#examples]

```typescript
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')); // "🇨🇭"
```

## 备注 [#notes]

* 返回使用 Unicode 区域指示符号表示的旗帜表情符号。
* 自定义映射的表情符号优先于基于区域的选择。
* 支持所有 ISO 3166-1 alpha-2 区域代码，覆盖全面。