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

package/core/field_registry.d.ts

@@ -9,6 +9,7 @@ import type { IRegistrableField } from './interfaces/i_registrable_field.js';
  * Registers a field type.
  * fieldRegistry.fromJson uses this registry to
  * find the appropriate field type.
+ *
  * @param type The field type name as used in the JSON definition.
  * @param fieldClass The field class containing a fromJson function that can
  *     construct an instance of the field.
@@ -19,6 +20,7 @@ import type { IRegistrableField } from './interfaces/i_registrable_field.js';
 export declare function register(type: string, fieldClass: IRegistrableField): void;
 /**
  * Unregisters the field registered with the given type.
+ *
  * @param type The field type name as used in the JSON definition.
  * @alias Blockly.fieldRegistry.unregister
  */
@@ -27,19 +29,23 @@ export declare function unregister(type: string): void;
  * Construct a Field from a JSON arg object.
  * Finds the appropriate registered field by the type name as registered using
  * fieldRegistry.register.
+ *
  * @param options A JSON object with a type and options specific to the field
  *     type.
- * @return The new field instance or null if a field wasn't found with the given
- *     type name
+ * @returns The new field instance or null if a field wasn't found with the
+ *     given type name
  * @alias Blockly.fieldRegistry.fromJson
  * @internal
  */
 export declare function fromJson(options: any): Field | null;
 /**
  * Private version of fromJson for stubbing in tests.
+ *
+ * @param options
  */
 declare function fromJsonInternal(options: any): Field | null;
 export declare const TEST_ONLY: {
     fromJsonInternal: typeof fromJsonInternal;
 };
 export {};
+//# sourceMappingURL=field_registry.d.ts.map

package/core/field_textinput.d.ts

