blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/block_animations.d.ts

@@ -6,6 +6,7 @@
 import type { BlockSvg } from './block_svg.js';
 /**
  * Play some UI effects (sound, animation) when disposing of a block.
+ *
  * @param block The block being disposed of.
  * @alias Blockly.blockAnimations.disposeUiEffect
  * @internal
@@ -13,6 +14,7 @@ import type { BlockSvg } from './block_svg.js';
 export declare function disposeUiEffect(block: BlockSvg): void;
 /**
  * Play some UI effects (sound, ripple) after a connection has been established.
+ *
  * @param block The block being connected.
  * @alias Blockly.blockAnimations.connectionUiEffect
  * @internal
@@ -20,6 +22,7 @@ export declare function disposeUiEffect(block: BlockSvg): void;
 export declare function connectionUiEffect(block: BlockSvg): void;
 /**
  * Play some UI effects (sound, animation) when disconnecting a block.
+ *
  * @param block The block being disconnected.
  * @alias Blockly.blockAnimations.disconnectUiEffect
  * @internal
@@ -27,7 +30,9 @@ export declare function connectionUiEffect(block: BlockSvg): void;
 export declare function disconnectUiEffect(block: BlockSvg): void;
 /**
  * Stop the disconnect UI animation immediately.
+ *
  * @alias Blockly.blockAnimations.disconnectUiStop
  * @internal
  */
 export declare function disconnectUiStop(): void;
+//# sourceMappingURL=block_animations.d.ts.map

package/core/block_drag_surface.d.ts

