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

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

---

Le composable `useSetLocale` renvoie le setter asynchrone permettant de définir le paramètre régional du plugin installé. Son comportement en matière de chargement et de navigation dépend de la manière dont ce plugin a été créé.

## Vue d’ensemble [#overview]

Appelez la fonction renvoyée avec le paramètre régional cible :

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

const setLocale = useSetLocale();
</script>

<template>
  <button @click="setLocale('fr')">Français</button>
</template>
```

Utilisez [`useLocale()`](/docs/vue/reference/composables/use-locale) pour récupérer le paramètre régional actif.

## Fonctionnement [#how-it-works]

### Plugins réactifs

Pour un plugin [`createGT()`](/docs/vue/reference/functions/create-gt), le setter :

1. Charge un catalogue cible non mis en cache via le loader configuré.
2. Enregistre le paramètre régional cible dans le cookie configuré une fois le chargement terminé avec succès.
3. Met à jour les consommateurs réactifs sans recharger la page.

Les catalogues chargés avec succès restent en cache. Les requêtes simultanées peuvent se terminer dans n&#39;importe quel ordre, mais seule la requête la plus récente modifie le paramètre régional actif. Si le chargement de son catalogue échoue, la promesse est rejetée et le paramètre régional actuel ainsi que le cookie restent inchangés.

### Plugins SPA pour navigateur

Pour le document unique renvoyé par [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa), le setter résout le paramètre régional demandé par rapport à la liste des paramètres régionaux configurés lorsqu’elle est fournie, écrit le cookie et recharge le document. Il ne charge pas le catalogue cible sur la page actuelle, dont le paramètre régional reste épinglé jusqu’au rechargement. Le rechargement permet aux appels à [`t()`](/docs/vue/reference/functions/t) au niveau du module de s’exécuter à nouveau une fois le nouveau catalogue préchargé.

## Paramètres [#parameters]

`useSetLocale` n’accepte aucun paramètre.

## Renvoie [#returns]

**Type** `(locale: string) => Promise<void>`

Un accesseur asynchrone acceptant le paramètre suivant :

| Paramètre           | Description                       | Type     | Facultatif | Par défaut |
| ------------------- | --------------------------------- | -------- | ---------- | ---------- |
| [`locale`](#locale) | Code de langue cible. | `string` | Non        | —          |

### `locale`

**Type** `string` · **Obligatoire**

Le code de langue du paramètre régional cible. Un plugin réactif [`createGT()`](/docs/vue/reference/functions/create-gt) accepte tout code que son loader peut gérer. Lorsqu&#39;un plugin [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa) dispose d&#39;une liste `locales` configurée, il reconnaît ces paramètres régionaux et les alias configurés, et utilise son paramètre régional par défaut si la requête n&#39;est pas prise en charge.

## Exemple [#example]

Attendez que les modifications réactives soient appliquées lorsque le code qui suit dépend du nouveau paramètre régional :

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

const locale = useLocale();
const setLocale = useSetLocale();

async function changeLocale(event: Event) {
  const target = event.target as HTMLSelectElement;
  await setLocale(target.value);
}
</script>

<template>
  <select :value="locale" @change="changeLocale">
    <option value="en">English</option>
    <option value="fr">Français</option>
    <option value="ja">日本語</option>
  </select>
</template>
```

Dans une SPA initialisée avec [`initializeGTSPA()`](/docs/vue/reference/functions/initialize-gt-spa), le rechargement du document démarre lors de l’appel ; ne planifiez donc pas de tâches sur la même page en supposant que le paramètre régional cible est déjà actif.