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

title: useLocale
description: Lit le paramètre régional actif. Référence de l’API de useLocale.

---

Le composable `useLocale` renvoie le paramètre régional actif du plugin installé sous la forme d’une ref Vue en lecture seule. La valeur est un code de langue tel que `en` ou `fr-CA`.

## Vue d’ensemble [#overview]

Les modèles Vue déréférencent automatiquement les refs :

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

const locale = useLocale();
</script>

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

Dans le script, lisez `locale.value`.

## Fonctionnement [#how-it-works]

* Avec un plugin [`createGT()`](/docs/vue/reference/functions/create-gt), la ref se met à jour après un changement de paramètre régional réussi, sans rechargement de la page.
* Avec un plugin renvoyé par [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa), le paramètre régional reste épinglé pour la page actuelle. [`useSetLocale()`](/docs/vue/reference/composables/use-set-locale) enregistre le nouveau paramètre régional et recharge le document ; il est ensuite exposé lors de l&#39;initialisation de la page suivante.
* Appeler le composable sans avoir installé de plugin génère une erreur.

Le cookie de paramètre régional du navigateur n&#39;est pas une source d&#39;événements réactive. Modifiez le paramètre régional via [`useSetLocale()`](/docs/vue/reference/composables/use-set-locale) plutôt que d&#39;écrire directement dans `document.cookie`.

## Paramètres [#parameters]

`useLocale` ne prend aucun paramètre.

## Renvoie [#returns]

**Type** `Readonly<Ref<string>>`

Une ref en lecture seule contenant le paramètre régional actif. Vue la désencapsule dans les modèles ; le code JavaScript et TypeScript utilise `.value`.

```ts
const locale = useLocale();

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

## Exemple [#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>
```