# General Translation React SDKs (gt-react, gt-next): useLocaleProperties
URL: https://generaltranslation.com/fr/docs/react/reference/hooks/use-locale-properties.mdx
---

title: useLocaleProperties
description: Consultez les métadonnées d’affichage d’un paramètre régional avec General Translation gt-react. Référence d’API pour useLocaleProperties.

---

Le hook `useLocaleProperties` renvoie les métadonnées d’affichage d’un paramètre régional : son nom, son nom natif, sa langue, sa région et son écriture.

*Disponible dans `gt-react`, `gt-next` et `gt-react-native`. Les exemples importent depuis `gt-react` ; importez plutôt depuis le package de votre framework.*

*Remarque : n’est pas exporté par `gt-tanstack-start`.*

## Aperçu [#overview]

Appelez `useLocaleProperties` avec un code de langue pour en obtenir les propriétés.

```tsx
import { useLocale, useLocaleProperties } from 'gt-react';

export default function LocaleInfo() {
  const locale = useLocale();
  const props = useLocaleProperties(locale); // [!code highlight]
  return (
    <div>
      <p>Name: {props.name}</p>
      <p>Native name: {props.nativeName}</p>
      <p>Region: {props.regionName}</p>
    </div>
  );
}
```

*Remarque : dans `gt-react`, appelez `useLocaleProperties` à l’intérieur d’un [`<GTProvider>`](/docs/react/reference/components/gt-provider). Dans `gt-next`, cela fonctionne également dans les composants serveur.*

## Fonctionnement [#how-it-works]

Le hook transforme le code de langue fourni en objet [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties), ce qui est utile pour créer des sélecteurs de paramètre régional personnalisés ou afficher aux utilisateurs les métadonnées du paramètre régional.

## Paramètres [#parameters]

| Paramètre           | Description                      | Type     | Facultatif | Par défaut |
| ------------------- | -------------------------------- | -------- | ---------- | ---------- |
| [`locale`](#locale) | Le paramètre régional à décrire. | `string` | Non        | —          |

### `locale` [#locale]

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

Un code de langue BCP 47, comme `en-US` ou `ja`.

## Valeur renvoyée [#returns]

**Type** [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties)

Objet décrivant le paramètre régional. Les principaux champs sont les suivants :

| Champ                      | Description                                                               | Type     |
| -------------------------- | ------------------------------------------------------------------------- | -------- |
| `code`                     | Le code de langue, par exemple `en-US`.                                   | `string` |
| `name`                     | Le nom anglais du paramètre régional, par exemple `American English`.     | `string` |
| `nativeName`               | Le nom dans la langue du paramètre régional.                              | `string` |
| `languageCode`             | Le sous-tag de langue, par exemple `en`.                                  | `string` |
| `languageName`             | Le nom anglais de la langue.                                              | `string` |
| `nativeLanguageName`       | Le nom de la langue dans sa propre langue.                                | `string` |
| `nameWithRegionCode`       | Le nom du paramètre régional, région incluse, par exemple `English (US)`. | `string` |
| `nativeNameWithRegionCode` | Le nom natif du paramètre régional, région incluse.                       | `string` |
| `regionCode`               | Le sous-tag de région, par exemple `US`.                                  | `string` |
| `regionName`               | Le nom anglais de la région.                                              | `string` |
| `nativeRegionName`         | Le nom de la région dans la langue du paramètre régional.                 | `string` |
| `scriptCode`               | Le sous-tag d’écriture, par exemple `Latn`.                               | `string` |
| `scriptName`               | Le nom anglais de l’écriture.                                             | `string` |
| `nativeScriptName`         | Le nom de l’écriture dans la langue du paramètre régional.                | `string` |
| `maximizedCode`            | Le code de langue complet, par exemple `en-Latn-US`.                      | `string` |
| `emoji`                    | L’émoji associé à la région du paramètre régional.                        | `string` |

Consultez [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties) pour voir la liste complète des champs.

## Remarques [#notes]

* `useLocaleProperties` est synchrone et fonctionne aussi bien dans les composants serveur que client.
* Pour lire le paramètre régional actif, utilisez [`useLocale`](/docs/react/reference/hooks/use-locale).