summaryrefslogtreecommitdiffstats
path: root/dom/webidl/PageTransitionEvent.webidl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/webidl/PageTransitionEvent.webidl')
-rw-r--r--dom/webidl/PageTransitionEvent.webidl35
1 files changed, 35 insertions, 0 deletions
diff --git a/dom/webidl/PageTransitionEvent.webidl b/dom/webidl/PageTransitionEvent.webidl
new file mode 100644
index 0000000000..20bcd6f3f2
--- /dev/null
+++ b/dom/webidl/PageTransitionEvent.webidl
@@ -0,0 +1,35 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+/**
+ * The PageTransitionEvent interface is used for the pageshow and
+ * pagehide events, which are generic events that apply to both page
+ * load/unload and saving/restoring a document from session history.
+ */
+
+[Exposed=Window]
+interface PageTransitionEvent : Event
+{
+ constructor(DOMString type,
+ optional PageTransitionEventInit eventInitDict = {});
+
+ /**
+ * Set to true if the document has been or will be persisted across
+ * firing of the event. For example, if a document is being cached in
+ * session history, |persisted| is true for the PageHide event.
+ */
+ readonly attribute boolean persisted;
+
+ // Whether the document is in the middle of a frame swap.
+ [ChromeOnly]
+ readonly attribute boolean inFrameSwap;
+};
+
+dictionary PageTransitionEventInit : EventInit
+{
+ boolean persisted = false;
+ boolean inFrameSwap = false;
+};