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

package/core/keyboard_nav/basic_cursor.d.ts

@@ -0,0 +1,99 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ASTNode } from './ast_node.js';
+import { Cursor } from './cursor.js';
+/**
+ * Class for a basic cursor.
+ * This will allow the user to get to all nodes in the AST by hitting next or
+ * previous.
+ *
+ * @alias Blockly.BasicCursor
+ */
+export declare class BasicCursor extends Cursor {
+    /** Name used for registering a basic cursor. */
+    static readonly registrationName = "basicCursor";
+    /** @alias Blockly.BasicCursor */
+    constructor();
+    /**
+     * Find the next node in the pre order traversal.
+     *
+     * @returns The next node, or null if the current node is not set or there is
+     *     no next value.
+     */
+    next(): ASTNode | null;
+    /**
+     * For a basic cursor we only have the ability to go next and previous, so
+     * in will also allow the user to get to the next node in the pre order
+     * traversal.
+     *
+     * @returns The next node, or null if the current node is not set or there is
+     *     no next value.
+     */
+    in(): ASTNode | null;
+    /**
+     * Find the previous node in the pre order traversal.
+     *
+     * @returns The previous node, or null if the current node is not set or there
+     *     is no previous value.
+     */
+    prev(): ASTNode | null;
+    /**
+     * For a basic cursor we only have the ability to go next and previous, so
+     * out will allow the user to get to the previous node in the pre order
+     * traversal.
+     *
+     * @returns The previous node, or null if the current node is not set or there
+     *     is no previous value.
+     */
+    out(): ASTNode | null;
+    /**
+     * Uses pre order traversal to navigate the Blockly AST. This will allow
+     * a user to easily navigate the entire Blockly AST without having to go in
+     * and out levels on the tree.
+     *
+     * @param node The current position in the AST.
+     * @param isValid A function true/false depending on whether the given node
+     *     should be traversed.
+     * @returns The next node in the traversal.
+     */
+    protected getNextNode_(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
+    /**
+     * Reverses the pre order traversal in order to find the previous node. This
+     * will allow a user to easily navigate the entire Blockly AST without having
+     * to go in and out levels on the tree.
+     *
+     * @param node The current position in the AST.
+     * @param isValid A function true/false depending on whether the given node
+     *     should be traversed.
+     * @returns The previous node in the traversal or null if no previous node
+     *     exists.
+     */
+    protected getPreviousNode_(node: ASTNode | null, isValid: (p1: ASTNode | null) => boolean): ASTNode | null;
+    /**
+     * Decides what nodes to traverse and which ones to skip. Currently, it
+     * skips output, stack and workspace nodes.
+     *
+     * @param node The AST node to check whether it is valid.
+     * @returns True if the node should be visited, false otherwise.
+     */
+    protected validNode_(node: ASTNode | null): boolean;
+    /**
+     * From the given node find either the next valid sibling or parent.
+     *
+     * @param node The current position in the AST.
+     * @returns The parent AST node or null if there are no valid parents.
+     */
+    private findSiblingOrParent_;
+    /**
+     * Get the right most child of a node.
+     *
+     * @param node The node to find the right most child of.
+     * @returns The right most child of the given node, or the node if no child
+     *     exists.
+     */
+    private getRightMostChild_;
+}
+//# sourceMappingURL=basic_cursor.d.ts.map

package/core/keyboard_nav/cursor.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ASTNode } from './ast_node.js';
+import { Marker } from './marker.js';
+/**
+ * Class for a cursor.
+ * A cursor controls how a user navigates the Blockly AST.
+ *
+ * @alias Blockly.Cursor
+ */
+export declare class Cursor extends Marker {
+    type: string;
+    /** @alias Blockly.Cursor */
+    constructor();
+    /**
+     * Find the next connection, field, or block.
+     *
+     * @returns The next element, or null if the current node is not set or there
+     *     is no next value.
+     */
+    next(): ASTNode | null;
+    /**
+     * Find the in connection or field.
+     *
+     * @returns The in element, or null if the current node is not set or there is
+     *     no in value.
+     */
+    in(): ASTNode | null;
+    /**
+     * Find the previous connection, field, or block.
+     *
+     * @returns The previous element, or null if the current node is not set or
+     *     there is no previous value.
+     */
+    prev(): ASTNode | null;
+    /**
+     * Find the out connection, field, or block.
+     *
+     * @returns The out element, or null if the current node is not set or there
+     *     is no out value.
+     */
+    out(): ASTNode | null;
+}
+//# sourceMappingURL=cursor.d.ts.map

