From 86181c0cda2f5b88ad9d6fee4775f885eae01461 Mon Sep 17 00:00:00 2001
From: Jesse <jesse.greenberg@colorado.edu>
Date: Fri, 26 Apr 2024 16:13:41 -0400
Subject: [PATCH] example of createGlobal, see
 https://github.com/phetsims/scenery/issues/1570

---
 doc/alternative-input-quickstart-guide.md | 23 ++++++++++++++++-------
 1 file changed, 16 insertions(+), 7 deletions(-)

diff --git a/doc/alternative-input-quickstart-guide.md b/doc/alternative-input-quickstart-guide.md
index 5ae9066e..50d4c7bb 100644
--- a/doc/alternative-input-quickstart-guide.md
+++ b/doc/alternative-input-quickstart-guide.md
@@ -219,29 +219,38 @@ functionality.
 
 ## Hotkeys
 
-Hotkeys are added with `KeyboardListener` like this:
+Hotkeys are added with `KeyboardListener`. A KeyboardListener can be added to a Node, and will fire its callback
+whenever the specified keys are pressed while the Node has focus. Here is an example:
 
 ```ts
 
 const keyboardListener = new KeyboardListener( {
   keys: [ 'escape', 'j+0' ],
-  callback: ( event, keysPressed, listener ) => {
+  fire: ( event, keysPressed, listener ) => {
     if ( keysPressed === 'escape' ) {
       // escape key was pressed
     }
     else if ( keysPressed === 'j+0' ) {
       // j and 0 were pressed
     }
-  },
-
-  // By making this listener "global" it will fire no matter where focus is in the document as long as
-  // myNode is visible and has input enabled. If this is false, callback will only fire when myNode has keyboard focus.
-  global: true
+  }
 } );
 
 myNode.addInputListener( keyboardListener );
 ```
 
+You can also add a global Hotkey that will fire regardless of which Node has focus. As long as the target Node can
+receive input events, the listener will fire. Here is an example:
+
+```ts
+const globalKeyboardListener = KeyboardListener.createGlobal( targetNode, {
+  keys: [ 'alt+r' ],
+  fire: ( event, keysPressed, listener ) => {
+    // alt+r was pressed
+  }
+} );
+```
+
 Be careful not to add hotkeys that collide with other global hotkeys defined by PhET such as hotkeys that pan and zoom
 into the sim. We need a list of global hotkeys or a way to automatically prevent collisions but do not have that yet. It
 will throw an assertion at runtime though if there is an overlap. See https://github.com/phetsims/phet-info/issues/188.