@blockly/keyboard-navigation
Version:
A plugin for keyboard navigation.
58 lines • 1.55 kB
TypeScript
/**
* Centralises hints that we show.
*
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { WorkspaceSvg } from 'blockly';
/**
* Nudge the user to use unconstrained movement.
*
* @param workspace Workspace.
* @param force Set to show it even if previously shown.
*/
export declare function showUnconstrainedMoveHint(workspace: WorkspaceSvg, force?: boolean): void;
/**
* Nudge the user to move a block that's in move mode.
*
* @param workspace Workspace.
*/
export declare function showConstrainedMovementHint(workspace: WorkspaceSvg): void;
/**
* Clear active move-related hints, if any.
*
* @param workspace The workspace.
*/
export declare function clearMoveHints(workspace: WorkspaceSvg): void;
/**
* Nudge the user to paste after a copy.
*
* @param workspace Workspace.
*/
export declare function showCopiedHint(workspace: WorkspaceSvg): void;
/**
* Nudge the user to paste after a cut.
*
* @param workspace Workspace.
*/
export declare function showCutHint(workspace: WorkspaceSvg): void;
/**
* Clear active paste-related hints, if any.
*
* @param workspace The workspace.
*/
export declare function clearPasteHints(workspace: WorkspaceSvg): void;
/**
* Nudge the user to open the help.
*
* @param workspace The workspace.
*/
export declare function showHelpHint(workspace: WorkspaceSvg): void;
/**
* Clear the help hint.
*
* @param workspace The workspace.
*/
export declare function clearHelpHint(workspace: WorkspaceSvg): void;
//# sourceMappingURL=hints.d.ts.map