# gt-react: General Translation React SDK: useLocaleProperties
URL: https://generaltranslation.com/fr/docs/react/api/helpers/use-locale-properties.mdx
---
title: useLocaleProperties
description: Référence de l’API du hook useLocaleProperties
---

{/* GÉNÉRÉ AUTOMATIQUEMENT : ne modifiez pas ce fichier directement. Modifiez plutôt le modèle dans content/docs-templates/. */}


## Vue d’ensemble

Le hook `useLocaleProperties` renvoie des métadonnées sur un paramètre régional donné, notamment son nom, son nom dans la langue locale, sa langue, sa région et les informations sur son écriture.

<Callout>
  `useLocaleProperties` est un hook côté client et *ne peut être utilisé que dans des composants côté client*.
  Assurez-vous que votre application est enveloppée dans un [`<GTProvider>`](/docs/react/api/components/gtprovider).
</Callout>

## Référence

### Paramètres

| Paramètre | Type     | Description                                                     |
| --------- | -------- | --------------------------------------------------------------- |
| `locale`  | `string` | Un code de langue au format BCP 47 (par ex. `'en-US'`, `'ja'`). |

### Valeur de retour

Un objet `LocaleProperties` avec les champs suivants :

| Champ                      | Type     | Description                                                              |
| -------------------------- | -------- | ------------------------------------------------------------------------ |
| `code`                     | `string` | Le code de langue (par ex. `'en-US'`).                                   |
| `name`                     | `string` | Le nom anglais du paramètre régional (par ex. `'American English'`).     |
| `nativeName`               | `string` | Le nom du paramètre régional dans sa propre langue.                      |
| `languageCode`             | `string` | Le sous-tag de langue (par ex. `'en'`).                                  |
| `languageName`             | `string` | Le nom anglais de la langue.                                             |
| `nativeLanguageName`       | `string` | Le nom de la langue dans sa propre langue.                               |
| `nameWithRegionCode`       | `string` | Le nom du paramètre régional, région incluse (par ex. `'English (US)'`). |
| `nativeNameWithRegionCode` | `string` | Le nom natif du paramètre régional, région incluse.                      |
| `regionCode`               | `string` | Le sous-tag de région (par ex. `'US'`).                                  |
| `regionName`               | `string` | Le nom anglais de la région.                                             |
| `nativeRegionName`         | `string` | Le nom de la région dans la langue du paramètre régional.                |
| `scriptCode`               | `string` | Le sous-tag d&#39;écriture (par ex. `'Latn'`).                           |
| `scriptName`               | `string` | Le nom anglais de l’écriture.                                            |
| `nativeScriptName`         | `string` | Le nom de l’écriture dans la langue du paramètre régional.               |
| `maximizedCode`            | `string` | Le code de langue entièrement développé (par ex. `'en-Latn-US'`).        |

***

## Exemples

### Utilisation de base

```jsx title="LocaleInfo.jsx" copy
'use client';
import { useLocaleProperties } from 'gt-react';
import { useLocale } 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>
  );
}
```

***


## Remarques

* Ce hook est synchrone — il renvoie directement les propriétés.
* Utile pour créer des sélecteurs de paramètres régionaux personnalisés ou afficher aux utilisateurs les métadonnées d’un paramètre régional.

## Prochaines étapes

* Pour en savoir plus, consultez [les codes de langue](/docs/core/locales).