title | slug | page-type | browser-compat |
---|---|---|---|
PopStateEvent.state |
Web/API/PopStateEvent/state |
web-api-instance-property |
api.PopStateEvent.state |
{{ APIRef("History API") }}
The state
read-only property of the {{domxref("PopStateEvent")}} interface represents the state stored when the event was created.
Practically it is a value provided by the call to {{domxref("history.pushState()")}} or {{domxref("history.replaceState()")}}
An object, or null
.
The code below logs the value of state
when using the
{{domxref("History.pushState","pushState()")}} method to push a value to the history.
// Log the state of
addEventListener("popstate", (event) => {
console.log("State received: ", event.state);
});
// Now push something on the stack
history.pushState({ name: "Example" }, "pushState example", "page1.html");
history.pushState(
{ name: "Another example" },
"pushState example",
"page1.html"
);
This will log:
State received: { name: "Example" }
State received: { name: "Another example" }
{{Specifications}}
{{Compat}}
- {{domxref("PopStateEvent()")}} constructor
- {{domxref("History.state")}}