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

package/core/renderers/common/info.d.ts

@@ -21,12 +21,13 @@ import type { Renderer } from './renderer.js';
  * This measure pass does not propagate changes to the block (although fields
  * may choose to rerender when getSize() is called).  However, calling it
  * repeatedly may be expensive.
+ *
  * @alias Blockly.blockRendering.RenderInfo
  */
 export declare class RenderInfo {
-    block_: any;
+    block_: BlockSvg;
     protected constants_: ConstantProvider;
-    outputConnection: OutputConnection;
+    outputConnection: OutputConnection | null;
     isInline: boolean;
     isCollapsed: boolean;
     isInsertionMarker: boolean;
@@ -61,7 +62,8 @@ export declare class RenderInfo {
     constructor(renderer: Renderer, block: BlockSvg);
     /**
      * Get the block renderer in use.
-     * @return The block renderer in use.
+     *
+     * @returns The block renderer in use.
      * @internal
      */
     getRenderer(): Renderer;
@@ -72,6 +74,7 @@ export declare class RenderInfo {
      * This measure pass does not propagate changes to the block (although fields
      * may choose to rerender when getSize() is called).  However, calling it
      * repeatedly may be expensive.
+     *
      * @internal
      */
     measure(): void;
@@ -82,37 +85,42 @@ export declare class RenderInfo {
     protected createRows_(): void;
     /**
      * Create all non-spacer elements that belong on the top row.
+     *
      * @internal
      */
     populateTopRow_(): void;
     /**
      * Create all non-spacer elements that belong on the bottom row.
+     *
      * @internal
      */
     populateBottomRow_(): void;
     /**
      * Add an input element to the active row, if needed, and record the type of
      * the input on the row.
+     *
      * @param input The input to record information about.
      * @param activeRow The row that is currently being populated.
      */
     protected addInput_(input: Input, activeRow: Row): void;
     /**
      * Decide whether to start a new row between the two Blockly.Inputs.
+     *
      * @param input The first input to consider
      * @param lastInput The input that follows.
-     * @return True if the next input should be rendered on a new row.
+     * @returns True if the next input should be rendered on a new row.
      */
-    protected shouldStartNewRow_(input: Input, lastInput: Input): boolean;
+    protected shouldStartNewRow_(input: Input, lastInput?: Input): boolean;
     /** Add horizontal spacing between and around elements within each row. */
     protected addElemSpacing_(): void;
     /**
      * Calculate the width of a spacer element in a row based on the previous and
      * next elements in that row.  For instance, extra padding is added between
      * two editable fields.
+     *
      * @param prev The element before the spacer.
      * @param next The element after the spacer.
-     * @return The size of the spacing between the two elements.
+     * @returns The size of the spacing between the two elements.
      */
     protected getInRowSpacing_(prev: Measurable | null, next: Measurable | null): number;
     /**
@@ -128,14 +136,16 @@ export declare class RenderInfo {
     protected alignRowElements_(): void;
     /**
      * Calculate the desired width of an input row.
+     *
      * @param _row The input row.
-     * @return The desired width of the input row.
+     * @returns The desired width of the input row.
      */
     protected getDesiredRowWidth_(_row: Row): number;
     /**
      * Modify the given row to add the given amount of padding around its fields.
      * The exact location of the padding is based on the alignment property of the
      * last input in the field.
+     *
      * @param row The row to add padding to.
      * @param missingSpace How much padding to add.
      */
@@ -143,6 +153,7 @@ export declare class RenderInfo {
     /**
      * Align the elements of a statement row based on computed bounds.
      * Unlike other types of rows, statement rows add space in multiple places.
+     *
      * @param row The statement row to resize.
      */
     protected alignStatementRow_(row: InputRow): void;
@@ -150,23 +161,26 @@ export declare class RenderInfo {
     protected addRowSpacing_(): void;
     /**
      * Create a spacer row to go between prev and next, and set its size.
+     *
      * @param prev The previous row.
      * @param next The next row.
-     * @return The newly created spacer row.
+     * @returns The newly created spacer row.
      */
     protected makeSpacerRow_(prev: Row, next: Row): SpacerRow;
     /**
      * Calculate the width of a spacer row.
+     *
      * @param _prev The row before the spacer.
      * @param _next The row after the spacer.
-     * @return The desired width of the spacer row between these two rows.
+     * @returns The desired width of the spacer row between these two rows.
      */
     protected getSpacerRowWidth_(_prev: Row, _next: Row): number;
     /**
      * Calculate the height of a spacer row.
+     *
      * @param _prev The row before the spacer.
      * @param _next The row after the spacer.
-     * @return The desired height of the spacer row between these two rows.
+     * @returns The desired height of the spacer row between these two rows.
      */
     protected getSpacerRowHeight_(_prev: Row, _next: Row): number;
     /**
@@ -174,15 +188,17 @@ export declare class RenderInfo {
      * This base implementation puts the centerline at the middle of the row
      * vertically, with no special cases.  You will likely need extra logic to
      * handle (at minimum) top and bottom rows.
+     *
      * @param row The row containing the element.
      * @param elem The element to place.
-     * @return The desired centerline of the given element, as an offset from the
+     * @returns The desired centerline of the given element, as an offset from the
      *     top left of the block.
      */
     protected getElemCenterline_(row: Row, elem: Measurable): number;
     /**
      * Record final position information on elements on the given row, for use in
      * drawing.  At minimum this records xPos and centerline on each element.
+     *
      * @param row The row containing the elements.
      */
     protected recordElemPositions_(row: Row): void;
@@ -192,3 +208,4 @@ export declare class RenderInfo {
      */
     protected finalize_(): void;
 }
+//# sourceMappingURL=info.d.ts.map

package/core/renderers/common/marker_svg.d.ts

@@ -12,6 +12,7 @@ import type { WorkspaceSvg } from '../../workspace_svg.js';
 import type { ConstantProvider, Notch, PuzzleTab } from './constants.js';
 /**
  * Class for a marker.
+ *
  * @alias Blockly.blockRendering.MarkerSvg
  */
 export declare class MarkerSvg {
@@ -23,7 +24,7 @@ export declare class MarkerSvg {
      */
     private parent_;
     /** The current SVG element for the marker. */
-    currentMarkerSvg: Element | null;
+    currentMarkerSvg: SVGElement | null;
     colour_: string;
     /** The root SVG group containing the marker. */
     protected markerSvg_: SVGGElement | null;
@@ -42,40 +43,47 @@ export declare class MarkerSvg {
     constructor(workspace: WorkspaceSvg, constants: ConstantProvider, marker: Marker);
     /**
      * Return the root node of the SVG or null if none exists.
-     * @return The root SVG node.
+     *
+     * @returns The root SVG node.
      */
-    getSvgRoot(): SVGElement;
+    getSvgRoot(): SVGElement | null;
     /**
      * Get the marker.
-     * @return The marker to draw for.
+     *
+     * @returns The marker to draw for.
      */
     getMarker(): Marker;
     /**
      * True if the marker should be drawn as a cursor, false otherwise.
      * A cursor is drawn as a flashing line. A marker is drawn as a solid line.
-     * @return True if the marker is a cursor, false otherwise.
+     *
+     * @returns True if the marker is a cursor, false otherwise.
      */
     isCursor(): boolean;
     /**
      * Create the DOM element for the marker.
-     * @return The marker controls SVG group.
+     *
+     * @returns The marker controls SVG group.
      * @internal
      */
     createDom(): SVGElement;
     /**
      * Attaches the SVG root of the marker to the SVG group of the parent.
+     *
      * @param newParent The workspace, field, or block that the marker SVG element
      *     should be attached to.
      */
     protected setParent_(newParent: IASTNodeLocationSvg): void;
     /**
      * Update the marker.
+     *
      * @param oldNode The previous node the marker was on or null.
      * @param curNode The node that we want to draw the marker for.
      */
     draw(oldNode: ASTNode, curNode: ASTNode): void;
     /**
      * Update the marker's visible state based on the type of curNode..
+     *
      * @param curNode The node that we want to draw the marker for.
      */
     protected showAtLocation_(curNode: ASTNode): void;
@@ -85,51 +93,60 @@ export declare class MarkerSvg {
     /**
      * Show the marker as a combination of the previous connection and block,
      * the output connection and block, or just the block.
+     *
      * @param curNode The node to draw the marker for.
      */
     private showWithBlockPrevOutput_;
     /**
      * Position and display the marker for a block.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithBlock_(curNode: ASTNode): void;
     /**
      * Position and display the marker for a previous connection.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithPrevious_(curNode: ASTNode): void;
     /**
      * Position and display the marker for an output connection.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithOutput_(curNode: ASTNode): void;
     /**
      * Position and display the marker for a workspace coordinate.
      * This is a horizontal line.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithCoordinates_(curNode: ASTNode): void;
     /**
      * Position and display the marker for a field.
      * This is a box around the field.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithField_(curNode: ASTNode): void;
     /**
      * Position and display the marker for an input.
      * This is a puzzle piece.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithInput_(curNode: ASTNode): void;
     /**
      * Position and display the marker for a next connection.
      * This is a horizontal line.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithNext_(curNode: ASTNode): void;
     /**
      * Position and display the marker for a stack.
      * This is a box with extra padding around the entire stack of blocks.
+     *
      * @param curNode The node to draw the marker for.
      */
     protected showWithStack_(curNode: ASTNode): void;
@@ -141,6 +158,7 @@ export declare class MarkerSvg {
     /**
      * Position the marker for a block.
      * Displays an outline of the top half of a rectangle around a block.
+     *
      * @param width The width of the block.
      * @param markerOffset The extra padding for around the block.
      * @param markerHeight The height of the marker.
@@ -149,12 +167,14 @@ export declare class MarkerSvg {
     /**
      * Position the marker for an input connection.
      * Displays a filled in puzzle piece.
+     *
      * @param connection The connection to position marker around.
      */
     protected positionInput_(connection: RenderedConnection): void;
     /**
      * Move and show the marker at the specified coordinate in workspace units.
      * Displays a horizontal line.
+     *
      * @param x The new x, in workspace units.
      * @param y The new y, in workspace units.
      * @param width The new width, in workspace units.
@@ -163,24 +183,27 @@ export declare class MarkerSvg {
     /**
      * Position the marker for an output connection.
      * Displays a puzzle outline and the top and bottom path.
+     *
      * @param width The width of the block.
      * @param height The height of the block.
      * @param connectionShape The shape object for the connection.
      */
-    protected positionOutput_(width: number, height: number, connectionShape: Notch | PuzzleTab): void;
+    protected positionOutput_(width: number, height: number, connectionShape: PuzzleTab): void;
     /**
      * Position the marker for a previous connection.
      * Displays a half rectangle with a notch in the top to represent the previous
      * connection.
+     *
      * @param width The width of the block.
      * @param markerOffset The offset of the marker from around the block.
      * @param markerHeight The height of the marker.
      * @param connectionShape The shape object for the connection.
      */
-    protected positionPrevious_(width: number, markerOffset: number, markerHeight: number, connectionShape: Notch | PuzzleTab): void;
+    protected positionPrevious_(width: number, markerOffset: number, markerHeight: number, connectionShape: Notch): void;
     /**
      * Move and show the marker at the specified coordinate in workspace units.
      * Displays a filled in rectangle.
+     *
      * @param x The new x, in workspace units.
      * @param y The new y, in workspace units.
      * @param width The new width, in workspace units.
@@ -189,6 +212,7 @@ export declare class MarkerSvg {
     protected positionRect_(x: number, y: number, width: number, height: number): void;
     /**
      * Flip the SVG paths in RTL.
+     *
      * @param markerSvg The marker that we want to flip.
      */
     private flipRtl_;
@@ -196,25 +220,32 @@ export declare class MarkerSvg {
     hide(): void;
     /**
      * Fire event for the marker or marker.
+     *
      * @param oldNode The old node the marker used to be on.
      * @param curNode The new node the marker is currently on.
      */
     private fireMarkerEvent_;
     /**
      * Get the properties to make a marker blink.
-     * @return The object holding attributes to make the marker blink.
+     *
+     * @returns The object holding attributes to make the marker blink.
      */
-    protected getBlinkProperties_(): any;
+    protected getBlinkProperties_(): {
+        [key: string]: string;
+    };
     /**
      * Create the marker SVG.
-     * @return The SVG node created.
+     *
+     * @returns The SVG node created.
      */
     protected createDomInternal_(): Element;
     /**
      * Apply the marker's colour.
+     *
      * @param _curNode The node that we want to draw the marker for.
      */
     protected applyColour_(_curNode: ASTNode): void;
     /** Dispose of this marker. */
     dispose(): void;
 }
+//# sourceMappingURL=marker_svg.d.ts.map

package/core/renderers/common/path_object.d.ts

@@ -11,24 +11,27 @@ import type { IPathObject } from './i_path_object.js';
 /**
  * An object that handles creating and setting each of the SVG elements
  * used by the renderer.
+ *
  * @alias Blockly.blockRendering.PathObject
  */
 export declare class PathObject implements IPathObject {
-    svgRoot: any;
+    svgRoot: SVGElement;
     /** @internal */
     svgPath: SVGElement;
     /**
      * Holds the cursors svg element when the cursor is attached to the block.
      * This is null if there is no cursor on the block.
+     *
      * @internal
      */
-    cursorSvg: SVGElement;
+    cursorSvg: SVGElement | null;
     /**
      * Holds the markers svg element when the marker is attached to the block.
      * This is null if there is no marker on the block.
+     *
      * @internal
      */
-    markerSvg: SVGElement;
+    markerSvg: SVGElement | null;
     /** @internal */
     constants: ConstantProvider;
     /** @internal */
@@ -42,17 +45,20 @@ export declare class PathObject implements IPathObject {
     constructor(root: SVGElement, style: BlockStyle, constants: ConstantProvider);
     /**
      * Set the path generated by the renderer onto the respective SVG element.
+     *
      * @param pathString The path.
      * @internal
      */
     setPath(pathString: string): void;
     /**
      * Flip the SVG paths in RTL.
+     *
      * @internal
      */
     flipRTL(): void;
     /**
      * Add the cursor SVG to this block's SVG group.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the block SVG
      *     group.
      * @internal
@@ -60,6 +66,7 @@ export declare class PathObject implements IPathObject {
     setCursorSvg(cursorSvg: SVGElement): void;
     /**
      * Add the marker SVG to this block's SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the block SVG
      *     group.
      * @internal
@@ -68,18 +75,21 @@ export declare class PathObject implements IPathObject {
     /**
      * Apply the stored colours to the block's path, taking into account whether
      * the paths belong to a shadow block.
+     *
      * @param block The source block.
      * @internal
      */
     applyColour(block: BlockSvg): void;
     /**
      * Set the style.
+     *
      * @param blockStyle The block style to use.
      * @internal
      */
     setStyle(blockStyle: BlockStyle): void;
     /**
      * Add or remove the given CSS class on the path object's root SVG element.
+     *
      * @param className The name of the class to add or remove
      * @param add True if the class should be added.  False if it should be
      *     removed.
@@ -88,28 +98,33 @@ export declare class PathObject implements IPathObject {
     /**
      * Set whether the block shows a highlight or not.  Block highlighting is
      * often used to visually mark blocks currently being executed.
+     *
      * @param enable True if highlighted.
      * @internal
      */
     updateHighlighted(enable: boolean): void;
     /**
      * Updates the look of the block to reflect a shadow state.
+     *
      * @param shadow True if the block is a shadow block.
      */
     protected updateShadow_(shadow: boolean): void;
     /**
      * Updates the look of the block to reflect a disabled state.
+     *
      * @param disabled True if disabled.
      */
     protected updateDisabled_(disabled: boolean): void;
     /**
      * Add or remove styling showing that a block is selected.
+     *
      * @param enable True if selection is enabled, false otherwise.
      * @internal
      */
     updateSelected(enable: boolean): void;
     /**
      * Add or remove styling showing that a block is dragged over a delete area.
+     *
      * @param enable True if the block is being dragged over a delete area, false
      *     otherwise.
      * @internal
@@ -117,12 +132,14 @@ export declare class PathObject implements IPathObject {
     updateDraggingDelete(enable: boolean): void;
     /**
      * Add or remove styling showing that a block is an insertion marker.
+     *
      * @param enable True if the block is an insertion marker, false otherwise.
      * @internal
      */
     updateInsertionMarker(enable: boolean): void;
     /**
      * Add or remove styling showing that a block is movable.
+     *
      * @param enable True if the block is movable, false otherwise.
      * @internal
      */
@@ -131,6 +148,7 @@ export declare class PathObject implements IPathObject {
      * Add or remove styling that shows that if the dragging block is dropped,
      * this block will be replaced.  If a shadow block, it will disappear.
      * Otherwise it will bump.
+     *
      * @param enable True if styling should be added.
      * @internal
      */
@@ -138,9 +156,11 @@ export declare class PathObject implements IPathObject {
     /**
      * Add or remove styling that shows that if the dragging block is dropped,
      * this block will be connected to the input.
+     *
      * @param _conn The connection on the input to highlight.
      * @param _enable True if styling should be added.
      * @internal
      */
     updateShapeForInputHighlight(_conn: Connection, _enable: boolean): void;
 }
+//# sourceMappingURL=path_object.d.ts.map

package/core/renderers/common/renderer.d.ts

@@ -19,6 +19,7 @@ import { RenderInfo } from './info.js';
 import { MarkerSvg } from './marker_svg.js';
 /**
  * The base class for a block renderer.
+ *
  * @alias Blockly.blockRendering.Renderer
  */
 export declare class Renderer implements IRegistrable {
@@ -28,6 +29,7 @@ export declare class Renderer implements IRegistrable {
     name: string;
     /**
      * Rendering constant overrides, passed in through options.
+     *
      * @internal
      */
     overrides: object | null;
@@ -38,19 +40,24 @@ export declare class Renderer implements IRegistrable {
     constructor(name: string);
     /**
      * Gets the class name that identifies this renderer.
-     * @return The CSS class name.
+     *
+     * @returns The CSS class name.
      * @internal
      */
     getClassName(): string;
     /**
      * Initialize the renderer.
+     *
      * @param theme The workspace theme object.
      * @param opt_rendererOverrides Rendering constant overrides.
      * @internal
      */
-    init(theme: Theme, opt_rendererOverrides?: object): void;
+    init(theme: Theme, opt_rendererOverrides?: {
+        [rendererConstant: string]: any;
+    }): void;
     /**
      * Create any DOM elements that this renderer needs.
+     *
      * @param svg The root of the workspace's SVG.
      * @param theme The workspace theme object.
      * @internal
@@ -58,6 +65,7 @@ export declare class Renderer implements IRegistrable {
     createDom(svg: SVGElement, theme: Theme): void;
     /**
      * Refresh the renderer after a theme change.
+     *
      * @param svg The root of the workspace's SVG.
      * @param theme The workspace theme object.
      * @internal
@@ -66,62 +74,71 @@ export declare class Renderer implements IRegistrable {
     /**
      * Dispose of this renderer.
      * Delete all DOM elements that this renderer and its constants created.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Create a new instance of the renderer's constant provider.
-     * @return The constant provider.
+     *
+     * @returns The constant provider.
      */
     protected makeConstants_(): ConstantProvider;
     /**
      * Create a new instance of the renderer's render info object.
+     *
      * @param block The block to measure.
-     * @return The render info object.
+     * @returns The render info object.
      */
     protected makeRenderInfo_(block: BlockSvg): RenderInfo;
     /**
      * Create a new instance of the renderer's drawer.
+     *
      * @param block The block to render.
      * @param info An object containing all information needed to render this
      *     block.
-     * @return The drawer.
+     * @returns The drawer.
      */
     protected makeDrawer_(block: BlockSvg, info: RenderInfo): Drawer;
     /**
      * Create a new instance of the renderer's debugger.
-     * @return The renderer debugger.
+     *
+     * @returns The renderer debugger.
      * @suppress {strictModuleDepCheck} Debug renderer only included in
      * playground.
      */
     protected makeDebugger_(): Debug;
     /**
      * Create a new instance of the renderer's marker drawer.
+     *
      * @param workspace The workspace the marker belongs to.
      * @param marker The marker.
-     * @return The object in charge of drawing the marker.
+     * @returns The object in charge of drawing the marker.
      * @internal
      */
     makeMarkerDrawer(workspace: WorkspaceSvg, marker: Marker): MarkerSvg;
     /**
      * Create a new instance of a renderer path object.
+     *
      * @param root The root SVG element.
      * @param style The style object to use for colouring.
-     * @return The renderer path object.
+     * @returns The renderer path object.
      * @internal
      */
     makePathObject(root: SVGElement, style: BlockStyle): IPathObject;
     /**
      * Get the current renderer's constant provider.  We assume that when this is
      * called, the renderer has already been initialized.
-     * @return The constant provider.
+     *
+     * @returns The constant provider.
      * @internal
      */
     getConstants(): ConstantProvider;
     /**
      * Determine whether or not to highlight a connection.
+     *
      * @param _conn The connection to determine whether or not to highlight.
-     * @return True if we should highlight the connection.
+     * @returns True if we should highlight the connection.
      * @internal
      */
     shouldHighlightConnection(_conn: Connection): boolean;
@@ -130,28 +147,32 @@ export declare class Renderer implements IRegistrable {
      * block-clump. If the clump is a row the end is the last input. If the clump
      * is a stack, the end is the last next connection. If the clump is neither,
      * then this returns false.
+     *
      * @param topBlock The top block of the block clump we want to try and connect
      *     to.
      * @param orphanBlock The orphan block that wants to find a home.
      * @param localType The type of the connection being dragged.
-     * @return Whether there is a home for the orphan or not.
+     * @returns Whether there is a home for the orphan or not.
      * @internal
      */
     orphanCanConnectAtEnd(topBlock: BlockSvg, orphanBlock: BlockSvg, localType: number): boolean;
     /**
      * Chooses a connection preview method based on the available connection, the
      * current dragged connection, and the block being dragged.
+     *
      * @param closest The available connection.
      * @param local The connection currently being dragged.
      * @param topBlock The block currently being dragged.
-     * @return The preview type to display.
+     * @returns The preview type to display.
      * @internal
      */
     getConnectionPreviewMethod(closest: RenderedConnection, local: RenderedConnection, topBlock: BlockSvg): PreviewType;
     /**
      * Render the block.
+     *
      * @param block The block to render.
      * @internal
      */
     render(block: BlockSvg): void;
 }
+//# sourceMappingURL=renderer.d.ts.map