package/core/keyboard_nav/marker.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { MarkerSvg } from '../renderers/common/marker_svg.js';
+import type { ASTNode } from './ast_node.js';
+/**
+ * Class for a marker.
+ * This is used in keyboard navigation to save a location in the Blockly AST.
+ *
+ * @alias Blockly.Marker
+ */
+export declare class Marker {
+    /** The colour of the marker. */
+    colour: string | null;
+    /** The current location of the marker. */
+    private curNode_;
+    /**
+     * The object in charge of drawing the visual representation of the current
+     * node.
+     */
+    private drawer_;
+    /** The type of the marker. */
+    type: string;
+    /** Constructs a new Marker instance. */
+    constructor();
+    /**
+     * Sets the object in charge of drawing the marker.
+     *
+     * @param drawer The object in charge of drawing the marker.
+     */
+    setDrawer(drawer: MarkerSvg): void;
+    /**
+     * Get the current drawer for the marker.
+     *
+     * @returns The object in charge of drawing the marker.
+     */
+    getDrawer(): MarkerSvg;
+    /**
+     * Gets the current location of the marker.
+     *
+     * @returns The current field, connection, or block the marker is on.
+     */
+    getCurNode(): ASTNode;
+    /**
+     * Set the location of the marker and call the update method.
+     * Setting isStack to true will only work if the newLocation is the top most
+     * output or previous connection on a stack.
+     *
+     * @param newNode The new location of the marker.
+     */
+    setCurNode(newNode: ASTNode): void;
+    /**
+     * Redraw the current marker.
+     *
+     * @internal
+     */
+    draw(): void;
+    /** Hide the marker SVG. */
+    hide(): void;
+    /** Dispose of this marker. */
+    dispose(): void;
+}
+//# sourceMappingURL=marker.d.ts.map

package/core/keyboard_nav/tab_navigate_cursor.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ASTNode } from './ast_node.js';
+import { BasicCursor } from './basic_cursor.js';
+/**
+ * A cursor for navigating between tab navigable fields.
+ *
+ * @alias Blockly.TabNavigateCursor
+ */
+export declare class TabNavigateCursor extends BasicCursor {
+    /**
+     * Skip all nodes except for tab navigable fields.
+     *
+     * @param node The AST node to check whether it is valid.
+     * @returns True if the node should be visited, false otherwise.
+     */
+    validNode_(node: ASTNode | null): boolean;
+}
+//# sourceMappingURL=tab_navigate_cursor.d.ts.map

package/core/main.d.ts

@@ -0,0 +1,12 @@
+declare const Blockly: any;
+declare const ContextMenu: any;
+declare const Events: any;
+declare const Msg: any;
+declare const Tooltip: any;
+declare const WidgetDiv: any;
+declare const colour: any;
+declare const common: any;
+declare const deprecation: any;
+declare const dialog: any;
+declare const eventUtils: any;
+//# sourceMappingURL=main.d.ts.map

package/core/marker_manager.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Cursor } from './keyboard_nav/cursor.js';
+import type { Marker } from './keyboard_nav/marker.js';
+import type { WorkspaceSvg } from './workspace_svg.js';
+/**
+ * Class to manage the multiple markers and the cursor on a workspace.
+ *
+ * @alias Blockly.MarkerManager
+ */
+export declare class MarkerManager {
+    private readonly workspace;
+    /** The name of the local marker. */
+    static readonly LOCAL_MARKER = "local_marker_1";
+    /** The cursor. */
+    private cursor_;
+    /** The cursor's SVG element. */
+    private cursorSvg_;
+    /** The map of markers for the workspace. */
+    private markers;
+    /** The marker's SVG element. */
+    private markerSvg_;
+    /**
+     * @param workspace The workspace for the marker manager.
+     * @internal
+     */
+    constructor(workspace: WorkspaceSvg);
+    /**
+     * Register the marker by adding it to the map of markers.
+     *
+     * @param id A unique identifier for the marker.
+     * @param marker The marker to register.
+     */
+    registerMarker(id: string, marker: Marker): void;
+    /**
+     * Unregister the marker by removing it from the map of markers.
+     *
+     * @param id The ID of the marker to unregister.
+     */
+    unregisterMarker(id: string): void;
+    /**
+     * Get the cursor for the workspace.
+     *
+     * @returns The cursor for this workspace.
+     */
+    getCursor(): Cursor | null;
+    /**
+     * Get a single marker that corresponds to the given ID.
+     *
+     * @param id A unique identifier for the marker.
+     * @returns The marker that corresponds to the given ID, or null if none
+     *     exists.
+     */
+    getMarker(id: string): Marker | null;
+    /**
+     * Sets the cursor and initializes the drawer for use with keyboard
+     * navigation.
+     *
+     * @param cursor The cursor used to move around this workspace.
+     */
+    setCursor(cursor: Cursor): void;
+    /**
+     * Add the cursor SVG to this workspace SVG group.
+     *
+     * @param cursorSvg The SVG root of the cursor to be added to the workspace
+     *     SVG group.
+     * @internal
+     */
+    setCursorSvg(cursorSvg: SVGElement | null): void;
+    /**
+     * Add the marker SVG to this workspaces SVG group.
+     *
+     * @param markerSvg The SVG root of the marker to be added to the workspace
+     *     SVG group.
+     * @internal
+     */
+    setMarkerSvg(markerSvg: SVGElement | null): void;
+    /**
+     * Redraw the attached cursor SVG if needed.
+     *
+     * @internal
+     */
+    updateMarkers(): void;
+    /**
+     * Dispose of the marker manager.
+     * Go through and delete all markers associated with this marker manager.
+     *
+     * @suppress {checkTypes}
+     * @internal
+     */
+    dispose(): void;
+}
+//# sourceMappingURL=marker_manager.d.ts.map

