blockly 9.3.2 → 10.0.0-beta.0

package/core/field_variable.d.ts

@@ -18,7 +18,7 @@ export declare class FieldVariable extends FieldDropdown {
     protected menuGenerator_: MenuGenerator | undefined;
     defaultVariableName: string;
     /** The type of the default variable for this field. */
-    private defaultType_;
+    private defaultType;
     /**
      * All of the types of variables that will be available in this field's
      * dropdown.
@@ -26,7 +26,7 @@ export declare class FieldVariable extends FieldDropdown {
     variableTypes: string[] | null;
     protected size_: Size;
     /** The variable model associated with this field. */
-    private variable_;
+    private variable;
     /**
      * Serializable fields are saved by the serializer, non-serializable fields
      * are not. Editable fields should also be serializable.
@@ -158,14 +158,14 @@ export declare class FieldVariable extends FieldDropdown {
      * @param type The type to check.
      * @returns True if the type is in the list of allowed types.
      */
-    private typeIsAllowed_;
+    private typeIsAllowed;
     /**
      * Return a list of variable types to include in the dropdown.
      *
      * @returns Array of variable types.
      * @throws {Error} if variableTypes is an empty array.
      */
-    private getVariableTypes_;
+    private getVariableTypes;
     /**
      * Parse the optional arguments representing the allowed variable types and
      * the default variable type.
@@ -176,7 +176,7 @@ export declare class FieldVariable extends FieldDropdown {
      * @param defaultType The type of the variable to create if this field's
      *     value is not explicitly set.  Defaults to ''.
      */
-    private setTypes_;
+    private setTypes;
     /**
      * Refreshes the name of the variable by grabbing the name of the model.
      * Used when a variable gets renamed, but the ID stays the same. Should only

package/core/flyout_base.d.ts

@@ -102,18 +102,18 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * Function that will be registered as a change listener on the workspace
      * to reflow when blocks in the flyout workspace change.
      */
-    private reflowWrapper_;
+    private reflowWrapper;
     /**
      * Function that disables blocks in the flyout based on max block counts
      * allowed in the target workspace. Registered as a change listener on the
      * target workspace.
      */
-    private filterWrapper_;
+    private filterWrapper;
     /**
      * List of background mats that lurk behind each block to catch clicks
      * landing in the blocks' lakes and bays.
      */
-    private mats_;
+    private mats;
     /**
      * List of visible buttons.
      */
@@ -121,11 +121,11 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * List of event listeners.
      */
-    private listeners_;
+    private listeners;
     /**
      * List of blocks that should always be disabled.
      */
-    private permanentlyDisabled_;
+    private permanentlyDisabled;
     protected readonly tabWidth_: number;
     /**
      * The target workspace.
@@ -136,7 +136,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * A list of blocks that can be reused.
      */
-    private recycledBlocks_;
+    private recycledBlocks;
     /**
      * Does the flyout automatically close when a block is created?
      */
@@ -148,7 +148,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * Whether the workspace containing this flyout is visible.
      */
-    private containerVisible_;
+    private containerVisible;
     protected rectMap_: WeakMap<BlockSvg, SVGElement>;
     /**
      * Corner radius of the flyout background.
@@ -224,8 +224,6 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * Dispose of this flyout.
      * Unlink from all DOM elements to prevent memory leaks.
-     *
-     * @suppress {checkTypes}
      */
     dispose(): void;
     /**
@@ -277,7 +275,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * Update the display property of the flyout based whether it thinks it should
      * be visible and whether its containing workspace is visible.
      */
-    private updateDisplay_;
+    private updateDisplay;
     /**
      * Update the view based on coordinates calculated in position().
      *
@@ -307,7 +305,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      *     of objects to show in the flyout.
      * @returns The list of contents and gaps needed to lay out the flyout.
      */
-    private createFlyoutInfo_;
+    private createFlyoutInfo;
     /**
      * Gets the flyout definition for the dynamic category.
      *
@@ -315,7 +313,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @returns The definition of the
      *     flyout in one of its many forms.
      */
-    private getDynamicCategoryContents_;
+    private getDynamicCategoryContents;
     /**
      * Creates a flyout button or a flyout label.
      *
@@ -324,7 +322,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @returns The object used to display the button in the
      *    flyout.
      */
-    private createButton_;
+    private createButton;
     /**
      * Create a block from the xml and permanently disable any blocks that were
      * defined as disabled.
@@ -332,7 +330,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @param blockInfo The info of the block.
      * @returns The block created from the blockInfo.
      */
-    private createFlyoutBlock_;
+    private createFlyoutBlock;
     /**
      * Returns a block from the array of recycled blocks with the given type, or
      * undefined if one cannot be found.
@@ -341,7 +339,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @returns The recycled block, or undefined if
      *     one could not be recycled.
      */
-    private getRecycledBlock_;
+    private getRecycledBlock;
     /**
      * Adds a gap in the flyout based on block info.
      *
@@ -350,7 +348,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @param defaultGap The default gap between one element and the
      *     next.
      */
-    private addBlockGap_;
+    private addBlockGap;
     /**
      * Add the necessary gap in the flyout for a separator.
      *
@@ -360,15 +358,15 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @param defaultGap The default gap between the button and next
      *     element.
      */
-    private addSeparatorGap_;
+    private addSeparatorGap;
     /**
      * Delete blocks, mats and buttons from a previous showing of the flyout.
      */
-    private clearOldBlocks_;
+    private clearOldBlocks;
     /**
      * Empties all of the recycled blocks, properly disposing of them.
      */
-    private emptyRecycledBlocks_;
+    private emptyRecycledBlocks;
     /**
      * Returns whether the given block can be recycled or not.
      *
@@ -383,7 +381,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      *
      * @param block The block to recycle.
      */
-    private recycleBlock_;
+    private recycleBlock;
     /**
      * Add listeners to a block that has been added to the flyout.
      *
@@ -399,13 +397,13 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @param block The flyout block to copy.
      * @returns Function to call when block is clicked.
      */
-    private blockMouseDown_;
+    private blockMouseDown;
     /**
      * Pointer down on the flyout background.  Start a vertical scroll drag.
      *
      * @param e Pointer down event.
      */
-    private onMouseDown_;
+    private onMouseDown;
     /**
      * Does this flyout allow you to create a new instance of the given block?
      * Used for deciding if a block can be "dragged out of" the flyout.
@@ -465,7 +463,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * on the workspace, an "a + b" block that has two shadow blocks would be
      * disabled.
      */
-    private filterForCapacity_;
+    private filterForCapacity;
     /**
      * Reflow blocks and their mats.
      */
@@ -482,14 +480,14 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * @param oldBlock The flyout block to copy.
      * @returns The new block in the main workspace.
      */
-    private placeNewBlock_;
+    private placeNewBlock;
     /**
      * Positions a block on the target workspace.
      *
      * @param oldBlock The flyout block being copied.
      * @param block The block to posiiton.
      */
-    private positionNewBlock_;
+    private positionNewBlock;
 }
 /**
  * A flyout content item.

package/core/flyout_button.d.ts

@@ -19,21 +19,21 @@ export declare class FlyoutButton {
     static TEXT_MARGIN_Y: number;
     /** The radius of the flyout button's borders. */
     static BORDER_RADIUS: number;
