The History API provides access to the browser's session history (not to be confused with WebExtensions history) through the history
global object. It exposes useful methods and properties that let you navigate back and forth through the user's history, and manipulate the contents of the history stack.
Note: This API is only available on the main thread (Window
). It cannot be accessed in Worker
or Worklet
contexts.
Moving backward and forward through the user's history is done using the back()
, forward()
, and go()
methods.
To move backward through history:
This acts exactly as if the user clicked on the Back button in their browser toolbar.
Similarly, you can move forward (as if the user clicked the Forward button), like this:
You can use the go()
method to load a specific page from session history, identified by its relative position to the current page. (The current page's relative position is 0
.)
To move back one page (the equivalent of calling back()
):
To move forward a page, just like calling forward()
:
Similarly, you can move forward 2 pages by passing 2
, and so forth.
Another use for the go()
method is to refresh the current page by either passing 0
, or by invoking it without an argument:
history.go(0);
history.go();
You can determine the number of pages in the history stack by looking at the value of the length
property:
const numberOfEntries = history.length;
The following example assigns a listener for the popstate
event. It then illustrates some of the methods of the history object to add, replace, and move within the browser history for the current tab.
window.addEventListener("popstate", (event) => {
alert(
`location: ${document.location}, state: ${JSON.stringify(event.state)}`,
);
});
history.pushState({ page: 1 }, "title 1", "?page=1");
history.pushState({ page: 2 }, "title 2", "?page=2");
history.replaceState({ page: 3 }, "title 3", "?page=3");
history.back();
history.back();
history.go(2);