mirror of
https://github.com/google/blockly.git
synced 2026-01-10 10:27:08 +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
68 lines
1.7 KiB
TypeScript
68 lines
1.7 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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;
|
|
}
|