package/core/menu.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { MenuItem } from './menuitem.js';
+import * as aria from './utils/aria.js';
+import { Coordinate } from './utils/coordinate.js';
+import type { Size } from './utils/size.js';
+/**
+ * A basic menu class.
+ *
+ * @alias Blockly.Menu
+ */
+export declare class Menu {
+    /**
+     * Array of menu items.
+     * (Nulls are never in the array, but typing the array as nullable prevents
+     * the compiler from objecting to .indexOf(null))
+     */
+    private readonly menuItems_;
+    /**
+     * Coordinates of the mousedown event that caused this menu to open. Used to
+     * prevent the consequent mouseup event due to a simple click from
+     * activating a menu item immediately.
+     */
+    openingCoords: Coordinate | null;
+    /**
+     * This is the element that we will listen to the real focus events on.
+     * A value of null means no menu item is highlighted.
+     */
+    private highlightedItem_;
+    /** Mouse over event data. */
+    private mouseOverHandler_;
+    /** Click event data. */
+    private clickHandler_;
+    /** Mouse enter event data. */
+    private mouseEnterHandler_;
+    /** Mouse leave event data. */
+    private mouseLeaveHandler_;
+    /** Key down event data. */
+    private onKeyDownHandler_;
+    /** The menu's root DOM element. */
+    private element_;
+    /** ARIA name for this menu. */
+    private roleName_;
+    /** Constructs a new Menu instance. */
+    constructor();
+    /**
+     * Add a new menu item to the bottom of this menu.
+     *
+     * @param menuItem Menu item to append.
+     * @internal
+     */
+    addChild(menuItem: MenuItem): void;
+    /**
+     * Creates the menu DOM.
+     *
+     * @param container Element upon which to append this menu.
+     */
+    render(container: Element): void;
+    /**
+     * Gets the menu's element.
+     *
+     * @returns The DOM element.
+     * @internal
+     */
+    getElement(): HTMLDivElement | null;
+    /**
+     * Focus the menu element.
+     *
+     * @internal
+     */
+    focus(): void;
+    /** Blur the menu element. */
+    private blur_;
+    /**
+     * Set the menu accessibility role.
+     *
+     * @param roleName role name.
+     * @internal
+     */
+    setRole(roleName: aria.Role): void;
+    /** Dispose of this menu. */
+    dispose(): void;
+    /**
+     * Returns the child menu item that owns the given DOM element,
+     * or null if no such menu item is found.
+     *
+     * @param elem DOM element whose owner is to be returned.
+     * @returns Menu item for which the DOM element belongs to.
+     */
+    private getMenuItem_;
+    /**
+     * Highlights the given menu item, or clears highlighting if null.
+     *
+     * @param item Item to highlight, or null.
+     * @internal
+     */
+    setHighlighted(item: MenuItem | null): void;
+    /**
+     * Highlights the next highlightable item (or the first if nothing is
+     * currently highlighted).
+     *
+     * @internal
+     */
+    highlightNext(): void;
+    /**
+     * Highlights the previous highlightable item (or the last if nothing is
+     * currently highlighted).
+     *
+     * @internal
+     */
+    highlightPrevious(): void;
+    /** Highlights the first highlightable item. */
+    private highlightFirst_;
+    /** Highlights the last highlightable item. */
+    private highlightLast_;
+    /**
+     * Helper function that manages the details of moving the highlight among
+     * child menuitems in response to keyboard events.
+     *
+     * @param startIndex Start index.
+     * @param delta Step direction: 1 to go down, -1 to go up.
+     */
+    private highlightHelper_;
+    /**
+     * Handles mouseover events. Highlight menuitems as the user hovers over them.
+     *
+     * @param e Mouse event to handle.
+     */
+    private handleMouseOver_;
+    /**
+     * Handles click events. Pass the event onto the child menuitem to handle.
+     *
+     * @param e Click event to handle.
+     */
+    private handleClick_;
+    /**
+     * Handles mouse enter events. Focus the element.
+     *
+     * @param _e Mouse event to handle.
+     */
+    private handleMouseEnter_;
+    /**
+     * Handles mouse leave events. Blur and clear highlight.
+     *
+     * @param _e Mouse event to handle.
+     */
+    private handleMouseLeave_;
+    /**
+     * Attempts to handle a keyboard event, if the menu item is enabled, by
+     * calling
+     * {@link Menu#handleKeyEventInternal_}.
+     *
+     * @param e Key event to handle.
+     */
+    private handleKeyEvent_;
+    /**
+     * Get the size of a rendered menu.
+     *
+     * @returns Object with width and height properties.
+     * @internal
+     */
+    getSize(): Size;
+}
+//# sourceMappingURL=menu.d.ts.map

