PageTransitionEvent: PageTransitionEvent() constructor

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

The PageTransitionEvent() constructor creates a new PageTransitionEvent object, that is used by the pageshow or pagehide events, fired at the window object when a page is loaded or unloaded.

Note: A web developer doesn't typically need to call this constructor, as the browser creates these objects itself when firing pageshow or pagehide events.

Syntax

js
new PageTransitionEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to pageshow or pagehide.

options Optional

An object that, in addition to the properties defined in Event(), has the following property:

persisted Optional

A boolean indicating if the document is loading from a cache.

Return value

A new PageTransitionEvent object.

Specifications

Specification
HTML Standard
# the-pagetransitionevent-interface

Browser compatibility

BCD tables only load in the browser

See also