Merge branch 'main' into block-comment-nav

gonfunko · web-flow · commit b03791d768d5 · 2025-07-18T14:48:05.000-07:00
diff --git a/src/actions/action_menu.ts b/src/actions/action_menu.ts
@@ -86,9 +86,7 @@ export class ActionMenu {
     // TODO(#362): Pass this through the precondition and callback instead of making it up.
     const menuOpenEvent = new KeyboardEvent('keydown');
 
-    const cursor = workspace.getCursor();
-    if (!cursor) throw new Error('workspace has no cursor');
-    const node = cursor.getCurNode();
+    const node = workspace.getCursor().getCurNode();
     if (!node) return false;
     // TODO(google/blockly#8847): Add typeguard for IContextMenu in core when this moves over
     if (
diff --git a/src/actions/arrow_navigation.ts b/src/actions/arrow_navigation.ts
@@ -38,11 +38,7 @@ export class ArrowNavigation {
     workspace: WorkspaceSvg,
     shortcut: ShortcutRegistry.KeyboardShortcut,
   ): boolean {
-    const cursor = workspace.getCursor();
-    if (!cursor || !cursor.getCurNode()) {
-      return false;
-    }
-    const curNode = cursor.getCurNode();
+    const curNode = workspace.getCursor().getCurNode();
     if (curNode instanceof Field) {
       return curNode.onShortcut(shortcut);
     }
@@ -70,7 +66,7 @@ export class ArrowNavigation {
             if (
               !this.navigation.defaultWorkspaceCursorPositionIfNeeded(workspace)
             ) {
-              workspace.getCursor()?.in();
+              workspace.getCursor().in();
             }
             isHandled = true;
           }
@@ -103,7 +99,7 @@ export class ArrowNavigation {
             if (
               !this.navigation.defaultWorkspaceCursorPositionIfNeeded(workspace)
             ) {
-              workspace.getCursor()?.out();
+              workspace.getCursor().out();
             }
             isHandled = true;
           }
@@ -169,7 +165,7 @@ export class ArrowNavigation {
                     workspace,
                   )
                 ) {
-                  workspace.getCursor()?.next();
+                  workspace.getCursor().next();
                 }
                 isHandled = true;
               }
@@ -182,7 +178,7 @@ export class ArrowNavigation {
                     workspace.targetWorkspace,
                   )
                 ) {
-                  workspace.getCursor()?.next();
+                  workspace.getCursor().next();
                 }
                 isHandled = true;
               }
@@ -232,7 +228,7 @@ export class ArrowNavigation {
                     'last',
                   )
                 ) {
-                  workspace.getCursor()?.prev();
+                  workspace.getCursor().prev();
                 }
                 isHandled = true;
               }
@@ -246,7 +242,7 @@ export class ArrowNavigation {
                     'last',
                   )
                 ) {
-                  workspace.getCursor()?.prev();
+                  workspace.getCursor().prev();
                 }
                 isHandled = true;
               }
