# General Translation Platform: getLocaleName
URL: https://generaltranslation.com/fr/docs/platform/core/reference/utility-functions/locales/get-locale-name.mdx
---
title: getLocaleName
description: Renvoie un nom de paramètre régional lisible sans instance GT. Référence API de getLocaleName.

---

[`getLocaleName`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-name) est une fonction utilitaire autonome de la bibliothèque Core de General Translation qui renvoie le nom d’affichage d’un code de langue. Elle utilise l’API `Intl.DisplayNames` pour produire un nom localisé pour tout code BCP-47 valide.

## Vue d’ensemble [#overview]

Importez `getLocaleName` directement depuis `generaltranslation` et appelez-la avec un code de langue et, en option, un paramètre régional d’affichage. Elle ne nécessite ni clé API ni instance de [GT](/docs/platform/core/reference/gt-class/constructor). Pour l’équivalent basé sur une instance, utilisez plutôt la méthode [`getLocaleName`](/docs/platform/core/reference/gt-class-methods/locales/get-locale-name) d’une instance de [`GT`](/docs/platform/core/reference/gt-class/constructor).

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

const name = getLocaleName('fr-CA', 'en');
console.log(name); // "Canadian French" (français canadien)
```

Signature :

```typescript
getLocaleName(
  locale: string,
  defaultLocale?: string,
  customMapping?: CustomMapping
): string
```

## Fonctionnement [#how-it-works]

### Résolution de la langue d’affichage

La fonction localise les noms selon l’ordre de priorité suivant :

1. Le paramètre `defaultLocale`, s’il est fourni.
2. Le paramètre régional par défaut de la bibliothèque, `en`.

### Intégration du mapping personnalisé

* Les mappages personnalisés sont vérifiés en premier pour les codes de langue comme pour les noms.
* Prend en charge la résolution des alias et des noms d’affichage personnalisés.
* Utilise `Intl.DisplayNames` par défaut pour les codes non mappés.

### Stratégie de résolution des noms

1. **Nom du mapping personnalisé** (priorité la plus élevée).
2. **`Intl.DisplayNames`** dans le paramètre régional par défaut.
3. **`Intl.DisplayNames`** dans le paramètre régional par défaut de la bibliothèque (`en`).
4. **Une chaîne vide** (contenu de secours).

*Remarque : le nom d’affichage utilise la forme dialectale du CLDR, donc `fr-CA` donne « français canadien » et `es-ES` « espagnol d’Europe » — et non « français (Canada) » ou « espagnol (Espagne) ». Une langue de base comme `es` donne « espagnol », sans région.*

## Paramètres [#parameters]

| Paramètre                          | Description                                                    | Type                                                                  | Facultatif | Par défaut |
| ---------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------- | ---------- | ---------- |
| [`locale`](#locale)                | Code de langue BCP-47 dont on veut obtenir le nom d’affichage. | `string`                                                              | Non        | —          |
| [`defaultLocale`](#default-locale) | Paramètre régional utilisé pour localiser le nom d’affichage.  | `string`                                                              | Oui        | `en`       |
| [`customMapping`](#custom-mapping) | Mapping personnalisé des codes de langue et des noms.          | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Oui        | —          |

### `locale` [#locale]

**Type** `string` · **Obligatoire**

Le code de langue BCP-47 dont on veut obtenir le nom d’affichage.

### `defaultLocale` [#default-locale]

**Type** `string` · **Facultatif** · **Par défaut** `en`

Paramètre régional utilisé pour localiser le nom d’affichage renvoyé.

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

**Type** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Facultatif**

Un mapping personnalisé pour les codes de langue et les noms de paramètres régionaux.

## Renvoie [#returns]

**Type** `string`

Le nom d’affichage localisé associé au paramètre régional. Renvoie une chaîne vide si aucun nom d’affichage ne peut être déterminé.

## Exemples [#examples]

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

// Noms d'affichage en anglais
console.log(getLocaleName('es', 'en')); // "Spanish"
console.log(getLocaleName('ja', 'en')); // "Japanese"
console.log(getLocaleName('zh', 'en')); // "Chinese"
console.log(getLocaleName('fr-CA', 'en')); // "Canadian French"
console.log(getLocaleName('es-ES', 'en')); // "European Spanish"
```

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

// Construction des options de paramètres régionaux pour un sélecteur
function buildLocaleOptions(
  supportedLocales: string[],
  displayLocale: string = 'en'
) {
  return supportedLocales.map((locale) => ({
    value: locale,
    label: getLocaleName(locale, displayLocale),
    emoji: getLocaleEmoji(locale),
  }));
}

const options = buildLocaleOptions(['en', 'es', 'fr', 'de', 'ja'], 'en');

console.log(options);
// [
//   { value: 'en', label: 'English', emoji: '🇺🇸' },
//   { value: 'es', label: 'Spanish', emoji: '🇪🇸' },
//   ...
// ]
```

## Remarques [#notes]

* Les mappings personnalisés priment sur `Intl.DisplayNames` standard.
* Renvoie une chaîne vide si aucun nom d’affichage ne peut être déterminé.
* Le paramètre `defaultLocale` détermine la langue du nom renvoyé.