Formations — 1 037 leçons en français

Accueil › Vue.js › Gardes de navigation

Gardes de navigation

Vue Routerintermediaire

Une garde est une fonction appelée avant qu'une navigation soit confirmée. Elle peut laisser passer, annuler, ou rediriger.

router.beforeEach((to, from) => {
  const protegee = to.matched.some((r) => r.meta.authentification)
  if (protegee && !session.connecte) {
    return { name: 'connexion', query: { suite: to.fullPath } }
  }
})

Trois niveaux existent, du plus large au plus précis. router.beforeEach vaut pour toutes les navigations. beforeEnter, déclaré sur une route, ne vaut que pour l'entrée dans cette route. onBeforeRouteLeave, appelé dans un composant, protège sa sortie.

{ path: '/admin', component: Admin, beforeEnter: (to) => session.role === 'admin' }
<script setup>
import { onBeforeRouteLeave } from 'vue-router'

onBeforeRouteLeave(() => {
  if (modifie.value) return confirm('Quitter sans enregistrer ?')
})
</script>

La valeur de retour commande. undefined ou true laisse passer. false annule et laisse l'URL où elle était. Un objet de destination redirige.

Le piège à connaître avant d'écrire la première garde est la boucle : beforeEach s'exécute aussi pour la navigation qu'elle déclenche elle-même. Rediriger vers la connexion sans exclure la connexion tourne en rond.

Dernier point, de conception : une garde décide à partir de ce que porte l'URL. C'est pourquoi l'URL doit porter l'état partageable et rechargeable, et lui seul.

Les termes à connaître

Garde globale

Une fonction enregistrée avec router.beforeEach, exécutée avant chaque navigation, quelle que soit la route visée.

beforeEnter

Une garde déclarée sur une route précise. Elle ne s'exécute que lorsqu'on entre dans cette route depuis une autre.

onBeforeRouteLeave

Le composable qui enregistre une garde dans le composant quitté. Il sert à retenir l'utilisateur sur un formulaire non enregistré.

Redirection

Le fait, pour une garde, de renvoyer un objet de destination au lieu de laisser passer. La navigation en cours est abandonnée au profit de la nouvelle.

Boucle de redirection

Une garde qui redirige vers une route elle-même interceptée par la même garde, sans condition d'arrêt.

meta

Un objet libre attaché à une route, lisible dans les gardes via to.meta ou via to.matched.

État partageable

Un état porté par l'URL, donc restituable à l'identique par copie du lien ou par rechargement de la page.

Lire l'explication détaillée et faire le quiz →

Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.