blockly 9.3.0-beta.0 → 9.3.0

package/core/workspace_comment_svg.d.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import './events/events_selected.js';
+import type { BlockDragSurfaceSvg } from './block_drag_surface.js';
 import type { IBoundedElement } from './interfaces/i_bounded_element.js';
 import type { IBubble } from './interfaces/i_bubble.js';
 import type { CopyData, ICopyable } from './interfaces/i_copyable.js';
@@ -13,8 +14,6 @@ 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 {
     /**
@@ -43,9 +42,10 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
     private focused_;
     private autoLayout_;
     private readonly svgGroup_;
-    svgRect_: any;
+    svgRect_: SVGRectElement;
     /** Whether the comment is rendered onscreen and is a part of the DOM. */
     private rendered_;
+    private readonly useDragSurface_;
     /**
      * @param workspace The block's workspace.
      * @param content The content of this workspace comment.
@@ -147,12 +147,23 @@ export declare class WorkspaceCommentSvg extends WorkspaceComment implements IBo
      */
     translate(x: number, y: number): void;
     /**
-     * Move this comment during a drag.
+     * 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.
      * @internal
      */
-    moveDuringDrag(newLoc: Coordinate): void;
+    moveDuringDrag(dragSurface: BlockDragSurfaceSvg, newLoc: Coordinate): void;
     /**
      * Move the bubble group to the specified location in workspace coordinates.
      *

package/core/workspace_drag_surface_svg.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @license
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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 {
+    private readonly container;
+    /**
+     * The SVG drag surface. Set once by WorkspaceDragSurfaceSvg.createDom.
+     */
+    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;
+    /** @param container Containing element. */
+    constructor(container: Element);
+    /** Create the drag surface and inject it into the container. */
+    createDom(): void;
+    /**
+     * Translate the entire drag surface during a drag.
+     * 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
+     */
+    translateSurface(x: number, y: number): void;
+    /**
+     * Reports the surface translation in scaled workspace coordinates.
+     * Use this when finishing a drag to return blocks to the correct position.
+     *
+     * @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
+       bubbles.
+     * @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
+     */
+    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

@@ -8,8 +8,9 @@ import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a workspace dragger.  It moves the workspace around when it is
  * being dragged by a mouse or touch.
- *
- * @alias Blockly.WorkspaceDragger
+ * 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.
  */
 export declare class WorkspaceDragger {
     private workspace;

package/core/workspace_svg.d.ts

@@ -7,6 +7,7 @@ import './events/events_block_create.js';
 import './events/events_theme_change.js';
 import './events/events_viewport.js';
 import type { Block } from './block.js';
+import type { BlockDragSurfaceSvg } from './block_drag_surface.js';
 import type { BlockSvg } from './block_svg.js';
 import * as browserEvents from './browser_events.js';
 import { ComponentManager } from './component_manager.js';
@@ -39,13 +40,12 @@ import type { VariableModel } from './variable_model.js';
 import { Workspace } from './workspace.js';
 import { WorkspaceAudio } from './workspace_audio.js';
 import { WorkspaceComment } from './workspace_comment.js';
+import type { WorkspaceDragSurfaceSvg } from './workspace_drag_surface_svg.js';
 import { ZoomControls } from './zoom_controls.js';
 import { ContextMenuOption } from './contextmenu_registry.js';
 /**
  * Class for a workspace.  This is an onscreen area with optional trashcan,
  * scrollbars, bubbles, and dragging.
- *
- * @alias Blockly.WorkspaceSvg
  */
 export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationSvg {
     /**
@@ -164,6 +164,22 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      * @internal
      */
     currentGesture_: Gesture | null;
+    /** This workspace's surface for dragging blocks, if it exists. */
+    private readonly blockDragSurface;
+    /** This workspace's drag surface, if it exists. */
+    private readonly workspaceDragSurface;
+    /**
+     * Whether to move workspace to the drag surface when it is dragged.
+     * True if it should move, false if it should be translated directly.
+     */
+    private readonly useWorkspaceDragSurface;
+    /**
+     * Whether the drag surface is actively in use. When true, calls to
+     * translate will translate the drag surface instead of the translating the
+     * workspace directly.
+     * This is set to true in setupDragSurface and to false in resetDragSurface.
+     */
+    private isDragSurfaceActive;
     /**
      * The first parent div with 'injectionDiv' in the name, or null if not set.
      * Access this with getInjectionDiv.
@@ -240,8 +256,10 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     zoomControls_: ZoomControls | null;
     /**
      * @param options Dictionary of options.
+     * @param opt_blockDragSurface Drag surface for blocks.
+     * @param opt_wsDragSurface Drag surface for the workspace.
      */
-    constructor(options: Options);
+    constructor(options: Options, opt_blockDragSurface?: BlockDragSurfaceSvg, opt_wsDragSurface?: WorkspaceDragSurfaceSvg);
     /**
      * Get the marker manager for this workspace.
      *
@@ -527,6 +545,29 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
      *     the Blockly div.
      */
     translate(x: number, y: number): void;
+    /**
+     * Called at the end of a workspace drag to take the contents
+     * out of the drag surface and put them back into the workspace SVG.
+     * Does nothing if the workspace drag surface is not enabled.
+     *
+     * @internal
+     */
+    resetDragSurface(): void;
+    /**
+     * Called at the beginning of a workspace drag to move contents of
+     * the workspace to the drag surface.
+     * Does nothing if the drag surface is not enabled.
+     *
+     * @internal
+     */
+    setupDragSurface(): void;
+    /**
+     * Gets the drag surface blocks are moved to when a drag is started.
+     *
+     * @returns This workspace's block drag surface, if one is in use.
+     * @internal
+     */
+    getBlockDragSurface(): BlockDragSurfaceSvg | null;
     /**
      * Returns the horizontal offset of the workspace.
      * Intended for LTR/RTL compatibility in XML.
@@ -721,8 +762,6 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     updateToolbox(toolboxDef: toolbox.ToolboxDefinition | null): void;
     /** Mark this workspace as the currently focused main workspace. */
     markFocused(): void;
-    /** Set the workspace to have focus in the browser. */
-    private setBrowserFocus;
     /**
      * Zooms the workspace in or out relative to/centered on the given (x, y)
      * coordinate.
@@ -762,11 +801,13 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
     scrollCenter(): void;
     /**
      * Scroll the workspace to center on the given block. If the block has other
-     * blocks stacked below it, the workspace will be centered on the stack.
+     * blocks stacked below it, the workspace will be centered on the stack,
+     * unless blockOnly is true.
      *
      * @param id ID of block center on.
+     * @param blockOnly True to center only on the block itself, not its stack.
      */
-    centerOnBlock(id: string | null): void;
+    centerOnBlock(id: string | null, blockOnly?: boolean): void;
     /**
      * Set the workspace's zoom factor.
      *
@@ -974,7 +1015,6 @@ export declare class WorkspaceSvg extends Workspace implements IASTNodeLocationS
  * scrollbars accordingly.
  *
  * @param workspace The workspace to resize.
- * @alias Blockly.WorkspaceSvg.resizeSvgContents
  * @internal
  */
 export declare function resizeSvgContents(workspace: WorkspaceSvg): void;

package/core/xml.d.ts

@@ -13,7 +13,6 @@ import type { WorkspaceSvg } from './workspace_svg.js';
  * @param workspace The workspace containing blocks.
  * @param opt_noId True if the encoder should skip the block IDs.
  * @returns XML DOM element.
- * @alias Blockly.Xml.workspaceToDom
  */
 export declare function workspaceToDom(workspace: Workspace, opt_noId?: boolean): Element;
 /**
@@ -21,7 +20,6 @@ export declare function workspaceToDom(workspace: Workspace, opt_noId?: boolean)
  *
  * @param variableList List of all variable models.
  * @returns Tree of XML elements.
- * @alias Blockly.Xml.variablesToDom
  */
 export declare function variablesToDom(variableList: VariableModel[]): Element;
 /**
@@ -31,7 +29,6 @@ export declare function variablesToDom(variableList: VariableModel[]): Element;
  * @param opt_noId True if the encoder should skip the block ID.
  * @returns Tree of XML elements or an empty document fragment if the block was
  *     an insertion marker.
- * @alias Blockly.Xml.blockToDomWithXY
  */
 export declare function blockToDomWithXY(block: Block, opt_noId?: boolean): Element | DocumentFragment;
 /**
@@ -41,7 +38,6 @@ export declare function blockToDomWithXY(block: Block, opt_noId?: boolean): Elem
  * @param opt_noId True if the encoder should skip the block ID.
  * @returns Tree of XML elements or an empty document fragment if the block was
  *     an insertion marker.
- * @alias Blockly.Xml.blockToDom
  */
 export declare function blockToDom(block: Block, opt_noId?: boolean): Element | DocumentFragment;
 /**
@@ -51,7 +47,6 @@ export declare function blockToDom(block: Block, opt_noId?: boolean): Element |
  *
  * @param dom A tree of XML nodes.
  * @returns Text representation.
- * @alias Blockly.Xml.domToText
  */
 export declare function domToText(dom: Node): string;
 /**
@@ -59,7 +54,6 @@ export declare function domToText(dom: Node): string;
  *
  * @param dom A tree of XML elements.
  * @returns Text representation.
- * @alias Blockly.Xml.domToPrettyText
  */
 export declare function domToPrettyText(dom: Node): string;
 /**
@@ -69,7 +63,7 @@ export declare function domToPrettyText(dom: Node): string;
  * @returns A DOM object representing the singular child of the document
  *     element.
  * @throws if the text doesn't parse.
- * @alias Blockly.Xml.textToDom
+ * @deprecated Moved to core/utils/xml.js.
  */
 export declare function textToDom(text: string): Element;
 /**
@@ -79,7 +73,6 @@ export declare function textToDom(text: string): Element;
  * @param xml XML DOM.
  * @param workspace The workspace.
  * @returns An array containing new block IDs.
- * @alias Blockly.Xml.clearWorkspaceAndLoadFromXml
  */
 export declare function clearWorkspaceAndLoadFromXml(xml: Element, workspace: WorkspaceSvg): string[];
 /**
@@ -90,7 +83,6 @@ export declare function clearWorkspaceAndLoadFromXml(xml: Element, workspace: Wo
  * @returns An array containing new block IDs.
  * @suppress {strictModuleDepCheck} Suppress module check while workspace
  * comments are not bundled in.
- * @alias Blockly.Xml.domToWorkspace
  */
 export declare function domToWorkspace(xml: Element, workspace: Workspace): string[];
 /**
@@ -100,7 +92,6 @@ export declare function domToWorkspace(xml: Element, workspace: Workspace): stri
  * @param xml The XML DOM.
  * @param workspace The workspace to add to.
  * @returns An array containing new block IDs.
- * @alias Blockly.Xml.appendDomToWorkspace
  */
 export declare function appendDomToWorkspace(xml: Element, workspace: WorkspaceSvg): string[];
 /**
@@ -110,7 +101,6 @@ export declare function appendDomToWorkspace(xml: Element, workspace: WorkspaceS
  * @param xmlBlock XML block element.
  * @param workspace The workspace.
  * @returns The root block created.
- * @alias Blockly.Xml.domToBlock
  */
 export declare function domToBlock(xmlBlock: Element, workspace: Workspace): Block;
 /**
@@ -118,7 +108,6 @@ export declare function domToBlock(xmlBlock: Element, workspace: Workspace): Blo
  *
  * @param xmlVariables List of XML variable elements.
  * @param workspace The workspace to which the variable should be added.
- * @alias Blockly.Xml.domToVariables
  */
 export declare function domToVariables(xmlVariables: Element, workspace: Workspace): void;
 /**
@@ -126,7 +115,6 @@ export declare function domToVariables(xmlVariables: Element, workspace: Workspa
  *
  * @param xmlBlock XML block element or an empty DocumentFragment if the block
  *     was an insertion marker.
- * @alias Blockly.Xml.deleteNext
  */
 export declare function deleteNext(xmlBlock: Element | DocumentFragment): void;
 //# sourceMappingURL=xml.d.ts.map

package/core/zoom_controls.d.ts

@@ -10,8 +10,6 @@ import { Rect } from './utils/rect.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a zoom controls.
- *
- * @alias Blockly.ZoomControls
  */
 export declare class ZoomControls implements IPositionable {
     private readonly workspace;
@@ -21,20 +19,11 @@ export declare class ZoomControls implements IPositionable {
      */
     id: string;
     /**
-     * A handle to use to unbind the mouse down event handler for zoom reset
-     *    button. Opaque data returned from browserEvents.conditionalBind.
+     * Array holding info needed to unbind events.
+     * Used for disposing.
+     * Ex: [[node, name, func], [node, name, func]].
      */
-    private onZoomResetWrapper;
-    /**
-     * A handle to use to unbind the mouse down event handler for zoom in
-     * button. Opaque data returned from browserEvents.conditionalBind.
-     */
-    private onZoomInWrapper;
-    /**
-     * A handle to use to unbind the mouse down event handler for zoom out
-     * button. Opaque data returned from browserEvents.conditionalBind.
-     */
-    private onZoomOutWrapper;
+    private boundEvents;
     /** The zoom in svg <g> element. */
     private zoomInGroup;
     /** The zoom out svg <g> element. */