blockly 12.0.0-beta.3 → 12.0.0-beta.4

package/core/block_svg.d.ts

@@ -10,7 +10,6 @@
  */
 import './events/events_selected.js';
 import { Block } from './block.js';
-import { IDeletable } from './blockly.js';
 import { BlockCopyData } from './clipboard/block_paster.js';
 import type { Connection } from './connection.js';
 import { ConnectionType } from './connection_type.js';
@@ -20,7 +19,9 @@ import { MutatorIcon } from './icons/mutator_icon.js';
 import type { Input } from './inputs/input.js';
 import type { IASTNodeLocationSvg } from './interfaces/i_ast_node_location_svg.js';
 import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+import { IContextMenu } from './interfaces/i_contextmenu.js';
 import type { ICopyable } from './interfaces/i_copyable.js';
+import { IDeletable } from './interfaces/i_deletable.js';
 import type { IDragStrategy, IDraggable } from './interfaces/i_draggable.js';
 import { IIcon } from './interfaces/i_icon.js';
 import { RenderedConnection } from './rendered_connection.js';
@@ -35,7 +36,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * Class for a block's SVG representation.
  * Not normally called directly, workspace.newBlock() is preferred.
  */
-export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBoundedElement, ICopyable<BlockCopyData>, IDraggable, IDeletable {
+export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBoundedElement, IContextMenu, ICopyable<BlockCopyData>, IDraggable, IDeletable {
     /**
      * Constant for identifying rows that are to be rendered inline.
      * Don't collide with Blockly.inputTypes.
@@ -248,14 +249,20 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      *
      * @returns Context menu options or null if no menu.
      */
-    protected generateContextMenu(): Array<ContextMenuOption | LegacyContextMenuOption> | null;
+    protected generateContextMenu(e: Event): Array<ContextMenuOption | LegacyContextMenuOption> | null;
+    /**
+     * Gets the location in which to show the context menu for this block.
+     * Use the location of a click if the block was clicked, or a location
+     * based on the block's fields otherwise.
+     */
+    protected calculateContextMenuLocation(e: Event): Coordinate;
     /**
      * Show the context menu for this block.
      *
      * @param e Mouse event.
      * @internal
      */
-    showContextMenu(e: PointerEvent): void;
+    showContextMenu(e: Event): void;
     /**
      * Updates the locations of any parts of the block that need to know where
      * they are (e.g. connections, icons).
@@ -705,6 +712,13 @@ export declare class BlockSvg extends Block implements IASTNodeLocationSvg, IBou
      * @internal
      */
     highlightShapeForInput(conn: RenderedConnection, add: boolean): void;
+    /**
+     * Returns the drag strategy currently in use by this block.
+     *
+     * @internal
+     * @returns This block's drag strategy.
+     */
+    getDragStrategy(): IDragStrategy;
     /** Sets the drag strategy for this block. */
     setDragStrategy(dragStrategy: IDragStrategy): void;
     /** Returns whether this block is movable or not. */

package/core/comments/rendered_workspace_comment.d.ts

@@ -95,7 +95,7 @@ export declare class RenderedWorkspaceComment extends WorkspaceComment implement
      */
     toCopyData(): WorkspaceCommentCopyData | null;
     /** Show a context menu for this comment. */
-    showContextMenu(e: PointerEvent): void;
+    showContextMenu(e: Event): void;
     /** Snap this comment to the nearest grid point. */
     snapToGrid(): void;
 }

package/core/contextmenu.d.ts

@@ -7,9 +7,12 @@ import type { Block } from './block.js';
 import type { BlockSvg } from './block_svg.js';
 import type { ContextMenuOption, LegacyContextMenuOption } from './contextmenu_registry.js';
 import * as serializationBlocks from './serialization/blocks.js';
+import { Coordinate } from './utils/coordinate.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Gets the block the context menu is currently attached to.
+ * It is not recommended that you use this function; instead,
+ * use the scope object passed to the context menu callback.
  *
  * @returns The block the context menu is attached to.
  */
@@ -23,12 +26,13 @@ export declare function setCurrentBlock(block: Block | null): void;
 /**
  * Construct the menu based on the list of options and show the menu.
  *
- * @param e Mouse event.
+ * @param menuOpenEvent Event that caused the menu to open.
  * @param options Array of menu options.
  * @param rtl True if RTL, false if LTR.
  * @param workspace The workspace associated with the context menu, if any.
+ * @param location The screen coordinates at which to show the menu.
  */
-export declare function show(e: PointerEvent, options: (ContextMenuOption | LegacyContextMenuOption)[], rtl: boolean, workspace?: WorkspaceSvg): void;
+export declare function show(menuOpenEvent: Event, options: (ContextMenuOption | LegacyContextMenuOption)[], rtl: boolean, workspace?: WorkspaceSvg, location?: Coordinate): void;
 /**
  * Hide the context menu.
  */

package/core/contextmenu_registry.d.ts

@@ -10,6 +10,7 @@
  */
 import type { BlockSvg } from './block_svg.js';
 import { RenderedWorkspaceComment } from './comments/rendered_workspace_comment.js';
+import { Coordinate } from './utils/coordinate.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for the registry of context menu items. This is intended to be a
@@ -54,7 +55,7 @@ export declare class ContextMenuRegistry {
      *     block being clicked on)
      * @returns the list of ContextMenuOptions
      */
-    getContextMenuOptions(scopeType: ScopeType, scope: Scope): ContextMenuOption[];
+    getContextMenuOptions(scopeType: ScopeType, scope: Scope, menuOpenEvent: Event): ContextMenuOption[];
 }
 export declare namespace ContextMenuRegistry {
     /**
@@ -91,12 +92,13 @@ export declare namespace ContextMenuRegistry {
         /**
          * @param scope Object that provides a reference to the thing that had its
          *     context menu opened.
-         * @param e The original event that triggered the context menu to open. Not
-         *     the event that triggered the click on the option.
+         * @param menuOpenEvent The original event that triggered the context menu to open.
+         * @param menuSelectEvent The event that triggered the option being selected.
+         * @param location The location in screen coordinates where the menu was opened.
          */
-        callback: (scope: Scope, e: PointerEvent) => void;
+        callback: (scope: Scope, menuOpenEvent: Event, menuSelectEvent: Event, location: Coordinate) => void;
         displayText: ((p1: Scope) => string | HTMLElement) | string | HTMLElement;
-        preconditionFn: (p1: Scope) => string;
+        preconditionFn: (p1: Scope, menuOpenEvent: Event) => string;
         separator?: never;
     }
     /**
@@ -128,10 +130,11 @@ export declare namespace ContextMenuRegistry {
         /**
          * @param scope Object that provides a reference to the thing that had its
          *     context menu opened.
-         * @param e The original event that triggered the context menu to open. Not
-         *     the event that triggered the click on the option.
+         * @param menuOpenEvent The original event that triggered the context menu to open.
+         * @param menuSelectEvent The event that triggered the option being selected.
+         * @param location The location in screen coordinates where the menu was opened.
          */
