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

package/core/workspace_comment_svg.d.ts

@@ -14,12 +14,14 @@ import { WorkspaceComment } from './workspace_comment.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a workspace comment's SVG representation.
+ *
  * @alias Blockly.WorkspaceCommentSvg
  */
 export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBoundedElement, IBubble, ICopyable {
     /**
      * The width and height to use to size a workspace comment when it is first
      * added, before it has been edited by the user.
+     *
      * @internal
      */
     static DEFAULT_SIZE: number;
@@ -57,6 +59,7 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     constructor(workspace: WorkspaceSvg, content: string, height: number, width: number, opt_id?: string);
     /**
      * Dispose of this comment.
+     *
      * @internal
      */
     dispose(): void;
@@ -70,42 +73,50 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     initSvg(opt_noSelect?: boolean): void;
     /**
      * Handle a mouse-down on an SVG comment.
+     *
      * @param e Mouse down event or touch start event.
      */
     private pathMouseDown_;
     /**
      * Show the context menu for this workspace comment.
+     *
      * @param e Mouse event.
      * @internal
      */
     showContextMenu(e: Event): void;
     /**
      * Select this comment.  Highlight it visually.
+     *
      * @internal
      */
     select(): void;
     /**
      * Unselect this comment.  Remove its highlighting.
+     *
      * @internal
      */
     unselect(): void;
     /**
      * Select this comment.  Highlight it visually.
+     *
      * @internal
      */
     addSelect(): void;
     /**
      * Unselect this comment.  Remove its highlighting.
+     *
      * @internal
      */
     removeSelect(): void;
     /**
      * Focus this comment.  Highlight it visually.
+     *
      * @internal
      */
     addFocus(): void;
     /**
      * Unfocus this comment.  Remove its highlighting.
+     *
      * @internal
      */
     removeFocus(): void;
@@ -115,12 +126,14 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      * If the comment is on the workspace, (0, 0) is the origin of the workspace
      * coordinate system.
      * This does not change with workspace scale.
-     * @return Object with .x and .y properties in workspace coordinates.
+     *
+     * @returns Object with .x and .y properties in workspace coordinates.
      * @internal
      */
     getRelativeToSurfaceXY(): Coordinate;
     /**
      * Move a comment by a relative offset.
+     *
      * @param dx Horizontal offset, in workspace units.
      * @param dy Vertical offset, in workspace units.
      * @internal
@@ -129,6 +142,7 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     /**
      * Transforms a comment by setting the translation on the transform attribute
      * of the block's SVG.
+     *
      * @param x The x coordinate of the translation in workspace units.
      * @param y The y coordinate of the translation in workspace units.
      * @internal
@@ -138,12 +152,14 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      * Move this comment to its workspace's drag surface, accounting for
      * positioning.  Generally should be called at the same time as
      * setDragging(true).  Does nothing if useDragSurface_ is false.
+     *
      * @internal
      */
     moveToDragSurface(): void;
     /**
      * Move this comment during a drag, taking into account whether we are using a
      * drag surface to translate blocks.
+     *
      * @param dragSurface The surface that carries rendered items during a drag,
      *     or null if no drag surface is in use.
      * @param newLoc The location to translate to, in workspace coordinates.
@@ -152,6 +168,7 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     moveDuringDrag(dragSurface: BlockDragSurfaceSvg, newLoc: Coordinate): void;
     /**
      * Move the bubble group to the specified location in workspace coordinates.
+     *
      * @param x The x position to move to.
      * @param y The y position to move to.
      * @internal
@@ -166,53 +183,62 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      * Returns the coordinates of a bounding box describing the dimensions of this
      * comment.
      * Coordinate system: workspace coordinates.
-     * @return Object with coordinates of the bounding box.
+     *
+     * @returns Object with coordinates of the bounding box.
      * @internal
      */
     getBoundingRectangle(): Rect;
     /**
      * Add or remove the UI indicating if this comment is movable or not.
+     *
      * @internal
      */
     updateMovable(): void;
     /**
      * Set whether this comment is movable or not.
+     *
      * @param movable True if movable.
      * @internal
      */
     setMovable(movable: boolean): void;
     /**
      * Set whether this comment is editable or not.
+     *
      * @param editable True if editable.
      */
     setEditable(editable: boolean): void;
     /**
      * Recursively adds or removes the dragging class to this node and its
      * children.
+     *
      * @param adding True if adding, false if removing.
      * @internal
      */
     setDragging(adding: boolean): void;
     /**
      * Return the root node of the SVG or null if none exists.
-     * @return The root SVG node (probably a group).
+     *
+     * @returns The root SVG node (probably a group).
      * @internal
      */
     getSvgRoot(): SVGElement;
     /**
      * Returns this comment's text.
-     * @return Comment text.
+     *
+     * @returns Comment text.
      * @internal
      */
     getContent(): string;
     /**
      * Set this comment's content.
+     *
      * @param content Comment content.
      * @internal
      */
     setContent(content: string): void;
     /**
      * Update the cursor over this comment by adding or removing a class.
+     *
      * @param enable True if the delete cursor should be shown, false otherwise.
      * @internal
      */
@@ -221,26 +247,30 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      * Set whether auto-layout of this bubble is enabled.  The first time a bubble
      * is shown it positions itself to not cover any blocks.  Once a user has
      * dragged it to reposition, it renders where the user put it.
+     *
      * @param _enable True if auto-layout should be enabled, false otherwise.
      * @internal
      */
     setAutoLayout(_enable: boolean): void;
     /**
      * Encode a comment subtree as XML with XY coordinates.
+     *
      * @param opt_noId True if the encoder should skip the comment ID.
-     * @return Tree of XML elements.
+     * @returns Tree of XML elements.
      * @internal
      */
     toXmlWithXY(opt_noId?: boolean): Element;
     /**
      * Encode a comment for copying.
-     * @return Copy metadata.
+     *
+     * @returns Copy metadata.
      * @internal
      */
     toCopyData(): CopyData;
     /**
      * Returns a bounding box describing the dimensions of this comment.
-     * @return Object with height and width properties in workspace units.
+     *
+     * @returns Object with height and width properties in workspace units.
      * @internal
      */
     getHeightWidth(): {
@@ -249,12 +279,14 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     };
     /**
      * Renders the workspace comment.
+     *
      * @internal
      */
     render(): void;
     /**
      * Create the text area for the comment.
-     * @return The top-level node of the editor.
+     *
+     * @returns The top-level node of the editor.
      */
     private createEditor_;
     /** Add the resize icon to the DOM */
@@ -263,21 +295,25 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     private addDeleteDom_;
     /**
      * Handle a mouse-down on comment's resize corner.
+     *
      * @param e Mouse down event.
      */
     private resizeMouseDown_;
     /**
      * Handle a mouse-down on comment's delete icon.
+     *
      * @param e Mouse down event.
      */
     private deleteMouseDown_;
     /**
      * Handle a mouse-out on comment's delete icon.
+     *
      * @param _e Mouse out event.
      */
     private deleteMouseOut_;
     /**
      * Handle a mouse-up on comment's delete icon.
+     *
      * @param e Mouse up event.
      */
     private deleteMouseUp_;
@@ -285,11 +321,13 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     private unbindDragEvents_;
     /**
      * Handle a mouse-up event while dragging a comment's border or resize handle.
+     *
      * @param _e Mouse up event.
      */
     private resizeMouseUp_;
     /**
      * Resize this comment to follow the mouse.
+     *
      * @param e Mouse move event.
      */
     private resizeMouseMove_;
@@ -300,6 +338,7 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     private resizeComment_;
     /**
      * Set size
+     *
      * @param width width of the container
      * @param height height of the container
      */
@@ -308,22 +347,26 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     private disposeInternal_;
     /**
      * Set the focus on the text area.
+     *
      * @internal
      */
     setFocus(): void;
     /**
      * Remove focus from the text area.
+     *
      * @internal
      */
     blurFocus(): void;
     /**
      * Decode an XML comment tag and create a rendered comment on the workspace.
+     *
      * @param xmlComment XML comment element.
      * @param workspace The workspace.
      * @param opt_wsWidth The width of the workspace, which is used to position
      *     comments correctly in RTL.
-     * @return The created workspace comment.
+     * @returns The created workspace comment.
      * @internal
      */
     static fromXmlRendered(xmlComment: Element, workspace: WorkspaceSvg, opt_wsWidth?: number): WorkspaceCommentSvg;
 }
