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

package/core/toolbox/toolbox_item.d.ts

@@ -10,6 +10,7 @@ import type * as toolbox from '../utils/toolbox.js';
 import type { WorkspaceSvg } from '../workspace_svg.js';
 /**
  * Class for an item in the toolbox.
+ *
  * @alias Blockly.ToolboxItem
  */
 export declare class ToolboxItem implements IToolboxItem {
@@ -35,7 +36,8 @@ export declare class ToolboxItem implements 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;
     /**
@@ -43,35 +45,41 @@ export declare class ToolboxItem implements 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, or null if this item should
+     *
+     * @returns The HTML element that receives clicks, or null if this item should
      *     not receive clicks.
      */
     getClickTarget(): 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(): ICollapsibleToolboxItem | 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. */
@@ -79,7 +87,9 @@ export declare class ToolboxItem implements IToolboxItem {
     /**
      * 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=toolbox_item.d.ts.map

package/core/tooltip.d.ts

@@ -8,6 +8,7 @@
  * Either a string, an object containing a tooltip property, or a function which
  * returns either a string, or another arbitrarily nested function which
  * eventually unwinds to a string.
+ *
  * @alias Blockly.Tooltip.TipInfo
  */
 export declare type TipInfo = string | {
@@ -18,101 +19,119 @@ export declare type TipInfo = string | {
  * 1st parameter: the div element to render content into.
  * 2nd parameter: the element being moused over (i.e., the element for which the
  * tooltip should be shown).
+ *
  * @alias Blockly.Tooltip.CustomTooltip
  */
 export declare type CustomTooltip = (p1: Element, p2: Element) => any;
 /**
  * Sets a custom function that will be called if present instead of the default
  * tooltip UI.
+ *
  * @param customFn A custom tooltip used to render an alternate tooltip UI.
  * @alias Blockly.Tooltip.setCustomTooltip
  */
 export declare function setCustomTooltip(customFn: CustomTooltip): void;
 /**
  * Gets the custom tooltip function.
+ *
  * @returns The custom tooltip function, if defined.
  */
 export declare function getCustomTooltip(): CustomTooltip | undefined;
 /**
  * Returns whether or not a tooltip is showing
+ *
  * @returns True if a tooltip is showing
  * @alias Blockly.Tooltip.isVisible
  */
 export declare function isVisible(): boolean;
 /**
  * Maximum width (in characters) of a tooltip.
+ *
  * @alias Blockly.Tooltip.LIMIT
  */
 export declare const LIMIT = 50;
 /**
  * Horizontal offset between mouse cursor and tooltip.
+ *
  * @alias Blockly.Tooltip.OFFSET_X
  */
 export declare const OFFSET_X = 0;
 /**
  * Vertical offset between mouse cursor and tooltip.
+ *
  * @alias Blockly.Tooltip.OFFSET_Y
  */
 export declare const OFFSET_Y = 10;
 /**
  * Radius mouse can move before killing tooltip.
+ *
  * @alias Blockly.Tooltip.RADIUS_OK
  */
 export declare const RADIUS_OK = 10;
 /**
  * Delay before tooltip appears.
+ *
  * @alias Blockly.Tooltip.HOVER_MS
  */
 export declare const HOVER_MS = 750;
 /**
  * Horizontal padding between tooltip and screen edge.
+ *
  * @alias Blockly.Tooltip.MARGINS
  */
 export declare const MARGINS = 5;
 /**
  * Returns the HTML tooltip container.
+ *
  * @returns The HTML tooltip container.
  * @alias Blockly.Tooltip.getDiv
  */
 export declare function getDiv(): HTMLDivElement | null;
 /**
  * Returns the tooltip text for the given element.
+ *
  * @param object The object to get the tooltip text of.
- * @return The tooltip text of the element.
+ * @returns The tooltip text of the element.
  * @alias Blockly.Tooltip.getTooltipOfObject
  */
 export declare function getTooltipOfObject(object: any | null): string;
 /**
  * Create the tooltip div and inject it onto the page.
+ *
  * @alias Blockly.Tooltip.createDom
  */
 export declare function createDom(): void;
 /**
  * Binds the required mouse events onto an SVG element.
+ *
  * @param element SVG element onto which tooltip is to be bound.
  * @alias Blockly.Tooltip.bindMouseEvents
  */
 export declare function bindMouseEvents(element: Element): void;
 /**
  * Unbinds tooltip mouse events from the SVG element.
+ *
  * @param element SVG element onto which tooltip is bound.
  * @alias Blockly.Tooltip.unbindMouseEvents
  */
 export declare function unbindMouseEvents(element: Element): void;
 /**
  * Dispose of the tooltip.
+ *
  * @alias Blockly.Tooltip.dispose
  * @internal
  */
 export declare function dispose(): void;
 /**
  * Hide the tooltip.
+ *
  * @alias Blockly.Tooltip.hide
  */
 export declare function hide(): void;
 /**
  * Hide any in-progress tooltips and block showing new tooltips until the next
  * call to unblock().
+ *
  * @alias Blockly.Tooltip.block
  * @internal
  */
@@ -120,7 +139,9 @@ export declare function block(): void;
 /**
  * Unblock tooltips: allow them to be scheduled and shown according to their own
  * logic.
+ *
  * @alias Blockly.Tooltip.unblock
  * @internal
  */
 export declare function unblock(): void;
+//# sourceMappingURL=tooltip.d.ts.map

package/core/touch.d.ts

@@ -23,6 +23,7 @@ export declare const TOUCH_ENABLED: boolean;
 /**
  * The TOUCH_MAP lookup dictionary specifies additional touch events to fire,
  * in conjunction with mouse events.
+ *
  * @alias Blockly.Touch.TOUCH_MAP
  */
 export declare const TOUCH_MAP: {
@@ -34,6 +35,7 @@ export declare const TOUCH_MAP: {
  * by Chrome.  This function is fired on any touchstart event, queues a task,
  * which after about a second opens the context menu.  The tasks is killed
  * if the touch event terminates early.
+ *
  * @param e Touch start event.
  * @param gesture The gesture that triggered this longStart.
  * @alias Blockly.Touch.longStart
@@ -43,6 +45,7 @@ export declare function longStart(e: Event, gesture: Gesture): void;
 /**
  * Nope, that's not a long-press.  Either touchend or touchcancel was fired,
  * or a drag hath begun.  Kill the queued long-press task.
+ *
  * @alias Blockly.Touch.longStop
  * @internal
  */
@@ -51,6 +54,7 @@ export declare function longStop(): void;
  * Clear the touch identifier that tracks which touch stream to pay attention
  * to.  This ends the current drag/gesture and allows other pointers to be
  * captured.
+ *
  * @alias Blockly.Touch.clearTouchIdentifier
  */
 export declare function clearTouchIdentifier(): void;
@@ -58,8 +62,9 @@ export declare function clearTouchIdentifier(): void;
  * Decide whether Blockly should handle or ignore this event.
  * Mouse and touch events require special checks because we only want to deal
  * with one touch stream at a time.  All other events should always be handled.
+ *
  * @param e The event to check.
- * @return True if this event should be passed through to the registered
+ * @returns True if this event should be passed through to the registered
  *     handler; false if it should be blocked.
  * @alias Blockly.Touch.shouldHandleEvent
  */
@@ -67,8 +72,9 @@ export declare function shouldHandleEvent(e: Event | PseudoEvent): boolean;
 /**
  * Get the touch identifier from the given event.  If it was a mouse event, the
  * identifier is the string 'mouse'.
+ *
  * @param e Mouse event or touch event.
- * @return The touch identifier from the first changed touch, if defined.
+ * @returns The touch identifier from the first changed touch, if defined.
  *     Otherwise 'mouse'.
  * @alias Blockly.Touch.getTouchIdentifierFromEvent
  */
@@ -81,8 +87,9 @@ export declare function getTouchIdentifierFromEvent(e: Event | PseudoEvent): str
  * If the current identifier was unset, save the identifier from the
  * event.  This starts a drag/gesture, during which touch events with other
  * identifiers will be silently ignored.
+ *
  * @param e Mouse event or touch event.
- * @return Whether the identifier on the event matches the current saved
+ * @returns Whether the identifier on the event matches the current saved
  *     identifier.
  * @alias Blockly.Touch.checkTouchIdentifier
  */
@@ -90,32 +97,37 @@ export declare function checkTouchIdentifier(e: Event | PseudoEvent): boolean;
 /**
  * Set an event's clientX and clientY from its first changed touch.  Use this to
  * make a touch event work in a mouse event handler.
+ *
  * @param e A touch event.
  * @alias Blockly.Touch.setClientFromTouch
  */
 export declare function setClientFromTouch(e: Event | PseudoEvent): void;
 /**
  * Check whether a given event is a mouse, touch, or pointer event.
+ *
  * @param e An event.
- * @return True if it is a mouse, touch, or pointer event; false otherwise.
+ * @returns True if it is a mouse, touch, or pointer event; false otherwise.
  * @alias Blockly.Touch.isMouseOrTouchEvent
  */
 export declare function isMouseOrTouchEvent(e: Event | PseudoEvent): boolean;
 /**
  * Check whether a given event is a touch event or a pointer event.
+ *
  * @param e An event.
- * @return True if it is a touch or pointer event; false otherwise.
+ * @returns True if it is a touch or pointer event; false otherwise.
  * @alias Blockly.Touch.isTouchEvent
  */
 export declare function isTouchEvent(e: Event | PseudoEvent): boolean;
 /**
  * Split an event into an array of events, one per changed touch or mouse
  * point.
+ *
  * @param e A mouse event or a touch event with one or more changed touches.
- * @return An array of events or pseudo events.
+ * @returns An array of events or pseudo events.
  *     Each pseudo-touch event will have exactly one changed touch and there
  * will be no real touch events.
  * @alias Blockly.Touch.splitEventByTouches
  */
 export declare function splitEventByTouches(e: Event): Array<Event | PseudoEvent>;
 export {};
+//# sourceMappingURL=touch.d.ts.map

package/core/touch_gesture.d.ts

@@ -7,6 +7,7 @@ import { Gesture } from './gesture.js';
 import { Coordinate } from './utils/coordinate.js';
 /**
  * Class for one gesture.
+ *
  * @alias Blockly.TouchGesture
  */
 export declare class TouchGesture extends Gesture {
@@ -36,6 +37,7 @@ export declare class TouchGesture extends Gesture {
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
      * progress and bind mousemove and mouseup handlers.
+     *
      * @param e A mouse down, touch start or pointer down event.
      * @internal
      */
@@ -47,42 +49,49 @@ export declare class TouchGesture extends Gesture {
      * opt_noCaptureIdentifier.
      * In addition, binding a second mouse down event to detect multi-touch
      * events.
+     *
      * @param e A mouse down or touch start event.
      * @internal
      */
     bindMouseEvents(e: Event): void;
     /**
      * Handle a mouse down, touch start, or pointer down event.
+     *
      * @param e A mouse down, touch start, or pointer down event.
      * @internal
      */
     handleStart(e: Event): void;
     /**
      * Handle a mouse move, touch move, or pointer move event.
+     *
      * @param e A mouse move, touch move, or pointer move event.
      * @internal
      */
     handleMove(e: MouseEvent): void;
     /**
      * Handle a mouse up, touch end, or pointer up event.
+     *
      * @param e A mouse up, touch end, or pointer up event.
      * @internal
      */
     handleUp(e: Event): void;
     /**
      * Whether this gesture is part of a multi-touch gesture.
-     * @return Whether this gesture is part of a multi-touch gesture.
+     *
+     * @returns Whether this gesture is part of a multi-touch gesture.
      * @internal
      */
     isMultiTouch(): boolean;
     /**
      * Sever all links from this object.
+     *
      * @internal
      */
     dispose(): void;
     /**
      * Handle a touch start or pointer down event and keep track of current
      * pointers.
+     *
      * @param e A touch start, or pointer down event.
      * @internal
      */
@@ -90,26 +99,31 @@ export declare class TouchGesture extends Gesture {
     /**
      * Handle a touch move or pointer move event and zoom in/out if two pointers
      * are on the screen.
+     *
      * @param e A touch move, or pointer move event.
      * @internal
      */
     handleTouchMove(e: MouseEvent): void;
     /**
      * Handle pinch zoom gesture.
+     *
      * @param e A touch move, or pointer move event.
      */
     private handlePinch_;
     /**
      * Handle a touch end or pointer end event and end the gesture.
+     *
      * @param e A touch end, or pointer end event.
      * @internal
      */
     handleTouchEnd(e: Event): void;
     /**
      * Helper function returning the current touch point coordinate.
+     *
      * @param e A touch or pointer event.
-     * @return The current touch point coordinate
+     * @returns The current touch point coordinate
      * @internal
      */
     getTouchPoint(e: Event): Coordinate | null;
 }
+//# sourceMappingURL=touch_gesture.d.ts.map

package/core/trashcan.d.ts

@@ -14,6 +14,7 @@ import { Rect } from './utils/rect.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for a trash can.
+ *
  * @alias Blockly.Trashcan
  */
 export declare class Trashcan extends DeleteArea implements IAutoHideable, IPositionable {
@@ -29,6 +30,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     private readonly contents_;
     /**
      * The trashcan flyout.
+     *
      * @internal
      */
     flyout: IFlyout | null;
@@ -57,7 +59,8 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     constructor(workspace: WorkspaceSvg);
     /**
      * Create the trash can elements.
-     * @return The trash can's SVG group.
+     *
+     * @returns The trash can's SVG group.
      */
     createDom(): SVGElement;
     /** Initializes the trash can. */
@@ -65,17 +68,20 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * Dispose of this trash can.
      * Unlink from all DOM elements to prevent memory leaks.
+     *
      * @suppress {checkTypes}
      */
     dispose(): void;
     /**
      * Whether the trashcan has contents.
-     * @return True if the trashcan has contents.
+     *
+     * @returns True if the trashcan has contents.
      */
     private hasContents_;
     /**
      * Returns true if the trashcan contents-flyout is currently open.
-     * @return True if the trashcan contents-flyout is currently open.
+     *
+     * @returns True if the trashcan contents-flyout is currently open.
      */
     contentsIsOpen(): boolean;
     /** Opens the trashcan flyout. */
@@ -84,6 +90,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     closeFlyout(): void;
     /**
      * Hides the component. Called in WorkspaceSvg.hideChaff.
+     *
      * @param onlyClosePopups Whether only popups should be closed.
      *     Flyouts should not be closed if this is true.
      */
@@ -97,6 +104,7 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
      * Positions the trashcan.
      * It is positioned in the opposite corner to the corner the
      * categories/toolbox starts at.
+     *
      * @param metrics The workspace metrics.
      * @param savedPositions List of rectangles that are already on the workspace.
      */
@@ -104,36 +112,42 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * 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;
     /**
      * 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 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;
     /**
      * Flip the lid open or shut.
+     *
      * @param state True if open.
      * @internal
      */
@@ -142,12 +156,14 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     private animateLid_;
     /**
      * Set the angle of the trashcan's lid.
+     *
      * @param lidAngle The angle at which to set the lid.
      */
     private setLidAngle_;
     /**
      * Sets the minimum openness of the trashcan lid. If the lid is currently
      * closed, this will update lid's position.
+     *
      * @param newMin The new minimum openness of the lid. Should be between 0
      *     and 1.
      */
@@ -161,11 +177,13 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     click(): void;
     /**
      * Fires a UI event for trashcan flyout open or close.
+     *
      * @param trashcanOpen Whether the flyout is opening.
      */
     private fireUiEvent_;
     /**
      * Prevents a workspace scroll and click event if the trashcan has blocks.
+     *
      * @param e A mouse down event.
      */
     private blockMouseDownWhenOpenable_;
@@ -181,15 +199,18 @@ export declare class Trashcan extends DeleteArea implements IAutoHideable, IPosi
     /**
      * Handle a BLOCK_DELETE event. Adds deleted blocks oldXml to the content
      * array.
+     *
      * @param event Workspace event.
      */
     private onDelete_;
     /**
      * Converts JSON representing a block into text that can be stored in the
      * content array.
+     *
      * @param json A JSON representation of a block's state.
-     * @return A BlockInfo object corresponding to the JSON, cleaned of all
+     * @returns A BlockInfo object corresponding to the JSON, cleaned of all
      *     unnecessary attributes.
      */
     private cleanBlockJson_;
 }
+//# sourceMappingURL=trashcan.d.ts.map

package/core/utils/aria.d.ts

@@ -6,6 +6,7 @@
 /**
  * ARIA role values.
  * Copied from Closure's goog.a11y.aria.Role
+ *
  * @alias Blockly.utils.aria.Role
  */
 export declare enum Role {
@@ -25,6 +26,7 @@ export declare enum Role {
 /**
  * ARIA states and properties.
  * Copied from Closure's goog.a11y.aria.State
+ *
  * @alias Blockly.utils.aria.State
  */
 export declare enum State {
@@ -57,6 +59,7 @@ export declare function setRole(element: Element, roleName: Role): void;
 /**
  * Sets the state or property of an element.
  * Copied from Closure's goog.a11y.aria
+ *
  * @param element DOM node where we set state.
  * @param stateName State attribute being set.
  *     Automatically adds prefix 'aria-' to the state name if the attribute is
@@ -65,3 +68,4 @@ export declare function setRole(element: Element, roleName: Role): void;
  * @alias Blockly.utils.aria.setState
  */
 export declare function setState(element: Element, stateName: State, value: string | boolean | number | string[]): void;
+//# sourceMappingURL=aria.d.ts.map

package/core/utils/array.d.ts

@@ -5,10 +5,12 @@
  */
 /**
  * Removes the first occurrence of a particular value from an array.
+ *
  * @param arr Array from which to remove value.
  * @param value Value to remove.
- * @return True if an element was removed.
+ * @returns True if an element was removed.
  * @alias Blockly.array.removeElem
  * @internal
  */
-export declare function removeElem(arr: any[], value: any): boolean;
+export declare function removeElem<T>(arr: Array<T>, value: T): boolean;
+//# sourceMappingURL=array.d.ts.map