Navigation: traverseTo() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The traverseTo()
method of the Navigation
interface navigates to the NavigationHistoryEntry
identified by the given key
.
Syntax
js
traverseTo(key)
traverseTo(key, options)
Parameters
key
-
The
key
of theNavigationHistoryEntry
to navigate to. options
Optional-
An options object containing the following properties:
info
-
Developer-defined information to be passed along to the
navigate
event, made available inNavigateEvent.info
. This can be any data type. You might, for example, wish to display newly-navigated content with a different animation depending on how it was navigated to (swipe left, swipe right, or go home). A string indicating which animation to use could be passed in asinfo
.
Return value
An object with the following properties:
committed
-
A
Promise
which will fulfill when the visible URL has changed and a newNavigationHistoryEntry
has been created. finished
-
A
Promise
which will fulfill when all promises returned by theintercept()
handler are fulfilled. This is equivalent to theNavigationTransition.finished
promise fulfilling, when thenavigatesuccess
event fires.
Either one of these promises rejects if the navigation has failed for some reason.
Exceptions
InvalidStateError
DOMException
-
Thrown if the
Navigation.currentEntry
'sNavigationHistoryEntry.index
value is -1, meaning the currentDocument
is not yet active, of if the navigation history list does not contain aNavigationHistoryEntry
with the specified key.
Examples
Set up home button
js
function initHomeBtn() {
// Get the key of the first loaded entry
// so the user can always go back to this view.
const { key } = navigation.currentEntry;
backToHomeButton.onclick = () => {
navigation.traverseTo(key);
};
}
// Intercept navigate events, such as link clicks, and
// replace them with single-page navigations
navigation.addEventListener("navigate", (event) => {
event.intercept({
async handler() {
// Navigate to a different view,
// but the "home" button will always work.
},
});
});
Specifications
Specification |
---|
Unknown specification # dom-navigation-traverseto |
Browser compatibility
BCD tables only load in the browser