blockly 9.1.0 → 9.2.0

package/core/gesture.d.ts

@@ -11,12 +11,9 @@ import type { Field } from './field.js';
 import type { IBlockDragger } from './interfaces/i_block_dragger.js';
 import type { IBubble } from './interfaces/i_bubble.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
+import { Coordinate } from './utils/coordinate.js';
 import { WorkspaceDragger } from './workspace_dragger.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
-/**
- * Note: In this file "start" refers to touchstart, mousedown, and pointerstart
- * events.  "End" refers to touchend, mouseup, and pointerend events.
- */
 /**
  * Class for one gesture.
  *
@@ -25,8 +22,8 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 export declare class Gesture {
     private readonly creatorWorkspace;
     /**
-     * The position of the mouse when the gesture started.  Units are CSS
-     * pixels, with (0, 0) at the top left of the browser window (mouseEvent
+     * The position of the pointer when the gesture started.  Units are CSS
+     * pixels, with (0, 0) at the top left of the browser window (pointer event
      * clientX/Y).
      */
     private mouseDownXY_;
@@ -66,12 +63,12 @@ export declare class Gesture {
      */
     private hasExceededDragRadius_;
     /**
-     * A handle to use to unbind a mouse move listener at the end of a drag.
+     * A handle to use to unbind a pointermove listener at the end of a drag.
      * Opaque data returned from Blockly.bindEventWithChecks_.
      */
     protected onMoveWrapper_: browserEvents.Data | null;
     /**
-     * A handle to use to unbind a mouse up listener at the end of a drag.
+     * A handle to use to unbind a pointerup listener at the end of a drag.
      * Opaque data returned from Blockly.bindEventWithChecks_.
      */
     protected onUpWrapper_: browserEvents.Data | null;
@@ -95,12 +92,40 @@ export declare class Gesture {
     private healStack_;
     /** The event that most recently updated this gesture. */
     private mostRecentEvent_;
+    /** Boolean for whether or not this gesture is a multi-touch gesture. */
+    private isMultiTouch_;
+    /** A map of cached points used for tracking multi-touch gestures. */
+    private cachedPoints;
+    /**
+     * This is the ratio between the starting distance between the touch points
+     * and the most recent distance between the touch points.
+     * Scales between 0 and 1 mean the most recent zoom was a zoom out.
+     * Scales above 1.0 mean the most recent zoom was a zoom in.
+     */
+    private previousScale_;
+    /** The starting distance between two touch points. */
+    private startDistance_;
+    /**
+     * A handle to use to unbind the second pointerdown listener
+     * at the end of a drag.
+     * Opaque data returned from Blockly.bindEventWithChecks_.
+     */
+    private onStartWrapper_;
+    /** Boolean for whether or not the workspace supports pinch-zoom. */
+    private isPinchZoomEnabled_;
+    /**
+     * The owner of the dropdownDiv when this gesture first starts.
+     * Needed because we'll close the dropdown before fields get to
+     * act on their events, and some fields care about who owns
+     * the dropdown.
+     */
+    currentDropdownOwner: Field | null;
     /**
      * @param e The event that kicked off this gesture.
      * @param creatorWorkspace The workspace that created this gesture and has a
      *     reference to it.
      */
-    constructor(e: Event, creatorWorkspace: WorkspaceSvg);
+    constructor(e: PointerEvent, creatorWorkspace: WorkspaceSvg);
     /**
      * Sever all links from this object.
      *
@@ -110,13 +135,14 @@ export declare class Gesture {
     /**
      * Update internal state based on an event.
      *
-     * @param e The most recent mouse or touch event.
+     * @param e The most recent pointer event.
      */
     private updateFromEvent_;
     /**
-     * DO MATH to set currentDragDeltaXY_ based on the most recent mouse position.
+     * DO MATH to set currentDragDeltaXY_ based on the most recent pointer
+     * position.
      *
-     * @param currentXY The most recent mouse/pointer position, in pixel units,
+     * @param currentXY The most recent pointer position, in pixel units,
      *     with (0, 0) at the window's top left corner.
      * @returns True if the drag just exceeded the drag radius for the first time.
      */
@@ -124,7 +150,7 @@ export declare class Gesture {
     /**
      * Update this gesture to record whether a block is being dragged from the
      * flyout.
-     * This function should be called on a mouse/touch move event the first time
+     * This function should be called on a pointermove event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a block should be dragged from the flyout this function creates
      * the new block on the main workspace and updates targetBlock_ and
@@ -135,7 +161,7 @@ export declare class Gesture {
     private updateIsDraggingFromFlyout_;
     /**
      * Update this gesture to record whether a bubble is being dragged.
-     * This function should be called on a mouse/touch move event the first time
+     * This function should be called on a pointermove event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a bubble should be dragged this function creates the necessary
      * BubbleDragger and starts the drag.
@@ -148,7 +174,7 @@ export declare class Gesture {
      * from the flyout or in the workspace, create the necessary BlockDragger and
      * start the drag.
      *
-     * This function should be called on a mouse/touch move event the first time
+     * This function should be called on a pointermove event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a block should be dragged, either from the flyout or in the
      * workspace, this function creates the necessary BlockDragger and starts the
@@ -161,7 +187,7 @@ export declare class Gesture {
      * Check whether to start a workspace drag. If a workspace is being dragged,
      * create the necessary WorkspaceDragger and start the drag.
      *
-     * This function should be called on a mouse/touch move event the first time
+     * This function should be called on a pointermove event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture. If a workspace is being dragged this function creates the
      * necessary WorkspaceDragger and starts the drag.
@@ -169,7 +195,7 @@ export declare class Gesture {
     private updateIsDraggingWorkspace_;
     /**
      * Update this gesture to record whether anything is being dragged.
-     * This function should be called on a mouse/touch move event the first time
+     * This function should be called on a pointermove event the first time
      * the drag radius is exceeded.  It should be called no more than once per
      * gesture.
      */
@@ -180,33 +206,84 @@ export declare class Gesture {
     private startDraggingBubble_;
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
-     * progress and bind mousemove and mouseup handlers.
+     * progress and bind pointermove and pointerup handlers.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
      * @internal
      */
-    doStart(e: MouseEvent): void;
+    doStart(e: PointerEvent): void;
     /**
      * Bind gesture events.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
+     * @internal
+     */
+    bindMouseEvents(e: PointerEvent): void;
+    /**
+     * Handle a pointerdown event.
+     *
+     * @param e A pointerdown event.
+     * @internal
+     */
+    handleStart(e: PointerEvent): void;
+    /**
+     * Handle a pointermove event.
+     *
+     * @param e A pointermove event.
+     * @internal
+     */
+    handleMove(e: PointerEvent): void;
+    /**
+     * Handle a pointerup event.
+     *
+     * @param e A pointerup event.
+     * @internal
+     */
+    handleUp(e: PointerEvent): void;
+    /**
+     * Handle a pointerdown event and keep track of current
+     * pointers.
+     *
+     * @param e A pointerdown event.
+     * @internal
+     */
+    handleTouchStart(e: PointerEvent): void;
+    /**
+     * Handle a pointermove event and zoom in/out if two pointers
+     * are on the screen.
+     *
+     * @param e A pointermove event.
+     * @internal
+     */
+    handleTouchMove(e: PointerEvent): void;
+    /**
+     * Handle pinch zoom gesture.
+     *
+     * @param e A pointermove event.
+     */
+    private handlePinch_;
+    /**
+     * Handle a pointerup event and end the gesture.
+     *
+     * @param e A pointerup event.
      * @internal
      */
-    bindMouseEvents(e: Event): void;
+    handleTouchEnd(e: PointerEvent): void;
     /**
-     * Handle a mouse move or touch move event.
+     * Helper function returning the current touch point coordinate.
      *
-     * @param e A mouse move or touch move event.
+     * @param e A pointer event.
+     * @returns The current touch point coordinate
      * @internal
      */
-    handleMove(e: Event): void;
+    getTouchPoint(e: PointerEvent): Coordinate | null;
     /**
-     * Handle a mouse up or touch end event.
+     * Whether this gesture is part of a multi-touch gesture.
      *
-     * @param e A mouse up or touch end event.
+     * @returns Whether this gesture is part of a multi-touch gesture.
      * @internal
      */
-    handleUp(e: Event): void;
+    isMultiTouch(): boolean;
     /**
      * Cancel an in-progress gesture.  If a workspace or block drag is in
      * progress, end the drag at the most recent location.
@@ -217,18 +294,18 @@ export declare class Gesture {
     /**
      * Handle a real or faked right-click event by showing a context menu.
      *
-     * @param e A mouse move or touch move event.
+     * @param e A pointerdown event.
      * @internal
      */
-    handleRightClick(e: Event): void;
+    handleRightClick(e: PointerEvent): void;
     /**
-     * Handle a mousedown/touchstart event on a workspace.
+     * Handle a pointerdown event on a workspace.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
      * @param ws The workspace the event hit.
      * @internal
      */
-    handleWsStart(e: MouseEvent, ws: WorkspaceSvg): void;
+    handleWsStart(e: PointerEvent, ws: WorkspaceSvg): void;
     /**
      * Fires a workspace click event.
      *
@@ -236,29 +313,29 @@ export declare class Gesture {
      */
     private fireWorkspaceClick_;
     /**
-     * Handle a mousedown/touchstart event on a flyout.
+     * Handle a pointerdown event on a flyout.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
      * @param flyout The flyout the event hit.
      * @internal
      */
-    handleFlyoutStart(e: MouseEvent, flyout: IFlyout): void;
+    handleFlyoutStart(e: PointerEvent, flyout: IFlyout): void;
     /**
-     * Handle a mousedown/touchstart event on a block.
+     * Handle a pointerdown event on a block.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
      * @param block The block the event hit.
      * @internal
      */
-    handleBlockStart(e: Event, block: BlockSvg): void;
+    handleBlockStart(e: PointerEvent, block: BlockSvg): void;
     /**
-     * Handle a mousedown/touchstart event on a bubble.
+     * Handle a pointerdown event on a bubble.
      *
-     * @param e A mouse down or touch start event.
+     * @param e A pointerdown event.
      * @param bubble The bubble the event hit.
      * @internal
      */
-    handleBubbleStart(e: Event, bubble: IBubble): void;
+    handleBubbleStart(e: PointerEvent, bubble: IBubble): void;
     /** Execute a bubble click. */
     private doBubbleClick_;
     /** Execute a field click. */
@@ -269,7 +346,7 @@ export declare class Gesture {
      * Execute a workspace click. When in accessibility mode shift clicking will
      * move the cursor.
      *
-     * @param _e A mouse up or touch end event.
+     * @param _e A pointerup event.
      */
     private doWorkspaceClick_;
     /**
@@ -321,28 +398,28 @@ export declare class Gesture {
     private setStartFlyout_;
     /**
      * Whether this gesture is a click on a bubble.  This should only be called
-     * when ending a gesture (mouse up, touch end).
+     * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a bubble.
      */
     private isBubbleClick_;
     /**
      * Whether this gesture is a click on a block.  This should only be called
-     * when ending a gesture (mouse up, touch end).
+     * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a block.
      */
     private isBlockClick_;
     /**
      * Whether this gesture is a click on a field.  This should only be called
-     * when ending a gesture (mouse up, touch end).
+     * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a field.
      */
     private isFieldClick_;
     /**
      * Whether this gesture is a click on a workspace.  This should only be called
-     * when ending a gesture (mouse up, touch end).
+     * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a workspace.
      */
@@ -357,9 +434,9 @@ export declare class Gesture {
      */
     isDragging(): boolean;
     /**
-     * Whether this gesture has already been started.  In theory every mouse down
-     * has a corresponding mouse up, but in reality it is possible to lose a
-     * mouse up, leaving an in-process gesture hanging.
+     * Whether this gesture has already been started.  In theory every pointerdown
+     * has a corresponding pointerup, but in reality it is possible to lose a
+     * pointerup, leaving an in-process gesture hanging.
      *
      * @returns Whether this gesture was a click on a workspace.
      * @internal

package/core/icon.d.ts

@@ -43,7 +43,7 @@ export declare abstract class Icon {
      *
      * @param e Mouse click event.
      */
-    protected iconClick_(e: MouseEvent): void;
+    protected iconClick_(e: PointerEvent): void;
     /** Change the colour of the associated bubble to match its block. */
     applyColour(): void;
     /**
@@ -78,13 +78,13 @@ export declare abstract class Icon {
      */
     protected drawIcon_(_group: Element): void;
     /**
-     * Show or hide the icon.
+     * Show or hide the bubble.
      *
-     * @param _visible True if the icon should be visible.
+     * @param _visible True if the bubble should be visible.
      */
     setVisible(_visible: boolean): void;
     /**
-     * Returns the block this icon is attached to.
+     * @returns The block this icon is attached to.
      */
     protected getBlock(): BlockSvg;
 }

package/core/input.d.ts

@@ -17,11 +17,12 @@ export declare class Input {
     type: number;
     name: string;
     connection: Connection | null;
-    private sourceBlock_;
+    private sourceBlock;
     fieldRow: Field[];
-    align: Align;
+    /** Alignment of input's fields (left, right or centre). */
+    align: Input.Align;
     /** Is the input visible? */
-    private visible_;
+    private visible;
     /**
      * @param type The type of the input.
      * @param name Language-neutral identifier which may used to find this input
@@ -33,7 +34,7 @@ export declare class Input {
     /**
      * Get the source block for this input.
      *
-     * @returns The source block, or null if there is none.
+     * @returns The block this input is part of.
      */
     getSourceBlock(): Block;
     /**
@@ -45,7 +46,7 @@ export declare class Input {
      *     field again.  Should be unique to the host block.
      * @returns The input being append to (to allow chaining).
      */
-    appendField(field: string | Field, opt_name?: string): Input;
+    appendField<T>(field: string | Field<T>, opt_name?: string): Input;
     /**
      * Inserts a field (or label from string), and all prefix and suffix fields,
      * at the location of the input's field row.
@@ -56,7 +57,7 @@ export declare class Input {
      *     field again.  Should be unique to the host block.
      * @returns The index following the last inserted field.
      */
-    insertFieldAt(index: number, field: string | Field, opt_name?: string): number;
+    insertFieldAt<T>(index: number, field: string | Field<T>, opt_name?: string): number;
     /**
      * Remove a field from this input.
      *
@@ -138,6 +139,6 @@ export declare namespace Input {
         RIGHT = 1
     }
 }
-export declare type Align = Input.Align;
+export type Align = Input.Align;
 export declare const Align: typeof Input.Align;
 //# sourceMappingURL=input.d.ts.map