attach globalKeyStateTracker listeners via scenery input, #1445

phetsims · Oct 26, 2022 · 786d7e4 · 786d7e4
1 parent 168b469
commit 786d7e4
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/js/accessibility/KeyStateTracker.ts b/js/accessibility/KeyStateTracker.ts
@@ -382,8 +382,8 @@ class KeyStateTracker {
     const addListenersToDocument = () => {
 
       // attach with useCapture so that the keyStateTracker is updated before the events dispatch within Scenery
-      window.addEventListener( 'keyup', this.documentKeyupListener!, true );
-      window.addEventListener( 'keydown', this.documentKeydownListener!, true );
+      window.addEventListener( 'keyup', this.documentKeyupListener!, { capture: true } );
+      window.addEventListener( 'keydown', this.documentKeydownListener!, { capture: true } );
       this.attachedToDocument = true;
     };
 

diff --git a/js/accessibility/globalKeyStateTracker.ts b/js/accessibility/globalKeyStateTracker.ts
@@ -15,7 +15,6 @@ import { KeyStateTrackerOptions } from './KeyStateTracker.js';
 class GlobalKeyStateTracker extends KeyStateTracker {
   public constructor( options?: KeyStateTrackerOptions ) {
     super( options );
-    this.attachToWindow();
   }
 }
 

diff --git a/js/input/BrowserEvents.js b/js/input/BrowserEvents.js
@@ -8,11 +8,14 @@
 
 import arrayRemove from '../../../phet-core/js/arrayRemove.js';
 import platform from '../../../phet-core/js/platform.js';
-import { BatchedDOMEventType, Display, Features, PDOMUtils, scenery } from '../imports.js';
+import { BatchedDOMEventType, Display, Features, globalKeyStateTracker, PDOMUtils, scenery } from '../imports.js';
 
 // Sometimes we need to add a listener that does absolutely nothing
 const noop = () => {};
 
+// Ensure we only attach global window listeners (display independent) once
+let isGloballyAttached = false;
+
 const BrowserEvents = {
   /**
    * Adds a Display to the list of displays that will be notified of input events.
@@ -29,6 +32,14 @@ const BrowserEvents = {
     assert && assert( !_.includes( this.attachedDisplays, display ),
       'A display cannot be concurrently attached to events more than one time' );
 
+    // Always first please
+    if ( !isGloballyAttached ) {
+      isGloballyAttached = true;
+
+      // never unattach because we don't know if there are other Displays listening to this.
+      globalKeyStateTracker.attachToWindow();
+    }
+
     this.attachedDisplays.push( display );
 
     if ( attachToWindow ) {