diff --git a/src/actions/disconnect.ts b/src/actions/disconnect.ts
@@ -78,7 +78,6 @@ export class DisconnectAction {
    */
   disconnectBlocks(workspace: WorkspaceSvg) {
     const cursor = workspace.getCursor();
-    if (!cursor) return;
     const curNode = cursor.getCurNode();
     if (!(curNode instanceof BlockSvg)) return;
 
diff --git a/src/actions/edit.ts b/src/actions/edit.ts
@@ -4,12 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import {
-  ContextMenuRegistry,
-  LineCursor,
-  Msg,
-  keyboardNavigationController,
-} from 'blockly';
+import {ContextMenuRegistry, Msg, keyboardNavigationController} from 'blockly';
 import {Navigation} from 'src/navigation';
 import {getMenuItem} from '../shortcut_formatting';
 import * as Constants from '../constants';
@@ -67,7 +62,7 @@ export class EditAction {
         if (!workspace || !this.navigation.canCurrentlyNavigate(workspace)) {
           return 'disabled';
         }
-        const cursor = workspace.getCursor() as LineCursor | null;
+        const cursor = workspace.getCursor();
         if (!cursor) return 'disabled';
         return cursor.atEndOfLine() ? 'hidden' : 'enabled';
       },
diff --git a/src/actions/enter.ts b/src/actions/enter.ts
@@ -117,8 +117,7 @@ export class EnterAction {
   private shouldHandleEnterForWS(workspace: WorkspaceSvg): boolean {
     if (!this.navigation.canCurrentlyNavigate(workspace)) return false;
 
-    const cursor = workspace.getCursor();
-    const curNode = cursor?.getCurNode();
+    const curNode = workspace.getCursor().getCurNode();
     if (!curNode) return false;
     if (curNode instanceof Field) return curNode.isClickable();
     if (
@@ -144,7 +143,7 @@ export class EnterAction {
    */
   private handleEnterForWS(workspace: WorkspaceSvg): boolean {
     const cursor = workspace.getCursor();
-    const curNode = cursor?.getCurNode();
+    const curNode = cursor.getCurNode();
     if (!curNode) return false;
     if (curNode instanceof Field) {
       curNode.showEditor();
@@ -167,7 +166,7 @@ export class EnterAction {
       curNode.onClick();
       renderManagement.finishQueuedRenders().then(() => {
         if (hasBubble(curNode) && curNode.bubbleIsVisible()) {
-          cursor?.in();
+          cursor.in();
         }
       });
       return true;
diff --git a/src/actions/move.ts b/src/actions/move.ts
@@ -260,7 +260,7 @@ export class MoveActions {
     const node = getFocusManager().getFocusedNode();
     if (node instanceof comments.RenderedWorkspaceComment) return node;
 
-    let block = workspace?.getCursor()?.getSourceBlock();
+    let block = workspace.getCursor().getSourceBlock();
     if (!block) return undefined;
     while (block.isShadow()) {
       block = block.getParent();
diff --git a/src/actions/mover.ts b/src/actions/mover.ts
@@ -160,7 +160,7 @@ export class Mover {
     // In case a block is detached, ensure that it still retains focus
     // (otherwise dragging will break). This is also the point a new block's
     // initial insert position is scrolled into view.
-    workspace.getCursor()?.setCurNode(draggable);
+    workspace.getCursor().setCurNode(draggable);
     draggable.getFocusableElement().addEventListener('blur', blurListener);
 
     // Register a keyboard shortcut under the key combos of all existing
@@ -257,7 +257,7 @@ export class Mover {
     );
 
     if (dragStrategy.moveType === MoveType.Insert && target) {
-      workspace.getCursor()?.setCurNode(target);
+      workspace.getCursor().setCurNode(target);
     }
 
     this.postDragEndCleanup(workspace, info);
diff --git a/src/actions/ws_movement.ts b/src/actions/ws_movement.ts
@@ -119,11 +119,7 @@ export class WorkspaceMovement {
    * @param workspace The workspace the cursor is on.
    */
   createWSCursor(workspace: WorkspaceSvg) {
-    const cursor = workspace.getCursor();
-
-    if (!cursor) return false;
-
-    cursor.setCurNode(workspace);
+    workspace.getCursor().setCurNode(workspace);
     return true;
   }
 }
diff --git a/src/flyout_cursor.ts b/src/flyout_cursor.ts
@@ -89,8 +89,18 @@ export class FlyoutCursor extends Blockly.LineCursor {
 export const registrationType = Blockly.registry.Type.CURSOR;
 export const registrationName = 'FlyoutCursor';
 
-Blockly.registry.register(registrationType, registrationName, FlyoutCursor);
-
 export const pluginInfo = {
   [registrationType.toString()]: registrationName,
 };
+
+/**
+ * Registers the FlyoutCursor with Blockly's registry.
+ */
+export function registerFlyoutCursor() {
+  Blockly.registry.register(
+    registrationType,
+    registrationName,
+    FlyoutCursor,
+    true,
+  );
+}
diff --git a/src/index.ts b/src/index.ts
@@ -323,6 +323,148 @@ export class KeyboardNavigation {
   .blocklyMenuItemContent .blocklyShortcutContainer .blocklyShortcut {
     color: #ccc;
   }
+`);
+
+    // Register classes used by the shortcuts modal
+    Blockly.Css.register(`
+:root {
+  --divider-border-color: #eee;
+  --key-border-color: #ccc;
+  --shortcut-modal-border-color: #9aa0a6;
+}
+
+.shortcut-modal {
+  border: 1px solid var(--shortcut-modal-border-color);
+  border-radius: 12px;
+  box-shadow: 6px 6px 32px rgba(0,0,0,.5);
+  flex-direction: column;
+  gap: 12px;
+  margin: auto;
+  max-height: 82vh;
+  max-width: calc(100% - 10em);
+  padding: 24px 12px 24px 32px;
+  position: relative;
+  z-index: 99;
+}
+
+.shortcut-modal[open] {
+  display: flex;
+}
+
+.shortcut-modal .close-modal {
+  border: 0;
+  background: transparent;
+  float: inline-end;
+  margin: 0 0 0 0;
+  position: absolute;
+  top: 16px;
+  right: 24px;
+}
+
+.shortcut-modal h1 {
+  font-weight: 600;
+  font-size: 1.2em;
+}
+
+.shortcut-modal:before {
+  background: radial-gradient(rgba(244, 244, 244, 0.43), rgba(75, 75, 75, 0.51));
+  align-items: center;
+  display: block;
+  font-family: Roboto;
+  height: 100%;
+  justify-content: center;
+  left: 0;
+  position: absolute;
+  top: 0;
+  width: 100%;
+}
+
+.shortcut-tables {
+  display: grid;
+  align-items: start;
+  grid-template-columns: 1fr;
+  row-gap: 1em;
+  column-gap: 2em;
+}
+
+@media (min-width: 950px) {
+  .shortcut-tables {
+    grid-template-columns: 1fr 1fr
+  }
+}
+
+@media (min-width: 1360px) {
+  .shortcut-tables {
+    grid-template-columns: 1fr 1fr 1fr
+  }
+}
+
+.shortcut-table {
+  border-collapse: collapse;
+  font-family: Roboto;
+  font-size: .9em;
+}
+
+.shortcut-table th {
+  padding-inline-end: 0.5em;
+  text-align: left;
+  text-wrap: nowrap;
+  vertical-align: baseline;
+}
+
+.shortcut-table td:first-child {
+  text-wrap: auto;
+  width: 40%;
+}
+
+.shortcut-table tr:has(+ .category) {
+  --divider-border-color: transparent;
+  margin-end: 1em;
+}
+
+.shortcut-table tr:not(.category, :last-child) {
+  border-bottom: 1px solid var(--divider-border-color);
+}
+
+.shortcut-table td {
+  padding: 0.2em 1em 0.3em 0;
+  text-wrap: nowrap;
+}
+
+.shortcut-table h2 {
+  border-bottom: 1px solid #999;
+  font-size: 1em;
+  padding-block-end: 0.5em;
+}
+
+.shortcut-table .key {
+  border: 1px solid var(--key-border-color);
+  border-radius: 8px;
+  display: inline-block;
+  margin: 0 4px;
+  min-width: 2em;
+  padding: .3em .5em;
+  text-align: center;
+}
+
+.shortcut-table .separator {
+  color: gray;
+  display: inline-block;
+  padding: 0 0.5em;
+}
+
+.shortcut-container {
+  font-size: 0.95em;
+  overflow: auto;
+  padding: 0.5em;
+}
+
+.shortcut-combo {
+  display: inline-block;
+  padding: 0.25em 0;
+  text-wrap: nowrap;
+}
+
 `);
   }
 }
diff --git a/src/navigation.ts b/src/navigation.ts
@@ -72,10 +72,7 @@ export class Navigation {
   removeWorkspace(workspace: Blockly.WorkspaceSvg) {
     const workspaceIdx = this.workspaces.indexOf(workspace);
     const flyout = workspace.getFlyout();
-
-    if (workspace.getCursor()) {
-      this.disableKeyboardAccessibility(workspace);
-    }
+    this.disableKeyboardAccessibility(workspace);
 
     if (workspaceIdx > -1) {
       this.workspaces.splice(workspaceIdx, 1);
@@ -259,9 +256,9 @@ export class Navigation {
   ) {
     const mutatedBlockId = e.blockId;
     const cursor = workspace.getCursor();
-    const block = cursor?.getSourceBlock();
+    const block = cursor.getSourceBlock();
     if (block && block.id === mutatedBlockId) {
-      cursor?.setCurNode(block);
+      cursor.setCurNode(block);
     }
   }
 
@@ -346,9 +343,6 @@ export class Navigation {
   ) {
     const topBlocks = workspace.getTopBlocks(true);
     const cursor = workspace.getCursor();
-    if (!cursor) {
-      return;
-    }
     const disposed = cursor.getSourceBlock()?.disposed;
     if (cursor.getCurNode() && !disposed) {
       // Retain the cursor's previous position since it's set, but only if not
@@ -800,7 +794,7 @@ export class Navigation {
    */
   paste(copyData: Blockly.ICopyData, workspace: Blockly.WorkspaceSvg): boolean {
     // Do this before clipoard.paste due to cursor/focus workaround in getCurNode.
-    const targetNode = workspace.getCursor()?.getCurNode();
+    const targetNode = workspace.getCursor().getCurNode();
 
     Blockly.Events.setGroup(true);
     const block = Blockly.clipboard.paste(
diff --git a/src/navigation_controller.ts b/src/navigation_controller.ts
@@ -10,8 +10,6 @@
  * @author aschmiedt@google.com (Abby Schmiedt)
  */
 
-import './toolbox_monkey_patch';
-
 import * as Blockly from 'blockly/core';
 import {
   ShortcutRegistry,
diff --git a/src/navigation_deferring_toolbox.ts b/src/navigation_deferring_toolbox.ts
diff --git a/src/shortcut_dialog.ts b/src/shortcut_dialog.ts
diff --git a/src/toolbox_monkey_patch.js b/src/toolbox_monkey_patch.js
diff --git a/test/index.ts b/test/index.ts
diff --git a/test/webdriverio/index.ts b/test/webdriverio/index.ts
diff --git a/test/webdriverio/test/styling_test.ts b/test/webdriverio/test/styling_test.ts

Original file line number	Diff line number	Diff line change
`@@ -38,11 +38,7 @@ export class ArrowNavigation {`
`38`	`38`	`workspace: WorkspaceSvg,`
`39`	`39`	`shortcut: ShortcutRegistry.KeyboardShortcut,`
`40`	`40`	`): boolean {`
`41`		`- const cursor = workspace.getCursor();`
`42`		`- if (!cursor \|\| !cursor.getCurNode()) {`
`43`		`- return false;`
`44`		`- }`
`45`		`- const curNode = cursor.getCurNode();`
	`41`	`+ const curNode = workspace.getCursor().getCurNode();`
`46`	`42`	`if (curNode instanceof Field) {`
`47`	`43`	`return curNode.onShortcut(shortcut);`
`48`	`44`	`}`
`@@ -70,7 +66,7 @@ export class ArrowNavigation {`
`70`	`66`	`if (`
`71`	`67`	`!this.navigation.defaultWorkspaceCursorPositionIfNeeded(workspace)`
`72`	`68`	`) {`
`73`		`- workspace.getCursor()?.in();`
	`69`	`+ workspace.getCursor().in();`
`74`	`70`	`}`
`75`	`71`	`isHandled = true;`
`76`	`72`	`}`
`@@ -103,7 +99,7 @@ export class ArrowNavigation {`
`103`	`99`	`if (`
`104`	`100`	`!this.navigation.defaultWorkspaceCursorPositionIfNeeded(workspace)`
`105`	`101`	`) {`
`106`		`- workspace.getCursor()?.out();`
	`102`	`+ workspace.getCursor().out();`
`107`	`103`	`}`
`108`	`104`	`isHandled = true;`
`109`	`105`	`}`
`@@ -169,7 +165,7 @@ export class ArrowNavigation {`
`169`	`165`	`workspace,`
`170`	`166`	`)`
`171`	`167`	`) {`
`172`		`- workspace.getCursor()?.next();`
	`168`	`+ workspace.getCursor().next();`
`173`	`169`	`}`
`174`	`170`	`isHandled = true;`
`175`	`171`	`}`
`@@ -182,7 +178,7 @@ export class ArrowNavigation {`
`182`	`178`	`workspace.targetWorkspace,`
`183`	`179`	`)`
`184`	`180`	`) {`
`185`		`- workspace.getCursor()?.next();`
	`181`	`+ workspace.getCursor().next();`
`186`	`182`	`}`
`187`	`183`	`isHandled = true;`
`188`	`184`	`}`
`@@ -232,7 +228,7 @@ export class ArrowNavigation {`
`232`	`228`	`'last',`
`233`	`229`	`)`
`234`	`230`	`) {`
`235`		`- workspace.getCursor()?.prev();`
	`231`	`+ workspace.getCursor().prev();`
`236`	`232`	`}`
`237`	`233`	`isHandled = true;`
`238`	`234`	`}`
`@@ -246,7 +242,7 @@ export class ArrowNavigation {`
`246`	`242`	`'last',`
`247`	`243`	`)`
`248`	`244`	`) {`
`249`		`- workspace.getCursor()?.prev();`
	`245`	`+ workspace.getCursor().prev();`
`250`	`246`	`}`
`251`	`247`	`isHandled = true;`
`252`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -119,11 +119,7 @@ export class WorkspaceMovement {`
`119`	`119`	`* @param workspace The workspace the cursor is on.`
`120`	`120`	`*/`
`121`	`121`	`createWSCursor(workspace: WorkspaceSvg) {`
`122`		`- const cursor = workspace.getCursor();`
`123`		`-`
`124`		`- if (!cursor) return false;`
`125`		`-`
`126`		`- cursor.setCurNode(workspace);`
	`122`	`+ workspace.getCursor().setCurNode(workspace);`
`127`	`123`	`return true;`
`128`	`124`	`}`
`129`	`125`	`}`