mirror of
https://github.com/google/blockly.git
synced 2026-01-08 01:20:12 +01:00
f70f82327b
* refactor: Remove uses of AnyDuringMigration from trashcan.ts. * refactor: Remove uses of AnyDuringMigration in bubble.ts. * refactor: Remove uses of AnyDuringMigration from connection_checker.ts. * refactor: Remove uses of AnyDuringMigration from connection_db.ts. * refactor: Remove uses of AnyDuringMigration in contextmenu_items.ts. * refactor: Remove uses of AnyDuringMigration from grid.ts. * refactor: Remove uses of AnyDuringMigration from i_drag_target.ts. * refactor: Remove uses of AnyDuringMigration from i_ast_node_location_svg.ts. * refactor: Remove uses of AnyDuringMigration from i_ast_node_location_with_block.ts. * refactor: Remove uses of AnyDuringMigration from i_autohideable.ts. * refactor: Remove uses of AnyDuringMigration from i_block_dragger.ts. * refactor: Remove uses of AnyDuringMigration from i_bounded_element.ts. * refactor: Remove uses of AnyDuringMigration from i_bubble.ts. * refactor: Remove uses of AnyDuringMigration from i_collapsible_toolbox_item.ts. * refactor: Remove uses of AnyDuringMigration from i_connection_checker.ts. * refactor: Remove uses of AnyDuringMigration from i_contextmenu.ts. * refactor: Remove uses of AnyDuringMigration in i_copyable.ts. * refactor: Remove uses of AnyDuringMigration from i_deleteable.ts. * refactor: Remove uses of AnyDuringMigration from i_delete_area.ts. * refactor: Remove uses of AnyDuringMigration in i_flyout.ts. * refactor: Remove uses of AnyDuringMigration in i_keyboard_accessible.ts. * refactor: Remove uses of AnyDuringMigration in i_metrics_manager.ts. * refactor: Remove uses of AnyDuringMigration from i_movable.ts. * refactor: Remove uses of AnyDuringMigration in i_positionable.ts. * refactor: Remove uses of AnyDuringMigration in i_selectable_toolbox_item.ts. * refactor: Remove uses of AnyDuringMigration from i_selectable.ts. * refactor: Remove uses of AnyDuringMigration in i_serializer.ts. * refactor: Remove uses of AnyDuringMigration from i_styleable.ts. * refactor: Remove uses of AnyDuringMigration in i_toolbox.ts. * refactor: Make non-null checks explicit.
65 lines
1.8 KiB
TypeScript
65 lines
1.8 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a selectable toolbox item.
|
|
*/
|
|
|
|
/**
|
|
* The interface for a selectable toolbox item.
|
|
* @namespace Blockly.ISelectableToolboxItem
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
import type {FlyoutItemInfoArray} from '../utils/toolbox';
|
|
goog.declareModuleId('Blockly.ISelectableToolboxItem');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import '../utils/toolbox.js';
|
|
|
|
import type {IToolboxItem} from './i_toolbox_item.js';
|
|
|
|
|
|
/**
|
|
* Interface for an item in the toolbox that can be selected.
|
|
* @alias Blockly.ISelectableToolboxItem
|
|
*/
|
|
export interface ISelectableToolboxItem extends IToolboxItem {
|
|
/**
|
|
* Gets the name of the toolbox item. Used for emitting events.
|
|
* @return The name of the toolbox item.
|
|
*/
|
|
getName(): string;
|
|
|
|
/**
|
|
* Gets the contents of the toolbox item. These are items that are meant to be
|
|
* displayed in the flyout.
|
|
* @return The definition of items to be displayed in the flyout.
|
|
*/
|
|
getContents(): FlyoutItemInfoArray|string;
|
|
|
|
/**
|
|
* Sets the current toolbox item as selected.
|
|
* @param _isSelected True if this category is selected, false otherwise.
|
|
*/
|
|
setSelected(_isSelected: boolean): void;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
getClickTarget(): Element;
|
|
|
|
/**
|
|
* Handles when the toolbox item is clicked.
|
|
* @param _e Click event to handle.
|
|
*/
|
|
onClick(_e: Event): void;
|
|
}
|