mirror of
https://github.com/google/blockly.git
synced 2026-01-09 10:00:09 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
45 lines
1.3 KiB
TypeScript
45 lines
1.3 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The interface for a component that can delete a block or bubble
|
|
* that is dropped on top of it.
|
|
*
|
|
* @namespace Blockly.IDeleteArea
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.IDeleteArea');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import './i_draggable.js';
|
|
|
|
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.
|
|
*
|
|
* @alias Blockly.IDeleteArea
|
|
*/
|
|
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;
|
|
}
|