-    private readonly text_;
-    private readonly position_;
-    private readonly callbackKey_;
-    private readonly cssClass_;
+    private readonly text;
+    private readonly position;
+    private readonly callbackKey;
+    private readonly cssClass;
     /** Mouse up event data. */
-    private onMouseUpWrapper_;
+    private onMouseUpWrapper;
     info: toolbox.ButtonOrLabelInfo;
     /** The width of the button's rect. */
     width: number;
     /** The height of the button's rect. */
     height: number;
     /** The root SVG group for the button or label. */
-    private svgGroup_;
+    private svgGroup;
     /** The SVG element with the text of the label or button. */
-    private svgText_;
+    private svgText;
     /**
      * @param workspace The workspace in which to place this button.
      * @param targetWorkspace The flyout's target workspace.
@@ -51,7 +51,7 @@ export declare class FlyoutButton {
     /** Correctly position the flyout button and make it visible. */
     show(): void;
     /** Update SVG attributes to match internal state. */
-    private updateTransform_;
+    private updateTransform;
     /**
      * Move the button to the given x, y coordinates.
      *
@@ -83,6 +83,6 @@ export declare class FlyoutButton {
      *
      * @param e Pointer up event.
      */
-    private onMouseUp_;
+    private onMouseUp;
 }
 //# sourceMappingURL=flyout_button.d.ts.map

