refactor: Export KeyboardMover class with a static instance

Author: gonfunko

packages/blockly/core/bubbles/mini_workspace_bubble.ts

@@ -155,7 +155,9 @@ export class MiniWorkspaceBubble extends Bubble {
    */
   private bumpBlocksIntoBounds() {
     // Only bump for mouse-driven drags.
-    if (this.miniWorkspace.isDragging() && !KeyboardMover.isMoving()) return;
+    if (this.miniWorkspace.isDragging() && !KeyboardMover.mover.isMoving()) {
+      return;
+    }
 
     const MARGIN = 20;
 
@@ -187,11 +189,13 @@ export class MiniWorkspaceBubble extends Bubble {
    * mini workspace.
    */
   private updateBubbleSize() {
-    if (this.miniWorkspace.isDragging() && !KeyboardMover.isMoving()) return;
+    if (this.miniWorkspace.isDragging() && !KeyboardMover.mover.isMoving()) {
+      return;
+    }
 
     // Disable autolayout if a keyboard move is in progress to prevent the
     // mutator bubble from jumping around.
-    this.autoLayout &&= !KeyboardMover.isMoving();
+    this.autoLayout &&= !KeyboardMover.mover.isMoving();
 
     const currSize = this.getSize();
     const newSize = this.calculateWorkspaceSize();

packages/blockly/core/keyboard_nav/keyboard_mover.ts

@@ -32,7 +32,7 @@ const COMMIT_MOVE_SHORTCUT = 'commitMove';
  * Class responsible for coordinating keyboard-driven moves with the workspace
  * and dragging system.
  */
-class KeyboardMoverImplementation {
+export class KeyboardMover {
   /**
    * Object responsible for dragging workspace elements in response to move
    * commands.
@@ -70,6 +70,11 @@ class KeyboardMoverImplementation {
     this.abortMove();
   };
 
+  static mover = new KeyboardMover();
+
+  // Constructor is private to keep this class a singleton.
+  private constructor() {}
+
   /**
    * Returns true iff the given draggable is allowed to be moved.
    *
@@ -304,6 +309,3 @@ class KeyboardMoverImplementation {
     );
   }
 }
-
-const KeyboardMover = new KeyboardMoverImplementation();
-export {KeyboardMover};

packages/blockly/core/shortcut_items.ts

@@ -394,7 +394,7 @@ export function registerMovementShortcuts() {
       name: 'start_move',
       preconditionFn: (workspace) => {
         const startDraggable = getCurrentDraggable(workspace);
-        return !!startDraggable && KeyboardMover.canMove(startDraggable);
+        return !!startDraggable && KeyboardMover.mover.canMove(startDraggable);
       },
       callback: (workspace, e) => {
         keyboardNavigationController.setIsActive(true);
@@ -406,31 +406,33 @@ export function registerMovementShortcuts() {
         }
         return (
           !!startDraggable &&
-          KeyboardMover.startMove(startDraggable, e as KeyboardEvent)
+          KeyboardMover.mover.startMove(startDraggable, e as KeyboardEvent)
         );
       },
       keyCodes: [KeyCodes.M],
     },
     {
       name: 'finish_move',
-      preconditionFn: () => KeyboardMover.isMoving(),
-      callback: (_workspace, e) => KeyboardMover.finishMove(e as KeyboardEvent),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
+      callback: (_workspace, e) =>
+        KeyboardMover.mover.finishMove(e as KeyboardEvent),
       keyCodes: [KeyCodes.ENTER, KeyCodes.SPACE],
       allowCollision: true,
     },
     {
       name: 'abort_move',
-      preconditionFn: () => KeyboardMover.isMoving(),
-      callback: (_workspace, e) => KeyboardMover.abortMove(e as KeyboardEvent),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
+      callback: (_workspace, e) =>
+        KeyboardMover.mover.abortMove(e as KeyboardEvent),
       keyCodes: [KeyCodes.ESC],
       allowCollision: true,
     },
     {
       name: 'move_left',
-      preconditionFn: () => KeyboardMover.isMoving(),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
       callback: (_workspace, e) => {
         e.preventDefault();
-        return KeyboardMover.move(Direction.LEFT, e as KeyboardEvent);
+        return KeyboardMover.mover.move(Direction.LEFT, e as KeyboardEvent);
       },
       keyCodes: [
         KeyCodes.LEFT,
@@ -445,10 +447,10 @@ export function registerMovementShortcuts() {
     },
     {
       name: 'move_right',
-      preconditionFn: () => KeyboardMover.isMoving(),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
       callback: (_workspace, e) => {
         e.preventDefault();
-        return KeyboardMover.move(Direction.RIGHT, e as KeyboardEvent);
+        return KeyboardMover.mover.move(Direction.RIGHT, e as KeyboardEvent);
       },
       keyCodes: [
         KeyCodes.RIGHT,
@@ -463,10 +465,10 @@ export function registerMovementShortcuts() {
     },
     {
       name: 'move_up',
-      preconditionFn: () => KeyboardMover.isMoving(),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
       callback: (_workspace, e) => {
         e.preventDefault();
-        return KeyboardMover.move(Direction.UP, e as KeyboardEvent);
+        return KeyboardMover.mover.move(Direction.UP, e as KeyboardEvent);
       },
       keyCodes: [
         KeyCodes.UP,
@@ -481,10 +483,10 @@ export function registerMovementShortcuts() {
     },
     {
       name: 'move_down',
-      preconditionFn: () => KeyboardMover.isMoving(),
+      preconditionFn: () => KeyboardMover.mover.isMoving(),
       callback: (_workspace, e) => {
         e.preventDefault();
-        return KeyboardMover.move(Direction.DOWN, e as KeyboardEvent);
+        return KeyboardMover.mover.move(Direction.DOWN, e as KeyboardEvent);
       },
       keyCodes: [
         KeyCodes.DOWN,

packages/blockly/core/workspace_svg.ts

@@ -1490,7 +1490,7 @@ export class WorkspaceSvg
    */
   isDragging(): boolean {
     return (
-      KeyboardMover.isMoving() ||
+      KeyboardMover.mover.isMoving() ||
       (this.currentGesture_ !== null && this.currentGesture_.isDragging())
     );
   }
@@ -2449,7 +2449,7 @@ export class WorkspaceSvg
   getGesture(e?: PointerEvent): Gesture | null {
     // Ignore and cancel events that would start a gesture during a
     // keyboard-driven move.
-    if (KeyboardMover.isMoving()) {
+    if (KeyboardMover.mover.isMoving()) {
       e?.preventDefault();
       e?.stopPropagation();
       return null;

packages/blockly/tests/mocha/keyboard_movement_test.js

@@ -23,7 +23,7 @@ suite('Keyboard-driven movement', function () {
     const toolbox = document.getElementById('toolbox-simple');
     this.workspace = Blockly.inject('blocklyDiv', {toolbox: toolbox});
     Blockly.common.defineBlocks(p5blocks);
-    Blockly.KeyboardMover.setMoveDistance(20);
+    Blockly.KeyboardMover.mover.setMoveDistance(20);
   });
 
   teardown(function () {
@@ -320,7 +320,7 @@ suite('Keyboard-driven movement', function () {
       startMove(this.workspace);
       const steps = [100, 20, 0, -20, -100];
       for (const step of steps) {
-        Blockly.KeyboardMover.setMoveDistance(step);
+        Blockly.KeyboardMover.mover.setMoveDistance(step);
         const oldLeft = this.element.getBoundingRectangle().left;
         moveRight(this.workspace, this.modifiers);
         const newLeft = this.element.getBoundingRectangle().left;
@@ -335,15 +335,15 @@ suite('Keyboard-driven movement', function () {
       const oldBounds = this.element.getBoundingRectangle();
       Blockly.getFocusManager().focusNode(this.element);
       startMove(this.workspace);
-      assert.isTrue(Blockly.KeyboardMover.isMoving());
+      assert.isTrue(Blockly.KeyboardMover.mover.isMoving());
       moveRight(this.workspace, this.modifiers);
       moveRight(this.workspace, this.modifiers);
 
       const event = createKeyDownEvent(Blockly.utils.KeyCodes.C, [
         Blockly.utils.KeyCodes.META,
       ]);
       this.workspace.getInjectionDiv().dispatchEvent(event);
-      assert.isFalse(Blockly.KeyboardMover.isMoving());
+      assert.isFalse(Blockly.KeyboardMover.mover.isMoving());
 
       const newBounds = this.element.getBoundingRectangle();
       oldBounds.left += 40;