fix: Fixed #2176 virtual keyboard bug

arnog · Nov 16, 2023 · c0b06b2 · c0b06b2
1 parent d2799ac
commit c0b06b2
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@
 - **#2159** Runtime error in sandboxed mode when in an iframe from different 
   origin
 - **#2175** Addressed some rendering issues with Safar where a fraction inside a `\left...\right` was vertically offset.
-
+- **#2176** Using the `[hide-keyboard]` virtual keycap would cause a runtime error.
 
 ## 0.96.0 (2023-11-14)
 

diff --git a/src/editor/commands.ts b/src/editor/commands.ts
@@ -162,14 +162,15 @@ export function perform(
  * Perform a command, but:
  * * focus the mathfield
  * * provide haptic and audio feedback
- * This is used by the virtual keyboard when command keys (delete, arrows, etc..)
- * are pressed.
+ * This is used by the virtual keyboard when command keys (delete, arrows,
+ *  etc..) are pressed.
  */
 
 function performWithFeedback(
-  mathfield: MathfieldPrivate,
+  mathfield: MathfieldPrivate | undefined,
   selector: SelectorPrivate
 ): boolean {
+  if (!mathfield) return false;
   mathfield.focus();
 
   if (MathfieldElement.keypressVibration && canVibrate())

diff --git a/src/virtual-keyboard/utils.ts b/src/virtual-keyboard/utils.ts
@@ -752,7 +752,7 @@ const KEYCAP_SHORTCUTS: Record<string, Partial<VirtualKeyboardKeycap>> = {
   },
   '[hide-keyboard]': {
     class: 'action',
-    command: ['performWithFeedback', 'hideVirtualKeyboard'],
+    command: ['hideVirtualKeyboard'],
     width: 1.5,
     label:
       '<svg class=svg-glyph-lg><use xlink:href=#svg-keyboard-down /></svg>',

diff --git a/src/virtual-keyboard/virtual-keyboard.ts b/src/virtual-keyboard/virtual-keyboard.ts
@@ -834,17 +834,24 @@ export class VirtualKeyboard implements VirtualKeyboardInterface, EventTarget {
   ): boolean {
     let selector: SelectorPrivate;
     let args: string[] = [];
+    let target = getCommandTarget(command);
+
     if (isArray(command)) {
       selector = command[0];
+      if (selector === 'performWithFeedback') {
+        command = command.slice(1) as [SelectorPrivate, ...any[]];
+        target = getCommandTarget(command);
+      }
       args = command.slice(1);
     } else selector = command;
 
     // Convert kebab case (like-this) to camel case (likeThis).
     selector = selector.replace(/-\w/g, (m) =>
       m[1].toUpperCase()
     ) as SelectorPrivate;
-    if (getCommandTarget(command) === 'virtual-keyboard')
-      return COMMANDS[selector]!.fn(...args);
+
+    if (target === 'virtual-keyboard')
+      return COMMANDS[selector]!.fn(undefined, ...args);
 
     this.sendMessage('execute-command', { command });
     return false;

diff --git a/test/smoke/index.html b/test/smoke/index.html
@@ -151,24 +151,25 @@ <h2>Latex to Speakable Text</h2>
           /^[a-zA-Z]+$/.test(s) ? "function" : "unknown",
       };
 
-      // mathVirtualKeyboard.layouts = {
-      //   rows: [
-      //     [
-      //       { width: 1.5, latex: '\\ce{H2O}' },
-      //       '+',
-      //       '-',
-      //       '\\times',
-      //       '\\frac{#@}{#?}',
-      //       '=',
-      //       '.',
-      //       '(',
-      //       ')',
-      //       '\\sqrt{#0}',
-      //       '#@^{#?}',
-      //     ],
-      //     ['1', '2', '3', '4', '5', '6', '7', '8', '9', '0'],
-      //   ],
-      // };
+      mathVirtualKeyboard.layouts = {
+        rows: [
+          [
+            "[hide-keyboard]",
+            { width: 1.5, latex: "\\ce{H2O}" },
+            "+",
+            "-",
+            "\\times",
+            "\\frac{#@}{#?}",
+            "=",
+            ".",
+            "(",
+            ")",
+            "\\sqrt{#0}",
+            "#@^{#?}",
+          ],
+          ["1", "2", "3", "4", "5", "6", "7", "8", "9", "0"],
+        ],
+      };
       // makeVirtualKeyboard([
       //   '\\operatorname*{arg~max}_#?}',
       //   '\\%',