# generaltranslation: General Translation Core SDK: getLocaleEmoji
URL: https://generaltranslation.com/zh/docs/core/functions/locales/get-locale-emoji.mdx
---
title: getLocaleEmoji
description: 独立版 getLocaleEmoji 函数的 API 参考
---

## 概述

独立的 `getLocaleEmoji` 函数无需创建 GT 类实例，即可获取区域设置代码对应的旗帜表情符号或其他符号。
它会根据区域设置中的地区信息，返回相应国家或地区的旗帜表情符号，并支持自定义表情符号映射。

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

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

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

***


## 参考

### 参数

<TypeTable
  type={{
  "locale": {
    type: 'string',
    optional: false,
  },
  "customMapping?": {
    type: 'CustomMapping',
    optional: true,
  }
}}
/>

### 参数说明

| 参数              | 说明                            |
| --------------- | ----------------------------- |
| `locale`        | 要获取其对应表情符号的 BCP-47 区域设置代码     |
| `customMapping` | 可选的自定义映射，用于指定区域设置代码与表情符号的覆盖关系 |

### 返回值

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

* 对于带地区的区域设置，返回国家/地区旗帜表情符号 (例如 `🇺🇸`、`🇫🇷`、`🇯🇵`) 
* 如果映射中已定义，则返回自定义表情符号
* 对于无法识别的区域设置，返回默认旗帜表情符号 (`🏳️`) 

***

## 示例

### 获取基本表情符号

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

***


## 说明

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

## 后续步骤

* 使用 GT 类方法 [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji)
* 通过 [`getLocaleProperties`](/docs/core/functions/locales/get-locale-properties) 获取区域设置属性
* 通过 [`getLocaleName`](/docs/core/functions/locales/get-locale-name) 获取区域设置名称
* 通过 [`isValidLocale`](/docs/core/functions/locales/is-valid-locale) 验证区域设置