This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

PopStateEvent

Summary

Fires when a history entry changes.

Inherits from EventEvent

Properties

state
The current history entry’s state object (if any).

Methods

initPopStateEvent
Initializes the properties of a PopStateEvent.

Events

popstate
An event handler that is fired when changes are made to the active history. Calls to pushState or replaceState can trigger this event.

Inherited from Event

Properties

bubbles
Gets a value that indicates whether an event propagates up from the event target.
cancelable
Gets a value that indicates whether you can cancel an event’s default action.
currentTarget
Gets the event target that is currently being processed.
defaultPrevented
Gets whether the default action should be canceled.
eventPhase
Gets the event phase that is being evaluated.
isTrusted
Gets a value that indicates whether a trusted event source created an event.
target
Gets the element that is the original target of the event.
timeStamp
Gets the time, in milliseconds, when an event occurred.
type
Gets the name of an event.

Methods

initEvent
Initializes a new generic event that the createEvent method created.
preventDefault
Cancels the default action of an event, if possible.
stopImmediatePropagation
Prevents any further propagation of an event.
stopPropagation
Prevents propagation of an event beyond the current target.

Events

DOMContentLoaded
:

afterprint
:

afterupdate
:

beforeactivate
:

beforecopy
:

beforecut
:

beforeeditfocus
:

beforepaste
:

beforeprint
:

beforeunload
:

beforeupdate
:

bounce
:

cellchange
:

change
:

contextmenu
:

controlselect
:

copy
:

cut
Fires after a data selection is cut to the clipboard.
dataavailable
Fires when new data at a data source becomes available.
datasetchanged
Fires when content at a data source has changed.
datasetcomplete
Fires when data transfer from the data source has completed.
deactivate
Sets an active version of an object to not active.
error
Fires when an error occurs.
errorupdate
Executes any error handling associated with the event.

filterchange
:

finish
:

Examples

window.onpopstate = function(evt) { document.write("location: " + document.location + ", state: " + JSON.stringify(evt.state)); };

Usage

 Used, for example to prevent back navigation to a login page after the user has already logged in.

Notes

Remarks

A pop state event is dispatched to the window object every time the active history entry changes. To read the current history entry immediately, invoke history.state.

Related specifications

The History Interface
Recommendation

Attributions