@@ -7,6 +7,7 @@ import { Coordinate } from './utils/coordinate.js';
 /**
  * Class for a drag surface for the currently dragged block. This is a separate
  * SVG that contains only the currently moving block, or nothing.
+ *
  * @alias Blockly.BlockDragSurfaceSvg
  */
 export declare class BlockDragSurfaceSvg {
@@ -37,12 +38,14 @@ export declare class BlockDragSurfaceSvg {
     /**
      * Set the SVG blocks on the drag surface's group and show the surface.
      * Only one block group should be on the drag surface at a time.
+     *
      * @param blocks Block or group of blocks to place on the drag surface.
      */
     setBlocksAndShow(blocks: SVGElement): void;
     /**
      * Translate and scale the entire drag surface group to the given position, to
      * keep in sync with the workspace.
+     *
      * @param x X translation in pixel coordinates.
      * @param y Y translation in pixel coordinates.
      * @param scale Scale of the group.
@@ -50,11 +53,13 @@ export declare class BlockDragSurfaceSvg {
     translateAndScaleGroup(x: number, y: number, scale: number): void;
     /**
      * Translate the drag surface's SVG based on its internal state.
-     * @private
+     *
+     * @internal
      */
     translateSurfaceInternal_(): void;
     /**
      * Translates the entire surface by a relative offset.
+     *
      * @param deltaX Horizontal offset in pixel units.
      * @param deltaY Vertical offset in pixel units.
      */
@@ -64,6 +69,7 @@ export declare class BlockDragSurfaceSvg {
      * We translate the drag surface instead of the blocks inside the surface
      * so that the browser avoids repainting the SVG.
      * Because of this, the drag coordinates must be adjusted by scale.
+     *
      * @param x X translation for the entire surface.
      * @param y Y translation for the entire surface.
      */
@@ -71,31 +77,36 @@ export declare class BlockDragSurfaceSvg {
     /**
      * Reports the surface translation in scaled workspace coordinates.
      * Use this when finishing a drag to return blocks to the correct position.
-     * @return Current translation of the surface.
+     *
+     * @returns Current translation of the surface.
      */
     getSurfaceTranslation(): Coordinate;
     /**
      * Provide a reference to the drag group (primarily for
      * BlockSvg.getRelativeToSurfaceXY).
-     * @return Drag surface group element.
+     *
+     * @returns Drag surface group element.
      */
     getGroup(): SVGElement | null;
     /**
      * Returns the SVG drag surface.
+     *
      * @returns The SVG drag surface.
      */
     getSvgRoot(): SVGElement | null;
     /**
      * Get the current blocks on the drag surface, if any (primarily
      * for BlockSvg.getRelativeToSurfaceXY).
-     * @return Drag surface block DOM element, or null if no blocks exist.
+     *
+     * @returns Drag surface block DOM element, or null if no blocks exist.
      */
     getCurrentBlock(): Element | null;
     /**
      * Gets the translation of the child block surface
      * This surface is in charge of keeping track of how much the workspace has
      * moved.
-     * @return The amount the workspace has been moved.
+     *
+     * @returns The amount the workspace has been moved.
      */
     getWsTranslation(): Coordinate;
     /**
@@ -103,9 +114,11 @@ export declare class BlockDragSurfaceSvg {
      * element.
      * If the block is being deleted it doesn't need to go back to the original
      * surface, since it would be removed immediately during dispose.
+     *
      * @param opt_newSurface Surface the dragging blocks should be moved to, or
      *     null if the blocks should be removed from this surface without being
      *     moved to a different surface.
      */
     clearAndHide(opt_newSurface?: Element): void;
 }
+//# sourceMappingURL=block_drag_surface.d.ts.map

package/core/block_dragger.d.ts

@@ -13,6 +13,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a block dragger.  It moves blocks around the workspace when they
  * are being dragged by a mouse or touch.
+ *
  * @alias Blockly.BlockDragger
  */
 export declare class BlockDragger implements IBlockDragger {
@@ -34,11 +35,13 @@ export declare class BlockDragger implements IBlockDragger {
     constructor(block: BlockSvg, workspace: WorkspaceSvg);
     /**
      * Sever all links from this object.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Start dragging a block.  This includes moving it to the drag surface.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.
      * @param healStack Whether or not to heal the stack after disconnecting.
@@ -46,12 +49,14 @@ export declare class BlockDragger implements IBlockDragger {
     startDrag(currentDragDeltaXY: Coordinate, healStack: boolean): void;
     /**
      * Whether or not we should disconnect the block when a drag is started.
+     *
      * @param healStack Whether or not to heal the stack after disconnecting.
-     * @return True to disconnect the block, false otherwise.
+     * @returns True to disconnect the block, false otherwise.
      */
     protected shouldDisconnect_(healStack: boolean): boolean;
     /**
      * Disconnects the block and moves it to a new location.
+     *
      * @param healStack Whether or not to heal the stack after disconnecting.
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at mouse down, in pixel units.
@@ -62,6 +67,7 @@ export declare class BlockDragger implements IBlockDragger {
     /**
      * Execute a step of block dragging, based on the given event.  Update the
      * display accordingly.
+     *
      * @param e The most recent move event.
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel units.
@@ -69,6 +75,7 @@ export declare class BlockDragger implements IBlockDragger {
     drag(e: Event, currentDragDeltaXY: Coordinate): void;
     /**
      * Finish a block drag and put the block back on the workspace.
+     *
      * @param e The mouseup/touchend event.
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel units.
@@ -76,9 +83,10 @@ export declare class BlockDragger implements IBlockDragger {
     endDrag(e: Event, currentDragDeltaXY: Coordinate): void;
     /**
      * Calculates the drag delta and new location values after a block is dragged.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the start of
      *     the drag, in pixel units.
-     * @return New location after drag. delta is in workspace units. newLocation
+     * @returns New location after drag. delta is in workspace units. newLocation
      *     is the new coordinate where the block should end up.
      */
     protected getNewLocationAfterDrag_(currentDragDeltaXY: Coordinate): {
@@ -89,11 +97,13 @@ export declare class BlockDragger implements IBlockDragger {
      * May delete the dragging block, if allowed. If `this.wouldDeleteBlock_` is
      * not true, the block will not be deleted. This should be called at the end
      * of a block drag.
-     * @return True if the block was deleted.
+     *
+     * @returns True if the block was deleted.
      */
     protected maybeDeleteBlock_(): boolean;
     /**
      * Updates the necessary information to place a block at a certain location.
+     *
      * @param delta The change in location from where the block started the drag
      *     to where it ended the drag.
      */
@@ -104,6 +114,7 @@ export declare class BlockDragger implements IBlockDragger {
      * Adds or removes the style of the cursor for the toolbox.
      * This is what changes the cursor to display an x when a deletable block is
      * held over the toolbox.
+     *
      * @param isEnd True if we are at the end of a drag, false otherwise.
      */
     protected updateToolboxStyle_(isEnd: boolean): void;
@@ -119,12 +130,14 @@ export declare class BlockDragger implements IBlockDragger {
      * correction for mutator workspaces.
      * This function does not consider differing origins.  It simply scales the
      * input's x and y values.
+     *
      * @param pixelCoord A coordinate with x and y values in CSS pixel units.
-     * @return The input coordinate divided by the workspace scale.
+     * @returns The input coordinate divided by the workspace scale.
      */
     protected pixelsToWorkspaceUnits_(pixelCoord: Coordinate): Coordinate;
     /**
      * Move all of the icons connected to this drag.
+     *
      * @param dxy How far to move the icons from their original positions, in
      *     workspace units.
      */
@@ -132,7 +145,8 @@ export declare class BlockDragger implements IBlockDragger {
     /**
      * Get a list of the insertion markers that currently exist.  Drags have 0, 1,
      * or 2 insertion markers.
-     * @return A possibly empty list of insertion marker blocks.
+     *
+     * @returns A possibly empty list of insertion marker blocks.
      */
     getInsertionMarkers(): BlockSvg[];
 }
@@ -141,3 +155,4 @@ export interface IconPositionData {
     location: Coordinate;
     icon: Icon;
 }
+//# sourceMappingURL=block_dragger.d.ts.map