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

package/core/interfaces/i_drag_target.d.ts

@@ -9,35 +9,41 @@ import type { IComponent } from './i_component.js';
 /**
  * Interface for a component with custom behaviour when a block or bubble is
  * dragged over or dropped on top of it.
+ *
  * @alias Blockly.IDragTarget
  */
 export interface IDragTarget extends IComponent {
     /**
      * 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;
     /**
      * Handles when a cursor with a block or bubble enters this drag target.
+     *
      * @param dragElement The block or bubble currently being dragged.
      */
     onDragEnter(dragElement: IDraggable): void;
     /**
      * Handles when a cursor with a block or bubble is dragged over this drag
      * target.
+     *
      * @param dragElement The block or bubble currently being dragged.
      */
     onDragOver(dragElement: IDraggable): void;
     /**
      * Handles when a cursor with a block or bubble exits this drag target.
+     *
      * @param dragElement The block or bubble currently being dragged.
      */
     onDragExit(dragElement: IDraggable): void;
     /**
      * Handles when a block or bubble is dropped on this component.
      * Should not handle delete here.
+     *
      * @param dragElement The block or bubble currently being dragged.
      */
     onDrop(dragElement: IDraggable): void;
@@ -45,9 +51,11 @@ export interface IDragTarget extends IComponent {
      * Returns whether the provided block or bubble should not be moved after
      * being dropped on this component. If true, the element will return to where
      * it was when the drag started.
+     *
      * @param dragElement The block or bubble currently being dragged.
-     * @return Whether the block or bubble provided should be returned to drag
+     * @returns Whether the block or bubble provided should be returned to drag
      *     start.
      */
     shouldPreventMove(dragElement: IDraggable): boolean;
 }
+//# sourceMappingURL=i_drag_target.d.ts.map

package/core/interfaces/i_draggable.d.ts

@@ -6,7 +6,9 @@
 import type { IDeletable } from './i_deletable.js';
 /**
  * The interface for an object that can be dragged.
+ *
  * @alias Blockly.IDraggable
  */
 export interface IDraggable extends IDeletable {
 }
+//# sourceMappingURL=i_draggable.d.ts.map

package/core/interfaces/i_flyout.d.ts

@@ -11,6 +11,7 @@ import type { Svg } from '../utils/svg.js';
 import type { IRegistrable } from './i_registrable.js';
 /**
  * Interface for a flyout.
+ *
  * @alias Blockly.IFlyout
  */
 export interface IFlyout extends IRegistrable {
@@ -30,13 +31,15 @@ export interface IFlyout extends IRegistrable {
      * 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.
      */
     init(targetWorkspace: WorkspaceSvg): void;
@@ -47,33 +50,39 @@ export interface IFlyout extends IRegistrable {
     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 height of the flyout.
+     *
+     * @returns The height of the flyout.
      */
     getHeight(): number;
     /**
      * Get the workspace inside the flyout.
-     * @return The workspace inside the flyout.
+     *
+     * @returns The workspace inside the flyout.
      */
     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;
@@ -81,6 +90,7 @@ export interface IFlyout extends IRegistrable {
     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.
@@ -88,26 +98,29 @@ export interface IFlyout extends IRegistrable {
     show(flyoutDef: FlyoutDefinition | string): void;
     /**
      * 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.
      */
     createBlock(originalBlock: BlockSvg): BlockSvg;
     /** Reflow blocks and their mats. */
     reflow(): void;
     /**
-     * @return True if this flyout may be scrolled with a scrollbar or by
+     * @returns True if this flyout may be scrolled with a scrollbar or by
      *     dragging.
      */
     isScrollable(): boolean;
     /**
      * 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;
     /** Position the flyout. */
@@ -116,19 +129,22 @@ export interface IFlyout extends IRegistrable {
      * 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.
      */
     isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean;
     /**
      * 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.
      */
     isBlockCreatable(block: BlockSvg): boolean;
     /** Scroll the flyout to the beginning of its contents. */
     scrollToStart(): void;
 }
+//# sourceMappingURL=i_flyout.d.ts.map

package/core/interfaces/i_keyboard_accessible.d.ts

@@ -6,13 +6,16 @@
 import { KeyboardShortcut } from '../shortcut_registry.js';
 /**
  * An interface for an object that handles keyboard shortcuts.
+ *
  * @alias Blockly.IKeyboardAccessible
  */
 export interface IKeyboardAccessible {
     /**
      * Handles the given keyboard shortcut.
+     *
      * @param shortcut The shortcut to be handled.
-     * @return True if the shortcut has been handled, false otherwise.
+     * @returns True if the shortcut has been handled, false otherwise.
      */
     onShortcut(shortcut: KeyboardShortcut): boolean;
 }
+//# sourceMappingURL=i_keyboard_accessible.d.ts.map

package/core/interfaces/i_metrics_manager.d.ts

@@ -8,17 +8,20 @@ import type { Size } from '../utils/size.js';
 import type { Metrics } from '../utils/metrics.js';
 /**
  * Interface for a metrics manager.
+ *
  * @alias Blockly.IMetricsManager
  */
 export interface IMetricsManager {
     /**
      * Returns whether the scroll area has fixed edges.
-     * @return Whether the scroll area has fixed edges.
+     *
+     * @returns Whether the scroll area has fixed edges.
      * @internal
      */
     hasFixedEdges(): boolean;
     /**
      * Returns the metrics for the scroll area of the workspace.
+     *
      * @param opt_getWorkspaceCoordinates True to get the scroll metrics in
      *     workspace coordinates, false to get them in pixel coordinates.
      * @param opt_viewMetrics The view metrics if they have been previously
@@ -27,15 +30,16 @@ export interface IMetricsManager {
      * @param opt_contentMetrics The content metrics if they have been previously
      *     computed. Passing in null may cause the content metrics to be computed
      *     again, if it is needed.
-     * @return The metrics for the scroll container
+     * @returns The metrics for the scroll container
      */
     getScrollMetrics(opt_getWorkspaceCoordinates?: boolean, opt_viewMetrics?: ContainerRegion, opt_contentMetrics?: ContainerRegion): ContainerRegion;
     /**
      * Gets the width and the height of the flyout on the workspace in pixel
      * coordinates. Returns 0 for the width and height if the workspace has a
      * category toolbox instead of a simple toolbox.
+     *
      * @param opt_own Whether to only return the workspace's own flyout.
-     * @return The width and height of the flyout.
+     * @returns The width and height of the flyout.
      */
     getFlyoutMetrics(opt_own?: boolean): ToolboxMetrics;
     /**
@@ -43,39 +47,44 @@ export interface IMetricsManager {
      * pixel coordinates. Returns 0 for the width and height if the workspace has
      * a simple toolbox instead of a category toolbox. To get the width and height
      * of a
-     * simple toolbox @see {@link getFlyoutMetrics}.
-     * @return The object with the width, height and position of the toolbox.
+     * simple toolbox @see {@link IMetricsManager#getFlyoutMetrics}.
+     *
+     * @returns The object with the width, height and position of the toolbox.
      */
     getToolboxMetrics(): ToolboxMetrics;
     /**
      * Gets the width and height of the workspace's parent SVG element in pixel
      * coordinates. This area includes the toolbox and the visible workspace area.
-     * @return The width and height of the workspace's parent SVG element.
+     *
+     * @returns The width and height of the workspace's parent SVG element.
      */
     getSvgMetrics(): Size;
     /**
      * Gets the absolute left and absolute top in pixel coordinates.
      * This is where the visible workspace starts in relation to the SVG
      * container.
-     * @return The absolute metrics for the workspace.
+     *
+     * @returns The absolute metrics for the workspace.
      */
     getAbsoluteMetrics(): AbsoluteMetrics;
     /**
      * Gets the metrics for the visible workspace in either pixel or workspace
      * coordinates. The visible workspace does not include the toolbox or flyout.
+     *
      * @param opt_getWorkspaceCoordinates True to get the view metrics in
      *     workspace coordinates, false to get them in pixel coordinates.
-     * @return The width, height, top and left of the viewport in either workspace
-     *     coordinates or pixel coordinates.
+     * @returns The width, height, top and left of the viewport in either
+     *     workspace coordinates or pixel coordinates.
      */
     getViewMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion;
     /**
      * Gets content metrics in either pixel or workspace coordinates.
      * The content area is a rectangle around all the top bounded elements on the
      * workspace (workspace comments and blocks).
+     *
      * @param opt_getWorkspaceCoordinates True to get the content metrics in
      *     workspace coordinates, false to get them in pixel coordinates.
-     * @return The metrics for the content container.
+     * @returns The metrics for the content container.
      */
     getContentMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion;
     /**
@@ -106,12 +115,15 @@ export interface IMetricsManager {
      * .flyoutHeight: Height of the flyout if it is always open.  Otherwise zero.
      * .toolboxPosition: Top, bottom, left or right. Use TOOLBOX_AT constants to
      *     compare.
-     * @return Contains size and position metrics of a top level workspace.
+     *
+     * @returns Contains size and position metrics of a top level workspace.
      */
     getMetrics(): Metrics;
     /**
      * Returns common metrics used by UI elements.
-     * @return The UI metrics.
+     *
+     * @returns The UI metrics.
      */
     getUiMetrics(): UiMetrics;
 }
+//# sourceMappingURL=i_metrics_manager.d.ts.map

package/core/interfaces/i_movable.d.ts

@@ -5,12 +5,15 @@
  */
 /**
  * The interface for an object that is movable.
+ *
  * @alias Blockly.IMovable
  */
 export interface IMovable {
     /**
      * Get whether this is movable or not.
-     * @return True if movable.
+     *
+     * @returns True if movable.
      */
     isMovable(): boolean;
 }
+//# sourceMappingURL=i_movable.d.ts.map

package/core/interfaces/i_positionable.d.ts

@@ -8,11 +8,13 @@ import type { UiMetrics } from '../metrics_manager.js';
 import type { IComponent } from './i_component.js';
 /**
  * Interface for a component that is positioned on top of the workspace.
+ *
  * @alias Blockly.IPositionable
  */
 export interface IPositionable extends IComponent {
     /**
      * Positions the element. Called when the window is resized.
+     *
      * @param metrics The workspace metrics.
      * @param savedPositions List of rectangles that are already on the workspace.
      */
@@ -20,8 +22,10 @@ export interface IPositionable extends IComponent {
     /**
      * Returns the bounding rectangle of the UI element in pixel units relative to
      * the Blockly injection div.
-     * @return The UI elements's bounding box. Null if bounding box should be
+     *
+     * @returns The UI elements's bounding box. Null if bounding box should be
      *     ignored by other UI elements.
      */
     getBoundingRectangle(): Rect | null;
 }
+//# sourceMappingURL=i_positionable.d.ts.map

package/core/interfaces/i_registrable.d.ts

@@ -5,7 +5,9 @@
  */
 /**
  * The interface for a Blockly component that can be registered.
+ *
  * @alias Blockly.IRegistrable
  */
 export interface IRegistrable {
 }
+//# sourceMappingURL=i_registrable.d.ts.map

package/core/interfaces/i_registrable_field.d.ts

@@ -9,9 +9,11 @@ declare type fromJson = (p1: object) => Field;
  * A registrable field.
  * Note: We are not using an interface here as we are interested in defining the
  * static methods of a field rather than the instance methods.
+ *
  * @alias Blockly.IRegistrableField
  */
 export interface IRegistrableField {
     fromJson: fromJson;
 }
 export {};
+//# sourceMappingURL=i_registrable_field.d.ts.map

package/core/interfaces/i_selectable.d.ts

@@ -7,6 +7,7 @@ import type { IDeletable } from './i_deletable.js';
 import type { IMovable } from './i_movable.js';
 /**
  * The interface for an object that is selectable.
+ *
  * @alias Blockly.ISelectable
  */
 export interface ISelectable extends IDeletable, IMovable {
@@ -16,3 +17,4 @@ export interface ISelectable extends IDeletable, IMovable {
     /** Unselect this.  Unhighlight it visually. */
     unselect(): void;
 }
+//# sourceMappingURL=i_selectable.d.ts.map

package/core/interfaces/i_selectable_toolbox_item.d.ts

@@ -7,22 +7,26 @@ import type { FlyoutItemInfoArray } from '../utils/toolbox';
 import type { IToolboxItem } from './i_toolbox_item.js';
 /**
  * Interface for an item in the toolbox that can be selected.
+ *
  * @alias Blockly.ISelectableToolboxItem
  */
 export interface ISelectableToolboxItem extends IToolboxItem {
     /**
      * Gets the name of the toolbox item. Used for emitting events.
-     * @return The name of the toolbox item.
+     *
+     * @returns The name of the toolbox item.
      */
     getName(): string;
     /**
      * Gets the contents of the toolbox item. These are items that are meant to be
      * displayed in the flyout.
-     * @return The definition of items to be displayed in the flyout.
+     *
+     * @returns The definition of items to be displayed in the flyout.
      */
     getContents(): FlyoutItemInfoArray | string;
     /**
      * Sets the current toolbox item as selected.
+     *
      * @param _isSelected True if this category is selected, false otherwise.
      */
     setSelected(_isSelected: boolean): void;
@@ -31,12 +35,15 @@ export interface ISelectableToolboxItem extends IToolboxItem {
      * The parent toolbox element receives clicks. The parent toolbox will add an
      * ID to this element so it can pass the onClick event to the correct
      * toolboxItem.
-     * @return The HTML element that receives clicks.
+     *
+     * @returns The HTML element that receives clicks.
      */
     getClickTarget(): Element;
     /**
      * Handles when the toolbox item is clicked.
+     *
      * @param _e Click event to handle.
      */
     onClick(_e: Event): void;
 }
+//# sourceMappingURL=i_selectable_toolbox_item.d.ts.map

package/core/interfaces/i_serializer.d.ts

@@ -6,6 +6,7 @@
 import type { Workspace } from '../workspace.js';
 /**
  * Serializes and deserializes a plugin or system.
+ *
  * @alias Blockly.serialization.ISerializer.ISerializer
  */
 export interface ISerializer {
@@ -20,13 +21,15 @@ export interface ISerializer {
     priority: number;
     /**
      * Saves the state of the plugin or system.
+     *
      * @param workspace The workspace the system to serialize is associated with.
-     * @return A JS object containing the system's state, or null if there is no
+     * @returns A JS object containing the system's state, or null if there is no
      *     state to record.
      */
     save(workspace: Workspace): Object | null;
     /**
      * Loads the state of the plugin or system.
+     *
      * @param state The state of the system to deserialize. This will always be
      *     non-null.
      * @param workspace The workspace the system to deserialize is associated
@@ -35,8 +38,10 @@ export interface ISerializer {
     load(state: Object, workspace: Workspace): void;
     /**
      * Clears the state of the plugin or system.
+     *
      * @param workspace The workspace the system to clear the state of is
      *     associated with.
      */
     clear(workspace: Workspace): void;
 }
+//# sourceMappingURL=i_serializer.d.ts.map

package/core/interfaces/i_styleable.d.ts

@@ -5,17 +5,21 @@
  */
 /**
  * Interface for an object that a style can be added to.
+ *
  * @alias Blockly.IStyleable
  */
 export interface IStyleable {
     /**
      * Adds a style on the toolbox. Usually used to change the cursor.
+     *
      * @param style The name of the class to add.
      */
     addStyle(style: string): void;
     /**
      * Removes a style from the toolbox. Usually used to change the cursor.
+     *
      * @param style The name of the class to remove.
      */
     removeStyle(style: string): void;
 }
+//# sourceMappingURL=i_styleable.d.ts.map

package/core/interfaces/i_toolbox.d.ts

@@ -10,6 +10,7 @@ import type { IFlyout } from './i_flyout.js';
 import type { WorkspaceSvg } from '../workspace_svg.js';
 /**
  * Interface for a toolbox.
+ *
  * @alias Blockly.IToolbox
  */
 export interface IToolbox extends IRegistrable {
@@ -17,32 +18,38 @@ export interface IToolbox extends IRegistrable {
     init(): void;
     /**
      * Fills the toolbox with new toolbox items and removes any old contents.
+     *
      * @param toolboxDef Object holding information for creating a toolbox.
      */
     render(toolboxDef: ToolboxInfo): void;
     /**
      * Gets the width of the toolbox.
-     * @return The width of the toolbox.
+     *
+     * @returns The width of the toolbox.
      */
     getWidth(): number;
     /**
      * Gets the height of the toolbox.
-     * @return The height of the toolbox.
+     *
+     * @returns The height of the toolbox.
      */
     getHeight(): number;
     /**
      * Gets the toolbox flyout.
-     * @return The toolbox flyout.
+     *
+     * @returns The toolbox flyout.
      */
     getFlyout(): IFlyout | null;
     /**
      * Gets the workspace for the toolbox.
-     * @return The parent workspace for the toolbox.
+     *
+     * @returns The parent workspace for the toolbox.
      */
     getWorkspace(): WorkspaceSvg;
     /**
      * Gets whether or not the toolbox is horizontal.
-     * @return True if the toolbox is horizontal, false if the toolbox is
+     *
+     * @returns True if the toolbox is horizontal, false if the toolbox is
      *     vertical.
      */
     isHorizontal(): boolean;
@@ -67,19 +74,23 @@ export interface IToolbox extends IRegistrable {
     refreshSelection(): void;
     /**
      * Sets the visibility of the toolbox.
+     *
      * @param isVisible True if toolbox should be visible.
      */
     setVisible(isVisible: boolean): void;
     /**
      * Selects the toolbox item by it's position in the list of toolbox items.
+     *
      * @param position The position of the item to select.
      */
     selectItemByPosition(position: number): void;
     /**
      * Gets the selected item.
-     * @return The selected item, or null if no item is currently selected.
+     *
+     * @returns The selected item, or null if no item is currently selected.
      */
     getSelectedItem(): IToolboxItem | null;
     /** Disposes of this toolbox. */
     dispose(): void;
 }
+//# sourceMappingURL=i_toolbox.d.ts.map

package/core/interfaces/i_toolbox_item.d.ts

@@ -5,6 +5,7 @@
  */
 /**
  * Interface for an item in the toolbox.
+ *
  * @alias Blockly.IToolboxItem
  */
 export interface IToolboxItem {
@@ -16,47 +17,56 @@ export interface IToolboxItem {
     init(): void;
     /**
      * Gets the div for the toolbox item.
-     * @return The div for the toolbox item.
+     *
+     * @returns The div for the toolbox item.
      */
     getDiv(): Element | null;
     /**
      * Gets a unique identifier for this toolbox item.
-     * @return The ID for the toolbox item.
+     *
+     * @returns The ID for the toolbox item.
      */
     getId(): string;
     /**
      * Gets the parent if the toolbox item is nested.
-     * @return The parent toolbox item, or null if this toolbox item is not
+     *
+     * @returns The parent toolbox item, or null if this toolbox item is not
      *     nested.
      */
     getParent(): IToolboxItem | null;
     /**
      * Gets the nested level of the category.
-     * @return The nested level of the category.
+     *
+     * @returns The nested level of the category.
      * @internal
      */
     getLevel(): number;
     /**
      * Whether the toolbox item is selectable.
-     * @return True if the toolbox item can be selected.
+     *
+     * @returns True if the toolbox item can be selected.
      */
     isSelectable(): boolean;
     /**
      * Whether the toolbox item is collapsible.
-     * @return True if the toolbox item is collapsible.
+     *
+     * @returns True if the toolbox item is collapsible.
      */
     isCollapsible(): boolean;
     /** Dispose of this toolbox item. No-op by default. */
     dispose(): void;
     /**
      * Gets the HTML element that is clickable.
-     * @return The HTML element that receives clicks.
+     *
+     * @returns The HTML element that receives clicks.
      */
     getClickTarget(): Element | null;
     /**
      * Sets whether the category is visible or not.
      * For a category to be visible its parent category must also be expanded.
+     *
      * @param isVisible True if category should be visible.
      */
     setVisible_(isVisible: boolean): void;
 }
+//# sourceMappingURL=i_toolbox_item.d.ts.map