Files
blockly/core/interfaces/i_selectable_toolbox_item.ts
Christopher Allen b0a7c004a9 refactor(build): Delete Closure Library (#7415)
* fix(build): Restore erroneously-deleted filter function

  This was deleted in PR #7406 as it was mainly being used to
  filter core/ vs. test/mocha/ deps into separate deps files -
  but it turns out also to be used for filtering error
  messages too.  Oops.

* refactor(tests): Migrate advanced compilation test to ES Modules

* refactor(build): Migrate main.js to TypeScript

  This turns out to be pretty straight forward, even if it would
  cause crashing if one actually tried to import this module
  instead of just feeding it to Closure Compiler.

* chore(build): Remove goog.declareModuleId calls

  Replace goog.declareModuleId calls with a comment recording the
  former module ID for posterity (or at least until we decide
  how to reformat the renamings file.

* chore(tests): Delete closure/goog/*

  For the moment we still need something to serve as base.js for
  the benefit of closure-make-deps, so we keep a vestigial
  base.js around, containing only the @provideGoog declaration.

* refactor(build): Remove vestigial base.js

  By changing slightly the command line arguments to
  closure-make-deps and closure-calculate-chunks the need to have
  any base.js is eliminated.

* chore: Typo fix for PR #7415
2023-08-31 00:24:47 +01:00

64 lines
1.6 KiB
TypeScript

/**
* @license
* Copyright 2020 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import type {FlyoutItemInfoArray} from '../utils/toolbox';
// Former goog.module ID: Blockly.ISelectableToolboxItem
import type {IToolboxItem} from './i_toolbox_item.js';
/**
* Interface for an item in the toolbox that can be selected.
*/
export interface ISelectableToolboxItem extends IToolboxItem {
/**
* Gets the name of the toolbox item. Used for emitting events.
*
* @returns 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.
*
* @returns 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.
*
* @returns 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;
}
/**
* Type guard that checks whether an IToolboxItem is an ISelectableToolboxItem.
*/
export function isSelectableToolboxItem(
toolboxItem: IToolboxItem,
): toolboxItem is ISelectableToolboxItem {
return toolboxItem.isSelectable();
}