mirror of
https://github.com/google/blockly.git
synced 2026-01-10 02:17: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
51 lines
1.5 KiB
TypeScript
51 lines
1.5 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2021 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The interface for a positionable UI element.
|
|
*
|
|
* @namespace Blockly.IPositionable
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
import type {Rect} from '../utils/rect.js';
|
|
import type {UiMetrics} from '../metrics_manager.js';
|
|
goog.declareModuleId('Blockly.IPositionable');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import '../metrics_manager.js';
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
// import '../utils/rect.js';
|
|
|
|
import type {IComponent} from './i_component.js';
|
|
|
|
|
|
/**
|
|
* Interface for a component that is positioned on top of the workspace.
|
|
*
|
|
* @alias Blockly.IPositionable
|
|
*/
|
|
export interface IPositionable extends IComponent {
|
|
/**
|
|
* Positions the element. Called when the window is resized.
|
|
*
|
|
* @param metrics The workspace metrics.
|
|
* @param savedPositions List of rectangles that are already on the workspace.
|
|
*/
|
|
position(metrics: UiMetrics, savedPositions: Rect[]): void;
|
|
|
|
/**
|
|
* Returns the bounding rectangle of the UI element in pixel units relative to
|
|
* the Blockly injection div.
|
|
*
|
|
* @returns The UI elements's bounding box. Null if bounding box should be
|
|
* ignored by other UI elements.
|
|
*/
|
|
getBoundingRectangle(): Rect|null;
|
|
}
|