ContextQMD
Back to Content

PopStateEvent

files/en-us/web/api/popstateevent/index.md

latest1.5 KB
Original Source

{{APIRef("History API")}}

PopStateEvent is an interface for the {{domxref("Window/popstate_event", "popstate")}} event.

A popstate event is dispatched to the window every time the active history entry changes between two history entries for the same document. If the history entry being activated was created by a call to history.pushState() or was affected by a call to history.replaceState(), the popstate event's state property contains a copy of the history entry's state object.

{{InheritanceDiagram}}

Constructor

  • {{domxref("PopStateEvent.PopStateEvent", "PopStateEvent()")}}
    • : Creates a new PopStateEvent object.

Instance properties

This interface also inherits the properties of its parent, {{domxref("Event")}}.

  • {{domxref("PopStateEvent.state")}} {{ReadOnlyInline}}
    • : Returns a copy of the information that was provided to pushState() or replaceState().
  • {{domxref("PopStateEvent.hasUAVisualTransition", "hasUAVisualTransition")}} {{ReadOnlyInline}}
    • : Returns true if the user agent performed a visual transition for this navigation before dispatching this event, or false otherwise.

Instance methods

This interface has no methods of its own, but inherits the methods of its parent, {{domxref("Event")}}.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also