When someone interacts with a webpage, the browser sends events to the relevant JavaScript code. The popstate event happens when the active session history entry changes.
When popstate happens
The active session history entry changes.
You can listen for it using addEventListener(). That keeps event handling separate from HTML attributes such as onclick and works well with modern code organization.
A small working example
<p>Try the relevant browser action described below.</p>
<p id="event-status" role="status">Waiting for popstate...</p>
<script>
const eventTarget = window;
const eventStatus = document.getElementById("event-status");
if (eventTarget) {
eventTarget.addEventListener("popstate", (eventDetails) => {
eventStatus.textContent = "popstate event received";
console.log(eventDetails.type, eventDetails.target);
});
}
</script>
Reading the code
The browser listens for popstate on the relevant target. When the event occurs, the callback receives eventDetails, updates the status message and logs the event name and target in Developer Tools.
Navigate back after pushState; pushState itself does not fire popstate.
eventDetails.state comes from the active session history entry created by the History API.
Some events need a specific browser condition, another tab or window, or a Web Component to reproduce. Read the trigger steps carefully before deciding that an event handler is not working.
Try it in your browser
Open the page, show the Console panel, and follow this test: Navigate back after pushState; pushState itself does not fire popstate. Then change one thing in the example and observe whether the event still fires.
Common Beginner Mistakes
- Expecting
popstateto fire without its required user action or browser condition. - Navigate back after pushState; pushState itself does not fire popstate.
- Adding repeated event listeners without considering cleanup or unwanted side effects.
Key Takeaways
popstatereports the active session history entry changes.addEventListener("popstate", ...)listens for the event on the appropriate target.- Navigate back after pushState; pushState itself does not fire popstate.