feat: Add window events "pagehide" / "pageshow" (#1308)

MDN documentation at: https://developer.mozilla.org/en-US/docs/Web/API/Window/pagehide_event https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event By adding these events, it allows library users to use the familiar fireEvent & friends in their test environments to verify pagehide and pageshow behavior. Co-authored-by: Matan Borenkraout <Matanbobi@gmail.com>
testing-library · Apr 29, 2024 · 56543d5 · 56543d5
1 parent 47fe879
commit 56543d5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/__tests__/events.js b/src/__tests__/events.js
@@ -77,8 +77,8 @@ const eventTypes = [
     elementType: 'img',
   },
   {
-    type: '',
-    events: ['offline', 'online'],
+    type: 'Window',
+    events: ['offline', 'online', 'pageHide', 'pageShow'],
     elementType: 'window',
   },
   {

diff --git a/src/event-map.js b/src/event-map.js
@@ -372,6 +372,14 @@ export const eventMap = {
     EventType: 'Event',
     defaultInit: {bubbles: false, cancelable: false},
   },
+  pageHide: {
+    EventType: 'PageTransitionEvent',
+    defaultInit: {bubbles: true, cancelable: true},
+  },
+  pageShow: {
+    EventType: 'PageTransitionEvent',
+    defaultInit: {bubbles: true, cancelable: true},
+  },
 }
 
 export const eventAliasMap = {

diff --git a/types/events.d.ts b/types/events.d.ts
@@ -88,6 +88,8 @@ export type EventType =
   | 'lostPointerCapture'
   | 'offline'
   | 'online'
+  | 'pageHide'
+  | 'pageShow'
 
 export type FireFunction = (
   element: Document | Element | Window | Node,