blockly 12.4.0 → 12.5.0

package/core/dropdowndiv.d.ts

@@ -0,0 +1,208 @@
+/**
+ * @license
+ * Copyright 2016 Massachusetts Institute of Technology
+ * All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * A div that floats on top of the workspace, for drop-down menus.
+ *
+ * @class
+ */
+import type { BlockSvg } from './block_svg.js';
+import type { Field } from './field.js';
+/**
+ * Arrow size in px. Should match the value in CSS
+ * (need to position pre-render).
+ */
+export declare const ARROW_SIZE = 16;
+/**
+ * Drop-down border size in px. Should match the value in CSS (need to position
+ * the arrow).
+ */
+export declare const BORDER_SIZE = 1;
+/**
+ * Amount the arrow must be kept away from the edges of the main drop-down div,
+ * in px.
+ */
+export declare const ARROW_HORIZONTAL_PADDING = 12;
+/** Amount drop-downs should be padded away from the source, in px. */
+export declare const PADDING_Y = 16;
+/** Length of animations in seconds. */
+export declare const ANIMATION_TIME = 0.25;
+/**
+ * Dropdown bounds info object used to encapsulate sizing information about a
+ * bounding element (bounding box and width/height).
+ */
+export interface BoundsInfo {
+    top: number;
+    left: number;
+    bottom: number;
+    right: number;
+    width: number;
+    height: number;
+}
+/** Dropdown position metrics. */
+export interface PositionMetrics {
+    initialX: number;
+    initialY: number;
+    finalX: number;
+    finalY: number;
+    arrowX: number | null;
+    arrowY: number | null;
+    arrowAtTop: boolean | null;
+    arrowVisible: boolean;
+}
+/**
+ * Create and insert the DOM element for this div.
+ *
+ * @internal
+ */
+export declare function createDom(): void;
+/**
+ * Set an element to maintain bounds within. Drop-downs will appear
+ * within the box of this element if possible.
+ *
+ * @param boundsElem Element to bind drop-down to.
+ */
+export declare function setBoundsElement(boundsElem: Element | null): void;
+/**
+ * @returns The field that currently owns this, or null.
+ */
+export declare function getOwner(): Field | null;
+/**
+ * Provide the div for inserting content into the drop-down.
+ *
+ * @returns Div to populate with content.
+ */
+export declare function getContentDiv(): HTMLDivElement;
+/** Clear the content of the drop-down. */
+export declare function clearContent(): void;
+/**
+ * Set the colour for the drop-down.
+ *
+ * @param backgroundColour Any CSS colour for the background.
+ * @param borderColour Any CSS colour for the border.
+ */
+export declare function setColour(backgroundColour: string, borderColour: string): void;
+/**
+ * Shortcut to show and place the drop-down with positioning determined
+ * by a particular block. The primary position will be below the block,
+ * and the secondary position above the block. Drop-down will be
+ * constrained to the block's workspace.
+ *
+ * @param field The field showing the drop-down.
+ * @param block Block to position the drop-down around.
+ * @param opt_onHide Optional callback for when the drop-down is hidden.
+ * @param opt_secondaryYOffset Optional Y offset for above-block positioning.
+ * @param manageEphemeralFocus Whether ephemeral focus should be managed
+ *     according to the drop-down div's lifetime. Note that if a false value is
+ *     passed in here then callers should manage ephemeral focus directly
+ *     otherwise focus may not properly restore when the widget closes. Defaults
+ *     to true.
+ * @returns True if the menu rendered below block; false if above.
+ */
+export declare function showPositionedByBlock<T>(field: Field<T>, block: BlockSvg, opt_onHide?: () => void, opt_secondaryYOffset?: number, manageEphemeralFocus?: boolean): boolean;
+/**
+ * Shortcut to show and place the drop-down with positioning determined
+ * by a particular field. The primary position will be below the field,
+ * and the secondary position above the field. Drop-down will be
+ * constrained to the block's workspace.
+ *
+ * @param field The field to position the dropdown against.
+ * @param opt_onHide Optional callback for when the drop-down is hidden.
+ * @param opt_secondaryYOffset Optional Y offset for above-block positioning.
+ * @param manageEphemeralFocus Whether ephemeral focus should be managed
+ *     according to the drop-down div's lifetime. Note that if a false value is
+ *     passed in here then callers should manage ephemeral focus directly
+ *     otherwise focus may not properly restore when the widget closes. Defaults
+ *     to true.
+ * @returns True if the menu rendered below block; false if above.
+ */
+export declare function showPositionedByField<T>(field: Field<T>, opt_onHide?: () => void, opt_secondaryYOffset?: number, manageEphemeralFocus?: boolean): boolean;
+/**
+ * Show and place the drop-down.
+ * The drop-down is placed with an absolute "origin point" (x, y) - i.e.,
+ * the arrow will point at this origin and box will positioned below or above
+ * it.  If we can maintain the container bounds at the primary point, the arrow
+ * will point there, and the container will be positioned below it.
+ * If we can't maintain the container bounds at the primary point, fall-back to
+ * the secondary point and position above.
+ *
+ * @param newOwner The object showing the drop-down
+ * @param rtl Right-to-left (true) or left-to-right (false).
+ * @param primaryX Desired origin point x, in absolute px.
+ * @param primaryY Desired origin point y, in absolute px.
+ * @param secondaryX Secondary/alternative origin point x, in absolute px.
+ * @param secondaryY Secondary/alternative origin point y, in absolute px.
+ * @param opt_onHide Optional callback for when the drop-down is hidden.
+ * @param manageEphemeralFocus Whether ephemeral focus should be managed
+ *     according to the widget div's lifetime.
+ * @returns True if the menu rendered at the primary origin point.
+ * @internal
+ */
+export declare function show<T>(newOwner: Field<T>, rtl: boolean, primaryX: number, primaryY: number, secondaryX: number, secondaryY: number, manageEphemeralFocus: boolean, opt_onHide?: () => void): boolean;
+/**
+ * Get the x positions for the left side of the DropDownDiv and the arrow,
+ * accounting for the bounds of the workspace.
+ *
+ * @param sourceX Desired origin point x, in absolute px.
+ * @param boundsLeft The left edge of the bounding element, in absolute px.
+ * @param boundsRight The right edge of the bounding element, in absolute px.
+ * @param divWidth The width of the div in px.
+ * @returns An object containing metrics for the x positions of the left side of
+ *     the DropDownDiv and the arrow.
+ * @internal
+ */
+export declare function getPositionX(sourceX: number, boundsLeft: number, boundsRight: number, divWidth: number): {
+    divX: number;
+    arrowX: number;
+};
+/**
+ * Is the container visible?
+ *
+ * @returns True if visible.
+ */
+export declare function isVisible(): boolean;
+/**
+ * Hide the menu only if it is owned by the provided object.
+ *
+ * @param divOwner Object which must be owning the drop-down to hide.
+ * @param opt_withoutAnimation True if we should hide the dropdown without
+ *     animating.
+ * @returns True if hidden.
+ */
+export declare function hideIfOwner<T>(divOwner: Field<T>, opt_withoutAnimation?: boolean): boolean;
+/** Hide the menu, triggering animation. */
+export declare function hide(): void;
+/** Hide the menu, without animation. */
+export declare function hideWithoutAnimation(): void;
+/**
+ * Repositions the dropdownDiv on window resize. If it doesn't know how to
+ * calculate the new position, it will just hide it instead.
+ *
+ * @internal
+ */
+export declare function repositionForWindowResize(): void;
+export declare const TEST_ONLY: {
+    /**
+     * Get sizing info about the bounding element.
+     *
+     * @returns An object containing size information about the bounding element
+     *     (bounding box and width/height).
+     */
+    getBoundsInfo: () => BoundsInfo;
+    /**
+     * Helper to position the drop-down and the arrow, maintaining bounds.
+     * See explanation of origin points in show.
+     *
+     * @param primaryX Desired origin point x, in absolute px.
+     * @param primaryY Desired origin point y, in absolute px.
+     * @param secondaryX Secondary/alternative origin point x, in absolute px.
+     * @param secondaryY Secondary/alternative origin point y, in absolute px.
+     * @returns Various final metrics, including rendered positions for drop-down
+     *     and arrow.
+     */
+    getPositionMetrics: (primaryX: number, primaryY: number, secondaryX: number, secondaryY: number) => PositionMetrics;
+};
+//# sourceMappingURL=dropdowndiv.d.ts.map

