mirror of
https://github.com/google/blockly.git
synced 2026-01-19 23:07:21 +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
33 lines
792 B
TypeScript
33 lines
792 B
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The interface for a component that is automatically hidden
|
|
* when WorkspaceSvg.hideChaff is called.
|
|
*
|
|
* @namespace Blockly.IAutoHideable
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.IAutoHideable');
|
|
|
|
import type {IComponent} from './i_component.js';
|
|
|
|
|
|
/**
|
|
* Interface for a component that can be automatically hidden.
|
|
*
|
|
* @alias Blockly.IAutoHideable
|
|
*/
|
|
export interface IAutoHideable extends IComponent {
|
|
/**
|
|
* Hides the component. Called in WorkspaceSvg.hideChaff.
|
|
*
|
|
* @param onlyClosePopups Whether only popups should be closed.
|
|
* Flyouts should not be closed if this is true.
|
|
*/
|
|
autoHide(onlyClosePopups: boolean): void;
|
|
}
|