blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/field_colour.d.ts

@@ -8,6 +8,7 @@ import { FieldConfig, Field } from './field.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for a colour input field.
+ *
  * @alias Blockly.FieldColour
  */
 export declare class FieldColour extends Field {
@@ -87,69 +88,80 @@ export declare class FieldColour extends Field {
     constructor(opt_value?: string | Sentinel, opt_validator?: Function, opt_config?: FieldColourConfig);
     /**
      * Configure the field based on the given map of options.
+     *
      * @param config A map of options to configure the field based on.
      */
     protected configure_(config: FieldColourConfig): void;
     /**
      * Create the block UI for this colour field.
+     *
      * @internal
      */
     initView(): void;
     applyColour(): void;
     /**
      * Ensure that the input value is a valid colour.
+     *
      * @param opt_newValue The input value.
-     * @return A valid colour, or null if invalid.
+     * @returns A valid colour, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
      * Update the value of this colour field, and update the displayed colour.
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a colour in '#rrggbb' format.
      */
     protected doValueUpdate_(newValue: any): void;
     /**
      * Get the text for this field.  Used when the block is collapsed.
-     * @return Text representing the value of this field.
+     *
+     * @returns Text representing the value of this field.
      */
     getText(): string;
     /**
      * Set a custom colour grid for this field.
+     *
      * @param colours Array of colours for this block, or null to use default
      *     (FieldColour.COLOURS).
      * @param opt_titles Optional array of colour tooltips, or null to use default
      *     (FieldColour.TITLES).
-     * @return Returns itself (for method chaining).
+     * @returns Returns itself (for method chaining).
      */
     setColours(colours: string[], opt_titles?: string[]): FieldColour;
     /**
      * Set a custom grid size for this field.
+     *
      * @param columns Number of columns for this block, or 0 to use default
      *     (FieldColour.COLUMNS).
-     * @return Returns itself (for method chaining).
+     * @returns Returns itself (for method chaining).
      */
     setColumns(columns: number): FieldColour;
     /** Create and show the colour field's editor. */
     protected showEditor_(): void;
     /**
      * Handle a click on a colour cell.
+     *
      * @param e Mouse event.
      */
     private onClick_;
     /**
      * Handle a key down event. Navigate around the grid with the
      * arrow keys. Enter selects the highlighted colour.
+     *
      * @param e Keyboard event.
      */
     private onKeyDown_;
     /**
      * Move the currently highlighted position by dx and dy.
+     *
      * @param dx Change of x
      * @param dy Change of y
      */
     private moveHighlightBy_;
     /**
      * Handle a mouse move event. Highlight the hovered colour.
+     *
      * @param e Mouse event.
      */
     private onMouseMove_;
@@ -162,11 +174,13 @@ export declare class FieldColour extends Field {
     private onMouseLeave_;
     /**
      * Returns the currently highlighted item (if any).
-     * @return Highlighted item (null if none).
+     *
+     * @returns Highlighted item (null if none).
      */
     private getHighlighted_;
     /**
      * Update the currently highlighted cell.
+     *
      * @param cell the new cell to highlight
      * @param index the index of the new cell
      */
@@ -177,8 +191,9 @@ export declare class FieldColour extends Field {
     private dropdownDispose_;
     /**
      * Construct a FieldColour from a JSON arg object.
+     *
      * @param options A JSON object with options (colour).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -198,3 +213,4 @@ export interface FieldColourConfig extends FieldConfig {
 export interface FieldColourFromJsonConfig extends FieldColourConfig {
     colour?: string;
 }
+//# sourceMappingURL=field_colour.d.ts.map

package/core/field_dropdown.d.ts

@@ -9,6 +9,7 @@ import { MenuItem } from './menuitem.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for an editable dropdown field.
+ *
  * @alias Blockly.FieldDropdown
  */
 export declare class FieldDropdown extends Field {
@@ -44,11 +45,13 @@ export declare class FieldDropdown extends Field {
     private generatedOptions_;
     /**
      * The prefix field label, of common words set after options are trimmed.
+     *
      * @internal
      */
     prefixField: string | null;
     /**
      * The suffix field label, of common words set after options are trimmed.
+     *
      * @internal
      */
     suffixField: string | null;
@@ -74,24 +77,28 @@ export declare class FieldDropdown extends Field {
     /**
      * Sets the field's value based on the given XML element. Should only be
      * called by Blockly.Xml.
+     *
      * @param fieldElement The element containing info about the field's state.
      * @internal
      */
     fromXml(fieldElement: Element): void;
     /**
      * Sets the field's value based on the given state.
+     *
      * @param state The state to apply to the dropdown field.
      * @internal
      */
     loadState(state: any): void;
     /**
      * Create the block UI for this dropdown.
+     *
      * @internal
      */
     initView(): void;
     /**
      * Whether or not the dropdown should add a border rect.
-     * @return True if the dropdown field should add a border rect.
+     *
+     * @returns True if the dropdown field should add a border rect.
      */
     protected shouldAddBorderRect_(): boolean;
     /** Create a tspan based arrow. */
@@ -100,6 +107,7 @@ export declare class FieldDropdown extends Field {
     protected createSVGArrow_(): void;
     /**
      * Create a dropdown menu under the text.
+     *
      * @param opt_e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
      */
@@ -112,11 +120,13 @@ export declare class FieldDropdown extends Field {
     private dropdownDispose_;
     /**
      * Handle an action in the dropdown menu.
+     *
      * @param menuItem The MenuItem selected within menu.
      */
     private handleMenuActionEvent_;
     /**
      * Handle the selection of an item in the dropdown menu.
+     *
      * @param menu The Menu component clicked.
      * @param menuItem The MenuItem selected within menu.
      */
@@ -127,33 +137,37 @@ export declare class FieldDropdown extends Field {
      */
     private trimOptions_;
     /**
-     * @return True if the option list is generated by a function.
+     * @returns True if the option list is generated by a function.
      *     Otherwise false.
      */
     isOptionListDynamic(): boolean;
     /**
      * Return a list of the options for this dropdown.
+     *
      * @param opt_useCache For dynamic options, whether or not to use the cached
      *     options or to re-generate them.
-     * @return A non-empty array of option tuples:
+     * @returns A non-empty array of option tuples:
      *     (human-readable text or image, language-neutral name).
      * @throws {TypeError} If generated options are incorrectly structured.
      */
     getOptions(opt_useCache?: boolean): any[][];
     /**
      * Ensure that the input value is a valid language-neutral option.
+     *
      * @param opt_newValue The input value.
-     * @return A valid language-neutral option, or null if invalid.
+     * @returns A valid language-neutral option, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
      * Update the value of this dropdown field.
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is one of the valid dropdown options.
      */
     protected doValueUpdate_(newValue: any): void;
     /**
      * Updates the dropdown arrow to match the colour/style of the block.
+     *
      * @internal
      */
     applyColour(): void;
@@ -161,6 +175,7 @@ export declare class FieldDropdown extends Field {
     protected render_(): void;
     /**
      * Renders the selected option, which must be an image.
+     *
      * @param imageJson Selected option that must be an image.
      */
     private renderSelectedImage_;
@@ -168,22 +183,25 @@ export declare class FieldDropdown extends Field {
     private renderSelectedText_;
     /**
      * Position a drop-down arrow at the appropriate location at render-time.
+     *
      * @param x X position the arrow is being rendered at, in px.
      * @param y Y position the arrow is being rendered at, in px.
-     * @return Amount of space the arrow is taking up, in px.
+     * @returns Amount of space the arrow is taking up, in px.
      */
     private positionSVGArrow_;
     /**
      * Use the `getText_` developer hook to override the field's text
      * representation.  Get the selected option text. If the selected option is an
      * image we return the image alt text.
-     * @return Selected option text.
+     *
+     * @returns Selected option text.
      */
     protected getText_(): string | null;
     /**
      * Construct a FieldDropdown from a JSON arg object.
+     *
      * @param options A JSON object with options (options).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -191,11 +209,12 @@ export declare class FieldDropdown extends Field {
     /**
      * Use the calculated prefix and suffix lengths to trim all of the options in
      * the given array.
+     *
      * @param options Array of option tuples:
      *     (human-readable text or image, language-neutral name).
      * @param prefixLength The length of the common prefix.
      * @param suffixLength The length of the common suffix
-     * @return A new array with all of the option text trimmed.
+     * @returns A new array with all of the option text trimmed.
      */
     static applyTrim_(options: any[][], prefixLength: number, suffixLength: number): any[][];
 }
@@ -220,3 +239,4 @@ export declare type MenuOption = [string | ImageProperties, string];
 export interface FieldDropdownFromJsonConfig extends FieldConfig {
     options?: MenuOption[];
 }
+//# sourceMappingURL=field_dropdown.d.ts.map

package/core/field_image.d.ts

@@ -8,6 +8,7 @@ import type { Sentinel } from './utils/sentinel.js';
 import { Size } from './utils/size.js';
 /**
  * Class for an image on a block.
+ *
  * @alias Blockly.FieldImage
  */
 export declare class FieldImage extends Field {
@@ -57,34 +58,40 @@ export declare class FieldImage extends Field {
     constructor(src: string | Sentinel, width: string | number, height: string | number, opt_alt?: string, opt_onClick?: (p1: FieldImage) => any, opt_flipRtl?: boolean, opt_config?: FieldImageConfig);
     /**
      * Configure the field based on the given map of options.
+     *
      * @param config A map of options to configure the field based on.
      */
     protected configure_(config: FieldImageConfig): void;
     /**
      * Create the block UI for this image.
+     *
      * @internal
      */
     initView(): void;
     updateSize_(): void;
     /**
      * Ensure that the input value (the source URL) is a string.
+     *
      * @param opt_newValue The input value.
-     * @return A string, or null if invalid.
+     * @returns A string, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
      * Update the value of this image field, and update the displayed image.
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
     protected doValueUpdate_(newValue: any): void;
     /**
      * Get whether to flip this image in RTL
-     * @return True if we should flip in RTL.
+     *
+     * @returns True if we should flip in RTL.
      */
     getFlipRtl(): boolean;
     /**
      * Set the alt text of this image.
+     *
      * @param alt New alt text.
      */
     setAlt(alt: string | null): void;
@@ -95,6 +102,7 @@ export declare class FieldImage extends Field {
     protected showEditor_(): void;
     /**
      * Set the function that is called when this image  is clicked.
+     *
      * @param func The function that is called when the image is clicked, or null
      *     to remove.
      */
@@ -103,15 +111,17 @@ export declare class FieldImage extends Field {
      * Use the `getText_` developer hook to override the field's text
      * representation.
      * Return the image alt text instead.
-     * @return The image alt text.
+     *
+     * @returns The image alt text.
      */
     protected getText_(): string | null;
     /**
      * Construct a FieldImage from a JSON arg object,
      * dereferencing any string table references.
+     *
      * @param options A JSON object with options (src, width, height, alt, and
      *     flipRtl).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -132,3 +142,4 @@ export interface FieldImageFromJsonConfig extends FieldImageConfig {
     width?: number;
     height?: number;
 }
+//# sourceMappingURL=field_image.d.ts.map

package/core/field_label.d.ts

@@ -7,6 +7,7 @@ import { FieldConfig, Field } from './field.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for a non-editable, non-serializable text field.
+ *
  * @alias Blockly.FieldLabel
  */
 export declare class FieldLabel extends Field {
@@ -33,25 +34,29 @@ export declare class FieldLabel extends Field {
     protected configure_(config: FieldLabelConfig): void;
     /**
      * Create block UI for this label.
+     *
      * @internal
      */
     initView(): void;
     /**
      * Ensure that the input value casts to a valid string.
+     *
      * @param opt_newValue The input value.
-     * @return A valid string, or null if invalid.
+     * @returns A valid string, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
      * Set the CSS class applied to the field's textElement_.
+     *
      * @param cssClass The new CSS class name, or null to remove.
      */
     setClass(cssClass: string | null): void;
     /**
      * Construct a FieldLabel from a JSON arg object,
      * dereferencing any string table references.
+     *
      * @param options A JSON object with options (text, and class).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -69,3 +74,4 @@ export interface FieldLabelConfig extends FieldConfig {
 export interface FieldLabelFromJsonConfig extends FieldLabelConfig {
     text?: string;
 }
+//# sourceMappingURL=field_label.d.ts.map

package/core/field_label_serializable.d.ts

@@ -6,6 +6,7 @@
 import { FieldLabelConfig, FieldLabelFromJsonConfig, FieldLabel } from './field_label.js';
 /**
  * Class for a non-editable, serializable text field.
+ *
  * @alias Blockly.FieldLabelSerializable
  */
 export declare class FieldLabelSerializable extends FieldLabel {
@@ -33,10 +34,12 @@ export declare class FieldLabelSerializable extends FieldLabel {
     /**
      * Construct a FieldLabelSerializable from a JSON arg object,
      * dereferencing any string table references.
+     *
      * @param options A JSON object with options (text, and class).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
     static fromJson(options: FieldLabelFromJsonConfig): FieldLabelSerializable;
 }
+//# sourceMappingURL=field_label_serializable.d.ts.map

package/core/field_multilineinput.d.ts

@@ -7,6 +7,7 @@ import { FieldTextInputConfig, FieldTextInput } from './field_textinput.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for an editable text area field.
+ *
  * @alias Blockly.FieldMultilineInput
  */
 export declare class FieldMultilineInput extends FieldTextInput {
@@ -41,40 +42,46 @@ export declare class FieldMultilineInput extends FieldTextInput {
     protected configure_(config: FieldMultilineInputConfig): void;
     /**
      * Serializes this field's value to XML. Should only be called by Blockly.Xml.
+     *
      * @param fieldElement The element to populate with info about the field's
      *     state.
-     * @return The element containing info about the field's state.
+     * @returns The element containing info about the field's state.
      * @internal
      */
     toXml(fieldElement: Element): Element;
     /**
      * Sets the field's value based on the given XML element. Should only be
      * called by Blockly.Xml.
+     *
      * @param fieldElement The element containing info about the field's state.
      * @internal
      */
     fromXml(fieldElement: Element): void;
     /**
      * Saves this field's value.
-     * @return The state of this field.
+     *
+     * @returns The state of this field.
      * @internal
      */
     saveState(): any;
     /**
      * Sets the field's value based on the given state.
+     *
      * @param state The state of the variable to assign to this variable field.
      * @internal
      */
     loadState(state: any): void;
     /**
      * Create the block UI for this field.
+     *
      * @internal
      */
     initView(): void;
     /**
      * Get the text from this field as displayed on screen.  May differ from
      * getText due to ellipsis, and other formatting.
-     * @return Currently displayed text.
+     *
+     * @returns Currently displayed text.
      */
     protected getDisplayText_(): string;
     /**
@@ -82,6 +89,7 @@ export declare class FieldMultilineInput extends FieldTextInput {
      * field, and updates the text of the field if it is not currently being
      * edited (i.e. handled by the htmlInput_). Is being redefined here to update
      * overflow state of the field.
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
@@ -94,6 +102,7 @@ export declare class FieldMultilineInput extends FieldTextInput {
      * Show the inline free-text editor on top of the text.
      * Overrides the default behaviour to force rerender in order to
      * correct block size, based on editor text.
+     *
      * @param _opt_e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
      * @param opt_quietInput True if editor should be created without focus.
@@ -102,31 +111,36 @@ export declare class FieldMultilineInput extends FieldTextInput {
     showEditor_(_opt_e?: Event, opt_quietInput?: boolean): void;
     /**
      * Create the text input editor widget.
-     * @return The newly created text input editor.
+     *
+     * @returns The newly created text input editor.
      */
     protected widgetCreate_(): HTMLTextAreaElement;
     /**
      * Sets the maxLines config for this field.
+     *
      * @param maxLines Defines the maximum number of lines allowed, before
      *     scrolling functionality is enabled.
      */
     setMaxLines(maxLines: number): void;
     /**
      * Returns the maxLines config of this field.
-     * @return The maxLines config value.
+     *
+     * @returns The maxLines config value.
      */
     getMaxLines(): number;
     /**
      * Handle key down to the editor. Override the text input definition of this
      * so as to not close the editor when enter is typed in.
+     *
      * @param e Keyboard event.
      */
     protected onHtmlInputKeyDown_(e: Event): void;
     /**
      * Construct a FieldMultilineInput from a JSON arg object,
      * dereferencing any string table references.
+     *
      * @param options A JSON object with options (text, and spellcheck).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -144,3 +158,4 @@ export interface FieldMultilineInputConfig extends FieldTextInputConfig {
 export interface FieldMultilineInputFromJsonConfig extends FieldMultilineInputConfig {
     text?: string;
 }
+//# sourceMappingURL=field_multilineinput.d.ts.map

package/core/field_number.d.ts

@@ -7,6 +7,7 @@ import { FieldTextInputConfig, FieldTextInput } from './field_textinput.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for an editable number field.
+ *
  * @alias Blockly.FieldNumber
  */
 export declare class FieldNumber extends FieldTextInput {
@@ -48,6 +49,7 @@ export declare class FieldNumber extends FieldTextInput {
     constructor(opt_value?: string | number | Sentinel, opt_min?: string | number | null, opt_max?: string | number | null, opt_precision?: string | number | null, opt_validator?: Function | null, opt_config?: FieldNumberConfig);
     /**
      * Configure the field based on the given map of options.
+     *
      * @param config A map of options to configure the field based on.
      */
     protected configure_(config: FieldNumberConfig): void;
@@ -59,6 +61,7 @@ export declare class FieldNumber extends FieldTextInput {
      * precision. The least significant digit place is inferred from the
      * precision. Integers values can be enforces by choosing an integer
      * precision.
+     *
      * @param min Minimum value.
      * @param max Maximum value.
      * @param precision Precision for value.
@@ -67,48 +70,56 @@ export declare class FieldNumber extends FieldTextInput {
     /**
      * Sets the minimum value this field can contain. Updates the value to
      * reflect.
+     *
      * @param min Minimum value.
      */
     setMin(min: number | string | undefined | null): void;
     /**
      * Sets the minimum value this field can contain. Called internally to avoid
      * value updates.
+     *
      * @param min Minimum value.
      */
     private setMinInternal_;
     /**
      * Returns the current minimum value this field can contain. Default is
      * -Infinity.
-     * @return The current minimum value this field can contain.
+     *
+     * @returns The current minimum value this field can contain.
      */
     getMin(): number;
     /**
      * Sets the maximum value this field can contain. Updates the value to
      * reflect.
+     *
      * @param max Maximum value.
      */
     setMax(max: number | string | undefined | null): void;
     /**
      * Sets the maximum value this field can contain. Called internally to avoid
      * value updates.
+     *
      * @param max Maximum value.
      */
     private setMaxInternal_;
     /**
      * Returns the current maximum value this field can contain. Default is
      * Infinity.
-     * @return The current maximum value this field can contain.
+     *
+     * @returns The current maximum value this field can contain.
      */
     getMax(): number;
     /**
      * Sets the precision of this field's value, i.e. the number to which the
      * value is rounded. Updates the field to reflect.
+     *
      * @param precision The number to which the field's value is rounded.
      */
     setPrecision(precision: number | string | undefined | null): void;
     /**
      * Sets the precision of this field's value. Called internally to avoid
      * value updates.
+     *
      * @param precision The number to which the field's value is rounded.
      */
     private setPrecisionInternal_;
@@ -116,25 +127,29 @@ export declare class FieldNumber extends FieldTextInput {
      * 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
      * the value is not rounded.
-     * @return The number to which this field's value is rounded.
+     *
+     * @returns The number to which this field's value is rounded.
      */
     getPrecision(): number;
     /**
      * Ensure that the input value is a valid number (must fulfill the
      * constraints placed on the field).
+     *
      * @param opt_newValue The input value.
-     * @return A valid number, or null if invalid.
+     * @returns A valid number, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): number | null;
     /**
      * Create the number input editor widget.
-     * @return The newly created number input editor.
+     *
+     * @returns The newly created number input editor.
      */
     protected widgetCreate_(): HTMLElement;
     /**
      * Construct a FieldNumber from a JSON arg object.
+     *
      * @param options A JSON object with options (value, min, max, and precision).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -154,3 +169,4 @@ export interface FieldNumberConfig extends FieldTextInputConfig {
 export interface FieldNumberFromJsonConfig extends FieldNumberConfig {
     value?: number;
 }
+//# sourceMappingURL=field_number.d.ts.map