mirror of
https://github.com/google/blockly.git
synced 2025-12-16 14:20:10 +01:00
* chore: add configuration for api extractor * fix: remove extra param names * chore: private to internal * remove unrestricted * chore: remove double backticks * chore: remove fileoverview and export * as * chore: return to returns * chore: fix backslashes and angle brackets in tsdoc * chore: final to sealed * chore: ignore to internal * chore: fix link tags * chore: add api-extractor configuration * chore: add unrecognized tag names * chore: remove tsdoc-metadata * fix: correct index.d.ts * chore: fix connection link
765 lines
26 KiB
TypeScript
765 lines
26 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2011 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The top level namespace used to access the Blockly library.
|
|
*
|
|
* @namespace Blockly
|
|
*/
|
|
import * as goog from '../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly');
|
|
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import './events/events_block_create.js';
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import './events/workspace_events.js';
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import './events/events_ui.js';
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import './events/events_ui_base.js';
|
|
// Unused import preserved for side-effects. Remove if unneeded.
|
|
import './events/events_var_create.js';
|
|
|
|
import {Block} from './block.js';
|
|
import * as blockAnimations from './block_animations.js';
|
|
import {BlockDragSurfaceSvg} from './block_drag_surface.js';
|
|
import {BlockDragger} from './block_dragger.js';
|
|
import {BlockSvg} from './block_svg.js';
|
|
import {BlocklyOptions} from './blockly_options.js';
|
|
import {Blocks} from './blocks.js';
|
|
import * as browserEvents from './browser_events.js';
|
|
import {Bubble} from './bubble.js';
|
|
import {BubbleDragger} from './bubble_dragger.js';
|
|
import * as bumpObjects from './bump_objects.js';
|
|
import * as clipboard from './clipboard.js';
|
|
import {Comment} from './comment.js';
|
|
import * as common from './common.js';
|
|
import {ComponentManager} from './component_manager.js';
|
|
import {config} from './config.js';
|
|
import {Connection} from './connection.js';
|
|
import {ConnectionChecker} from './connection_checker.js';
|
|
import {ConnectionDB} from './connection_db.js';
|
|
import {ConnectionType} from './connection_type.js';
|
|
import * as ContextMenu from './contextmenu.js';
|
|
import * as ContextMenuItems from './contextmenu_items.js';
|
|
import {ContextMenuRegistry} from './contextmenu_registry.js';
|
|
import * as Css from './css.js';
|
|
import {DeleteArea} from './delete_area.js';
|
|
import * as dialog from './dialog.js';
|
|
import {DragTarget} from './drag_target.js';
|
|
import * as dropDownDiv from './dropdowndiv.js';
|
|
import * as Events from './events/events.js';
|
|
import * as Extensions from './extensions.js';
|
|
import {Field} from './field.js';
|
|
import {FieldAngle} from './field_angle.js';
|
|
import {FieldCheckbox} from './field_checkbox.js';
|
|
import {FieldColour} from './field_colour.js';
|
|
import {FieldDropdown} from './field_dropdown.js';
|
|
import {FieldImage} from './field_image.js';
|
|
import {FieldLabel} from './field_label.js';
|
|
import {FieldLabelSerializable} from './field_label_serializable.js';
|
|
import {FieldMultilineInput} from './field_multilineinput.js';
|
|
import {FieldNumber} from './field_number.js';
|
|
import * as fieldRegistry from './field_registry.js';
|
|
import {FieldTextInput} from './field_textinput.js';
|
|
import {FieldVariable} from './field_variable.js';
|
|
import {Flyout} from './flyout_base.js';
|
|
import {FlyoutButton} from './flyout_button.js';
|
|
import {HorizontalFlyout} from './flyout_horizontal.js';
|
|
import {FlyoutMetricsManager} from './flyout_metrics_manager.js';
|
|
import {VerticalFlyout} from './flyout_vertical.js';
|
|
import {Generator} from './generator.js';
|
|
import {Gesture} from './gesture.js';
|
|
import {Grid} from './grid.js';
|
|
import {Icon} from './icon.js';
|
|
import {inject} from './inject.js';
|
|
import {Align, Input} from './input.js';
|
|
import {inputTypes} from './input_types.js';
|
|
import {InsertionMarkerManager} from './insertion_marker_manager.js';
|
|
import {IASTNodeLocation} from './interfaces/i_ast_node_location.js';
|
|
import {IASTNodeLocationSvg} from './interfaces/i_ast_node_location_svg.js';
|
|
import {IASTNodeLocationWithBlock} from './interfaces/i_ast_node_location_with_block.js';
|
|
import {IAutoHideable} from './interfaces/i_autohideable.js';
|
|
import {IBlockDragger} from './interfaces/i_block_dragger.js';
|
|
import {IBoundedElement} from './interfaces/i_bounded_element.js';
|
|
import {IBubble} from './interfaces/i_bubble.js';
|
|
import {ICollapsibleToolboxItem} from './interfaces/i_collapsible_toolbox_item.js';
|
|
import {IComponent} from './interfaces/i_component.js';
|
|
import {IConnectionChecker} from './interfaces/i_connection_checker.js';
|
|
import {IContextMenu} from './interfaces/i_contextmenu.js';
|
|
import {ICopyable} from './interfaces/i_copyable.js';
|
|
import {IDeletable} from './interfaces/i_deletable.js';
|
|
import {IDeleteArea} from './interfaces/i_delete_area.js';
|
|
import {IDragTarget} from './interfaces/i_drag_target.js';
|
|
import {IDraggable} from './interfaces/i_draggable.js';
|
|
import {IFlyout} from './interfaces/i_flyout.js';
|
|
import {IKeyboardAccessible} from './interfaces/i_keyboard_accessible.js';
|
|
import {IMetricsManager} from './interfaces/i_metrics_manager.js';
|
|
import {IMovable} from './interfaces/i_movable.js';
|
|
import {IPositionable} from './interfaces/i_positionable.js';
|
|
import {IRegistrable} from './interfaces/i_registrable.js';
|
|
import {IRegistrableField} from './interfaces/i_registrable_field.js';
|
|
import {ISelectable} from './interfaces/i_selectable.js';
|
|
import {ISelectableToolboxItem} from './interfaces/i_selectable_toolbox_item.js';
|
|
import {ISerializer as SerializerInterface} from './interfaces/i_serializer.js';
|
|
import {IStyleable} from './interfaces/i_styleable.js';
|
|
import {IToolbox} from './interfaces/i_toolbox.js';
|
|
import {IToolboxItem} from './interfaces/i_toolbox_item.js';
|
|
import * as internalConstants from './internal_constants.js';
|
|
import {ASTNode} from './keyboard_nav/ast_node.js';
|
|
import {BasicCursor} from './keyboard_nav/basic_cursor.js';
|
|
import {Cursor} from './keyboard_nav/cursor.js';
|
|
import {Marker} from './keyboard_nav/marker.js';
|
|
import {TabNavigateCursor} from './keyboard_nav/tab_navigate_cursor.js';
|
|
import {MarkerManager} from './marker_manager.js';
|
|
import {Menu} from './menu.js';
|
|
import {MenuItem} from './menuitem.js';
|
|
import {MetricsManager} from './metrics_manager.js';
|
|
import {Msg} from './msg.js';
|
|
import {Mutator} from './mutator.js';
|
|
import {Names} from './names.js';
|
|
import {Options} from './options.js';
|
|
import * as uiPosition from './positionable_helpers.js';
|
|
import * as Procedures from './procedures.js';
|
|
import * as registry from './registry.js';
|
|
import {RenderedConnection} from './rendered_connection.js';
|
|
import * as blockRendering from './renderers/common/block_rendering.js';
|
|
import * as constants from './constants.js';
|
|
import * as geras from './renderers/geras/geras.js';
|
|
import * as minimalist from './renderers/minimalist/minimalist.js';
|
|
import * as thrasos from './renderers/thrasos/thrasos.js';
|
|
import * as zelos from './renderers/zelos/zelos.js';
|
|
import {Scrollbar} from './scrollbar.js';
|
|
import {ScrollbarPair} from './scrollbar_pair.js';
|
|
import * as serializationBlocks from './serialization/blocks.js';
|
|
import * as serializationExceptions from './serialization/exceptions.js';
|
|
import * as serializationPriorities from './serialization/priorities.js';
|
|
import * as serializationRegistry from './serialization/registry.js';
|
|
import * as serializationVariables from './serialization/variables.js';
|
|
import * as serializationWorkspaces from './serialization/workspaces.js';
|
|
import * as ShortcutItems from './shortcut_items.js';
|
|
import {ShortcutRegistry} from './shortcut_registry.js';
|
|
import {Theme} from './theme.js';
|
|
import * as Themes from './theme/themes.js';
|
|
import {ThemeManager} from './theme_manager.js';
|
|
import {ToolboxCategory} from './toolbox/category.js';
|
|
import {CollapsibleToolboxCategory} from './toolbox/collapsible_category.js';
|
|
import {ToolboxSeparator} from './toolbox/separator.js';
|
|
import {Toolbox} from './toolbox/toolbox.js';
|
|
import {ToolboxItem} from './toolbox/toolbox_item.js';
|
|
import * as Tooltip from './tooltip.js';
|
|
import * as Touch from './touch.js';
|
|
import {TouchGesture} from './touch_gesture.js';
|
|
import {Trashcan} from './trashcan.js';
|
|
import * as utils from './utils.js';
|
|
import * as colour from './utils/colour.js';
|
|
import * as deprecation from './utils/deprecation.js';
|
|
import * as svgMath from './utils/svg_math.js';
|
|
import * as toolbox from './utils/toolbox.js';
|
|
import {VariableMap} from './variable_map.js';
|
|
import {VariableModel} from './variable_model.js';
|
|
import * as Variables from './variables.js';
|
|
import * as VariablesDynamic from './variables_dynamic.js';
|
|
import {Warning} from './warning.js';
|
|
import * as WidgetDiv from './widgetdiv.js';
|
|
import {Workspace} from './workspace.js';
|
|
import {WorkspaceAudio} from './workspace_audio.js';
|
|
import {WorkspaceComment} from './workspace_comment.js';
|
|
import {WorkspaceCommentSvg} from './workspace_comment_svg.js';
|
|
import {WorkspaceDragSurfaceSvg} from './workspace_drag_surface_svg.js';
|
|
import {WorkspaceDragger} from './workspace_dragger.js';
|
|
import {resizeSvgContents as realResizeSvgContents, WorkspaceSvg} from './workspace_svg.js';
|
|
import * as Xml from './xml.js';
|
|
import {ZoomControls} from './zoom_controls.js';
|
|
|
|
|
|
/**
|
|
* Blockly core version.
|
|
* This constant is overridden by the build script (npm run build) to the value
|
|
* of the version in package.json. This is done by the Closure Compiler in the
|
|
* buildCompressed gulp task.
|
|
* For local builds, you can pass --define='Blockly.VERSION=X.Y.Z' to the
|
|
* compiler to override this constant.
|
|
*
|
|
* @define {string}
|
|
* @alias Blockly.VERSION
|
|
*/
|
|
export const VERSION = 'uncompiled';
|
|
|
|
/*
|
|
* Top-level functions and properties on the Blockly namespace.
|
|
* These are used only in external code. Do not reference these
|
|
* from internal code as importing from this file can cause circular
|
|
* dependencies. Do not add new functions here. There is probably a better
|
|
* namespace to put new functions on.
|
|
*/
|
|
|
|
/*
|
|
* Aliases for input alignments used in block defintions.
|
|
*/
|
|
|
|
/**
|
|
* @see Blockly.Input.Align.LEFT
|
|
* @alias Blockly.ALIGN_LEFT
|
|
*/
|
|
export const ALIGN_LEFT = Align.LEFT;
|
|
|
|
/**
|
|
* @see Blockly.Input.Align.CENTRE
|
|
* @alias Blockly.ALIGN_CENTRE
|
|
*/
|
|
export const ALIGN_CENTRE = Align.CENTRE;
|
|
|
|
/**
|
|
* @see Blockly.Input.Align.RIGHT
|
|
* @alias Blockly.ALIGN_RIGHT
|
|
*/
|
|
export const ALIGN_RIGHT = Align.RIGHT;
|
|
/*
|
|
* Aliases for constants used for connection and input types.
|
|
*/
|
|
|
|
/**
|
|
* @see ConnectionType.INPUT_VALUE
|
|
* @alias Blockly.INPUT_VALUE
|
|
*/
|
|
export const INPUT_VALUE = ConnectionType.INPUT_VALUE;
|
|
|
|
/**
|
|
* @see ConnectionType.OUTPUT_VALUE
|
|
* @alias Blockly.OUTPUT_VALUE
|
|
*/
|
|
export const OUTPUT_VALUE = ConnectionType.OUTPUT_VALUE;
|
|
|
|
/**
|
|
* @see ConnectionType.NEXT_STATEMENT
|
|
* @alias Blockly.NEXT_STATEMENT
|
|
*/
|
|
export const NEXT_STATEMENT = ConnectionType.NEXT_STATEMENT;
|
|
|
|
/**
|
|
* @see ConnectionType.PREVIOUS_STATEMENT
|
|
* @alias Blockly.PREVIOUS_STATEMENT
|
|
*/
|
|
export const PREVIOUS_STATEMENT = ConnectionType.PREVIOUS_STATEMENT;
|
|
|
|
/**
|
|
* @see inputTypes.DUMMY_INPUT
|
|
* @alias Blockly.DUMMY_INPUT
|
|
*/
|
|
export const DUMMY_INPUT = inputTypes.DUMMY;
|
|
|
|
/** Aliases for toolbox positions. */
|
|
|
|
/**
|
|
* @see toolbox.Position.TOP
|
|
* @alias Blockly.TOOLBOX_AT_TOP
|
|
*/
|
|
export const TOOLBOX_AT_TOP = toolbox.Position.TOP;
|
|
|
|
/**
|
|
* @see toolbox.Position.BOTTOM
|
|
* @alias Blockly.TOOLBOX_AT_BOTTOM
|
|
*/
|
|
export const TOOLBOX_AT_BOTTOM = toolbox.Position.BOTTOM;
|
|
|
|
/**
|
|
* @see toolbox.Position.LEFT
|
|
* @alias Blockly.TOOLBOX_AT_LEFT
|
|
*/
|
|
export const TOOLBOX_AT_LEFT = toolbox.Position.LEFT;
|
|
|
|
/**
|
|
* @see toolbox.Position.RIGHT
|
|
* @alias Blockly.TOOLBOX_AT_RIGHT
|
|
*/
|
|
export const TOOLBOX_AT_RIGHT = toolbox.Position.RIGHT;
|
|
|
|
/*
|
|
* Other aliased functions.
|
|
*/
|
|
|
|
/**
|
|
* Size the SVG image to completely fill its container. Call this when the view
|
|
* actually changes sizes (e.g. on a window resize/device orientation change).
|
|
* See workspace.resizeContents to resize the workspace when the contents
|
|
* change (e.g. when a block is added or removed).
|
|
* Record the height/width of the SVG image.
|
|
*
|
|
* @param workspace Any workspace in the SVG.
|
|
* @see Blockly.common.svgResize
|
|
* @alias Blockly.svgResize
|
|
*/
|
|
export const svgResize = common.svgResize;
|
|
|
|
/**
|
|
* Close tooltips, context menus, dropdown selections, etc.
|
|
*
|
|
* @param opt_onlyClosePopups Whether only popups should be closed.
|
|
* @see Blockly.WorkspaceSvg.hideChaff
|
|
* @alias Blockly.hideChaff
|
|
*/
|
|
export function hideChaff(opt_onlyClosePopups?: boolean) {
|
|
(common.getMainWorkspace() as WorkspaceSvg).hideChaff(opt_onlyClosePopups);
|
|
}
|
|
|
|
/**
|
|
* Returns the main workspace. Returns the last used main workspace (based on
|
|
* focus). Try not to use this function, particularly if there are multiple
|
|
* Blockly instances on a page.
|
|
*
|
|
* @see Blockly.common.getMainWorkspace
|
|
* @alias Blockly.getMainWorkspace
|
|
*/
|
|
export const getMainWorkspace = common.getMainWorkspace;
|
|
|
|
/**
|
|
* Returns the currently selected copyable object.
|
|
*
|
|
* @alias Blockly.common.getSelected
|
|
*/
|
|
export const getSelected = common.getSelected;
|
|
|
|
/**
|
|
* Define blocks from an array of JSON block definitions, as might be generated
|
|
* by the Blockly Developer Tools.
|
|
*
|
|
* @param jsonArray An array of JSON block definitions.
|
|
* @see Blockly.common.defineBlocksWithJsonArray
|
|
* @alias Blockly.defineBlocksWithJsonArray
|
|
*/
|
|
export const defineBlocksWithJsonArray = common.defineBlocksWithJsonArray;
|
|
|
|
/**
|
|
* Set the parent container. This is the container element that the WidgetDiv,
|
|
* dropDownDiv, and Tooltip are rendered into the first time `Blockly.inject`
|
|
* is called.
|
|
* This method is a NOP if called after the first `Blockly.inject`.
|
|
*
|
|
* @param container The container element.
|
|
* @see Blockly.common.setParentContainer
|
|
* @alias Blockly.setParentContainer
|
|
*/
|
|
export const setParentContainer = common.setParentContainer;
|
|
|
|
/**
|
|
* Returns the dimensions of the specified SVG image.
|
|
*
|
|
* @param svg SVG image.
|
|
* @returns Contains width and height properties.
|
|
* @deprecated Use workspace.setCachedParentSvgSize. (2021 March 5)
|
|
* @see Blockly.WorkspaceSvg.setCachedParentSvgSize
|
|
* @alias Blockly.svgSize
|
|
*/
|
|
export const svgSize = svgMath.svgSize;
|
|
|
|
/**
|
|
* Size the workspace when the contents change. This also updates
|
|
* scrollbars accordingly.
|
|
*
|
|
* @param workspace The workspace to resize.
|
|
* @deprecated Use workspace.resizeContents. (2021 December)
|
|
* @see Blockly.WorkspaceSvg.resizeContents
|
|
* @alias Blockly.resizeSvgContents
|
|
*/
|
|
function resizeSvgContentsLocal(workspace: WorkspaceSvg) {
|
|
deprecation.warn(
|
|
'Blockly.resizeSvgContents', 'December 2021', 'December 2022',
|
|
'Blockly.WorkspaceSvg.resizeSvgContents');
|
|
realResizeSvgContents(workspace);
|
|
}
|
|
export const resizeSvgContents = resizeSvgContentsLocal;
|
|
|
|
/**
|
|
* Copy a block or workspace comment onto the local clipboard.
|
|
*
|
|
* @param toCopy Block or Workspace Comment to be copied.
|
|
* @deprecated Use Blockly.clipboard.copy(). (2021 December)
|
|
* @see Blockly.clipboard.copy
|
|
* @alias Blockly.copy
|
|
*/
|
|
export function copy(toCopy: ICopyable) {
|
|
deprecation.warn(
|
|
'Blockly.copy', 'December 2021', 'December 2022',
|
|
'Blockly.clipboard.copy');
|
|
clipboard.copy(toCopy);
|
|
}
|
|
|
|
/**
|
|
* Paste a block or workspace comment on to the main workspace.
|
|
*
|
|
* @returns True if the paste was successful, false otherwise.
|
|
* @deprecated Use Blockly.clipboard.paste(). (2021 December)
|
|
* @see Blockly.clipboard.paste
|
|
* @alias Blockly.paste
|
|
*/
|
|
export function paste(): boolean {
|
|
deprecation.warn(
|
|
'Blockly.paste', 'December 2021', 'December 2022',
|
|
'Blockly.clipboard.paste');
|
|
return !!clipboard.paste();
|
|
}
|
|
|
|
/**
|
|
* Duplicate this block and its children, or a workspace comment.
|
|
*
|
|
* @param toDuplicate Block or Workspace Comment to be copied.
|
|
* @deprecated Use Blockly.clipboard.duplicate(). (2021 December)
|
|
* @see Blockly.clipboard.duplicate
|
|
* @alias Blockly.duplicate
|
|
*/
|
|
export function duplicate(toDuplicate: ICopyable) {
|
|
deprecation.warn(
|
|
'Blockly.duplicate', 'December 2021', 'December 2022',
|
|
'Blockly.clipboard.duplicate');
|
|
clipboard.duplicate(toDuplicate);
|
|
}
|
|
|
|
/**
|
|
* Is the given string a number (includes negative and decimals).
|
|
*
|
|
* @param str Input string.
|
|
* @returns True if number, false otherwise.
|
|
* @deprecated Use Blockly.utils.string.isNumber(str). (2021 December)
|
|
* @see Blockly.utils.string.isNumber
|
|
* @alias Blockly.isNumber
|
|
*/
|
|
export function isNumber(str: string): boolean {
|
|
deprecation.warn(
|
|
'Blockly.isNumber', 'December 2021', 'December 2022',
|
|
'Blockly.utils.string.isNumber');
|
|
return utils.string.isNumber(str);
|
|
}
|
|
|
|
/**
|
|
* Convert a hue (HSV model) into an RGB hex triplet.
|
|
*
|
|
* @param hue Hue on a colour wheel (0-360).
|
|
* @returns RGB code, e.g. '#5ba65b'.
|
|
* @deprecated Use Blockly.utils.colour.hueToHex(). (2021 December)
|
|
* @see Blockly.utils.colour.hueToHex
|
|
* @alias Blockly.hueToHex
|
|
*/
|
|
export function hueToHex(hue: number): string {
|
|
deprecation.warn(
|
|
'Blockly.hueToHex', 'December 2021', 'December 2022',
|
|
'Blockly.utils.colour.hueToHex');
|
|
return colour.hueToHex(hue);
|
|
}
|
|
|
|
/**
|
|
* Bind an event handler that should be called regardless of whether it is part
|
|
* of the active touch stream.
|
|
* Use this for events that are not part of a multi-part gesture (e.g.
|
|
* mouseover for tooltips).
|
|
*
|
|
* @param node Node upon which to listen.
|
|
* @param name Event name to listen to (e.g. 'mousedown').
|
|
* @param thisObject The value of 'this' in the function.
|
|
* @param func Function to call when event is triggered.
|
|
* @returns Opaque data that can be passed to unbindEvent_.
|
|
* @deprecated Use Blockly.browserEvents.bind(). (December 2021)
|
|
* @see Blockly.browserEvents.bind
|
|
* @alias Blockly.bindEvent_
|
|
*/
|
|
export function bindEvent_(
|
|
node: EventTarget, name: string, thisObject: Object|null,
|
|
func: Function): browserEvents.Data {
|
|
deprecation.warn(
|
|
'Blockly.bindEvent_', 'December 2021', 'December 2022',
|
|
'Blockly.browserEvents.bind');
|
|
return browserEvents.bind(node, name, thisObject, func);
|
|
}
|
|
|
|
/**
|
|
* Unbind one or more events event from a function call.
|
|
*
|
|
* @param bindData Opaque data from bindEvent_.
|
|
* This list is emptied during the course of calling this function.
|
|
* @returns The function call.
|
|
* @deprecated Use Blockly.browserEvents.unbind(). (December 2021)
|
|
* @see browserEvents.unbind
|
|
* @alias Blockly.unbindEvent_
|
|
*/
|
|
export function unbindEvent_(bindData: browserEvents.Data): Function {
|
|
deprecation.warn(
|
|
'Blockly.unbindEvent_', 'December 2021', 'December 2022',
|
|
'Blockly.browserEvents.unbind');
|
|
return browserEvents.unbind(bindData);
|
|
}
|
|
|
|
/**
|
|
* Bind an event handler that can be ignored if it is not part of the active
|
|
* touch stream.
|
|
* Use this for events that either start or continue a multi-part gesture (e.g.
|
|
* mousedown or mousemove, which may be part of a drag or click).
|
|
*
|
|
* @param node Node upon which to listen.
|
|
* @param name Event name to listen to (e.g. 'mousedown').
|
|
* @param thisObject The value of 'this' in the function.
|
|
* @param func Function to call when event is triggered.
|
|
* @param opt_noCaptureIdentifier True if triggering on this event should not
|
|
* block execution of other event handlers on this touch or other
|
|
* simultaneous touches. False by default.
|
|
* @param opt_noPreventDefault True if triggering on this event should prevent
|
|
* the default handler. False by default. If opt_noPreventDefault is
|
|
* provided, opt_noCaptureIdentifier must also be provided.
|
|
* @returns Opaque data that can be passed to unbindEvent_.
|
|
* @deprecated Use Blockly.browserEvents.conditionalBind(). (December 2021)
|
|
* @see browserEvents.conditionalBind
|
|
* @alias Blockly.bindEventWithChecks_
|
|
*/
|
|
export function bindEventWithChecks_(
|
|
node: EventTarget, name: string, thisObject: Object|null, func: Function,
|
|
opt_noCaptureIdentifier?: boolean,
|
|
opt_noPreventDefault?: boolean): browserEvents.Data {
|
|
deprecation.warn(
|
|
'Blockly.bindEventWithChecks_', 'December 2021', 'December 2022',
|
|
'Blockly.browserEvents.conditionalBind');
|
|
return browserEvents.conditionalBind(
|
|
node, name, thisObject, func, opt_noCaptureIdentifier,
|
|
opt_noPreventDefault);
|
|
}
|
|
|
|
// Aliases to allow external code to access these values for legacy reasons.
|
|
export const COLLAPSE_CHARS = internalConstants.COLLAPSE_CHARS;
|
|
export const DRAG_STACK = internalConstants.DRAG_STACK;
|
|
export const OPPOSITE_TYPE = internalConstants.OPPOSITE_TYPE;
|
|
export const RENAME_VARIABLE_ID = internalConstants.RENAME_VARIABLE_ID;
|
|
export const DELETE_VARIABLE_ID = internalConstants.DELETE_VARIABLE_ID;
|
|
export const COLLAPSED_INPUT_NAME = constants.COLLAPSED_INPUT_NAME;
|
|
export const COLLAPSED_FIELD_NAME = constants.COLLAPSED_FIELD_NAME;
|
|
|
|
/**
|
|
* String for use in the "custom" attribute of a category in toolbox XML.
|
|
* This string indicates that the category should be dynamically populated with
|
|
* variable blocks.
|
|
*
|
|
* @alias Blockly.VARIABLE_CATEGORY_NAME
|
|
*/
|
|
export const VARIABLE_CATEGORY_NAME: string = Variables.CATEGORY_NAME;
|
|
|
|
/**
|
|
* String for use in the "custom" attribute of a category in toolbox XML.
|
|
* This string indicates that the category should be dynamically populated with
|
|
* variable blocks.
|
|
*
|
|
* @alias Blockly.VARIABLE_DYNAMIC_CATEGORY_NAME
|
|
*/
|
|
export const VARIABLE_DYNAMIC_CATEGORY_NAME: string =
|
|
VariablesDynamic.CATEGORY_NAME;
|
|
/**
|
|
* String for use in the "custom" attribute of a category in toolbox XML.
|
|
* This string indicates that the category should be dynamically populated with
|
|
* procedure blocks.
|
|
*
|
|
* @alias Blockly.PROCEDURE_CATEGORY_NAME
|
|
*/
|
|
export const PROCEDURE_CATEGORY_NAME: string = Procedures.CATEGORY_NAME;
|
|
|
|
// Context for why we need to monkey-patch in these functions (internal):
|
|
// https://docs.google.com/document/d/1MbO0LEA-pAyx1ErGLJnyUqTLrcYTo-5zga9qplnxeXo/edit?usp=sharing&resourcekey=0-5h_32-i-dHwHjf_9KYEVKg
|
|
|
|
// clang-format off
|
|
Workspace.prototype.newBlock =
|
|
function(prototypeName: string, opt_id?: string): Block {
|
|
return new Block(this, prototypeName, opt_id);
|
|
};
|
|
|
|
WorkspaceSvg.prototype.newBlock =
|
|
function(prototypeName: string, opt_id?: string): BlockSvg {
|
|
return new BlockSvg(this, prototypeName, opt_id);
|
|
};
|
|
|
|
WorkspaceSvg.newTrashcan = function(workspace: WorkspaceSvg): Trashcan {
|
|
return new Trashcan(workspace);
|
|
};
|
|
|
|
WorkspaceCommentSvg.prototype.showContextMenu =
|
|
function(this: WorkspaceCommentSvg, e: Event) {
|
|
if (this.workspace.options.readOnly) {
|
|
return;
|
|
}
|
|
const menuOptions = [];
|
|
|
|
if (this.isDeletable() && this.isMovable()) {
|
|
menuOptions.push(ContextMenu.commentDuplicateOption(this));
|
|
menuOptions.push(ContextMenu.commentDeleteOption(this));
|
|
}
|
|
|
|
ContextMenu.show(e, menuOptions, this.RTL);
|
|
};
|
|
|
|
Mutator.prototype.newWorkspaceSvg =
|
|
function(options: Options): WorkspaceSvg {
|
|
return new WorkspaceSvg(options);
|
|
};
|
|
|
|
Names.prototype.populateProcedures =
|
|
function(this: Names, workspace: Workspace) {
|
|
const procedures = Procedures.allProcedures(workspace);
|
|
// Flatten the return vs no-return procedure lists.
|
|
const flattenedProcedures: AnyDuringMigration[][] =
|
|
procedures[0].concat(procedures[1]);
|
|
for (let i = 0; i < flattenedProcedures.length; i++) {
|
|
this.getName(flattenedProcedures[i][0], Names.NameType.PROCEDURE);
|
|
}
|
|
};
|
|
// clang-format on
|
|
|
|
|
|
// Re-export submodules that no longer declareLegacyNamespace.
|
|
export {browserEvents};
|
|
export {ContextMenu};
|
|
export {ContextMenuItems};
|
|
export {Css};
|
|
export {Events};
|
|
export {Extensions};
|
|
export {Procedures};
|
|
export {ShortcutItems};
|
|
export {Themes};
|
|
export {Tooltip};
|
|
export {Touch};
|
|
export {Variables};
|
|
export {VariablesDynamic};
|
|
export {WidgetDiv};
|
|
export {Xml};
|
|
export {blockAnimations};
|
|
export {blockRendering};
|
|
export {bumpObjects};
|
|
export {clipboard};
|
|
export {common};
|
|
export {constants};
|
|
export {dialog};
|
|
export {fieldRegistry};
|
|
export {geras};
|
|
export {minimalist};
|
|
export {registry};
|
|
export {thrasos};
|
|
export {uiPosition};
|
|
export {utils};
|
|
export {zelos};
|
|
export {ASTNode};
|
|
export {BasicCursor};
|
|
export {Block};
|
|
export {BlocklyOptions};
|
|
export {BlockDragger};
|
|
export {BlockDragSurfaceSvg};
|
|
export {BlockSvg};
|
|
export {Blocks};
|
|
export {Bubble};
|
|
export {BubbleDragger};
|
|
export {CollapsibleToolboxCategory};
|
|
export {Comment};
|
|
export {ComponentManager};
|
|
export {Connection};
|
|
export {ConnectionType};
|
|
export {ConnectionChecker};
|
|
export {ConnectionDB};
|
|
export {ContextMenuRegistry};
|
|
export {Cursor};
|
|
export {DeleteArea};
|
|
export {DragTarget};
|
|
export const DropDownDiv = dropDownDiv;
|
|
export {Field};
|
|
export {FieldAngle};
|
|
export {FieldCheckbox};
|
|
export {FieldColour};
|
|
export {FieldDropdown};
|
|
export {FieldImage};
|
|
export {FieldLabel};
|
|
export {FieldLabelSerializable};
|
|
export {FieldMultilineInput};
|
|
export {FieldNumber};
|
|
export {FieldTextInput};
|
|
export {FieldVariable};
|
|
export {Flyout};
|
|
export {FlyoutButton};
|
|
export {FlyoutMetricsManager};
|
|
export {Generator};
|
|
export {Gesture};
|
|
export {Grid};
|
|
export {HorizontalFlyout};
|
|
export {IASTNodeLocation};
|
|
export {IASTNodeLocationSvg};
|
|
export {IASTNodeLocationWithBlock};
|
|
export {IAutoHideable};
|
|
export {IBlockDragger};
|
|
export {IBoundedElement};
|
|
export {IBubble};
|
|
export {ICollapsibleToolboxItem};
|
|
export {IComponent};
|
|
export {IConnectionChecker};
|
|
export {IContextMenu};
|
|
export {Icon};
|
|
export {ICopyable};
|
|
export {IDeletable};
|
|
export {IDeleteArea};
|
|
export {IDragTarget};
|
|
export {IDraggable};
|
|
export {IFlyout};
|
|
export {IKeyboardAccessible};
|
|
export {IMetricsManager};
|
|
export {IMovable};
|
|
export {Input};
|
|
export {InsertionMarkerManager};
|
|
export {IPositionable};
|
|
export {IRegistrable};
|
|
export {IRegistrableField};
|
|
export {ISelectable};
|
|
export {ISelectableToolboxItem};
|
|
export {IStyleable};
|
|
export {IToolbox};
|
|
export {IToolboxItem};
|
|
export {Marker};
|
|
export {MarkerManager};
|
|
export {Menu};
|
|
export {MenuItem};
|
|
export {MetricsManager};
|
|
export {Mutator};
|
|
export {Msg};
|
|
export {Names};
|
|
export {Options};
|
|
export {RenderedConnection};
|
|
export {Scrollbar};
|
|
export {ScrollbarPair};
|
|
export {ShortcutRegistry};
|
|
export {TabNavigateCursor};
|
|
export {Theme};
|
|
export {ThemeManager};
|
|
export {Toolbox};
|
|
export {ToolboxCategory};
|
|
export {ToolboxItem};
|
|
export {ToolboxSeparator};
|
|
export {TouchGesture};
|
|
export {Trashcan};
|
|
export {VariableMap};
|
|
export {VariableModel};
|
|
export {VerticalFlyout};
|
|
export {Warning};
|
|
export {Workspace};
|
|
export {WorkspaceAudio};
|
|
export {WorkspaceComment};
|
|
export {WorkspaceCommentSvg};
|
|
export {WorkspaceDragSurfaceSvg};
|
|
export {WorkspaceDragger};
|
|
export {WorkspaceSvg};
|
|
export {ZoomControls};
|
|
export {config};
|
|
/** @deprecated Use Blockly.ConnectionType instead. */
|
|
export const connectionTypes = ConnectionType;
|
|
export {inject};
|
|
export {inputTypes};
|
|
export namespace serialization {
|
|
export const blocks = serializationBlocks;
|
|
export const exceptions = serializationExceptions;
|
|
export const priorities = serializationPriorities;
|
|
export const registry = serializationRegistry;
|
|
export const variables = serializationVariables;
|
|
export const workspaces = serializationWorkspaces;
|
|
export type ISerializer = SerializerInterface;
|
|
}
|