blockly 9.3.3 → 10.0.0-beta.0

package/core/events/events_block_delete.d.ts

@@ -29,12 +29,6 @@ export declare class BlockDelete extends BlockBase {
      * @returns JSON representation.
      */
     toJson(): BlockDeleteJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: BlockDeleteJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_block_drag.d.ts

@@ -36,12 +36,6 @@ export declare class BlockDrag extends UiBase {
      * @returns JSON representation.
      */
     toJson(): BlockDragJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: BlockDragJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_block_move.d.ts

@@ -33,10 +33,23 @@ export declare class BlockMove extends BlockBase {
      */
     newInputName?: string;
     /**
-     * The new X and Y workspace coordinates of the block if it is a top level
+     * The new X and Y workspace coordinates of the block if it is a top-level
      * block. Undefined if it is not a top level block.
      */
     newCoordinate?: Coordinate;
+    /**
+     * An explanation of what this move is for.  Known values include:
+     *  'drag' -- A drag operation completed.
+     *  'bump' -- Block got bumped away from an invalid connection.
+     *  'snap' -- Block got shifted to line up with the grid.
+     *  'inbounds' -- Block got pushed back into a non-scrolling workspace.
+     *  'connect' -- Block got connected to another block.
+     *  'disconnect' -- Block got disconnected from another block.
+     *  'create' -- Block created via XML.
+     *  'cleanup' -- Workspace aligned top-level blocks.
+     * Event merging may create multiple reasons: ['drag', 'bump', 'snap'].
+     */
+    reason?: string[];
     /** @param opt_block The moved block.  Undefined for a blank event. */
     constructor(opt_block?: Block);
     /**
@@ -45,12 +58,6 @@ export declare class BlockMove extends BlockBase {
      * @returns JSON representation.
      */
     toJson(): BlockMoveJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: BlockMoveJson): void;
     /**
      * Deserializes the JSON event.
      *
@@ -63,6 +70,12 @@ export declare class BlockMove extends BlockBase {
     static fromJson(json: BlockMoveJson, workspace: Workspace, event?: any): BlockMove;
     /** Record the block's new location.  Called after the move. */
     recordNew(): void;
+    /**
+     * Set the reason for a move event.
+     *
+     * @param reason Why is this move happening?  'drag', 'bump', 'snap', ...
+     */
+    setReason(reason: string[]): void;
     /**
      * Returns the parentId and input if the block is connected,
      *   or the XY location if disconnected.
@@ -90,6 +103,7 @@ export interface BlockMoveJson extends BlockBaseJson {
     newParentId?: string;
     newInputName?: string;
     newCoordinate?: string;
+    reason?: string[];
     recordUndo?: boolean;
 }
 //# sourceMappingURL=events_block_move.d.ts.map

package/core/events/events_bubble_open.d.ts

@@ -32,12 +32,6 @@ export declare class BubbleOpen extends UiBase {
      * @returns JSON representation.
      */
     toJson(): BubbleOpenJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: BubbleOpenJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_click.d.ts

@@ -35,12 +35,6 @@ export declare class Click extends UiBase {
      * @returns JSON representation.
      */
     toJson(): ClickJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: ClickJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_comment_base.d.ts

@@ -26,12 +26,6 @@ export declare class CommentBase extends AbstractEvent {
      * @returns JSON representation.
      */
     toJson(): CommentBaseJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: CommentBaseJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_comment_change.d.ts

@@ -28,12 +28,6 @@ export declare class CommentChange extends CommentBase {
      * @returns JSON representation.
      */
     toJson(): CommentChangeJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: CommentChangeJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_comment_create.d.ts

@@ -24,12 +24,6 @@ export declare class CommentCreate extends CommentBase {
      * @returns JSON representation.
      */
     toJson(): CommentCreateJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: CommentCreateJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_comment_move.d.ts

@@ -41,12 +41,6 @@ export declare class CommentMove extends CommentBase {
      * @returns JSON representation.
      */
     toJson(): CommentMoveJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: CommentMoveJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_marker_move.d.ts

@@ -43,12 +43,6 @@ export declare class MarkerMove extends UiBase {
      * @returns JSON representation.
      */
     toJson(): MarkerMoveJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: MarkerMoveJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_selected.d.ts

@@ -34,12 +34,6 @@ export declare class Selected extends UiBase {
      * @returns JSON representation.
      */
     toJson(): SelectedJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: SelectedJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_theme_change.d.ts

@@ -25,12 +25,6 @@ export declare class ThemeChange extends UiBase {
      * @returns JSON representation.
      */
     toJson(): ThemeChangeJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: ThemeChangeJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_toolbox_item_select.d.ts

@@ -30,12 +30,6 @@ export declare class ToolboxItemSelect extends UiBase {
      * @returns JSON representation.
      */
     toJson(): ToolboxItemSelectJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: ToolboxItemSelectJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_trashcan_open.d.ts

@@ -29,12 +29,6 @@ export declare class TrashcanOpen extends UiBase {
      * @returns JSON representation.
      */
     toJson(): TrashcanOpenJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: TrashcanOpenJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_var_base.d.ts

@@ -24,12 +24,6 @@ export declare class VarBase extends AbstractEvent {
      * @returns JSON representation.
      */
     toJson(): VarBaseJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: VarBaseJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_var_create.d.ts

@@ -25,12 +25,6 @@ export declare class VarCreate extends VarBase {
      * @returns JSON representation.
      */
     toJson(): VarCreateJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: VarCreateJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_var_delete.d.ts

@@ -27,12 +27,6 @@ export declare class VarDelete extends VarBase {
      * @returns JSON representation.
      */
     toJson(): VarDeleteJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: VarDeleteJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_var_rename.d.ts

@@ -28,12 +28,6 @@ export declare class VarRename extends VarBase {
      * @returns JSON representation.
      */
     toJson(): VarRenameJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: VarRenameJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/events_viewport.d.ts

@@ -46,12 +46,6 @@ export declare class ViewportChange extends UiBase {
      * @returns JSON representation.
      */
     toJson(): ViewportChangeJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: ViewportChangeJson): void;
     /**
      * Deserializes the JSON event.
      *

package/core/events/utils.d.ts

@@ -222,7 +222,7 @@ export declare function fromJson(json: any, workspace: Workspace): Abstract;
  * @param eventType The type of the event to get.
  * @returns The event class with the given type.
  */
-export declare function get(eventType: string): (new (...p1: any[]) => Abstract);
+export declare function get(eventType: string): new (...p1: any[]) => Abstract;
 /**
  * Enable/disable a block depending on whether it is properly connected.
  * Use this on applications where all blocks should be connected to a top block.

package/core/events/workspace_events.d.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Workspace } from '../workspace.js';
-import { Abstract as AbstractEvent, AbstractEventJson } from './events_abstract.js';
+import { Abstract as AbstractEvent } from './events_abstract.js';
 /**
  * Notifies listeners when the workspace has finished deserializing from
  * JSON/XML.
@@ -18,20 +18,5 @@ export declare class FinishedLoading extends AbstractEvent {
      *     for a blank event.
      */
     constructor(opt_workspace?: Workspace);
-    /**
-     * Encode the event as JSON.
-     *
-     * @returns JSON representation.
-     */
-    toJson(): FinishedLoadingJson;
-    /**
-     * Decode the JSON event.
-     *
-     * @param json JSON representation.
-     */
-    fromJson(json: FinishedLoadingJson): void;
-}
-export interface FinishedLoadingJson extends AbstractEventJson {
-    workspaceId: string;
 }
 //# sourceMappingURL=workspace_events.d.ts.map

package/core/field.d.ts

@@ -5,7 +5,7 @@
  */
 import './events/events_block_change.js';
 import type { Block } from './block.js';
-import type { Input } from './input.js';
+import type { Input } from './inputs/input.js';
 import type { IASTNodeLocationSvg } from './interfaces/i_ast_node_location_svg.js';
 import type { IASTNodeLocationWithBlock } from './interfaces/i_ast_node_location_with_block.js';
 import type { IKeyboardAccessible } from './interfaces/i_keyboard_accessible.js';
@@ -16,6 +16,7 @@ import * as Tooltip from './tooltip.js';
 import type { Coordinate } from './utils/coordinate.js';
 import { Rect } from './utils/rect.js';
 import { Size } from './utils/size.js';
+import { ISerializable } from './interfaces/i_serializable.js';
 /**
  * A function that is called to validate changes to the field's value before
  * they are set.
@@ -37,7 +38,7 @@ export type FieldValidator<T = any> = (newValue: T) => T | null | undefined;
  *
  * @typeParam T - The value stored on the field.
  */
-export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IASTNodeLocationWithBlock, IKeyboardAccessible, IRegistrable {
+export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IASTNodeLocationWithBlock, IKeyboardAccessible, IRegistrable, ISerializable {
     /**
      * To overwrite the default value which is set in **Field**, directly update
      * the prototype.
@@ -380,10 +381,16 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
      */
     protected getTextContent(): Text;
     /**
-     * Updates the field to match the colour/style of the block. Should only be
-     * called by BlockSvg.applyColour().
+     * Updates the field to match the colour/style of the block.
      *
-     * @internal
+     * Non-abstract sub-classes may wish to implement this if the colour of the
+     * field depends on the colour of the block. It will automatically be called
+     * at relevant times, such as when the parent block or renderer changes.
+     *
+     * See {@link
+     * https://developers.google.com/blockly/guides/create-custom-blocks/fields/customizing-fields/creating#matching_block_colours
+     * | the field documentation} for more information, or FieldDropdown for an
+     * example.
      */
     applyColour(): void;
     /**
@@ -411,6 +418,25 @@ export declare abstract class Field<T = any> implements IASTNodeLocationSvg, IAS
      *     undefined if triggered programmatically.
      */
     protected showEditor_(_e?: Event): void;
+    /**
+     * A developer hook to reposition the WidgetDiv during a window resize. You
+     * need to define this hook if your field has a WidgetDiv that needs to
+     * reposition itself when the window is resized. For example, text input
+     * fields define this hook so that the input WidgetDiv can reposition itself
+     * on a window resize event. This is especially important when modal inputs
+     * have been disabled, as Android devices will fire a window resize event when
+     * the soft keyboard opens.
+     *
+     * If you want the WidgetDiv to hide itself instead of repositioning, return
+     * false. This is the default behavior.
+     *
+     * DropdownDivs already handle their own positioning logic, so you do not need
+     * to override this function if your field only has a DropdownDiv.
+     *
+     * @returns True if the field should be repositioned,
+     *    false if the WidgetDiv should hide itself instead.
+     */
+    repositionForWindowResize(): boolean;
     /**
      * Updates the size of the field based on the text.
      *

package/core/field_checkbox.d.ts

@@ -13,7 +13,7 @@ type CheckboxBool = BoolString | boolean;
 export declare class FieldCheckbox extends Field<CheckboxBool> {
     /** Default character for the checkmark. */
     static readonly CHECK_CHAR = "\u2713";
-    private checkChar_;
+    private checkChar;
     /**
      * Serializable fields are saved by the serializer, non-serializable fields
      * are not. Editable fields should also be serializable.

package/core/field_colour.d.ts

@@ -90,8 +90,6 @@ export declare class FieldColour extends Field<string> {
     initView(): void;
     /**
      * Updates text field to match the colour/style of the block.
-     *
-     * @internal
      */
     applyColour(): void;
     /**

package/core/field_dropdown.d.ts

@@ -19,17 +19,17 @@ export declare class FieldDropdown extends Field<string> {
     static MAX_MENU_HEIGHT_VH: number;
     static ARROW_CHAR: string;
     /** A reference to the currently selected menu item. */
-    private selectedMenuItem_;
+    private selectedMenuItem;
     /** The dropdown menu. */
     protected menu_: Menu | null;
     /**
      * SVG image element if currently selected option is an image, or null.
      */
-    private imageElement_;
+    private imageElement;
     /** Tspan based arrow element. */
-    private arrow_;
+    private arrow;
     /** SVG based arrow element. */
-    private svgArrow_;
+    private svgArrow;
     /**
      * Serializable fields are saved by the serializer, non-serializable fields
      * are not. Editable fields should also be serializable.
@@ -39,7 +39,7 @@ export declare class FieldDropdown extends Field<string> {
     CURSOR: string;
     protected menuGenerator_?: MenuGenerator;
     /** A cache of the most recently generated options. */
-    private generatedOptions_;
+    private generatedOptions;
     /**
      * The prefix field label, of common words set after options are trimmed.
      *
@@ -52,7 +52,7 @@ export declare class FieldDropdown extends Field<string> {
      * @internal
      */
     suffixField: string | null;
-    private selectedOption_;
+    private selectedOption;
     clickTarget_: SVGElement | null;
     /**
      * @param menuGenerator A non-empty array of options for a dropdown list, or a
@@ -111,7 +111,7 @@ export declare class FieldDropdown extends Field<string> {
      */
     protected showEditor_(e?: MouseEvent): void;
     /** Create the dropdown editor. */
-    private dropdownCreate_;
+    private dropdownCreate;
     /**
      * Disposes of events and DOM-references belonging to the dropdown editor.
      */
@@ -121,7 +121,7 @@ export declare class FieldDropdown extends Field<string> {
      *
      * @param menuItem The MenuItem selected within menu.
      */
-    private handleMenuActionEvent_;
+    private handleMenuActionEvent;
     /**
      * Handle the selection of an item in the dropdown menu.
      *
@@ -160,8 +160,6 @@ export declare class FieldDropdown extends Field<string> {
     protected doValueUpdate_(newValue: string): void;
     /**
      * Updates the dropdown arrow to match the colour/style of the block.
-     *
-     * @internal
      */
     applyColour(): void;
     /** Draws the border with the correct width. */
@@ -171,9 +169,9 @@ export declare class FieldDropdown extends Field<string> {
      *
      * @param imageJson Selected option that must be an image.
      */
-    private renderSelectedImage_;
+    private renderSelectedImage;
     /** Renders the selected option, which must be text. */
-    private renderSelectedText_;
+    private renderSelectedText;
     /**
      * Position a drop-down arrow at the appropriate location at render-time.
      *
@@ -181,7 +179,7 @@ export declare class FieldDropdown extends Field<string> {
      * @param y Y position the arrow is being rendered at, in px.
      * @returns Amount of space the arrow is taking up, in px.
      */
-    private positionSVGArrow_;
+    private positionSVGArrow;
     /**
      * Use the `getText_` developer hook to override the field's text
      * representation.  Get the selected option text.  If the selected option is

package/core/field_image.d.ts

@@ -15,11 +15,11 @@ export declare class FieldImage extends Field<string> {
      */
     private static readonly Y_PADDING;
     protected size_: Size;
-    private readonly imageHeight_;
+    private readonly imageHeight;
     /** The function to be called when this field is clicked. */
-    private clickHandler_;
+    private clickHandler;
     /** The rendered field's image element. */
-    private imageElement_;
+    private imageElement;
     /**
      * Editable fields usually show some sort of UI indicating they are
      * editable. This field should not.
@@ -32,9 +32,9 @@ export declare class FieldImage extends Field<string> {
      */
     protected isDirty_: boolean;
     /** Whether to flip this image in RTL. */
-    private flipRtl_;
+    private flipRtl;
     /** Alt text of this image. */
-    private altText_;
+    private altText;
     /**
      * @param src The URL of the image.
      *     Also accepts Field.SKIP_SETUP if you wish to skip setup (only used by

package/core/field_input.d.ts

@@ -91,8 +91,6 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<str
     protected doValueUpdate_(newValue: string | T): void;
     /**
      * Updates text field to match the colour/style of the block.
-     *
-     * @internal
      */
     applyColour(): void;
     /**
@@ -177,6 +175,15 @@ export declare abstract class FieldInput<T extends InputTypes> extends Field<str
     protected setEditorValue_(newValue: any): void;
     /** Resize the editor to fit the text. */
     protected resizeEditor_(): void;
+    /**
+     * Handles repositioning the WidgetDiv used for input fields when the
+     * workspace is resized. Will bump the block into the viewport and update the
+     * position of the field if necessary.
+     *
+     * @returns True for rendered workspaces, as we never want to hide the widget
+     *     div.
+     */
+    repositionForWindowResize(): boolean;
     /**
      * Returns whether or not the field is tab navigable.
      *

package/core/field_label.d.ts

@@ -9,12 +9,14 @@ import { Field, FieldConfig } from './field.js';
  */
 export declare class FieldLabel extends Field<string> {
     /** The HTML class name to use for this field. */
-    private class_;
+    private class;
     /**
      * Editable fields usually show some sort of UI indicating they are
      * editable. This field should not.
      */
     EDITABLE: boolean;
+    /** Text labels should not truncate. */
+    maxDisplayLength: number;
     /**
      * @param value The initial value of the field. Should cast to a string.
      *     Defaults to an empty string if null or undefined. Also accepts

package/core/field_number.d.ts

@@ -19,7 +19,7 @@ export declare class FieldNumber extends FieldInput<number> {
      * The number of decimal places to allow, or null to allow any number of
      * decimal digits.
      */
-    private decimalPlaces_;
+    private decimalPlaces;
     /** Don't spellcheck numbers.  Our validator does a better job. */
     protected spellcheck_: boolean;
     /**
@@ -75,7 +75,7 @@ export declare class FieldNumber extends FieldInput<number> {
      *
      * @param min Minimum value.
      */
-    private setMinInternal_;
+    private setMinInternal;
     /**
      * Returns the current minimum value this field can contain. Default is
      * -Infinity.
@@ -96,7 +96,7 @@ export declare class FieldNumber extends FieldInput<number> {
      *
      * @param max Maximum value.
      */
-    private setMaxInternal_;
+    private setMaxInternal;
     /**
      * Returns the current maximum value this field can contain. Default is
      * Infinity.
@@ -117,7 +117,7 @@ export declare class FieldNumber extends FieldInput<number> {
      *
      * @param precision The number to which the field's value is rounded.
      */
-    private setPrecisionInternal_;
+    private setPrecisionInternal;
     /**
      * Returns the current precision of this field. The precision being the
      * number to which the field's value is rounded. A precision of 0 means that