@@ -9,6 +9,7 @@ import type { Sentinel } from './utils/sentinel.js';
 import type { WorkspaceSvg } from './workspace_svg.js';
 /**
  * Class for an editable text field.
+ *
  * @alias Blockly.FieldTextInput
  */
 export declare class FieldTextInput extends Field {
@@ -68,14 +69,16 @@ export declare class FieldTextInput extends Field {
     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): any;
     /**
      * Called by setValue if the text input is not valid. If the field is
      * currently being edited it reverts value of the field to the previous
      * value while allowing the display text to be handled by the htmlInput_.
+     *
      * @param _invalidValue The input value that was determined to be invalid.
      *    This is not used by the text input because its display value is stored
      * on the htmlInput_.
@@ -85,12 +88,14 @@ export declare class FieldTextInput extends Field {
      * Called by setValue if the text input is valid. Updates the value of the
      * field, and updates the text of the field if it is not currently being
      * edited (i.e. handled by the htmlInput_).
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a string.
      */
     protected doValueUpdate_(newValue: any): void;
     /**
      * Updates text field to match the colour/style of the block.
+     *
      * @internal
      */
     applyColour(): void;
@@ -101,11 +106,13 @@ export declare class FieldTextInput extends Field {
     protected render_(): void;
     /**
      * Set whether this field is spellchecked by the browser.
+     *
      * @param check True if checked.
      */
     setSpellcheck(check: boolean): void;
     /**
      * Show the inline free-text editor on top of the 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.
@@ -119,12 +126,14 @@ export declare class FieldTextInput extends Field {
     private showPromptEditor_;
     /**
      * Create and show a text input editor that sits directly over the text input.
+     *
      * @param quietInput True if editor should be created without focus.
      */
     private showInlineEditor_;
     /**
      * Create the text input editor widget.
-     * @return The newly created text input editor.
+     *
+     * @returns The newly created text input editor.
      */
     protected widgetCreate_(): HTMLElement;
     /**
@@ -134,11 +143,13 @@ export declare class FieldTextInput extends Field {
     protected widgetDispose_(): void;
     /**
      * A callback triggered when the user is done editing the field via the UI.
+     *
      * @param _value The new value of the field.
      */
     onFinishEditing_(_value: any): void;
     /**
      * Bind handlers for user input on the text input field's editor.
+     *
      * @param htmlInput The htmlInput to which event handlers will be bound.
      */
     protected bindInputEvents_(htmlInput: HTMLElement): void;
@@ -146,18 +157,21 @@ export declare class FieldTextInput extends Field {
     protected unbindInputEvents_(): void;
     /**
      * Handle key down to the editor.
+     *
      * @param e Keyboard event.
      */
     protected onHtmlInputKeyDown_(e: Event): void;
     /**
      * Handle a change to the editor.
+     *
      * @param _e Keyboard event.
      */
     private onHtmlInputChange_;
     /**
      * Set the HTML input value and the field's internal value. The difference
-     * between this and ``setValue`` is that this also updates the HTML input
+     * between this and `setValue` is that this also updates the HTML input
      * value whilst editing.
+     *
      * @param newValue New value.
      */
     protected setEditorValue_(newValue: any): void;
@@ -165,7 +179,8 @@ export declare class FieldTextInput extends Field {
     protected resizeEditor_(): void;
     /**
      * Returns whether or not the field is tab navigable.
-     * @return True if the field is tab navigable.
+     *
+     * @returns True if the field is tab navigable.
      */
     isTabNavigable(): boolean;
     /**
@@ -173,7 +188,8 @@ export declare class FieldTextInput extends Field {
      * representation. When we're currently editing, return the current HTML value
      * instead. Otherwise, return null which tells the field to use the default
      * behaviour (which is a string cast of the field's value).
-     * @return The HTML value if we're editing, otherwise null.
+     *
+     * @returns The HTML value if we're editing, otherwise null.
      */
     protected getText_(): string | null;
     /**
@@ -181,8 +197,9 @@ export declare class FieldTextInput extends Field {
      * Override this method if the field's HTML input representation is different
      * than the field's value. This should be coupled with an override of
      * `getValueFromEditorText_`.
+     *
      * @param value The value stored in this field.
-     * @return The text to show on the HTML input.
+     * @returns The text to show on the HTML input.
      */
     protected getEditorText_(value: any): string;
     /**
@@ -191,15 +208,17 @@ export declare class FieldTextInput extends Field {
      * Override this method if the field's HTML input representation is different
      * than the field's value. This should be coupled with an override of
      * `getEditorText_`.
+     *
      * @param text Text received from the HTML input.
-     * @return The value to store.
+     * @returns The value to store.
      */
     protected getValueFromEditorText_(text: string): any;
     /**
      * Construct a FieldTextInput 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
      */
@@ -217,3 +236,4 @@ export interface FieldTextInputConfig extends FieldConfig {
 export interface FieldTextInputFromJsonConfig extends FieldTextInputConfig {
     text?: string;
 }
+//# sourceMappingURL=field_textinput.d.ts.map

package/core/field_variable.d.ts

@@ -14,6 +14,7 @@ import { Size } from './utils/size.js';
 import { VariableModel } from './variable_model.js';
 /**
  * Class for a variable's dropdown field.
+ *
  * @alias Blockly.FieldVariable
  */
 export declare class FieldVariable extends FieldDropdown {
@@ -56,6 +57,7 @@ export declare class FieldVariable extends FieldDropdown {
     constructor(varName: string | null | Sentinel, opt_validator?: Function, opt_variableTypes?: string[], opt_defaultType?: string, opt_config?: FieldVariableConfig);
     /**
      * 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: FieldVariableConfig): void;
@@ -63,59 +65,68 @@ export declare class FieldVariable extends FieldDropdown {
      * Initialize the model for this field if it has not already been initialized.
      * If the value has not been set to a variable by the first render, we make up
      * a variable rather than let the value be invalid.
+     *
      * @internal
      */
     initModel(): void;
     shouldAddBorderRect_(): boolean;
     /**
      * Initialize this field based on the given XML.
+     *
      * @param fieldElement The element containing information about the variable
      *     field's state.
      */
     fromXml(fieldElement: Element): void;
     /**
      * Serialize this field to 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.
      */
     toXml(fieldElement: Element): Element;
     /**
      * Saves this field's value.
+     *
      * @param doFullSerialization If true, the variable field will serialize the
      *     full state of the field being referenced (ie ID, name, and type) rather
      *     than just a reference to it (ie ID).
-     * @return The state of the variable field.
+     * @returns The state of the variable field.
      * @internal
      */
     saveState(doFullSerialization?: boolean): 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;
     /**
      * Attach this field to a block.
+     *
      * @param block The block containing this field.
      */
     setSourceBlock(block: Block): void;
     /**
      * Get the variable's ID.
-     * @return Current variable's ID.
+     *
+     * @returns Current variable's ID.
      */
     getValue(): string | null;
     /**
      * Get the text from this field, which is the selected variable's name.
-     * @return The selected variable's name, or the empty string if no variable is
-     *     selected.
+     *
+     * @returns The selected variable's name, or the empty string if no variable
+     *     is selected.
      */
     getText(): string;
     /**
      * Get the variable model for the selected variable.
      * Not guaranteed to be in the variable map on the workspace (e.g. if accessed
      * after the variable has been deleted).
-     * @return The selected variable, or null if none was selected.
+     *
+     * @returns The selected variable, or null if none was selected.
      * @internal
      */
     getVariable(): VariableModel | null;
@@ -124,13 +135,15 @@ export declare class FieldVariable extends FieldDropdown {
      * Returns null if the variable is not set, because validators should not
      * run on the initial setValue call, because the field won't be attached to
      * a block and workspace at that point.
-     * @return Validation function, or null.
+     *
+     * @returns Validation function, or null.
      */
     getValidator(): Function | null;
     /**
      * Ensure that the ID belongs to a valid variable of an allowed type.
+     *
      * @param opt_newValue The ID of the new variable to set.
-     * @return The validated ID, or null if invalid.
+     * @returns The validated ID, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
@@ -138,24 +151,28 @@ export declare class FieldVariable extends FieldDropdown {
      *
      * The variable ID should be valid at this point, but if a variable field
      * validator returns a bad ID, this could break.
+     *
      * @param newId The value to be saved.
      */
     protected doValueUpdate_(newId: any): void;
     /**
      * Check whether the given variable type is allowed on this field.
+     *
      * @param type The type to check.
-     * @return True if the type is in the list of allowed types.
+     * @returns True if the type is in the list of allowed types.
      */
     private typeIsAllowed_;
     /**
      * Return a list of variable types to include in the dropdown.
-     * @return Array of variable types.
+     *
+     * @returns Array of variable types.
      * @throws {Error} if variableTypes is an empty array.
      */
     private getVariableTypes_;
     /**
      * Parse the optional arguments representing the allowed variable types and
      * the default variable type.
+     *
      * @param opt_variableTypes A list of the types of variables to include in the
      *     dropdown.  If null or undefined, variables of all types will be
      *     displayed in the dropdown.
@@ -167,6 +184,7 @@ export declare class FieldVariable extends FieldDropdown {
      * Refreshes the name of the variable by grabbing the name of the model.
      * Used when a variable gets renamed, but the ID stays the same. Should only
      * be called by the block.
+     *
      * @internal
      */
     refreshVariableName(): void;
@@ -174,6 +192,7 @@ export declare class FieldVariable extends FieldDropdown {
      * Handle the selection of an item in the variable dropdown menu.
      * Special case the 'Rename variable...' and 'Delete variable...' options.
      * In the rename case, prompt the user for a new name.
+     *
      * @param menu The Menu component clicked.
      * @param menuItem The MenuItem selected within menu.
      */
@@ -181,16 +200,18 @@ export declare class FieldVariable extends FieldDropdown {
     /**
      * Overrides referencesVariables(), indicating this field refers to a
      * variable.
-     * @return True.
+     *
+     * @returns True.
      * @internal
      */
     referencesVariables(): boolean;
     /**
      * Construct a FieldVariable from a JSON arg object,
      * dereferencing any string table references.
+     *
      * @param options A JSON object with options (variable, variableTypes, and
      *     defaultType).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -198,7 +219,8 @@ export declare class FieldVariable extends FieldDropdown {
     /**
      * Return a sorted list of variable names for variable dropdown menus.
      * Include a special option at the end for creating a new variable name.
-     * @return Array of variable names/id tuples.
+     *
+     * @returns Array of variable names/id tuples.
      */
     static dropdownCreate(this: FieldVariable): any[][];
 }
@@ -215,3 +237,4 @@ export interface FieldVariableConfig extends FieldConfig {
 export interface FieldVariableFromJsonConfig extends FieldVariableConfig {
     variable?: string;
 }
+//# sourceMappingURL=field_variable.d.ts.map