package/core/menuitem.d.ts

@@ -0,0 +1,133 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import * as aria from './utils/aria.js';
+/**
+ * Class representing an item in a menu.
+ *
+ * @alias Blockly.MenuItem
+ */
+export declare class MenuItem {
+    private readonly content;
+    private readonly opt_value?;
+    /** Is the menu item clickable, as opposed to greyed-out. */
+    private enabled_;
+    /** The DOM element for the menu item. */
+    private element_;
+    /** Whether the menu item is rendered right-to-left. */
+    private rightToLeft_;
+    /** ARIA name for this menu. */
+    private roleName_;
+    /** Is this menu item checkable. */
+    private checkable_;
+    /** Is this menu item currently checked. */
+    private checked_;
+    /** Is this menu item currently highlighted. */
+    private highlight_;
+    /** Bound function to call when this menu item is clicked. */
+    private actionHandler_;
+    /**
+     * @param content Text caption to display as the content of the item, or a
+     *     HTML element to display.
+     * @param opt_value Data/model associated with the menu item.
+     */
+    constructor(content: string | HTMLElement, opt_value?: string | undefined);
+    /**
+     * Creates the menuitem's DOM.
+     *
+     * @returns Completed DOM.
+     */
+    createDom(): Element;
+    /** Dispose of this menu item. */
+    dispose(): void;
+    /**
+     * Gets the menu item's element.
+     *
+     * @returns The DOM element.
+     * @internal
+     */
+    getElement(): Element | null;
+    /**
+     * Gets the unique ID for this menu item.
+     *
+     * @returns Unique component ID.
+     * @internal
+     */
+    getId(): string;
+    /**
+     * Gets the value associated with the menu item.
+     *
+     * @returns value Value associated with the menu item.
+     * @internal
+     */
+    getValue(): string | null;
+    /**
+     * Set menu item's rendering direction.
+     *
+     * @param rtl True if RTL, false if LTR.
+     * @internal
+     */
+    setRightToLeft(rtl: boolean): void;
+    /**
+     * Set the menu item's accessibility role.
+     *
+     * @param roleName Role name.
+     * @internal
+     */
+    setRole(roleName: aria.Role): void;
+    /**
+     * Sets the menu item to be checkable or not. Set to true for menu items
+     * that represent checkable options.
+     *
+     * @param checkable Whether the menu item is checkable.
+     * @internal
+     */
+    setCheckable(checkable: boolean): void;
+    /**
+     * Checks or unchecks the component.
+     *
+     * @param checked Whether to check or uncheck the component.
+     * @internal
+     */
+    setChecked(checked: boolean): void;
+    /**
+     * Highlights or unhighlights the component.
+     *
+     * @param highlight Whether to highlight or unhighlight the component.
+     * @internal
+     */
+    setHighlighted(highlight: boolean): void;
+    /**
+     * Returns true if the menu item is enabled, false otherwise.
+     *
+     * @returns Whether the menu item is enabled.
+     * @internal
+     */
+    isEnabled(): boolean;
+    /**
+     * Enables or disables the menu item.
+     *
+     * @param enabled Whether to enable or disable the menu item.
+     * @internal
+     */
+    setEnabled(enabled: boolean): void;
+    /**
+     * Performs the appropriate action when the menu item is activated
+     * by the user.
+     *
+     * @internal
+     */
+    performAction(): void;
+    /**
+     * Set the handler that's called when the menu item is activated by the user.
+     * `obj` will be used as the 'this' object in the function when called.
+     *
+     * @param fn The handler.
+     * @param obj Used as the 'this' object in fn when called.
+     * @internal
+     */
+    onAction(fn: (p1: MenuItem) => void, obj: object): void;
+}
+//# sourceMappingURL=menuitem.d.ts.map