blockly 11.0.0-beta.6 → 11.0.0-beta.8

package/core/dragging/dragger.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IDragTarget } from '../interfaces/i_drag_target.js';
+import { IDeletable } from '../interfaces/i_deletable.js';
+import { IDragger } from '../interfaces/i_dragger.js';
+import { IDraggable } from '../interfaces/i_draggable.js';
+import { Coordinate } from '../utils/coordinate.js';
+import { WorkspaceSvg } from '../workspace_svg.js';
+export declare class Dragger implements IDragger {
+    protected draggable: IDraggable;
+    protected workspace: WorkspaceSvg;
+    protected startLoc: Coordinate;
+    protected dragTarget: IDragTarget | null;
+    constructor(draggable: IDraggable, workspace: WorkspaceSvg);
+    /** Handles any drag startup. */
+    onDragStart(e: PointerEvent): void;
+    /**
+     * Handles calculating where the element should actually be moved to.
+     *
+     * @param totalDelta The total amount in pixel coordinates the mouse has moved
+     *     since the start of the drag.
+     */
+    onDrag(e: PointerEvent, totalDelta: Coordinate): void;
+    /** Updates the drag target under the pointer (if there is one). */
+    protected updateDragTarget(e: PointerEvent): void;
+    /**
+     * Calculates the correct workspace coordinate for the movable and tells
+     * the draggable to go to that location.
+     */
+    private moveDraggable;
+    /**
+     * Returns true if we would delete the draggable if it was dropped
+     * at the current location.
+     */
+    protected wouldDeleteDraggable(e: PointerEvent, draggable: IDraggable & IDeletable): boolean;
+    /** Handles any drag cleanup. */
+    onDragEnd(e: PointerEvent): void;
+    /**
+     * Returns true if we should return the draggable to its original location
+     * at the end of the drag.
+     */
+    protected shouldReturnToStart(e: PointerEvent, draggable: IDraggable): boolean;
+    protected pixelsToWorkspaceUnits(pixelCoord: Coordinate): Coordinate;
+}
+//# sourceMappingURL=dragger.d.ts.map

package/core/dragging.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Dragger } from './dragging/dragger.js';
+import { BlockDragStrategy } from './dragging/block_drag_strategy.js';
+import { BubbleDragStrategy } from './dragging/bubble_drag_strategy.js';
+import { CommentDragStrategy } from './dragging/comment_drag_strategy.js';
+export { Dragger, BlockDragStrategy, BubbleDragStrategy, CommentDragStrategy };
+//# sourceMappingURL=dragging.d.ts.map

package/core/events/events.d.ts

@@ -18,6 +18,7 @@ import { CommentChange, CommentChangeJson } from './events_comment_change.js';
 import { CommentCreate, CommentCreateJson } from './events_comment_create.js';
 import { CommentDelete } from './events_comment_delete.js';
 import { CommentMove, CommentMoveJson } from './events_comment_move.js';
+import { CommentCollapse, CommentCollapseJson } from './events_comment_collapse.js';
 import { MarkerMove, MarkerMoveJson } from './events_marker_move.js';
 import { Selected, SelectedJson } from './events_selected.js';
 import { ThemeChange, ThemeChangeJson } from './events_theme_change.js';
@@ -62,6 +63,8 @@ export { CommentCreateJson };
 export { CommentDelete };
 export { CommentMove };
 export { CommentMoveJson };
+export { CommentCollapse };
+export { CommentCollapseJson };
 export { FinishedLoading };
 export { MarkerMove };
 export { MarkerMoveJson };

package/core/events/events_comment_base.d.ts

@@ -3,7 +3,12 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { WorkspaceComment } from '../workspace_comment.js';
+/**
+ * Base class for comment events.
+ *
+ * @class
+ */
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
 import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
 import type { CommentCreate } from './events_comment_create.js';
 import type { CommentDelete } from './events_comment_delete.js';

package/core/events/events_comment_change.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { WorkspaceComment } from '../workspace_comment.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**

