blockly 8.0.5 → 9.0.0-beta.0

package/core/toolbox/toolbox_item.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ICollapsibleToolboxItem } from '../interfaces/i_collapsible_toolbox_item.js';
+import type { IToolbox } from '../interfaces/i_toolbox.js';
+import type { IToolboxItem } from '../interfaces/i_toolbox_item.js';
+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 {
+    protected id_: string;
+    protected parent_: ICollapsibleToolboxItem | null;
+    protected level_: number;
+    protected toolboxItemDef_: toolbox.ToolboxItemInfo | null;
+    protected workspace_: WorkspaceSvg;
+    /** The toolbox this category belongs to. */
+    protected readonly parentToolbox_: IToolbox;
+    /**
+     * @param toolboxItemDef The JSON defining the toolbox item.
+     * @param parentToolbox The toolbox that holds the toolbox item.
+     * @param opt_parent The parent toolbox item or null if the category does not
+     *     have a parent.
+     */
+    constructor(toolboxItemDef: toolbox.ToolboxItemInfo, parentToolbox: IToolbox, opt_parent?: ICollapsibleToolboxItem);
+    /**
+     * Initializes the toolbox item.
+     * This includes creating the DOM and updating the state of any items based
+     * on the info object.
+     */
+    init(): void;
+    /**
+     * Gets the div for the toolbox item.
+     * @return The div for the toolbox item.
+     */
+    getDiv(): Element | null;
+    /**
+     * Gets the HTML element that is clickable.
+     * 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
+     *     not receive clicks.
+     */
+    getClickTarget(): Element | null;
+    /**
+     * Gets a unique identifier for this toolbox item.
+     * @return 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
+     *     nested.
+     */
+    getParent(): ICollapsibleToolboxItem | null;
+    /**
+     * Gets the nested level of the category.
+     * @return The nested level of the category.
+     * @internal
+     */
+    getLevel(): number;
+    /**
+     * Whether the toolbox item is selectable.
+     * @return True if the toolbox item can be selected.
+     */
+    isSelectable(): boolean;
+    /**
+     * Whether the toolbox item is collapsible.
+     * @return True if the toolbox item is collapsible.
+     */
+    isCollapsible(): boolean;
+    /** Dispose of this toolbox item. No-op by default. */
+    dispose(): void;
+    /**
+     * 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;
+}

package/core/toolbox/toolbox_item.ts

@@ -0,0 +1,147 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview An item in the toolbox.
+ */
+
+/**
+ * An item in the toolbox.
+ * @class
+ */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.ToolboxItem');
+
+import type {ICollapsibleToolboxItem} from '../interfaces/i_collapsible_toolbox_item.js';
+import type {IToolbox} from '../interfaces/i_toolbox.js';
+import type {IToolboxItem} from '../interfaces/i_toolbox_item.js';
+import * as idGenerator from '../utils/idgenerator.js';
+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 class ToolboxItem implements IToolboxItem {
+  protected id_: string;
+  protected parent_: ICollapsibleToolboxItem|null;
+  protected level_: number;
+  protected toolboxItemDef_: toolbox.ToolboxItemInfo|null;
+  protected workspace_: WorkspaceSvg;
+  /** The toolbox this category belongs to. */
+  protected readonly parentToolbox_: IToolbox;
+
+  /**
+   * @param toolboxItemDef The JSON defining the toolbox item.
+   * @param parentToolbox The toolbox that holds the toolbox item.
+   * @param opt_parent The parent toolbox item or null if the category does not
+   *     have a parent.
+   */
+  constructor(
+      toolboxItemDef: toolbox.ToolboxItemInfo, parentToolbox: IToolbox,
+      opt_parent?: ICollapsibleToolboxItem) {
+    /** The id for the category. */
+    this.id_ = (toolboxItemDef as AnyDuringMigration)['toolboxitemid'] ||
+        idGenerator.getNextUniqueId();
+
+    /** The parent of the category. */
+    this.parent_ = opt_parent || null;
+
+    /** The level that the category is nested at. */
+    this.level_ = this.parent_ ? this.parent_.getLevel() + 1 : 0;
+
+    /** The JSON definition of the toolbox item. */
+    this.toolboxItemDef_ = toolboxItemDef;
+
+    this.parentToolbox_ = parentToolbox;
+
+    /** The workspace of the parent toolbox. */
+    this.workspace_ = this.parentToolbox_.getWorkspace();
+  }
+
+  /**
+   * Initializes the toolbox item.
+   * This includes creating the DOM and updating the state of any items based
+   * on the info object.
+   */
+  init() {}
+  // No-op by default.
+
+  /**
+   * Gets the div for the toolbox item.
+   * @return The div for the toolbox item.
+   */
+  getDiv(): Element|null {
+    return null;
+  }
+
+  /**
+   * Gets the HTML element that is clickable.
+   * 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
+   *     not receive clicks.
+   */
+  getClickTarget(): Element|null {
+    return null;
+  }
+
+  /**
+   * Gets a unique identifier for this toolbox item.
+   * @return The ID for the toolbox item.
+   */
+  getId(): string {
+    return this.id_;
+  }
+
+  /**
+   * Gets the parent if the toolbox item is nested.
+   * @return The parent toolbox item, or null if this toolbox item is not
+   *     nested.
+   */
+  getParent(): ICollapsibleToolboxItem|null {
+    return null;
+  }
+
+  /**
+   * Gets the nested level of the category.
+   * @return The nested level of the category.
+   * @internal
+   */
+  getLevel(): number {
+    return this.level_;
+  }
+
+  /**
+   * Whether the toolbox item is selectable.
+   * @return True if the toolbox item can be selected.
+   */
+  isSelectable(): boolean {
+    return false;
+  }
+
+  /**
+   * Whether the toolbox item is collapsible.
+   * @return True if the toolbox item is collapsible.
+   */
+  isCollapsible(): boolean {
+    return false;
+  }
+
+  /** Dispose of this toolbox item. No-op by default. */
+  dispose() {}
+
+  /**
+   * 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) {}
+}
+// nop by default

package/core/tooltip.d.ts

@@ -0,0 +1,126 @@
+/**
+ * @license
+ * Copyright 2011 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * A type which can define a tooltip.
+ * 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 | {
+    tooltip: any;
+} | (() => TipInfo | string | Function);
+/**
+ * A function that renders custom tooltip UI.
+ * 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.
+ * @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
+ */
+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;