NavigateEvent
Navigation API
Navigation API
The NavigateEvent interface of the Navigation API is the event object for the navigate event, which fires when any type of navigation is initiated (this includes usage of History API features like History.go()). NavigateEvent provides access to information about that navigation, and allows developers to intercept and control the navigation handling.
Constructor
- NavigateEvent()
- : Creates a new
NavigateEventobject instance.
Instance properties
Inherits properties from its parent, Event.
- canIntercept
- : Returns
trueif the navigation can be intercepted, orfalseotherwise (e.g., you can't intercept a cross-origin navigation). - destination
- : Returns a NavigationDestination object representing the destination being navigated to.
- downloadRequest
- : Returns the filename of the file requested for download, in the case of a download navigation (e.g., an a or area element with a
downloadattribute), ornullotherwise. - formData
- : Returns the FormData object representing the submitted data in the case of a
POSTform submission, ornullotherwise. - hashChange
- : Returns
trueif the navigation is a fragment navigation (i.e., to a fragment identifier in the same document), orfalseotherwise. - hasUAVisualTransition
- : Returns
trueif the user agent performed a visual transition for this navigation before dispatching this event, orfalseotherwise. - info
- : Returns the
infodata value passed by the initiating navigation operation (e.g., Navigation.back(), or Navigation.navigate()), orundefinedif noinfodata was passed. - navigationType
- : Returns the type of the navigation —
push,reload,replace, ortraverse. - signal
- : Returns an AbortSignal, which will become aborted if the navigation is canceled (e.g., by the user pressing the browser's "Stop" button, or another navigation starting and thus canceling the ongoing one).
- sourceElement
- : When the navigation was initiated by an element (for example clicking a link), returns an Element object representing the initiating element.
- userInitiated
- : Returns
trueif the navigation was initiated by the user (e.g., by clicking a link, submitting a form, or pressing the browser's "Back"/"Forward" buttons), orfalseotherwise.
Instance methods
Inherits methods from its parent, Event.
- intercept()
- : Intercepts this navigation, turning it into a same-document navigation to the destination URL. It can accept handler functions that define what the navigation handling behavior should be, plus
focusResetandscrolloptions to enable or disable the browser's default focus and scrolling behavior as desired. - scroll()
- : Can be called to manually trigger the browser-driven scrolling behavior that occurs in response to the navigation, if you want it to happen before the navigation handling has completed.
Examples
Handling a navigation using intercept()
navigation.addEventListener("navigate", (event) => {
// Exit early if this navigation shouldn't be intercepted,
// e.g. if the navigation is cross-origin, or a download request
if (shouldNotIntercept(event)) return;
const url = new URL(event.destination.url);
if (url.pathname.startsWith("/articles/")) {
event.intercept({
async handler() {
// The URL has already changed, so show a placeholder while
// fetching the new content, such as a spinner or loading page
renderArticlePagePlaceholder();
// Fetch the new content and display when ready
const articleContent = await getArticleContent(url.pathname);
renderArticlePage(articleContent);
},
});
}
});
[!NOTE] Before the Navigation API was available, to do something similar you'd have to listen for all click events on links, run
e.preventDefault(), perform the appropriate History.pushState() call, then set up the page view based on the new URL. And this wouldn't handle all navigations — only user-initiated link clicks.
Handling scrolling using scroll()
In this example of intercepting a navigation, the handler() function starts by fetching and rendering some article content, but then fetches and renders some secondary content afterwards. It makes sense to scroll the page to the main article content as soon as it is available so the user can interact with it, rather than waiting until the secondary content is also rendered. To achieve this, we have added a scroll() call between the two.
navigation.addEventListener("navigate", (event) => {
if (shouldNotIntercept(event)) return;
const url = new URL(event.destination.url);
if (url.pathname.startsWith("/articles/")) {
event.intercept({
async handler() {
const articleContent = await getArticleContent(url.pathname);
renderArticlePage(articleContent);
event.scroll();
const secondaryContent = await getSecondaryContent(url.pathname);
addSecondaryContent(secondaryContent);
},
});
}
});