blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/flyout_base.d.ts

@@ -18,6 +18,7 @@ declare enum FlyoutItemType {
 }
 /**
  * Class for a flyout.
+ *
  * @alias Blockly.Flyout
  */
 export declare abstract class Flyout extends DeleteArea implements IFlyout {
@@ -29,23 +30,26 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * Determine if a drag delta is toward the workspace, based on the position
      * and orientation of the flyout. This is used in determineDragIntention_ to
      * determine if a new block should be created or if the flyout should scroll.
+     *
      * @param currentDragDeltaXY How far the pointer has
      *     moved from the position at mouse down, in pixel units.
-     * @return True if the drag is toward the workspace.
+     * @returns True if the drag is toward the workspace.
      */
     abstract isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean;
     /**
      * Sets the translation of the flyout to match the scrollbars.
+     *
      * @param xyRatio Contains a y property which is a float
      *     between 0 and 1 specifying the degree of scrolling and a
      *     similar x property.
      */
     protected abstract setMetrics_(xyRatio: {
-        x: number;
-        y: number;
+        x?: number;
+        y?: number;
     }): void;
     /**
      * Lay out the blocks in the flyout.
+     *
      * @param contents The blocks and buttons to lay
      *     out.
      * @param gaps The visible gaps between blocks.
@@ -53,6 +57,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     protected abstract layout_(contents: FlyoutItem[], gaps: number[]): void;
     /**
      * Scroll the flyout.
+     *
      * @param e Mouse wheel scroll event.
      */
     protected abstract wheel_(e: WheelEvent): void;
@@ -63,12 +68,14 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     protected abstract reflowInternal_(): void;
     /**
      * Calculates the x coordinate for the flyout position.
-     * @return X coordinate.
+     *
+     * @returns X coordinate.
      */
     abstract getX(): number;
     /**
      * Calculates the y coordinate for the flyout position.
-     * @return Y coordinate.
+     *
+     * @returns Y coordinate.
      */
     abstract getY(): number;
     /**
@@ -83,6 +90,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     RTL: boolean;
     /**
      * Whether the flyout should be laid out horizontally or not.
+     *
      * @internal
      */
     horizontalLayout: boolean;
@@ -122,6 +130,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     protected readonly tabWidth_: number;
     /**
      * The target workspace.
+     *
      * @internal
      */
     targetWorkspace: WorkspaceSvg;
@@ -166,11 +175,16 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * workspace". Drags that are within the bounds of this many degrees from
      * the orthogonal line to the flyout edge are considered to be "drags toward
      * the workspace".
-     * Example:
+     *
+     * @example
+     *
+     * ```
      * Flyout                                                 Edge   Workspace
      * [block] /  <-within this angle, drags "toward workspace" |
      * [block] ---- orthogonal to flyout boundary ----          |
      * [block] \                                                |
+     * ```
+     *
      * The angle is given in degrees from the orthogonal.
      *
      * This is used to know when to create a new block and when to scroll the
@@ -195,13 +209,15 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      * Creates the flyout's DOM.  Only needs to be called once.  The flyout can
      * either exist as its own SVG element or be a g element nested inside a
      * separate SVG element.
+     *
      * @param tagName The type of tag to
      *     put the flyout in. This should be <svg> or <g>.
-     * @return The flyout's SVG group.
+     * @returns The flyout's SVG group.
      */
     createDom(tagName: string | Svg<SVGSVGElement> | Svg<SVGGElement>): SVGElement;
     /**
      * Initializes the flyout.
+     *
      * @param targetWorkspace The workspace in which to
      *     create new blocks.
      */
@@ -209,45 +225,53 @@ 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;
     /**
      * Get the width of the flyout.
-     * @return The width of the flyout.
+     *
+     * @returns The width of the flyout.
      */
     getWidth(): number;
     /**
      * Get the height of the flyout.
-     * @return The width of the flyout.
+     *
+     * @returns The width of the flyout.
      */
     getHeight(): number;
     /**
      * Get the scale (zoom level) of the flyout. By default,
      * this matches the target workspace scale, but this can be overridden.
-     * @return Flyout workspace scale.
+     *
+     * @returns Flyout workspace scale.
      */
     getFlyoutScale(): number;
     /**
      * Get the workspace inside the flyout.
-     * @return The workspace inside the flyout.
+     *
+     * @returns The workspace inside the flyout.
      * @internal
      */
     getWorkspace(): WorkspaceSvg;
     /**
      * Is the flyout visible?
-     * @return True if visible.
+     *
+     * @returns True if visible.
      */
     isVisible(): boolean;
     /**
      * Set whether the flyout is visible. A value of true does not necessarily
      * mean that the flyout is shown. It could be hidden because its container is
      * hidden.
+     *
      * @param visible True if visible.
      */
     setVisible(visible: boolean): void;
     /**
      * Set whether this flyout's container is visible.
+     *
      * @param visible Whether the container is visible.
      */
     setContainerVisible(visible: boolean): void;
@@ -258,6 +282,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     private updateDisplay_;
     /**
      * Update the view based on coordinates calculated in position().
+     *
      * @param width The computed width of the flyout's SVG group
      * @param height The computed height of the flyout's SVG group.
      * @param x The computed x origin of the flyout's SVG group.
@@ -270,6 +295,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     hide(): void;
     /**
      * Show and populate the flyout.
+     *
      * @param flyoutDef Contents to display
      *     in the flyout. This is either an array of Nodes, a NodeList, a
      *     toolbox definition, or a string with the name of the dynamic category.
@@ -278,43 +304,49 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * Create the contents array and gaps array necessary to create the layout for
      * the flyout.
+     *
      * @param parsedContent The array
      *     of objects to show in the flyout.
-     * @return The list of contents and gaps needed to lay out the flyout.
+     * @returns The list of contents and gaps needed to lay out the flyout.
      */
     private createFlyoutInfo_;
     /**
      * Gets the flyout definition for the dynamic category.
+     *
      * @param categoryName The name of the dynamic category.
-     * @return The definition of the
+     * @returns The definition of the
      *     flyout in one of its many forms.
      */
     private getDynamicCategoryContents_;
     /**
      * Creates a flyout button or a flyout label.
+     *
      * @param btnInfo The object holding information about a button or a label.
      * @param isLabel True if the button is a label, false otherwise.
-     * @return The object used to display the button in the
+     * @returns The object used to display the button in the
      *    flyout.
      */
     private createButton_;
     /**
      * Create a block from the xml and permanently disable any blocks that were
      * defined as disabled.
+     *
      * @param blockInfo The info of the block.
-     * @return The block created from the blockInfo.
+     * @returns The block created from the blockInfo.
      */
     private createFlyoutBlock_;
     /**
      * Returns a block from the array of recycled blocks with the given type, or
      * undefined if one cannot be found.
+     *
      * @param blockType The type of the block to try to recycle.
-     * @return The recycled block, or undefined if
+     * @returns The recycled block, or undefined if
      *     one could not be recycled.
      */
     private getRecycledBlock_;
     /**
      * Adds a gap in the flyout based on block info.
+     *
      * @param blockInfo Information about a block.
      * @param gaps The list of gaps between items in the flyout.
      * @param defaultGap The default gap between one element and the
@@ -323,6 +355,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     private addBlockGap_;
     /**
      * Add the necessary gap in the flyout for a separator.
+     *
      * @param sepInfo The object holding
      *    information about a separator.
      * @param gaps The list gaps between items in the flyout.
@@ -340,19 +373,22 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     private emptyRecycledBlocks_;
     /**
      * Returns whether the given block can be recycled or not.
+     *
      * @param _block The block to check for recyclability.
-     * @return True if the block can be recycled. False otherwise.
+     * @returns True if the block can be recycled. False otherwise.
      */
     protected blockIsRecyclable_(_block: BlockSvg): boolean;
     /**
      * Puts a previously created block into the recycle bin and moves it to the
      * top of the workspace. Used during large workspace swaps to limit the number
      * of new DOM elements we need to create.
+     *
      * @param block The block to recycle.
      */
     private recycleBlock_;
     /**
      * Add listeners to a block that has been added to the flyout.
+     *
      * @param root The root node of the SVG group the block is in.
      * @param block The block to add listeners for.
      * @param rect The invisible rectangle under the block that acts
@@ -361,28 +397,32 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     protected addBlockListeners_(root: SVGElement, block: BlockSvg, rect: SVGElement): void;
     /**
      * Handle a mouse-down on an SVG block in a non-closing flyout.
+     *
      * @param block The flyout block to copy.
-     * @return Function to call when block is clicked.
+     * @returns Function to call when block is clicked.
      */
     private blockMouseDown_;
     /**
      * Mouse down on the flyout background.  Start a vertical scroll drag.
+     *
      * @param e Mouse down event.
      */
     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.
+     *
      * @param block The block to copy from the flyout.
-     * @return True if you can create a new instance of the block, false
+     * @returns True if you can create a new instance of the block, false
      *    otherwise.
      * @internal
      */
     isBlockCreatable(block: BlockSvg): boolean;
     /**
      * Create a copy of this block on the workspace.
+     *
      * @param originalBlock The block to copy from the flyout.
-     * @return The newly created block.
+     * @returns The newly created block.
      * @throws {Error} if something went wrong with deserialization.
      * @internal
      */
@@ -390,6 +430,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * Initialize the given button: move it to the correct location,
      * add listeners, etc.
+     *
      * @param button The button to initialize and place.
      * @param x The x position of the cursor during this layout pass.
      * @param y The y position of the cursor during this layout pass.
@@ -397,6 +438,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     protected initFlyoutButton_(button: FlyoutButton, x: number, y: number): void;
     /**
      * Create and place a rectangle corresponding to the given block.
+     *
      * @param block The block to associate the rect to.
      * @param x The x position of the cursor during this layout pass.
      * @param y The y position of the cursor during this layout pass.
@@ -404,7 +446,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      *     the block.
      * @param index The index into the mats list where this rect should
      *     be placed.
-     * @return Newly created SVG element for the rectangle behind
+     * @returns Newly created SVG element for the rectangle behind
      *     the block.
      */
     protected createRect_(block: BlockSvg, x: number, y: number, blockHW: {
@@ -414,6 +456,7 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
     /**
      * Move a rectangle to sit exactly behind a block, taking into account tabs,
      * hats, and any other protrusions we invent.
+     *
      * @param rect The rectangle to move directly behind the block.
      * @param block The block the rectangle should be behind.
      */
@@ -430,19 +473,21 @@ export declare abstract class Flyout extends DeleteArea implements IFlyout {
      */
     reflow(): void;
     /**
-     * @return True if this flyout may be scrolled with a scrollbar or
+     * @returns True if this flyout may be scrolled with a scrollbar or
      *     by dragging.
      * @internal
      */
     isScrollable(): boolean;
     /**
      * Copy a block from the flyout to the workspace and position it correctly.
+     *
      * @param oldBlock The flyout block to copy.
-     * @return The new block in the main workspace.
+     * @returns The new block in the main workspace.
      */
     private placeNewBlock_;
     /**
      * Positions a block on the target workspace.
+     *
      * @param oldBlock The flyout block being copied.
      * @param block The block to posiiton.
      */
@@ -457,3 +502,4 @@ export interface FlyoutItem {
     block?: BlockSvg | undefined;
 }
 export {};
+//# sourceMappingURL=flyout_base.d.ts.map

package/core/flyout_button.d.ts

@@ -8,6 +8,7 @@ import type * as toolbox from './utils/toolbox.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a button or label in the flyout.
+ *
  * @alias Blockly.FlyoutButton
  */
 export declare class FlyoutButton {
@@ -43,7 +44,8 @@ export declare class FlyoutButton {
     constructor(workspace: WorkspaceSvg, targetWorkspace: WorkspaceSvg, json: toolbox.ButtonOrLabelInfo, isLabel_: boolean);
     /**
      * Create the button elements.
-     * @return The button's SVG group.
+     *
+     * @returns The button's SVG group.
      */
     createDom(): SVGElement;
     /** Correctly position the flyout button and make it visible. */
@@ -52,30 +54,35 @@ export declare class FlyoutButton {
     private updateTransform_;
     /**
      * Move the button to the given x, y coordinates.
+     *
      * @param x The new x coordinate.
      * @param y The new y coordinate.
      */
     moveTo(x: number, y: number): void;
-    /** @return Whether or not the button is a label. */
+    /** @returns Whether or not the button is a label. */
     isLabel(): boolean;
     /**
      * Location of the button.
-     * @return x, y coordinates.
+     *
+     * @returns x, y coordinates.
      * @internal
      */
     getPosition(): Coordinate;
-    /** @return Text of the button. */
+    /** @returns Text of the button. */
     getButtonText(): string;
     /**
      * Get the button's target workspace.
-     * @return The target workspace of the flyout where this button resides.
+     *
+     * @returns The target workspace of the flyout where this button resides.
      */
     getTargetWorkspace(): WorkspaceSvg;
     /** Dispose of this button. */
     dispose(): void;
     /**
      * Do something when the button is clicked.
+     *
      * @param e Mouse up event.
      */
     private onMouseUp_;
 }
+//# sourceMappingURL=flyout_button.d.ts.map

package/core/flyout_horizontal.d.ts

@@ -9,16 +9,16 @@ import type { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
 /**
  * Class for a flyout.
+ *
  * @alias Blockly.HorizontalFlyout
  */
 export declare class HorizontalFlyout extends Flyout {
     horizontalLayout: boolean;
-    width_: any;
-    height_: any;
     /** @param workspaceOptions Dictionary of options for the workspace. */
     constructor(workspaceOptions: Options);
     /**
      * Sets the translation of the flyout to match the scrollbars.
+     *
      * @param xyRatio Contains a y property which is a float between 0 and 1
      *     specifying the degree of scrolling and a similar x property.
      */
@@ -28,18 +28,21 @@ export declare class HorizontalFlyout extends Flyout {
     }): void;
     /**
      * Calculates the x coordinate for the flyout position.
-     * @return X coordinate.
+     *
+     * @returns X coordinate.
      */
     getX(): number;
     /**
      * Calculates the y coordinate for the flyout position.
-     * @return Y coordinate.
+     *
+     * @returns Y coordinate.
      */
     getY(): number;
     /** Move the flyout to the edge of the workspace. */
     position(): void;
     /**
      * Create and set the path for the visible boundaries of the flyout.
+     *
      * @param width The width of the flyout, not including the rounded corners.
      * @param height The height of the flyout, not including rounded corners.
      */
@@ -48,11 +51,13 @@ export declare class HorizontalFlyout extends Flyout {
     scrollToStart(): void;
     /**
      * Scroll the flyout.
+     *
      * @param e Mouse wheel scroll event.
      */
     protected wheel_(e: WheelEvent): void;
     /**
      * Lay out the blocks in the flyout.
+     *
      * @param contents The blocks and buttons to lay out.
      * @param gaps The visible gaps between blocks.
      */
@@ -61,16 +66,18 @@ export declare class HorizontalFlyout extends Flyout {
      * Determine if a drag delta is toward the workspace, based on the position
      * and orientation of the flyout. This is used in determineDragIntention_ to
      * determine if a new block should be created or if the flyout should scroll.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.
-     * @return True if the drag is toward the workspace.
+     * @returns True if the drag is toward the workspace.
      * @internal
      */
     isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean;
     /**
      * Returns the bounding rectangle of the drag target area in pixel units
      * relative to viewport.
-     * @return The component's bounding box. Null if drag target area should be
+     *
+     * @returns The component's bounding box. Null if drag target area should be
      *     ignored.
      */
     getClientRect(): Rect | null;
@@ -80,3 +87,4 @@ export declare class HorizontalFlyout extends Flyout {
      */
     protected reflowInternal_(): void;
 }
+//# sourceMappingURL=flyout_horizontal.d.ts.map

package/core/flyout_metrics_manager.d.ts

@@ -9,6 +9,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Calculates metrics for a flyout's workspace.
  * The metrics are mainly used to size scrollbars for the flyout.
+ *
  * @alias Blockly.FlyoutMetricsManager
  */
 export declare class FlyoutMetricsManager extends MetricsManager {
@@ -22,19 +23,21 @@ export declare class FlyoutMetricsManager extends MetricsManager {
     /**
      * Gets the bounding box of the blocks on the flyout's workspace.
      * This is in workspace coordinates.
-     * @return The bounding box of the blocks on the workspace.
+     *
+     * @returns The bounding box of the blocks on the workspace.
      */
     private getBoundingBox_;
-    getContentMetrics(opt_getWorkspaceCoordinates: boolean): {
+    getContentMetrics(opt_getWorkspaceCoordinates?: boolean): {
         height: number;
         width: number;
         top: number;
         left: number;
     };
-    getScrollMetrics(opt_getWorkspaceCoordinates: boolean, opt_viewMetrics: ContainerRegion, opt_contentMetrics: ContainerRegion): {
+    getScrollMetrics(opt_getWorkspaceCoordinates?: boolean, opt_viewMetrics?: ContainerRegion, opt_contentMetrics?: ContainerRegion): {
         height: number;
         width: number;
         top: number;
         left: number;
     };
 }
+//# sourceMappingURL=flyout_metrics_manager.d.ts.map

package/core/flyout_vertical.d.ts

@@ -9,17 +9,17 @@ import type { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
 /**
  * Class for a flyout.
+ *
  * @alias Blockly.VerticalFlyout
  */
 export declare class VerticalFlyout extends Flyout {
     /** The name of the vertical flyout in the registry. */
     static registryName: string;
-    height_: any;
-    width_: any;
     /** @param workspaceOptions Dictionary of options for the workspace. */
     constructor(workspaceOptions: Options);
     /**
      * Sets the translation of the flyout to match the scrollbars.
+     *
      * @param xyRatio Contains a y property which is a float between 0 and 1
      *     specifying the degree of scrolling and a similar x property.
      */
@@ -29,18 +29,21 @@ export declare class VerticalFlyout extends Flyout {
     }): void;
     /**
      * Calculates the x coordinate for the flyout position.
-     * @return X coordinate.
+     *
+     * @returns X coordinate.
      */
     getX(): number;
     /**
      * Calculates the y coordinate for the flyout position.
-     * @return Y coordinate.
+     *
+     * @returns Y coordinate.
      */
     getY(): number;
     /** Move the flyout to the edge of the workspace. */
     position(): void;
     /**
      * Create and set the path for the visible boundaries of the flyout.
+     *
      * @param width The width of the flyout, not including the rounded corners.
      * @param height The height of the flyout, not including rounded corners.
      */
@@ -49,11 +52,13 @@ export declare class VerticalFlyout extends Flyout {
     scrollToStart(): void;
     /**
      * Scroll the flyout.
+     *
      * @param e Mouse wheel scroll event.
      */
     protected wheel_(e: WheelEvent): void;
     /**
      * Lay out the blocks in the flyout.
+     *
      * @param contents The blocks and buttons to lay out.
      * @param gaps The visible gaps between blocks.
      */
@@ -62,16 +67,18 @@ export declare class VerticalFlyout extends Flyout {
      * Determine if a drag delta is toward the workspace, based on the position
      * and orientation of the flyout. This is used in determineDragIntention_ to
      * determine if a new block should be created or if the flyout should scroll.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.
-     * @return True if the drag is toward the workspace.
+     * @returns True if the drag is toward the workspace.
      * @internal
      */
     isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean;
     /**
      * Returns the bounding rectangle of the drag target area in pixel units
      * relative to viewport.
-     * @return The component's bounding box. Null if drag target area should be
+     *
+     * @returns The component's bounding box. Null if drag target area should be
      *     ignored.
      */
     getClientRect(): Rect | null;
@@ -81,3 +88,4 @@ export declare class VerticalFlyout extends Flyout {
      */
     protected reflowInternal_(): void;
 }
+//# sourceMappingURL=flyout_vertical.d.ts.map