package/core/events/events_comment_collapse.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { WorkspaceComment } from '../comments/workspace_comment.js';
+import { CommentBase, CommentBaseJson } from './events_comment_base.js';
+import type { Workspace } from '../workspace.js';
+export declare class CommentCollapse extends CommentBase {
+    newCollapsed?: boolean | undefined;
+    type: string;
+    constructor(comment?: WorkspaceComment, newCollapsed?: boolean | undefined);
+    /**
+     * Encode the event as JSON.
+     *
+     * @returns JSON representation.
+     */
+    toJson(): CommentCollapseJson;
+    /**
+     * Deserializes the JSON event.
+     *
+     * @param event The event to append new properties to. Should be a subclass
+     *     of CommentCollapse, 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: CommentCollapseJson, workspace: Workspace, event?: any): CommentCollapse;
+    /**
+     * Run a collapse event.
+     *
+     * @param forward True if run forward, false if run backward (undo).
+     */
+    run(forward: boolean): void;
+}
+export interface CommentCollapseJson extends CommentBaseJson {
+    newCollapsed: boolean;
+}
+//# sourceMappingURL=events_comment_collapse.d.ts.map

package/core/events/events_comment_create.d.ts

@@ -3,7 +3,8 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { WorkspaceComment } from '../workspace_comment.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
+import * as comments from '../serialization/workspace_comments.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
@@ -13,6 +14,8 @@ export declare class CommentCreate extends CommentBase {
     type: string;
     /** The XML representation of the created workspace comment. */
     xml?: Element | DocumentFragment;
+    /** The JSON representation of the created workspace comment. */
+    json?: comments.State;
     /**
      * @param opt_comment The created comment.
      *     Undefined for a blank event.
@@ -43,5 +46,6 @@ export declare class CommentCreate extends CommentBase {
 }
 export interface CommentCreateJson extends CommentBaseJson {
     xml: string;
+    json: object;
 }
 //# sourceMappingURL=events_comment_create.d.ts.map

package/core/events/events_comment_delete.d.ts

@@ -3,7 +3,8 @@
  * Copyright 2018 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { WorkspaceComment } from '../workspace_comment.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
+import * as comments from '../serialization/workspace_comments.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
@@ -13,6 +14,8 @@ export declare class CommentDelete extends CommentBase {
     type: string;
     /** The XML representation of the deleted workspace comment. */
     xml?: Element;
+    /** The JSON representation of the created workspace comment. */
+    json?: comments.State;
     /**
      * @param opt_comment The deleted comment.
      *     Undefined for a blank event.
@@ -43,5 +46,6 @@ export declare class CommentDelete extends CommentBase {
 }
 export interface CommentDeleteJson extends CommentBaseJson {
     xml: string;
+    json: object;
 }
 //# sourceMappingURL=events_comment_delete.d.ts.map

package/core/events/events_comment_move.d.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { Coordinate } from '../utils/coordinate.js';
-import type { WorkspaceComment } from '../workspace_comment.js';
+import type { WorkspaceComment } from '../comments/workspace_comment.js';
 import { CommentBase, CommentBaseJson } from './events_comment_base.js';
 import type { Workspace } from '../workspace.js';
 /**
@@ -18,6 +18,16 @@ export declare class CommentMove extends CommentBase {
     oldCoordinate_?: Coordinate;
     /** The location of the comment after the move, in workspace coordinates. */
     newCoordinate_?: Coordinate;
+    /**
+     * An explanation of what this move is for.  Known values include:
+     *  'drag' -- A drag operation completed.
+     *  'snap' -- Comment got shifted to line up with the grid.
+     *  'inbounds' -- Block got pushed back into a non-scrolling workspace.
+     *  'create' -- Block created via deserialization.
+     *  'cleanup' -- Workspace aligned top-level blocks.
+     * Event merging may create multiple reasons: ['drag', 'inbounds', 'snap'].
+     */
+    reason?: string[];
     /**
      * @param opt_comment The comment that is being moved.  Undefined for a blank
      *     event.
@@ -28,6 +38,12 @@ export declare class CommentMove extends CommentBase {
      * called once.
      */
     recordNew(): void;
+    /**
+     * Sets the reason for a move event.
+     *
+     * @param reason Why is this move happening?  'drag', 'bump', 'snap', ...
+     */
+    setReason(reason: string[]): void;
     /**
      * Override the location before the move.  Use this if you don't create the
      * event until the end of the move, but you know the original location.

package/core/events/utils.d.ts

@@ -127,6 +127,8 @@ export declare const COMMENT_CHANGE = "comment_change";
  * Name of event that moves a comment.
  */
 export declare const COMMENT_MOVE = "comment_move";
+/** Type of event that moves a comment. */
+export declare const COMMENT_COLLAPSE = "comment_collapse";
 /**
  * Name of event that records a workspace load.
  */

package/core/flyout_base.d.ts

@@ -3,7 +3,7 @@
  * Copyright 2011 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { BlockSvg } from './block_svg.js';
+import { BlockSvg } from './block_svg.js';
 import { DeleteArea } from './delete_area.js';
 import { FlyoutButton } from './flyout_button.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
@@ -119,6 +119,10 @@ export declare abstract class Flyout extends DeleteArea implements IAutoHideable
      * List of visible buttons.
      */
     protected buttons_: FlyoutButton[];
+    /**
+     * List of visible buttons and blocks.
+     */
+    protected contents: FlyoutItem[];
     /**
      * List of event listeners.
      */
@@ -279,6 +283,18 @@ export declare abstract class Flyout extends DeleteArea implements IAutoHideable
      * @param visible Whether the container is visible.
      */
     setContainerVisible(visible: boolean): void;
+    /**
+     * Get the list of buttons and blocks of the current flyout.
+     *
+     * @returns The array of flyout buttons and blocks.
+     */
+    getContents(): FlyoutItem[];
+    /**
+     * Store the list of buttons and blocks on the flyout.
+     *
+     * @param contents - The array of items for the flyout.
+     */
+    setContents(contents: FlyoutItem[]): void;
     /**
      * Update the display property of the flyout based whether it thinks it should
      * be visible and whether its containing workspace is visible.

package/core/flyout_button.d.ts

@@ -6,10 +6,11 @@
 import { Coordinate } from './utils/coordinate.js';
 import type * as toolbox from './utils/toolbox.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
+import type { IASTNodeLocationSvg } from './blockly.js';
 /**
  * Class for a button or label in the flyout.
  */
-export declare class FlyoutButton {
+export declare class FlyoutButton implements IASTNodeLocationSvg {
     private readonly workspace;
     private readonly targetWorkspace;
     private readonly isLabel_;
@@ -34,6 +35,11 @@ export declare class FlyoutButton {
     private svgGroup;
     /** The SVG element with the text of the label or button. */
     private svgText;
+    /**
+     * Holds the cursors svg element when the cursor is attached to the button.
+     * This is null if there is no cursor on the button.
+     */
+    cursorSvg: SVGElement | null;
     /**
      * @param workspace The workspace in which to place this button.
      * @param targetWorkspace The flyout's target workspace.
@@ -76,8 +82,27 @@ export declare class FlyoutButton {
      * @returns The target workspace of the flyout where this button resides.
      */
     getTargetWorkspace(): WorkspaceSvg;
+    /**
+     * Get the button's workspace.
+     *
+     * @returns The workspace in which to place this button.
+     */
+    getWorkspace(): WorkspaceSvg;
     /** Dispose of this button. */
     dispose(): void;
+    /**
+     * Add the cursor SVG to this buttons's SVG group.
+     *
+     * @param cursorSvg The SVG root of the cursor to be added to the button SVG
+     *     group.
+     */
+    setCursorSvg(cursorSvg: SVGElement): void;
+    /**
+     * Required by IASTNodeLocationSvg, but not used. A marker cannot be set on a
+     * button. If the 'mark' shortcut is used on a button, its associated callback
+     * function is triggered.
+     */
+    setMarkerSvg(): void;
     /**
      * Do something when the button is clicked.
      *

package/core/gesture.d.ts

@@ -11,15 +11,15 @@
  */
 import './events/events_click.js';
 import type { BlockSvg } from './block_svg.js';
-import { BubbleDragger } from './bubble_dragger.js';
 import type { Field } from './field.js';
-import type { IBlockDragger } from './interfaces/i_block_dragger.js';
 import type { IBubble } from './interfaces/i_bubble.js';
 import type { IFlyout } from './interfaces/i_flyout.js';
 import { Coordinate } from './utils/coordinate.js';
 import { WorkspaceDragger } from './workspace_dragger.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 import type { IIcon } from './interfaces/i_icon.js';
+import { IDragger } from './interfaces/i_dragger.js';
+import { RenderedWorkspaceComment } from './comments.js';
 /**
  * Class for one gesture.
  */
@@ -52,6 +52,11 @@ export declare class Gesture {
      * block.
      */
     private startBlock;
+    /**
+     * The comment that the gesture started on, or null if it did not start on a
+     * comment.
+     */
+    private startComment;
     /**
      * The block that this gesture targets.  If the gesture started on a
      * shadow block, this is the first non-shadow parent of the block.  If the
@@ -77,10 +82,7 @@ export declare class Gesture {
      * Ex: [[node, name, func], [node, name, func]].
      */
     private boundEvents;
-    /** The object tracking a bubble drag, or null if none is in progress. */
-    private bubbleDragger;
-    /** The object tracking a block drag, or null if none is in progress. */
-    private blockDragger;
+    private dragger;
     /**
      * The object tracking a workspace or flyout workspace drag, or null if none
      * is in progress.
@@ -96,7 +98,6 @@ export declare class Gesture {
     private gestureHasStarted;
     /** Boolean used internally to break a cycle in disposal. */
     protected isEnding_: boolean;
-    private healStack;
     /** The event that most recently updated this gesture. */
     private mostRecentEvent;
     /** Boolean for whether or not this gesture is a multi-touch gesture. */
@@ -160,30 +161,6 @@ export declare class Gesture {
      * @returns True if a block is being dragged from the flyout.
      */
     private updateIsDraggingFromFlyout;
-    /**
-     * Update this gesture to record whether a bubble is being dragged.
-     * This function should be called on a pointermove event the first time
-     * the drag radius is exceeded.  It should be called no more than once per
-     * gesture. If a bubble should be dragged this function creates the necessary
-     * BubbleDragger and starts the drag.
-     *
-     * @returns True if a bubble is being dragged.
-     */
-    private updateIsDraggingBubble;
-    /**
-     * Check whether to start a block drag. If a block should be dragged, either
-     * from the flyout or in the workspace, create the necessary BlockDragger and
-     * start the drag.
-     *
-     * This function should be called on a pointermove event the first time
-     * the drag radius is exceeded.  It should be called no more than once per
-     * gesture. If a block should be dragged, either from the flyout or in the
-     * workspace, this function creates the necessary BlockDragger and starts the
-     * drag.
-     *
-     * @returns True if a block is being dragged.
-     */
-    private updateIsDraggingBlock;
     /**
      * Check whether to start a workspace drag. If a workspace is being dragged,
      * create the necessary WorkspaceDragger and start the drag.
@@ -201,10 +178,7 @@ export declare class Gesture {
      * gesture.
      */
     private updateIsDragging;
-    /** Create a block dragger and start dragging the selected block. */
-    private startDraggingBlock;
-    /** Create a bubble dragger and start dragging the selected bubble. */
-    private startDraggingBubble;
+    private createDragger;
     /**
      * Start a gesture: update the workspace to indicate that a gesture is in
      * progress and bind pointermove and pointerup handlers.
@@ -337,8 +311,14 @@ export declare class Gesture {
      * @internal
      */
     handleBubbleStart(e: PointerEvent, bubble: IBubble): void;
-    /** Execute a bubble click. */
-    private doBubbleClick;
+    /**
+     * Handle a pointerdown event on a workspace comment.
+     *
+     * @param e A pointerdown event.
+     * @param comment The comment the event hit.
+     * @internal
+     */
+    handleCommentStart(e: PointerEvent, comment: RenderedWorkspaceComment): void;
     /** Execute a field click. */
     private doFieldClick;
     /** Execute an icon click. */
@@ -378,6 +358,13 @@ export declare class Gesture {
      * @internal
      */
     setStartBubble(bubble: IBubble): void;
+    /**
+     * Record the comment that a gesture started on
+     *
+     * @param comment The comment the gesture started on.
+     * @internal
+     */
+    setStartComment(comment: RenderedWorkspaceComment): void;
     /**
      * Record the block that a gesture started on, and set the target block
      * appropriately.
@@ -413,6 +400,7 @@ export declare class Gesture {
      * @returns Whether this gesture was a click on a bubble.
      */
     private isBubbleClick;
+    private isCommentClick;
     /**
      * Whether this gesture is a click on a block.  This should only be called
      * when ending a gesture (pointerup).
@@ -436,6 +424,8 @@ export declare class Gesture {
      * @returns Whether this gesture was a click on a workspace.
      */
     private isWorkspaceClick;
+    /** Returns the current dragger if the gesture is a drag. */
+    getCurrentDragger(): WorkspaceDragger | IDragger | null;
     /**
      * Whether this gesture is a drag of either a workspace or block.
      * This function is called externally to block actions that cannot be taken
@@ -454,22 +444,6 @@ export declare class Gesture {
      * @internal
      */
     hasStarted(): boolean;
-    /**
-     * Get a list of the insertion markers that currently exist.  Block drags have
-     * 0, 1, or 2 insertion markers.
-     *
-     * @returns A possibly empty list of insertion marker blocks.
-     * @internal
-     */
-    getInsertionMarkers(): BlockSvg[];
-    /**
-     * Gets the current dragger if an item is being dragged. Null if nothing is
-     * being dragged.
-     *
-     * @returns The dragger that is currently in use or null if no drag is in
-     *     progress.
-     */
-    getCurrentDragger(): WorkspaceDragger | BubbleDragger | IBlockDragger | null;
     /**
      * Is a drag or other gesture currently in progress on any workspace?
      *

package/core/icons/comment_icon.d.ts

@@ -103,10 +103,15 @@ export declare class CommentIcon extends Icon implements IHasBubble, ISerializab
      */
     private getBubbleOwnerRect;
 }
+/** The save state format for a comment icon. */
 export interface CommentState {
+    /** The text of the comment. */
     text?: string;
+    /** True if the comment is open, false otherwise. */
     pinned?: boolean;
+    /** The height of the comment bubble. */
     height?: number;
+    /** The width of the comment bubble. */
     width?: number;
 }
 //# sourceMappingURL=comment_icon.d.ts.map

package/core/interfaces/i_comment_icon.d.ts

@@ -3,14 +3,18 @@
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { CommentState } from '../icons/comment_icon.js';
 import { IIcon } from './i_icon.js';
 import { Size } from '../utils/size.js';
 import { IHasBubble } from './i_has_bubble.js';
-export interface ICommentIcon extends IIcon, IHasBubble {
+import { ISerializable } from './i_serializable.js';
+export interface ICommentIcon extends IIcon, IHasBubble, ISerializable {
     setText(text: string): void;
     getText(): string;
     setBubbleSize(size: Size): void;
     getBubbleSize(): Size;
+    saveState(): CommentState;
+    loadState(state: CommentState): void;
 }
 /** Checks whether the given object is an ICommentIcon. */
 export declare function isCommentIcon(obj: Object): obj is ICommentIcon;

package/core/interfaces/i_deletable.d.ts

@@ -13,5 +13,11 @@ export interface IDeletable {
      * @returns True if deletable.
      */
     isDeletable(): boolean;
+    /** Disposes of this object, cleaning up any references or DOM elements. */
+    dispose(): void;
+    /** Visually indicates that the object is pending deletion. */
+    setDeleteStyle(wouldDelete: boolean): void;
 }
+/** Returns whether the given object is an IDeletable. */
+export declare function isDeletable(obj: any): obj is IDeletable;
 //# sourceMappingURL=i_deletable.d.ts.map

package/core/interfaces/i_delete_area.d.ts

@@ -17,10 +17,9 @@ export interface IDeleteArea extends IDragTarget {
      * before onDragEnter/onDragOver/onDragExit.
      *
      * @param element The block or bubble currently being dragged.
-     * @param couldConnect Whether the element could could connect to another.
      * @returns Whether the element provided would be deleted if dropped on this
      *     area.
      */
-    wouldDelete(element: IDraggable, couldConnect: boolean): boolean;
+    wouldDelete(element: IDraggable): boolean;
 }
 //# sourceMappingURL=i_delete_area.d.ts.map

package/core/interfaces/i_draggable.d.ts

@@ -3,10 +3,54 @@
  * Copyright 2021 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import type { IDeletable } from './i_deletable.js';
+import { Coordinate } from '../utils/coordinate';
 /**
- * The interface for an object that can be dragged.
+ * Represents an object that can be dragged.
  */
-export interface IDraggable extends IDeletable {
+export interface IDraggable extends IDragStrategy {
+    /**
+     * Returns the current location of the draggable in workspace
+     * coordinates.
+     *
+     * @returns Coordinate of current location on workspace.
+     */
+    getRelativeToSurfaceXY(): Coordinate;
 }
+export interface IDragStrategy {
+    /** Returns true iff the element is currently movable. */
+    isMovable(): boolean;
+    /**
+     * Handles any drag startup (e.g moving elements to the front of the
+     * workspace).
+     *
+     * @param e PointerEvent that started the drag; can be used to
+     *     check modifier keys, etc.  May be missing when dragging is
+     *     triggered programatically rather than by user.
+     */
+    startDrag(e?: PointerEvent): void;
+    /**
+     * Handles moving elements to the new location, and updating any
+     * visuals based on that (e.g connection previews for blocks).
+     *
+     * @param newLoc Workspace coordinate to which the draggable has
+     *     been dragged.
+     * @param e PointerEvent that continued the drag.  Can be
+     *     used to check modifier keys, etc.
+     */
+    drag(newLoc: Coordinate, e?: PointerEvent): void;
+    /**
+     * Handles any drag cleanup, including e.g. connecting or deleting
+     * blocks.
+     *
+     * @param newLoc Workspace coordinate at which the drag finished.
+     *     been dragged.
+     * @param e PointerEvent that finished the drag.  Can be
+     *     used to check modifier keys, etc.
+     */
+    endDrag(e?: PointerEvent): void;
+    /** Moves the draggable back to where it was at the start of the drag. */
+    revertDrag(): void;
+}
+/** Returns whether the given object is an IDraggable or not. */
+export declare function isDraggable(obj: any): obj is IDraggable;
 //# sourceMappingURL=i_draggable.d.ts.map

package/core/interfaces/i_dragger.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Coordinate } from '../utils/coordinate';
+export interface IDragger {
+    /**
+     * Handles any drag startup.
+     *
+     * @param e PointerEvent that started the drag.
+     */
+    onDragStart(e: PointerEvent): void;
+    /**
+     * Handles dragging, including calculating where the element should
+     * actually be moved to.
+     *
+     * @param e PointerEvent that continued the drag.
+     * @param totalDelta The total distance, in pixels, that the mouse
+     *     has moved since the start of the drag.
+     */
+    onDrag(e: PointerEvent, totalDelta: Coordinate): void;
+    /**
+     * Handles any drag cleanup.
+     *
+     * @param e PointerEvent that finished the drag.
+     * @param totalDelta The total distance, in pixels, that the mouse
+     *     has moved since the start of the drag.
+     */
+    onDragEnd(e: PointerEvent, totalDelta: Coordinate): void;
+}
+//# sourceMappingURL=i_dragger.d.ts.map