# vue: useLocale
URL: https://generaltranslation.com/ru/docs/vue/reference/composables/use-locale.mdx
---

title: useLocale
description: Получает активную локаль. Справочник API для useLocale.

---

Компонуемая функция `useLocale` возвращает активную локаль установленного плагина в виде доступного только для чтения ref Vue. Значение — код локали, например `en` или `fr-CA`.

## Обзор [#overview]

В шаблонах Vue ref разворачивается автоматически:

```vue
<script setup lang="ts">
import { useLocale } from 'gt-vue';

const locale = useLocale();
</script>

<template>
  <p>Current locale: {{ locale }}</p>
</template>
```

В коде скрипта используйте `locale.value`.

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

* При использовании плагина [`createGT()`](/docs/vue/reference/functions/create-gt) ref обновляется после успешной смены локали без перезагрузки страницы.
* При использовании плагина, возвращаемого [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa), локаль остаётся закреплённой для текущей страницы. [`useSetLocale()`](/docs/vue/reference/composables/use-set-locale) сохраняет новую локаль и перезагружает документ, после чего она становится доступна при инициализации следующей страницы.
* Вызов компонуемой функции без установленного плагина выбрасывает исключение.

Cookie-файл локали браузера не является реактивным источником событий. Изменяйте локаль с помощью [`useSetLocale()`](/docs/vue/reference/composables/use-set-locale), а не записывая `document.cookie` напрямую.

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

`useLocale` не принимает параметров.

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

**Тип** `Readonly<Ref<string>>`

Доступный только для чтения ref, содержащий активную локаль. Vue автоматически разворачивает её в шаблонах; в коде JavaScript и TypeScript используется `.value`.

```ts
const locale = useLocale();

console.log(locale.value);
```

## Пример [#example]

```vue title="CurrentLocale.vue"
<script setup lang="ts">
import { computed } from 'vue';
import { useLocale } from 'gt-vue';

const locale = useLocale();
const language = computed(() => locale.value.split('-')[0]);
</script>

<template>
  <p>Locale: {{ locale }}</p>
  <p>Language: {{ language }}</p>
</template>
```