# gt-next: General Translation Next.js SDK: useLocaleProperties
URL: https://generaltranslation.com/ru/docs/next/api/helpers/use-locale-properties.mdx
---
title: useLocaleProperties
description: Справка по API хука useLocaleProperties
---

{/* АВТОМАТИЧЕСКИ СГЕНЕРИРОВАНО: Не редактируйте напрямую. Вместо этого отредактируйте шаблон в content/docs-templates/. */}


## Обзор

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

<Callout>
  `useLocaleProperties` — это клиентский хук и *может использоваться только в клиентских компонентах*.
  Убедитесь, что приложение обёрнуто в [`<GTProvider>`](/docs/next/api/components/gtprovider).
</Callout>

## Справка

### Параметры

| Параметр | Тип      | Описание                                                   |
| -------- | -------- | ---------------------------------------------------------- |
| `locale` | `string` | Код локали в формате BCP 47 (например, `'en-US'`, `'ja'`). |

### Возвращаемое значение

Объект `LocaleProperties` со следующими полями:

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

***

## Примеры

### Основы использования

```jsx title="LocaleInfo.jsx" copy
'use client';
import { useLocaleProperties } from 'gt-next';
import { useLocale } from 'gt-next';

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

***


## Примечания

* Этот хук синхронный — он сразу возвращает свойства.
* Полезно для создания пользовательских селекторов локали или отображения пользователям метаданных локали.

## Следующие шаги

* Подробнее о [кодах локалей](/docs/core/locales).