package/core/events/events.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { EventType } from './type.js';
+export { Abstract, AbstractEventJson } from './events_abstract.js';
+export { BlockBase, BlockBaseJson } from './events_block_base.js';
+export { BlockChange, BlockChangeJson } from './events_block_change.js';
+export { BlockCreate, BlockCreateJson } from './events_block_create.js';
+export { BlockDelete, BlockDeleteJson } from './events_block_delete.js';
+export { BlockDrag, BlockDragJson } from './events_block_drag.js';
+export { BlockFieldIntermediateChange, BlockFieldIntermediateChangeJson, } from './events_block_field_intermediate_change.js';
+export { BlockMove, BlockMoveJson } from './events_block_move.js';
+export { BubbleOpen, BubbleOpenJson, BubbleType } from './events_bubble_open.js';
+export { Click, ClickJson, ClickTarget } from './events_click.js';
+export { CommentBase, CommentBaseJson } from './events_comment_base.js';
+export { CommentChange, CommentChangeJson } from './events_comment_change.js';
+export { CommentCollapse, CommentCollapseJson, } from './events_comment_collapse.js';
+export { CommentCreate, CommentCreateJson } from './events_comment_create.js';
+export { CommentDelete } from './events_comment_delete.js';
+export { CommentDrag, CommentDragJson } from './events_comment_drag.js';
+export { CommentMove, CommentMoveJson } from './events_comment_move.js';
+export { CommentResize, CommentResizeJson } from './events_comment_resize.js';
+export { Selected, SelectedJson } from './events_selected.js';
+export { ThemeChange, ThemeChangeJson } from './events_theme_change.js';
+export { ToolboxItemSelect, ToolboxItemSelectJson, } from './events_toolbox_item_select.js';
+export { TrashcanOpen, TrashcanOpenJson } from './events_trashcan_open.js';
+export { UiBase } from './events_ui_base.js';
+export { VarBase, VarBaseJson } from './events_var_base.js';
+export { VarCreate, VarCreateJson } from './events_var_create.js';
+export { VarDelete, VarDeleteJson } from './events_var_delete.js';
+export { VarRename, VarRenameJson } from './events_var_rename.js';
+export { VarTypeChange, VarTypeChangeJson } from './events_var_type_change.js';
+export { ViewportChange, ViewportChangeJson } from './events_viewport.js';
+export { FinishedLoading } from './workspace_events.js';
+export type { BumpEvent } from './utils.js';
+export declare const BLOCK_CHANGE = EventType.BLOCK_CHANGE;
+export declare const BLOCK_CREATE = EventType.BLOCK_CREATE;
+export declare const BLOCK_DELETE = EventType.BLOCK_DELETE;
+export declare const BLOCK_DRAG = EventType.BLOCK_DRAG;
+export declare const BLOCK_MOVE = EventType.BLOCK_MOVE;
+export declare const BLOCK_FIELD_INTERMEDIATE_CHANGE = EventType.BLOCK_FIELD_INTERMEDIATE_CHANGE;
+export declare const BUBBLE_OPEN = EventType.BUBBLE_OPEN;
+/** @deprecated Use BLOCK_CHANGE instead */
+export declare const CHANGE = EventType.BLOCK_CHANGE;
+export declare const CLICK = EventType.CLICK;
+export declare const COMMENT_CHANGE = EventType.COMMENT_CHANGE;
+export declare const COMMENT_CREATE = EventType.COMMENT_CREATE;
+export declare const COMMENT_DELETE = EventType.COMMENT_DELETE;
+export declare const COMMENT_MOVE = EventType.COMMENT_MOVE;
+export declare const COMMENT_RESIZE = EventType.COMMENT_RESIZE;
+export declare const COMMENT_DRAG = EventType.COMMENT_DRAG;
+/** @deprecated Use BLOCK_CREATE instead */
+export declare const CREATE = EventType.BLOCK_CREATE;
+/** @deprecated Use BLOCK_DELETE instead */
+export declare const DELETE = EventType.BLOCK_DELETE;
+export declare const FINISHED_LOADING = EventType.FINISHED_LOADING;
+/** @deprecated Use BLOCK_MOVE instead */
+export declare const MOVE = EventType.BLOCK_MOVE;
+export declare const SELECTED = EventType.SELECTED;
+export declare const THEME_CHANGE = EventType.THEME_CHANGE;
+export declare const TOOLBOX_ITEM_SELECT = EventType.TOOLBOX_ITEM_SELECT;
+export declare const TRASHCAN_OPEN = EventType.TRASHCAN_OPEN;
+export declare const UI = EventType.UI;
+export declare const VAR_CREATE = EventType.VAR_CREATE;
+export declare const VAR_DELETE = EventType.VAR_DELETE;
+export declare const VAR_RENAME = EventType.VAR_RENAME;
+export declare const VIEWPORT_CHANGE = EventType.VIEWPORT_CHANGE;
+export { BUMP_EVENTS } from './type.js';
+export { clearPendingUndo, disable, disableOrphans, enable, filter, fire, fromJson, get, getDescendantIds, getGroup, getRecordUndo, isEnabled, setGroup, setRecordUndo, } from './utils.js';
+//# sourceMappingURL=events.d.ts.map

