add getNumberFromCode to support number keys, #1053

phetsims · Jul 6, 2021 · 7f759c0 · 7f759c0
1 parent 960fd8e
commit 7f759c0
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/js/accessibility/KeyboardUtils.js b/js/accessibility/KeyboardUtils.js
@@ -152,6 +152,18 @@ const KeyboardUtils = {
     return KeyboardUtils.isAnyKeyEvent( domEvent, NUMBER_KEYS );
   },
 
+  /**
+   * For number keys, return the number of the key, or null if not a number
+   * @param {Event} domEvent
+   * @returns {null|number}
+   */
+  getNumberFromCode( domEvent ) {
+    if ( KeyboardUtils.isNumberKey( domEvent ) ) {
+      return Number( domEvent.code.replace( 'Digit', '' ) );
+    }
+    return null;
+  },
+
   /**
    * Event.code distinguishes between left and right shift keys. If all you care about is the presence
    * of a shift key you can use this.
@@ -216,7 +228,7 @@ const KeyboardUtils = {
    *
    * @param {Event} domEvent
    * @param {string[]} keyboardUtilsKeys
-   * @returns {*}
+   * @returns {boolean}
    */
   isAnyKeyEvent( domEvent, keyboardUtilsKeys ) {
     validate( domEvent, DOM_EVENT_VALIDATOR );