package/core/flyout_horizontal.d.ts

@@ -44,7 +44,7 @@ export declare class HorizontalFlyout extends Flyout {
      * @param width The width of the flyout, not including the rounded corners.
      * @param height The height of the flyout, not including rounded corners.
      */
-    private setBackgroundPath_;
+    private setBackgroundPath;
     /** Scroll the flyout to the top. */
     scrollToStart(): void;
     /**

package/core/flyout_vertical.d.ts

@@ -45,7 +45,7 @@ export declare class VerticalFlyout extends Flyout {
      * @param width The width of the flyout, not including the rounded corners.
      * @param height The height of the flyout, not including rounded corners.
      */
-    private setBackgroundPath_;
+    private setBackgroundPath;
     /** Scroll the flyout to the top. */
     scrollToStart(): void;
     /**

package/core/generator.d.ts

@@ -7,12 +7,25 @@ import type { Block } from './block.js';
 import { Names } from './names.js';
 import type { Workspace } from './workspace.js';
 /**
- * Class for a code generator that translates the blocks into a language.
+ * Type declaration for per-block-type generator functions.
  *
- * @unrestricted
+ * @see {@link https://developers.google.com/blockly/guides/create-custom-blocks/generating-code}
+ * @param block The Block instance to generate code for.
+ * @param genearator The CodeGenerator calling the function.
+ * @returns A string containing the generated code (for statement blocks),
+ *     or a [code, precedence] tuple (for value/expression blocks), or
+ *     null if no code should be emitted for block.
+ */
+export type BlockGenerator = (block: Block, generator: CodeGenerator) => [string, number] | string | null;
+/**
+ * Class for a code generator that translates the blocks into a language.
  */
 export declare class CodeGenerator {
     name_: string;
+    /** A dictionary of block generator functions keyed by block type. */
+    forBlock: {
+        [type: string]: BlockGenerator;
+    };
     /**
      * This is used as a placeholder in functions defined using
      * CodeGenerator.provideFunction_.  It must not be legal code that could

package/core/gesture.d.ts

@@ -13,6 +13,7 @@ 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';
+import type { IIcon } from './interfaces/i_icon.js';
 /**
  * Class for one gesture.
  */
@@ -23,30 +24,35 @@ export declare class Gesture {
      * pixels, with (0, 0) at the top left of the browser window (pointer event
      * clientX/Y).
      */
-    private mouseDownXY_;
-    private currentDragDeltaXY_;
+    private mouseDownXY;
+    private currentDragDeltaXY;
     /**
      * The bubble that the gesture started on, or null if it did not start on a
      * bubble.
      */
-    private startBubble_;
+    private startBubble;
     /**
      * The field that the gesture started on, or null if it did not start on a
      * field.
      */
-    private startField_;
+    private startField;
+    /**
+     * The icon that the gesture started on, or null if it did not start on an
+     * icon.
+     */
+    private startIcon;
     /**
      * The block that the gesture started on, or null if it did not start on a
      * block.
      */
-    private startBlock_;
+    private startBlock;
     /**
      * The block that this gesture targets.  If the gesture started on a
      * shadow block, this is the first non-shadow parent of the block.  If the
      * gesture started in the flyout, this is the root block of the block group
      * that was clicked or dragged.
      */
-    private targetBlock_;
+    private targetBlock;
     /**
      * The workspace that the gesture started on.  There may be multiple
      * workspaces on a page; this is more accurate than using
@@ -58,7 +64,7 @@ export declare class Gesture {
      * A gesture that exceeds the drag radius is a drag even if it ends exactly
      * at its start point.
      */
-    private hasExceededDragRadius_;
+    private hasExceededDragRadius;
     /**
      * Array holding info needed to unbind events.
      * Used for disposing.
@@ -66,25 +72,25 @@ export declare class Gesture {
      */
     private boundEvents;
     /** The object tracking a bubble drag, or null if none is in progress. */
-    private bubbleDragger_;
+    private bubbleDragger;
     /** The object tracking a block drag, or null if none is in progress. */
-    private blockDragger_;
+    private blockDragger;
     /**
      * The object tracking a workspace or flyout workspace drag, or null if none
      * is in progress.
      */
-    private workspaceDragger_;
+    private workspaceDragger;
     /** The flyout a gesture started in, if any. */
-    private flyout_;
+    private flyout;
     /** Boolean for sanity-checking that some code is only called once. */
-    private calledUpdateIsDragging_;
+    private calledUpdateIsDragging;
     /** Boolean for sanity-checking that some code is only called once. */
-    private hasStarted_;
+    private gestureHasStarted;
     /** Boolean used internally to break a cycle in disposal. */
     protected isEnding_: boolean;
-    private healStack_;
+    private healStack;
     /** The event that most recently updated this gesture. */
-    private mostRecentEvent_;
+    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. */
@@ -95,11 +101,11 @@ export declare class Gesture {
      * 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_;
+    private previousScale;
     /** The starting distance between two touch points. */
-    private startDistance_;
+    private startDistance;
     /** Boolean for whether or not the workspace supports pinch-zoom. */
-    private isPinchZoomEnabled_;
+    private isPinchZoomEnabled;
     /**
      * The owner of the dropdownDiv when this gesture first starts.
      * Needed because we'll close the dropdown before fields get to
@@ -124,7 +130,7 @@ export declare class Gesture {
      *
      * @param e The most recent pointer event.
      */
-    private updateFromEvent_;
+    private updateFromEvent;
     /**
      * DO MATH to set currentDragDeltaXY_ based on the most recent pointer
      * position.
@@ -133,7 +139,7 @@ export declare class Gesture {
      *     with (0, 0) at the window's top left corner.
      * @returns True if the drag just exceeded the drag radius for the first time.
      */
-    private updateDragDelta_;
+    private updateDragDelta;
     /**
      * Update this gesture to record whether a block is being dragged from the
      * flyout.
@@ -145,7 +151,7 @@ export declare class Gesture {
      *
      * @returns True if a block is being dragged from the flyout.
      */
-    private updateIsDraggingFromFlyout_;
+    private updateIsDraggingFromFlyout;
     /**
      * Update this gesture to record whether a bubble is being dragged.
      * This function should be called on a pointermove event the first time
@@ -155,7 +161,7 @@ export declare class Gesture {
      *
      * @returns True if a bubble is being dragged.
      */
-    private updateIsDraggingBubble_;
+    private updateIsDraggingBubble;
     /**
      * Check whether to start a block drag. If a block should be dragged, either
      * from the flyout or in the workspace, create the necessary BlockDragger and
@@ -169,7 +175,7 @@ export declare class Gesture {
      *
      * @returns True if a block is being dragged.
      */
-    private updateIsDraggingBlock_;
+    private updateIsDraggingBlock;
     /**
      * Check whether to start a workspace drag. If a workspace is being dragged,
      * create the necessary WorkspaceDragger and start the drag.
@@ -179,18 +185,18 @@ export declare class Gesture {
      * gesture. If a workspace is being dragged this function creates the
      * necessary WorkspaceDragger and starts the drag.
      */
-    private updateIsDraggingWorkspace_;
+    private updateIsDraggingWorkspace;
     /**
      * Update this gesture to record whether anything is being dragged.
      * 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.
      */
-    private updateIsDragging_;
+    private updateIsDragging;
     /** Create a block dragger and start dragging the selected block. */
-    private startDraggingBlock_;
+    private startDraggingBlock;
     /** Create a bubble dragger and start dragging the selected bubble. */
-    private startDraggingBubble_;
+    private startDraggingBubble;
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
      * progress and bind pointermove and pointerup handlers.
@@ -248,7 +254,7 @@ export declare class Gesture {
      *
      * @param e A pointermove event.
      */
-    private handlePinch_;
+    private handlePinch;
     /**
      * Handle a pointerup event and end the gesture.
      *
@@ -298,7 +304,7 @@ export declare class Gesture {
      *
      * @param ws The workspace that a user clicks on.
      */
-    private fireWorkspaceClick_;
+    private fireWorkspaceClick;
     /**
      * Handle a pointerdown event on a flyout.
      *
@@ -324,23 +330,25 @@ export declare class Gesture {
      */
     handleBubbleStart(e: PointerEvent, bubble: IBubble): void;
     /** Execute a bubble click. */
-    private doBubbleClick_;
+    private doBubbleClick;
     /** Execute a field click. */
-    private doFieldClick_;
+    private doFieldClick;
+    /** Execute an icon click. */
+    private doIconClick;
     /** Execute a block click. */
-    private doBlockClick_;
+    private doBlockClick;
     /**
      * Execute a workspace click. When in accessibility mode shift clicking will
      * move the cursor.
      *
      * @param _e A pointerup event.
      */
-    private doWorkspaceClick_;
+    private doWorkspaceClick;
     /**
      * Move the dragged/clicked block to the front of the workspace so that it is
      * not occluded by other blocks.
      */
-    private bringBlockToFront_;
+    private bringBlockToFront;
     /**
      * Record the field that a gesture started on.
      *
@@ -348,6 +356,13 @@ export declare class Gesture {
      * @internal
      */
     setStartField<T>(field: Field<T>): void;
+    /**
+     * Record the icon that a gesture started on.
+     *
+     * @param icon The icon the gesture started on.
+     * @internal
+     */
+    setStartIcon(icon: IIcon): void;
     /**
      * Record the bubble that a gesture started on
      *
@@ -370,47 +385,49 @@ export declare class Gesture {
      *
      * @param block The block the gesture targets.
      */
-    private setTargetBlock_;
+    private setTargetBlock;
     /**
      * Record the workspace that a gesture started on.
      *
      * @param ws The workspace the gesture started on.
      */
-    private setStartWorkspace_;
+    private setStartWorkspace;
     /**
      * Record the flyout that a gesture started on.
      *
      * @param flyout The flyout the gesture started on.
      */
-    private setStartFlyout_;
+    private setStartFlyout;
     /**
      * Whether this gesture is a click on a bubble.  This should only be called
      * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a bubble.
      */
-    private isBubbleClick_;
+    private isBubbleClick;
     /**
      * Whether this gesture is a click on a block.  This should only be called
      * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a block.
      */
-    private isBlockClick_;
+    private isBlockClick;
     /**
      * Whether this gesture is a click on a field.  This should only be called
      * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a field.
      */
-    private isFieldClick_;
+    private isFieldClick;
+    /** @returns Whether this gesture is a click on an icon. */
+    private isIconClick;
     /**
      * Whether this gesture is a click on a workspace.  This should only be called
      * when ending a gesture (pointerup).
      *
      * @returns Whether this gesture was a click on a workspace.
      */
-    private isWorkspaceClick_;
+    private isWorkspaceClick;
     /**
      * Whether this gesture is a drag of either a workspace or block.
      * This function is called externally to block actions that cannot be taken