package/core/events/events_abstract.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Workspace } from '../workspace.js';
+/**
+ * Abstract class for an event.
+ */
+export declare abstract class Abstract {
+    /**
+     * Whether or not the event was constructed without necessary parameters
+     * (to be populated by fromJson).
+     */
+    abstract isBlank: boolean;
+    /** The workspace identifier for this event. */
+    workspaceId?: string;
+    /**
+     * An ID for the group of events this block is associated with.
+     *
+     * Groups define events that should be treated as an single action from the
+     * user's perspective, and should be undone together.
+     */
+    group: string;
+    /** Whether this event is undoable or not. */
+    recordUndo: boolean;
+    /** Whether or not the event is a UI event. */
+    isUiEvent: boolean;
+    /** Type of this event. */
+    type: string;
+    constructor();
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): AbstractEventJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of Abstract (like all events), but we can't specify that due to the
+     *     fact that parameters to static methods in subclasses must be
+     *     supertypes of parameters to static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: AbstractEventJson, workspace: Workspace, event: any): Abstract;
+    /**
+     * Does this event record any change of state?
+     *
+     * @returns True if null, false if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run an event.
+     *
+     * @param _forward True if run forward, false if run backward (undo).
+     */
+    run(_forward: boolean): void;
+    /**
+     * Get workspace the event belongs to.
+     *
+     * @returns The workspace the event belongs to.
+     * @throws {Error} if workspace is null.
+     */
+    getEventWorkspace_(): Workspace;
+}
+export interface AbstractEventJson {
+    type: string;
+    group: string;
+}
+//# sourceMappingURL=events_abstract.d.ts.map