-        callback: (scope: Scope, e: PointerEvent) => void;
+        callback: (scope: Scope, menuOpenEvent: Event, menuSelectEvent: Event, location: Coordinate) => void;
         separator?: never;
     }
     /**

package/core/keyboard_nav/line_cursor.d.ts

@@ -141,7 +141,18 @@ export declare class LineCursor extends Marker {
      *     should be traversed.
      * @returns The next node in the traversal.
      */
-    getNextNode(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
+    private getNextNodeImpl;
+    /**
+     * Get the next node in the AST, optionally allowing for loopback.
+     *
+     * @param node The current position in the AST.
+     * @param isValid A function true/false depending on whether the given node
+     *     should be traversed.
+     * @param loop Whether to loop around to the beginning of the workspace if
+     *     novalid node was found.
+     * @returns The next node in the traversal.
+     */
+    getNextNode(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean, loop: boolean): ASTNode | null;
     /**
      * Reverses the pre order traversal in order to find the previous node. This
      * will allow a user to easily navigate the entire Blockly AST without having
@@ -153,7 +164,19 @@ export declare class LineCursor extends Marker {
      * @returns The previous node in the traversal or null if no previous node
      *     exists.
      */
-    getPreviousNode(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
+    private getPreviousNodeImpl;
+    /**
+     * Get the previous node in the AST, optionally allowing for loopback.
+     *
+     * @param node The current position in the AST.
+     * @param isValid A function true/false depending on whether the given node
+     *     should be traversed.
+     * @param loop Whether to loop around to the end of the workspace if no
+     *     valid node was found.
+     * @returns The previous node in the traversal or null if no previous node
+     *     exists.
+     */
+    getPreviousNode(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean, loop: boolean): ASTNode | null;
     /**
      * From the given node find either the next valid sibling or the parent's
      * next sibling.
@@ -309,5 +332,17 @@ export declare class LineCursor extends Marker {
      * @param newNode The new node.
      */
     private updateSelectionFromNode;
+    /**
+     * Get the first navigable node on the workspace, or null if none exist.
+     *
+     * @returns The first navigable node on the workspace, or null.
+     */
+    getFirstNode(): ASTNode | null;
+    /**
+     * Get the last navigable node on the workspace, or null if none exist.
+     *
+     * @returns The last navigable node on the workspace, or null.
+     */
+    getLastNode(): ASTNode | null;
 }
 //# sourceMappingURL=line_cursor.d.ts.map

package/core/menuitem.d.ts

@@ -120,9 +120,12 @@ export declare class MenuItem {
      * Performs the appropriate action when the menu item is activated
      * by the user.
      *
+     * @param menuSelectEvent the event that triggered the selection
+     * of the menu item.
+     *
      * @internal
      */
-    performAction(): void;
+    performAction(menuSelectEvent: Event): void;
     /**
      * Set the handler that's called when the menu item is activated by the user.
      * `obj` will be used as the 'this' object in the function when called.
@@ -131,6 +134,6 @@ export declare class MenuItem {
      * @param obj Used as the 'this' object in fn when called.
      * @internal
      */
-    onAction(fn: (p1: MenuItem) => void, obj: object): void;
+    onAction(fn: (p1: MenuItem, menuSelectEvent: Event) => void, obj: object): void;
 }
 //# sourceMappingURL=menuitem.d.ts.map

package/core/workspace_svg.d.ts

@@ -22,6 +22,7 @@ import { Gesture } from './gesture.js';
 import { Grid } from './grid.js';
 import type { IASTNodeLocationSvg } from './interfaces/i_ast_node_location_svg.js';
 import type { IBoundedElement } from './interfaces/i_bounded_element.js';
+import { IContextMenu } from './interfaces/i_contextmenu.js';
 import type { IDragTarget } from './interfaces/i_drag_target.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import type { IMetricsManager } from './interfaces/i_metrics_manager.js';
@@ -50,7 +51,7 @@ import { ZoomControls } from './zoom_controls.js';
  * Class for a workspace.  This is an onscreen area with optional trashcan,
  * scrollbars, bubbles, and dragging.
  */
-export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationSvg {
+export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationSvg, IContextMenu {
     /**
      * A wrapper function called when a resize event occurs.
      * You can pass the result to `eventHandling.unbind`.
@@ -711,7 +712,7 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @param e Mouse event.
      * @internal
      */
-    showContextMenu(e: PointerEvent): void;
+    showContextMenu(e: Event): void;
     /**
      * Modify the block tree on the existing toolbox.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blockly",
-  "version": "12.0.0-beta.3",
+  "version": "12.0.0-beta.4",
   "description": "Blockly is a library for building visual programming editors.",
   "keywords": [
     "blockly"