# gt-react: General Translation React SDK: useRegionSelector
URL: https://generaltranslation.com/ru/docs/react/api/helpers/use-region-selector.mdx
---
title: useRegionSelector
description: Справочная документация по API хука useRegionSelector
---

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


## Обзор

Хук `useRegionSelector` предоставляет данные и обработчики, необходимые для реализации пользовательского UI-компонента селектора региона. Он возвращает текущий регион, список доступных регионов, метаданные региона и функции для обновления региона или локали.

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

## Справочник

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

Необязательный объект конфигурации:

| Параметр                        | Тип        | По умолчанию | Описание                                                                                                                                                                                                                     |
| ------------------------------- | ---------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `regions`                       | `string[]` | —            | Необязательный массив кодов регионов ISO 3166 для отображения. Если не указан, регионы определяются по поддерживаемым локалям.                                                                                               |
| `customMapping`                 | `object`   | —            | Необязательное сопоставление для переопределения отображаемых названий регионов, эмодзи или связанных локалей. Значениями могут быть строка (отображаемое название) или объект со свойствами `name`, `emoji` и/или `locale`. |
| `prioritizeCurrentLocaleRegion` | `boolean`  | `true`       | Если `true`, регион, соответствующий текущей локали, будет иметь приоритет в списке.                                                                                                                                         |
| `sortRegionsAlphabetically`     | `boolean`  | `true`       | Если `true`, регионы сортируются по алфавиту по отображаемому названию.                                                                                                                                                      |

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

Объект, содержащий:

| Поле         | Тип                                     | Описание                                                                                     |
| ------------ | --------------------------------------- | -------------------------------------------------------------------------------------------- |
| `region`     | `string \| undefined`                   | Код текущего выбранного региона.                                                             |
| `setRegion`  | `(region: string \| undefined) => void` | Функция для обновления выбранного региона.                                                   |
| `regions`    | `string[]`                              | Массив доступных кодов регионов.                                                             |
| `regionData` | `Map<string, RegionData>`               | Сопоставление кодов регионов с их отображаемыми данными (`code`, `name`, `emoji`, `locale`). |
| `locale`     | `string`                                | Текущая локаль.                                                                              |
| `setLocale`  | `(locale: string) => void`              | Функция для обновления локали.                                                               |

***

## Примеры

### Создайте собственный селектор региона

```jsx title="CustomRegionSelector.jsx" copy
'use client';
import { useRegionSelector } from 'gt-react';

export default function CustomRegionSelector() {
  const { region, setRegion, regions, regionData } = useRegionSelector({ // [!code highlight]
    customMapping: { US: { name: "United States", emoji: "🇺🇸" } }, // [!code highlight]
  }); // [!code highlight]

  return (
    <select value={region} onChange={(e) => setRegion(e.target.value)}>
      {regions.map((r) => (
        <option key={r} value={r}>
          {regionData.get(r)?.emoji} {regionData.get(r)?.name}
        </option>
      ))}
    </select>
  );
}
```

***


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

* Если `regions` не указаны, доступные регионы определяются на основе поддерживаемых локалей, заданных в вашем [`gt.config.json`](/docs/react/api/config/gt-config-json).
* Для готового селектора региона используйте компонент [`<RegionSelector>`](/docs/react/api/components/region-selector).

## Что дальше

* См. [`<RegionSelector>`](/docs/react/api/components/region-selector) — готовый к использованию компонент выпадающего списка.
* См. [`useRegion`](/docs/react/api/helpers/use-region), чтобы узнать текущий регион.
* См. [`useLocaleSelector`](/docs/react/api/helpers/use-locale-selector) — аналог для локали.