package/core/events/events_block_base.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Base class for all types of block events.
+ *
+ * @class
+ */
+import type { Block } from '../block.js';
+import type { Workspace } from '../workspace.js';
+import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
+/**
+ * Abstract class for any event related to blocks.
+ */
+export declare class BlockBase extends AbstractEvent {
+    isBlank: boolean;
+    /** The ID of the block associated with this event. */
+    blockId?: string;
+    /**
+     * @param opt_block The block this event corresponds to.
+     *     Undefined for a blank event.
+     */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): BlockBaseJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of BlockBase, but we can't specify that due to the fact that parameters
+     *     to static methods in subclasses must be supertypes of parameters to
+     *     static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: BlockBaseJson, workspace: Workspace, event?: any): BlockBase;
+}
+export interface BlockBaseJson extends AbstractEventJson {
+    blockId: string;
+}
+//# sourceMappingURL=events_block_base.d.ts.map

package/core/events/events_block_change.d.ts

@@ -0,0 +1,100 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Class for a block change event.
+ *
+ * @class
+ */
+import type { Block } from '../block.js';
+import type { BlockSvg } from '../block_svg.js';
+import { Workspace } from '../workspace.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners when some element of a block has changed (e.g.
+ * field values, comments, etc).
+ */
+export declare class BlockChange extends BlockBase {
+    type: EventType;
+    /**
+     * The element that changed; one of 'field', 'comment', 'collapsed',
+     * 'disabled', 'inline', or 'mutation'
+     */
+    element?: string;
+    /** The name of the field that changed, if this is a change to a field. */
+    name?: string;
+    /** The original value of the element. */
+    oldValue: unknown;
+    /** The new value of the element. */
+    newValue: unknown;
+    /**
+     * If element is 'disabled', this is the language-neutral identifier of the
+     * reason why the block was or was not disabled.
+     */
+    private disabledReason?;
+    /**
+     * @param opt_block The changed block.  Undefined for a blank event.
+     * @param opt_element One of 'field', 'comment', 'disabled', etc.
+     * @param opt_name Name of input or field affected, or null.
+     * @param opt_oldValue Previous value of element.
+     * @param opt_newValue New value of element.
+     */
+    constructor(opt_block?: Block, opt_element?: string, opt_name?: string | null, opt_oldValue?: unknown, opt_newValue?: unknown);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): BlockChangeJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of BlockChange, but we can't specify that due to the fact that
+     *     parameters to static methods in subclasses must be supertypes of
+     *     parameters to static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: BlockChangeJson, workspace: Workspace, event?: any): BlockChange;
+    /**
+     * Set the language-neutral identifier for the reason why the block was or was
+     * not disabled. This is only valid for events where element is 'disabled'.
+     * Defaults to 'MANUALLY_DISABLED'.
+     *
+     * @param disabledReason The identifier of the reason why the block was or was
+     *     not disabled.
+     */
+    setDisabledReason(disabledReason: string): void;
+    /**
+     * Does this event record any change of state?
+     *
+     * @returns False if something changed.
+     */
+    isNull(): boolean;
+    /**
+     * Run a change event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+    /**
+     * Returns the extra state of the given block (either as XML or a JSO,
+     * depending on the block's definition).
+     *
+     * @param block The block to get the extra state of.
+     * @returns A stringified version of the extra state of the given block.
+     * @internal
+     */
+    static getExtraBlockState_(block: BlockSvg): string;
+}
+export interface BlockChangeJson extends BlockBaseJson {
+    element: string;
+    name?: string;
+    newValue: unknown;
+    oldValue: unknown;
+    disabledReason?: string;
+}
+//# sourceMappingURL=events_block_change.d.ts.map

