blockly 11.0.0-beta.5 → 11.0.0-beta.6

package/core/comments.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export { CommentView } from './comments/comment_view.js';
+export { WorkspaceComment } from './comments/workspace_comment.js';
+export { RenderedWorkspaceComment } from './comments/rendered_workspace_comment.js';
+//# sourceMappingURL=comments.d.ts.map

package/core/events/events_click.d.ts

@@ -13,7 +13,7 @@ import { AbstractEventJson } from './events_abstract.js';
 import { UiBase } from './events_ui_base.js';
 import { Workspace } from '../workspace.js';
 /**
- * Notifies listeners that ome blockly element was clicked.
+ * Notifies listeners that some blockly element was clicked.
  */
 export declare class Click extends UiBase {
     /** The ID of the block that was clicked, if a block was clicked. */

package/core/field_dropdown.d.ts

@@ -148,6 +148,7 @@ export declare class FieldDropdown extends Field<string> {
      * @param newValue The input value.
      * @returns A valid language-neutral option, or null if invalid.
      */
+    protected doClassValidation_(newValue: string): string | null | undefined;
     protected doClassValidation_(newValue?: string): string | null;
     /**
      * Update the value of this dropdown field.

package/core/field_image.d.ts

@@ -134,7 +134,7 @@ export interface FieldImageConfig extends FieldConfig {
     alt?: string;
 }
 /**
- * fromJson config options for the colour field.
+ * fromJson config options for the image field.
  */
 export interface FieldImageFromJsonConfig extends FieldImageConfig {
     src?: string;

package/core/generator.d.ts

@@ -254,7 +254,7 @@ export declare class CodeGenerator {
      * @param _opt_thisOnly True to generate code for only this statement.
      * @returns Code with comments and subsequent blocks added.
      */
-    protected scrub_(_block: Block, code: string, _opt_thisOnly?: boolean): string;
+    scrub_(_block: Block, code: string, _opt_thisOnly?: boolean): string;
     /**
      * Hook for code to run at end of code generation.
      * Subclasses may override this, e.g. to prepend the generated code with

package/core/gesture.d.ts

@@ -86,6 +86,8 @@ export declare class Gesture {
      * is in progress.
      */
     private workspaceDragger;
+    /** Whether the gesture is dragging or not. */
+    private dragging;
     /** The flyout a gesture started in, if any. */
     private flyout;
     /** Boolean for sanity-checking that some code is only called once. */

package/core/grid.d.ts

@@ -31,8 +31,16 @@ export declare class Grid {
      * dropped it will snap to the grid if snapping to the grid is enabled.
      */
     setSpacing(spacing: number): void;
+    /**
+     * Get the spacing of the grid points (in px).
+     *
+     * @returns The spacing of the grid points.
+     */
+    getSpacing(): number;
     /** Sets the length of the grid lines. */
     setLength(length: number): void;
+    /** Get the length of the grid lines (in px). */
+    getLength(): number;
     /**
      * Sets whether blocks should snap to the grid or not.
      *
@@ -43,19 +51,11 @@ export declare class Grid {
      */
     setSnapToGrid(snap: boolean): void;
     /**
-     * Whether blocks should snap to the grid, based on the initial configuration.
+     * Whether blocks should snap to the grid.
      *
      * @returns True if blocks should snap, false otherwise.
-     * @internal
      */
     shouldSnap(): boolean;
-    /**
-     * Get the spacing of the grid points (in px).
-     *
-     * @returns The spacing of the grid points.
-     * @internal
-     */
-    getSpacing(): number;
     /**
      * Get the ID of the pattern element, which should be randomized to avoid
      * conflicts with other Blockly instances on the page.

package/core/icons/comment_icon.d.ts

@@ -16,7 +16,7 @@ import { Size } from '../utils/size.js';
 export declare class CommentIcon extends Icon implements IHasBubble, ISerializable {
     protected readonly sourceBlock: Block;
     /** The type string used to identify this icon. */
-    static readonly TYPE: IconType<CommentIcon>;
+    static readonly TYPE: IconType<import("../interfaces/i_comment_icon.js").ICommentIcon>;
     /**
      * The weight this icon has relative to other icons. Icons with more positive
      * weight values are rendered farther toward the end of the block.
@@ -49,7 +49,7 @@ export declare class CommentIcon extends Icon implements IHasBubble, ISerializab
      * Updates the state of the bubble (editable / noneditable) to reflect the
      * state of the bubble if the bubble is currently shown.
      */
-    updateEditable(): void;
+    updateEditable(): Promise<void>;
     onLocationChange(blockOrigin: Coordinate): void;
     /** Sets the text of this comment. Updates any bubbles if they are visible. */
     setText(text: string): void;
@@ -82,7 +82,7 @@ export declare class CommentIcon extends Icon implements IHasBubble, ISerializab
      */
     onSizeChange(): void;
     bubbleIsVisible(): boolean;
-    setBubbleVisible(visible: boolean): void;
+    setBubbleVisible(visible: boolean): Promise<void>;
     /**
      * Shows the editable text bubble for this comment, and adds change listeners
      * to update the state of this icon in response to changes in the bubble.

package/core/icons/icon.d.ts

@@ -59,11 +59,5 @@ export declare abstract class Icon implements IIcon {
      * @returns Whether the icon should be clickable while the block is in a flyout.
      */
     isClickableInFlyout(autoClosingFlyout: boolean): boolean;
-    /**
-     * Sets the visibility of the icon's bubble if one exists.
-     *
-     * @deprecated Use `setBubbleVisible` instead. To be removed in v11.
-     */
-    setVisible(visibility: boolean): void;
 }
 //# sourceMappingURL=icon.d.ts.map

package/core/icons/icon_types.d.ts

@@ -3,8 +3,8 @@
  * Copyright 2023 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { ICommentIcon } from '../interfaces/i_comment_icon.js';
 import { IIcon } from '../interfaces/i_icon.js';
-import { CommentIcon } from './comment_icon.js';
 import { MutatorIcon } from './mutator_icon.js';
 import { WarningIcon } from './warning_icon.js';
 /**
@@ -20,6 +20,6 @@ export declare class IconType<_T extends IIcon> {
     equals(type: IconType<IIcon>): boolean;
     static MUTATOR: IconType<MutatorIcon>;
     static WARNING: IconType<WarningIcon>;
-    static COMMENT: IconType<CommentIcon>;
+    static COMMENT: IconType<ICommentIcon>;
 }
 //# sourceMappingURL=icon_types.d.ts.map

package/core/icons/mutator_icon.d.ts

@@ -4,9 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import type { Abstract } from '../events/events_abstract.js';
-import type { Block } from '../block.js';
 import type { BlockSvg } from '../block_svg.js';
-import type { Connection } from '../connection.js';
 import { Coordinate } from '../utils/coordinate.js';
 import type { IHasBubble } from '../interfaces/i_has_bubble.js';
 import { Icon } from './icon.js';
@@ -55,7 +53,7 @@ export declare class MutatorIcon extends Icon implements IHasBubble {
     onClick(): void;
     isClickableInFlyout(): boolean;
     bubbleIsVisible(): boolean;
-    setBubbleVisible(visible: boolean): void;
+    setBubbleVisible(visible: boolean): Promise<void>;
     /** @returns the configuration the mini workspace should have. */
     private getMiniWorkspaceConfig;
     /**
@@ -91,18 +89,5 @@ export declare class MutatorIcon extends Icon implements IHasBubble {
      *     currently open.
      */
     getWorkspace(): WorkspaceSvg | undefined;
-    /**
-     * Reconnects the given connection to the mutated input on the given block.
-     *
-     * @deprecated Use connection.reconnect instead. To be removed in v11.
-     */
-    static reconnect(connectionChild: Connection | null, block: Block, inputName: string): boolean;
-    /**
-     * Returns the parent workspace of a workspace that is inside a mini workspace
-     * bubble, taking into account whether the workspace is a flyout.
-     *
-     * @deprecated Use workspace.getRootWorkspace. To be removed in v11.
-     */
-    static findParentWs(workspace: WorkspaceSvg): WorkspaceSvg | null;
 }
 //# sourceMappingURL=mutator_icon.d.ts.map

package/core/icons/warning_icon.d.ts

@@ -59,7 +59,7 @@ export declare class WarningIcon extends Icon implements IHasBubble {
     onClick(): void;
     isClickableInFlyout(): boolean;
     bubbleIsVisible(): boolean;
-    setBubbleVisible(visible: boolean): void;
+    setBubbleVisible(visible: boolean): Promise<void>;
     /**
      * @returns the location the bubble should be anchored to.
      *     I.E. the middle of this icon.

package/core/inputs/input.d.ts

@@ -15,13 +15,14 @@ import type { Connection } from '../connection.js';
 import type { ConnectionType } from '../connection_type.js';
 import type { Field } from '../field.js';
 import { inputTypes } from './input_types.js';
+import { Align } from './align.js';
 /** Class for an input with optional fields. */
 export declare class Input {
     name: string;
     private sourceBlock;
     fieldRow: Field[];
     /** Alignment of input's fields (left, right or centre). */
-    align: Input.Align;
+    align: Align;
     /** Is the input visible? */
     private visible;
     readonly type: inputTypes;
@@ -121,6 +122,14 @@ export declare class Input {
     getShadowDom(): Element | null;
     /** Initialize the fields on this input. */
     init(): void;
+    /**
+     * Initializes the fields on this input for a headless block.
+     *
+     * @internal
+     */
+    initModel(): void;
+    /** Initializes the given field. */
+    private initField;
     /**
      * Sever all links to this input.
      */
@@ -135,22 +144,4 @@ export declare class Input {
      */
     protected makeConnection(type: ConnectionType): Connection;
 }
-export declare namespace Input {
-    /**
-     * Enum for alignment of inputs.
-     *
-     * @deprecated Use Blockly.inputs.Align. To be removed in v11.
-     */
-    enum Align {
-        LEFT = -1,
-        CENTRE = 0,
-        RIGHT = 1
-    }
-}
-/** @deprecated Use Blockly.inputs.Align. To be removed in v11. */
-/** @suppress {deprecated} */
-export type Align = Input.Align;
-/** @deprecated Use Blockly.inputs.Align. To be removed in v11. */
-/** @suppress {deprecated} */
-export declare const Align: typeof Input.Align;
 //# sourceMappingURL=input.d.ts.map

package/core/{connection_previewers/insertion_marker_previewer.d.ts → insertion_marker_previewer.d.ts}

@@ -3,9 +3,9 @@
  * Copyright 2024 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
-import { BlockSvg } from '../block_svg.js';
-import { IConnectionPreviewer } from '../interfaces/i_connection_previewer.js';
-import { RenderedConnection } from '../rendered_connection.js';
+import { BlockSvg } from './block_svg.js';
+import { IConnectionPreviewer } from './interfaces/i_connection_previewer.js';
+import { RenderedConnection } from './rendered_connection.js';
 export declare class InsertionMarkerPreviewer implements IConnectionPreviewer {
     private readonly workspace;
     private fadedBlock;

package/core/interfaces/i_comment_icon.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IIcon } from './i_icon.js';
+import { Size } from '../utils/size.js';
+import { IHasBubble } from './i_has_bubble.js';
+export interface ICommentIcon extends IIcon, IHasBubble {
+    setText(text: string): void;
+    getText(): string;
+    setBubbleSize(size: Size): void;
+    getBubbleSize(): Size;
+}
+/** Checks whether the given object is an ICommentIcon. */
+export declare function isCommentIcon(obj: Object): obj is ICommentIcon;
+//# sourceMappingURL=i_comment_icon.d.ts.map

package/core/interfaces/i_has_bubble.d.ts

@@ -7,7 +7,7 @@ export interface IHasBubble {
     /** @returns True if the bubble is currently open, false otherwise. */
     bubbleIsVisible(): boolean;
     /** Sets whether the bubble is open or not. */
-    setBubbleVisible(visible: boolean): void;
+    setBubbleVisible(visible: boolean): Promise<void>;
 }
 /** Type guard that checks whether the given object is a IHasBubble. */
 export declare function hasBubble(obj: any): obj is IHasBubble;

package/core/interfaces/i_parameter_model.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { ParameterState } from '../serialization/procedures';
 import { IProcedureModel } from './i_procedure_model';
 /**
  * A data model for a procedure.
@@ -33,5 +34,11 @@ export interface IParameterModel {
     getId(): string;
     /** Sets the procedure model this parameter is associated with. */
     setProcedureModel(model: IProcedureModel): this;
+    /**
+     * Serializes the state of the parameter to JSON.
+     *
+     * @returns JSON serializable state of the parameter.
+     */
+    saveState(): ParameterState;
 }
 //# sourceMappingURL=i_parameter_model.d.ts.map

package/core/interfaces/i_procedure_model.d.ts

@@ -3,6 +3,7 @@
  * Copyright 2022 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
+import { State } from '../serialization/procedures.js';
 import { IParameterModel } from './i_parameter_model.js';
 /**
  * A data model for a procedure.
@@ -48,5 +49,11 @@ export interface IProcedureModel {
      * disabled, all procedure caller blocks should be disabled as well.
      */
     getEnabled(): boolean;
+    /**
+     * Serializes the state of the procedure to JSON.
+     *
+     * @returns JSON serializable state of the procedure.
+     */
+    saveState(): State;
 }
 //# sourceMappingURL=i_procedure_model.d.ts.map

package/core/options.d.ts

@@ -32,6 +32,7 @@ export declare class Options {
     pathToMedia: string;
     hasCategories: boolean;
     moveOptions: MoveOptions;
+    /** @deprecated  January 2019 */
     hasScrollbars: boolean;
     hasTrashcan: boolean;
     maxTrashcanContents: number;

package/core/renderers/common/drawer.d.ts

@@ -38,13 +38,6 @@ export declare class Drawer {
      * required.
      */
     draw(): void;
-    /**
-     * Hide icons that were marked as hidden.
-     *
-     * @deprecated Manually hiding icons is no longer necessary. To be removed
-     *     in v11.
-     */
-    protected hideHiddenIcons_(): void;
     /**
      * Save sizing information back to the block
      * Most of the rendering information can be thrown away at the end of the

package/core/renderers/measurables/icon.d.ts

@@ -12,11 +12,6 @@ import { Measurable } from './base.js';
  */
 export declare class Icon extends Measurable {
     icon: BlocklyIcon;
-    /**
-     * @deprecated Will be removed in v11. Create a subclass of the Icon
-     *     measurable if this data is necessary for you.
-     */
-    isVisible: boolean;
     flipRtl: boolean;
     /**
      * An object containing information about the space an icon takes up during

package/core/serialization/priorities.d.ts

@@ -15,4 +15,6 @@ export declare const PROCEDURES = 75;
  * The priority for deserializing blocks.
  */
 export declare const BLOCKS = 50;
+/** The priority for deserializing workspace comments. */
+export declare const WORKSPACE_COMMENTS = 25;
 //# sourceMappingURL=priorities.d.ts.map

package/core/serialization/procedures.d.ts

@@ -7,63 +7,65 @@ import { IParameterModel } from '../interfaces/i_parameter_model.js';
 import { IProcedureModel } from '../interfaces/i_procedure_model.js';
 import type { ISerializer } from '../interfaces/i_serializer.js';
 import type { Workspace } from '../workspace.js';
-/**
- * Representation of a procedure data model.
- */
+/** Represents the state of a procedure model. */
 export interface State {
     id: string;
     name: string;
     returnTypes: string[] | null;
     parameters?: ParameterState[];
+    [key: string]: unknown;
 }
-/**
- * Representation of a parameter data model.
- */
+/** Represents the state of a parameter model. */
 export interface ParameterState {
     id: string;
     name: string;
     types?: string[];
+    [key: string]: unknown;
 }
 /**
  * A newable signature for an IProcedureModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
+ * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
  * for what is going on with this.
  */
-type ProcedureModelConstructor<ProcedureModel extends IProcedureModel> = new (workspace: Workspace, name: string, id: string) => ProcedureModel;
+interface ProcedureModelConstructor<ProcedureModel extends IProcedureModel> {
+    new (workspace: Workspace, name: string, id: string): ProcedureModel;
+    /**
+     * Deserializes the JSON state and returns a procedure model.
+     *
+     * @param state The state to deserialize.
+     * @param workspace The workspace to load the procedure model into.
+     * @returns The constructed procedure model.
+     */
+    loadState(state: Object, workspace: Workspace): ProcedureModel;
+}
 /**
  * A newable signature for an IParameterModel.
  *
  * Refer to
- * https://www.typescriptlang.org/docs/handbook/2/generics.html#using-class-types-in-generics
+ * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes
  * for what is going on with this.
  */
-type ParameterModelConstructor<ParameterModel extends IParameterModel> = new (workspace: Workspace, name: string, id: string) => ParameterModel;
+interface ParameterModelConstructor<ParameterModel extends IParameterModel> {
+    new (workspace: Workspace, name: string, id: string): ParameterModel;
+    /**
+     * Deserializes the JSON state and returns a parameter model.
+     *
+     * @param state The state to deserialize.
+     * @param workspace The workspace to load the parameter model into.
+     * @returns The constructed parameter model.
+     */
+    loadState(state: Object, workspace: Workspace): ParameterModel;
+}
 /**
  * Serializes the given IProcedureModel to JSON.
- *
- * @internal
  */
 export declare function saveProcedure(proc: IProcedureModel): State;
-/**
- * Serializes the given IParameterModel to JSON.
- *
- * @internal
- */
-export declare function saveParameter(param: IParameterModel): ParameterState;
 /**
  * Deserializes the given procedure model State from JSON.
- *
- * @internal
  */
 export declare function loadProcedure<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel>(procedureModelClass: ProcedureModelConstructor<ProcedureModel>, parameterModelClass: ParameterModelConstructor<ParameterModel>, state: State, workspace: Workspace): ProcedureModel;
-/**
- * Deserializes the given ParameterState from JSON.
- *
- * @internal
- */
-export declare function loadParameter<ParameterModel extends IParameterModel>(parameterModelClass: ParameterModelConstructor<ParameterModel>, state: ParameterState, workspace: Workspace): ParameterModel;
 /** Serializer for saving and loading procedure state. */
 export declare class ProcedureSerializer<ProcedureModel extends IProcedureModel, ParameterModel extends IParameterModel> implements ISerializer {
     private readonly procedureModelClass;

package/core/serialization/workspace_comments.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ISerializer } from '../interfaces/i_serializer.js';
+import { Workspace } from '../workspace.js';
+import { WorkspaceComment } from '../comments/workspace_comment.js';
+export interface State {
+    id?: string;
+    text?: string;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    collapsed?: boolean;
+    editable?: boolean;
+    movable?: boolean;
+    deletable?: boolean;
+}
+/** Serializes the state of the given comment to JSON. */
+export declare function save(comment: WorkspaceComment, { addCoordinates, saveIds, }?: {
+    addCoordinates?: boolean;
+    saveIds?: boolean;
+}): State;
+/** Appends the comment defined by the given state to the given workspace. */
+export declare function append(state: State, workspace: Workspace, { recordUndo }?: {
+    recordUndo?: boolean;
+}): WorkspaceComment;
+/** Serializer for saving and loading workspace comment state. */
+export declare class WorkspaceCommentSerializer implements ISerializer {
+    priority: number;
+    /**
+     * Returns the state of all workspace comments in the given workspace.
+     */
+    save(workspace: Workspace): State[] | null;
+    /**
+     * Deserializes the comments defined by the given state into the given
+     * workspace.
+     */
+    load(state: State[], workspace: Workspace): void;
+    /** Disposes of any comments that exist on the given workspace. */
+    clear(workspace: Workspace): void;
+}
+//# sourceMappingURL=workspace_comments.d.ts.map

package/core/serialization.d.ts

@@ -13,6 +13,7 @@ import * as procedures from './serialization/procedures.js';
 import * as registry from './serialization/registry.js';
 import * as variables from './serialization/variables.js';
 import * as workspaces from './serialization/workspaces.js';
+import * as workspaceComments from './serialization/workspace_comments.js';
 import { ISerializer } from './interfaces/i_serializer.js';
-export { blocks, exceptions, priorities, procedures, registry, variables, workspaces, ISerializer, };
+export { blocks, exceptions, priorities, procedures, registry, variables, workspaces, workspaceComments, ISerializer, };
 //# sourceMappingURL=serialization.d.ts.map

package/core/utils/dom.d.ts

@@ -86,15 +86,6 @@ export declare function removeNode(node: Node | null): Node | null;
  * @param refNode Existing element to precede new node.
  */
 export declare function insertAfter(newNode: Element, refNode: Element): void;
-/**
- * Whether a node contains another node.
- *
- * @param parent The node that should contain the other node.
- * @param descendant The node to test presence of.
- * @returns Whether the parent node contains the descendant node.
- * @deprecated Use native 'contains' DOM method.
- */
-export declare function containsNode(parent: Node, descendant: Node): boolean;
 /**
  * Sets the CSS transform property on an element. This function sets the
  * non-vendor-prefixed and vendor-prefixed versions for backwards compatibility

package/core/utils/keycodes.d.ts

@@ -16,7 +16,7 @@ export declare enum KeyCodes {
     MAC_ENTER = 3,
     BACKSPACE = 8,
     TAB = 9,
-    NUM_CENTER = 12,
+    NUM_CENTER = 12,// NUMLOCK on FF/Safari Mac
     ENTER = 13,
     SHIFT = 16,
     CTRL = 17,
@@ -25,18 +25,18 @@ export declare enum KeyCodes {
     CAPS_LOCK = 20,
     ESC = 27,
     SPACE = 32,
-    PAGE_UP = 33,
-    PAGE_DOWN = 34,
-    END = 35,
-    HOME = 36,
-    LEFT = 37,
-    UP = 38,
-    RIGHT = 39,
-    DOWN = 40,
-    PLUS_SIGN = 43,
+    PAGE_UP = 33,// also NUM_NORTH_EAST
+    PAGE_DOWN = 34,// also NUM_SOUTH_EAST
+    END = 35,// also NUM_SOUTH_WEST
+    HOME = 36,// also NUM_NORTH_WEST
+    LEFT = 37,// also NUM_WEST
+    UP = 38,// also NUM_NORTH
+    RIGHT = 39,// also NUM_EAST
+    DOWN = 40,// also NUM_SOUTH
+    PLUS_SIGN = 43,// NOT numpad plus
     PRINT_SCREEN = 44,
-    INSERT = 45,
-    DELETE = 46,
+    INSERT = 45,// also NUM_INSERT
+    DELETE = 46,// also NUM_DELETE
     ZERO = 48,
     ONE = 49,
     TWO = 50,
@@ -47,11 +47,11 @@ export declare enum KeyCodes {
     SEVEN = 55,
     EIGHT = 56,
     NINE = 57,
-    FF_SEMICOLON = 59,
-    FF_EQUALS = 61,
-    FF_DASH = 173,
+    FF_SEMICOLON = 59,// Firefox (Gecko) fires this for semicolon instead of 186
+    FF_EQUALS = 61,// Firefox (Gecko) fires this for equals instead of 187
+    FF_DASH = 173,// Firefox (Gecko) fires this for dash instead of 189
     FF_HASH = 163,
-    QUESTION_MARK = 63,
+    QUESTION_MARK = 63,// needs localization
     AT_SIGN = 64,
     A = 65,
     B = 66,
@@ -79,7 +79,7 @@ export declare enum KeyCodes {
     X = 88,
     Y = 89,
     Z = 90,
-    META = 91,
+    META = 91,// WIN_KEY_LEFT
     WIN_KEY_RIGHT = 92,
     CONTEXT_MENU = 93,
     NUM_ZERO = 96,
@@ -113,22 +113,22 @@ export declare enum KeyCodes {
     SCROLL_LOCK = 145,
     FIRST_MEDIA_KEY = 166,
     LAST_MEDIA_KEY = 183,
-    SEMICOLON = 186,
-    DASH = 189,
-    EQUALS = 187,
-    COMMA = 188,
-    PERIOD = 190,
-    SLASH = 191,
-    APOSTROPHE = 192,
-    TILDE = 192,
-    SINGLE_QUOTE = 222,
-    OPEN_SQUARE_BRACKET = 219,
-    BACKSLASH = 220,
-    CLOSE_SQUARE_BRACKET = 221,
+    SEMICOLON = 186,// needs localization
+    DASH = 189,// needs localization
+    EQUALS = 187,// needs localization
+    COMMA = 188,// needs localization
+    PERIOD = 190,// needs localization
+    SLASH = 191,// needs localization
+    APOSTROPHE = 192,// needs localization
+    TILDE = 192,// needs localization
+    SINGLE_QUOTE = 222,// needs localization
+    OPEN_SQUARE_BRACKET = 219,// needs localization
+    BACKSLASH = 220,// needs localization
+    CLOSE_SQUARE_BRACKET = 221,// needs localization
     WIN_KEY = 224,
-    MAC_FF_META = 224,
-    MAC_WK_CMD_LEFT = 91,
-    MAC_WK_CMD_RIGHT = 93,
+    MAC_FF_META = 224,// Firefox (Gecko) fires this for the meta key instead of 91
+    MAC_WK_CMD_LEFT = 91,// WebKit Left Command key fired, same as META
+    MAC_WK_CMD_RIGHT = 93,// WebKit Right Command key fired, different from META
     WIN_IME = 229,
     VK_NONAME = 252,
     PHANTOM = 255