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

title: useLocaleProperties
description: Получение отображаемых метаданных локали с помощью General Translation gt-react. Справочник API по useLocaleProperties.

---

Хук `useLocaleProperties` возвращает отображаемые метаданные локали — её название, самоназвание, язык, регион и систему письма.

*Доступно в `gt-react`, `gt-next` и `gt-react-native`. В примерах используется импорт из `gt-react`; вместо него импортируйте из пакета вашего фреймворка.*

*Примечание: не экспортируется из `gt-tanstack-start`.*

## Обзор [#overview]

Передайте в `useLocaleProperties` код локали, чтобы получить её свойства.

```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>
  );
}
```

*Примечание: в `gt-react` вызывайте `useLocaleProperties` внутри [`<GTProvider>`](/docs/react/reference/components/gt-provider). В `gt-next` это также работает в серверных компонентах.*

## Как это работает [#how-it-works]

Этот хук преобразует указанный код локали в объект [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties), что удобно для создания пользовательских селекторов локали или отображения пользователям метаданных локали.

## Параметры [#parameters]

| Параметр            | Описание                           | Тип      | Необязательный | По умолчанию |
| ------------------- | ---------------------------------- | -------- | -------------- | ------------ |
| [`locale`](#locale) | Локаль, которую требуется описать. | `string` | Нет            | —            |

### `locale` [#locale]

**Тип** `string` · **Обязательно**

Код локали в формате BCP 47, например `en-US` или `ja`.

## Возвращает [#returns]

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

Объект, описывающий локаль. Среди основных полей:

| Поле                       | Описание                                                          | Тип      |
| -------------------------- | ----------------------------------------------------------------- | -------- |
| `code`                     | Код локали, например `en-US`.                                     | `string` |
| `name`                     | Название локали на английском языке, например `American English`. | `string` |
| `nativeName`               | Название локали на её собственном языке.                          | `string` |
| `languageCode`             | Подтег языка, например `en`.                                      | `string` |
| `languageName`             | Название языка на английском языке.                               | `string` |
| `nativeLanguageName`       | Название языка на его собственном языке.                          | `string` |
| `nameWithRegionCode`       | Название локали с указанием региона, например `English (US)`.     | `string` |
| `nativeNameWithRegionCode` | Название локали на её собственном языке с указанием региона.      | `string` |
| `regionCode`               | Подтег региона, например `US`.                                    | `string` |
| `regionName`               | Название региона на английском языке.                             | `string` |
| `nativeRegionName`         | Название региона на собственном языке локали.                     | `string` |
| `scriptCode`               | Подтег системы письма, например `Latn`.                           | `string` |
| `scriptName`               | Название системы письма на английском языке.                      | `string` |
| `nativeScriptName`         | Название системы письма на собственном языке локали.              | `string` |
| `maximizedCode`            | Полностью развёрнутый код локали, например `en-Latn-US`.          | `string` |
| `emoji`                    | Эмодзи, связанный с регионом локали.                              | `string` |

Полный список полей см. в [`LocaleProperties`](/docs/platform/core/reference/types/locale-properties).

## Заметки [#notes]

* `useLocaleProperties` работает синхронно и доступен в серверных и клиентских компонентах.
* Чтобы узнать активную локаль, используйте [`useLocale`](/docs/react/reference/hooks/use-locale).