package/core/events/events_block_create.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Class for a block creation event.
+ *
+ * @class
+ */
+import type { Block } from '../block.js';
+import * as blocks from '../serialization/blocks.js';
+import { Workspace } from '../workspace.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners when a block (or connected stack of blocks) is
+ * created.
+ */
+export declare class BlockCreate extends BlockBase {
+    type: EventType;
+    /** The XML representation of the created block(s). */
+    xml?: Element | DocumentFragment;
+    /** The JSON respresentation of the created block(s). */
+    json?: blocks.State;
+    /** All of the IDs of created blocks. */
+    ids?: string[];
+    /** @param opt_block The created block.  Undefined for a blank event. */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): BlockCreateJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of BlockCreate, but we can't specify that due to the fact that
+     *     parameters to static methods in subclasses must be supertypes of
+     *     parameters to static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: BlockCreateJson, workspace: Workspace, event?: any): BlockCreate;
+    /**
+     * Run a creation event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}
+export interface BlockCreateJson extends BlockBaseJson {
+    xml: string;
+    ids: string[];
+    json: object;
+    recordUndo?: boolean;
+}
+//# sourceMappingURL=events_block_create.d.ts.map

package/core/events/events_block_delete.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Class for a block delete event.
+ *
+ * @class
+ */
+import type { Block } from '../block.js';
+import * as blocks from '../serialization/blocks.js';
+import { Workspace } from '../workspace.js';
+import { BlockBase, BlockBaseJson } from './events_block_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners when a block (or connected stack of blocks) is
+ * deleted.
+ */
+export declare class BlockDelete extends BlockBase {
+    /** The XML representation of the deleted block(s). */
+    oldXml?: Element | DocumentFragment;
+    /** The JSON respresentation of the deleted block(s). */
+    oldJson?: blocks.State;
+    /** All of the IDs of deleted blocks. */
+    ids?: string[];
+    /** True if the deleted block was a shadow block, false otherwise. */
+    wasShadow?: boolean;
+    type: EventType;
+    /** @param opt_block The deleted block.  Undefined for a blank event. */
+    constructor(opt_block?: Block);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): BlockDeleteJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of BlockDelete, but we can't specify that due to the fact that
+     *     parameters to static methods in subclasses must be supertypes of
+     *     parameters to static methods in superclasses.
+     * @internal
+     */
+    static fromJson(json: BlockDeleteJson, workspace: Workspace, event?: any): BlockDelete;
+    /**
+     * Run a deletion event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}
+export interface BlockDeleteJson extends BlockBaseJson {
+    oldXml: string;
+    ids: string[];
+    wasShadow: boolean;
+    oldJson: blocks.State;
+    recordUndo?: boolean;
+}
+//# sourceMappingURL=events_block_delete.d.ts.map

package/core/events/events_block_drag.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Events fired as a block drag.
+ *
+ * @class
+ */
+import type { Block } from '../block.js';
+import { Workspace } from '../workspace.js';
+import { AbstractEventJson } from './events_abstract.js';
+import { UiBase } from './events_ui_base.js';
+import { EventType } from './type.js';
+/**
+ * Notifies listeners when a block is being manually dragged/dropped.
+ */
+export declare class BlockDrag extends UiBase {
+    /** The ID of the top-level block being dragged. */
+    blockId?: string;
+    /** True if this is the start of a drag, false if this is the end of one. */
+    isStart?: boolean;
+    /**
+     * A list of all of the blocks (i.e. all descendants of the block associated
+     * with the block ID) being dragged.
+     */
+    blocks?: Block[];
+    type: EventType;
+    /**
+     * @param opt_block The top block in the stack that is being dragged.
+     *     Undefined for a blank event.
+     * @param opt_isStart Whether this is the start of a block drag.
+     *    Undefined for a blank event.
+     * @param opt_blocks The blocks affected by this drag. Undefined for a blank
+     *     event.
+     */
+    constructor(opt_block?: Block, opt_isStart?: boolean, opt_blocks?: Block[]);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): BlockDragJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of BlockDrag, but we can't specify that due to the fact that parameters
+     *     to static methods in subclasses must be supertypes of parameters to
+     *     static methods in superclasses..
+     * @internal
+     */
+    static fromJson(json: BlockDragJson, workspace: Workspace, event?: any): BlockDrag;
+}
+export interface BlockDragJson extends AbstractEventJson {
+    isStart: boolean;
+    blockId: string;
+    blocks?: Block[];
+}
+//# sourceMappingURL=events_block_drag.d.ts.map