+//# sourceMappingURL=workspace_comment_svg.d.ts.map

package/core/workspace_drag_surface_svg.d.ts

@@ -8,6 +8,7 @@ import type { Coordinate } from './utils/coordinate.js';
  * Blocks are moved into this SVG during a drag, improving performance.
  * The entire SVG is translated using CSS transforms instead of SVG so the
  * blocks are never repainted during drag improving performance.
+ *
  * @alias Blockly.WorkspaceDragSurfaceSvg
  */
 export declare class WorkspaceDragSurfaceSvg {
@@ -15,12 +16,12 @@ export declare class WorkspaceDragSurfaceSvg {
     /**
      * The SVG drag surface. Set once by WorkspaceDragSurfaceSvg.createDom.
      */
-    private SVG_;
+    private SVG;
     /**
      * The element to insert the block canvas and bubble canvas after when it
      * goes back in the DOM at the end of a drag.
      */
-    private previousSibling_;
+    private previousSibling;
     /** @param container Containing element. */
     constructor(container: Element);
     /** Create the drag surface and inject it into the container. */
@@ -30,6 +31,7 @@ export declare class WorkspaceDragSurfaceSvg {
      * 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
      * @internal
@@ -38,31 +40,35 @@ export declare class WorkspaceDragSurfaceSvg {
     /**
      * 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
      * @internal
      */
     getSurfaceTranslation(): Coordinate;
     /**
      * Move the blockCanvas and bubbleCanvas out of the surface SVG and on to
      * newSurface.
+     *
      * @param newSurface The element to put the drag surface contents into.
      * @internal
      */
     clearAndHide(newSurface: SVGElement): void;
     /**
-       * Set the SVG to have the block canvas and bubble canvas in it and then
-       * show the surface.
-       * @param blockCanvas The block canvas <g> element from the
-       *     workspace.
-       * @param bubbleCanvas The <g> element that contains the
+     * Set the SVG to have the block canvas and bubble canvas in it and then
+     * show the surface.
+     *
+     * @param blockCanvas The block canvas <g> element from the
+     *     workspace.
+     * @param bubbleCanvas The <g> element that contains the
        bubbles.
-       * @param previousSibling The element to insert the block canvas and
+     * @param previousSibling The element to insert the block canvas and
              bubble canvas after when it goes back in the DOM at the end of a
        drag.
-       * @param width The width of the workspace SVG element.
-       * @param height The height of the workspace SVG element.
-       * @param scale The scale of the workspace being dragged.
-   * @internal
-       */
+     * @param width The width of the workspace SVG element.
+     * @param height The height of the workspace SVG element.
+     * @param scale The scale of the workspace being dragged.
+     * @internal
+     */
     setContentsAndShow(blockCanvas: SVGElement, bubbleCanvas: SVGElement, previousSibling: Element, width: number, height: number, scale: number): void;
 }
+//# sourceMappingURL=workspace_drag_surface_svg.d.ts.map

package/core/workspace_dragger.d.ts

@@ -11,6 +11,7 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * Note that the workspace itself manages whether or not it has a drag surface
  * and how to do translations based on that.  This simply passes the right
  * commands based on events.
+ *
  * @alias Blockly.WorkspaceDragger
  */
 export declare class WorkspaceDragger {
@@ -22,17 +23,20 @@ export declare class WorkspaceDragger {
     constructor(workspace: WorkspaceSvg);
     /**
      * Sever all links from this object.
+     *
      * @suppress {checkTypes}
      * @internal
      */
     dispose(): void;
     /**
      * Start dragging the workspace.
+     *
      * @internal
      */
     startDrag(): void;
     /**
      * Finish dragging the workspace and put everything back where it belongs.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel coordinates.
      * @internal
@@ -40,9 +44,11 @@ export declare class WorkspaceDragger {
     endDrag(currentDragDeltaXY: Coordinate): void;
     /**
      * Move the workspace based on the most recent mouse movements.
+     *
      * @param currentDragDeltaXY How far the pointer has moved from the position
      *     at the start of the drag, in pixel coordinates.
      * @internal
      */
     drag(currentDragDeltaXY: Coordinate): void;
 }
+//# sourceMappingURL=workspace_dragger.d.ts.map