Files
blockly/core/interfaces/i_delete_area.ts
Beka Westberg ed531ec313 chore: remove all namespace comments (#6903)
* chore: remove all namespace comments

* chore: fix lint
2023-03-20 09:43:58 -07:00

32 lines
993 B
TypeScript

/**
* @license
* Copyright 2021 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.IDeleteArea');
import type {IDragTarget} from './i_drag_target.js';
import type {IDraggable} from './i_draggable.js';
/**
* Interface for a component that can delete a block or bubble that is dropped
* on top of it.
*/
export interface IDeleteArea extends IDragTarget {
/**
* Returns whether the provided block or bubble would be deleted if dropped on
* this area.
* This method should check if the element is deletable and is always called
* 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;
}