Navigation : méthode forward()

Syntaxe

forward(options)

Paramètres

options Facultatif

Un objet d'options contenant les propriétés suivantes :

info Facultatif

L'information définie par le·la développeur·euse à transmettre à l'évènement navigate, rendue disponible dans NavigateEvent.info. Cela peut être de n'importe quel type de données. Par exemple, vous pouvez vouloir afficher le contenu nouvellement navigué avec une animation différente selon la manière dont il a été navigué (glisser à gauche, glisser à droite ou aller à l'accueil). Une chaîne de caractères indiquant quelle animation utiliser peut être transmise en tant que info.

Valeur de retour

Un objet avec les propriétés suivantes :

committed

Une promesse (Promise) qui est complétée lorsque l'URL visible a changé et qu'une nouvelle NavigationHistoryEntry a été créée.

finished

Une promesse (Promise) qui est complétée lorsque toutes les promesses retournées par le gestionnaire NavigateEvent.intercept() sont complétées. Cela équivaut à la complétion de la promesse NavigationTransition.finished, lorsque l'évènement navigatesuccess se déclenche.

Chacune de ces promesses se rompt si la navigation a échoué pour une raison quelconque.

Exceptions

InvalidStateError DOMException

Levée si la valeur NavigationHistoryEntry.index de Navigation.currentEntry est -1 ou navigation.entries().length - 1, c'est-à-dire si le Document actuel n'est pas encore actif, ou si l'entrée d'historique actuelle est la dernière de l'historique, ce qui signifie que la navigation vers l'avant n'est pas possible, ou si le Document actuel est en cours de déchargement.

Exemples

async function gestionEnArriere() {
  if (navigation.canGoBack) {
    await navigation.back().finished;
    // HanGère le nettoyage nécessaire après
    // que la navigation est terminée
  } else {
    displayBanner("Vous êtes sur la première page");
  }
}

async function gestionEnAvant() {
  if (navigation.canGoForward) {
    await navigation.forward().finished;
    // Gère le nettoyage nécessaire après
    // que la navigation est terminée
  } else {
    displayBanner("Vous êtes sur la dernière page");
  }
}

Spécifications

Compatibilité des navigateurs

Voir aussi

• Routage moderne côté client : l'API Navigation ^(angl.)
• Présentation de l'API Navigation ^(angl.)