Files
blockly/core/utils/keycodes.ts
T
Christopher Allen 9eeb4fea0b fix: Correct enum formatting, use merged namespaces for types that are class static members (#6246)
* fix: formatting of enum KeyCodes

* fix: Use merged namespace for ContextMenuRegistry static types

  - Create a namespace to be merged with the ContextMenuRegistry
    class containing the types that were formerly declared as static
    properties on that class.

  - Use type aliases to export them individually as well, for
    compatibility with the changes made by MigranTS (and/or
    @gonfunko) to how other modules in core/ now import these
    types.

  - Update renamings.json5 to reflect the availability of the
    direct exports for modules that import this module directly
    (though they are not available to, and will not be used by,
    code that imports only via blockly.js/blockly.ts.)

* fix: Use merged namespace for Input.Align

  - Create a merged namespace for the Input.Align enum.

  - Use type/const aliases to export it as Input too.

  - Update renamings.json5 to reflect the availability of the
    direct export.

* fix: Use merged namespace for Names.NameType

  - Create a merged namespace for the Names.NameType enum.

  - Use type/const aliases to export it as NameType too.

  - Update renamings.json5 to reflect the availability of the
    direct export.  (This ought to have happened in an earlier
    version as it was already available by both routes.)

* chore: Fix minor issues for PR #6246

  - Use `Align` instead of `Input.Align` where possible.

* fix(build): Suppress irrelevant JSC_UNUSED_LOCAL_ASSIGNMENT errors

  tsc generates code for merged namespaces that looks like:

      (function (ClassName) {
          let EnumName;
          (function (EnumName) {
              EnumName[EnumNameAlign["v1"] = 0] = "v1";
              // etc.
          })(EnumName = ClassName.EnumName || (ClassName.EnumName = {}));
      })(ClassName || (ClassName = {}));

  and Closure Compiler complains about the fact that the EnumName let
  binding is initialised but never used.  (It exists so that any other
  code that was in the namespace could see the enum.)

  Suppress this message, since it is not actionable and lint and/or tsc
  should tell us if we have actual unused variables in our .ts files.
2022-06-29 12:14:34 +01:00

170 lines
4.3 KiB
TypeScript

/**
* @license
* Copyright 2019 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Constant declarations for common key codes.
* These methods are not specific to Blockly, and could be factored out into
* a JavaScript framework such as Closure.
*/
/**
* Constant declarations for common key codes.
* These methods are not specific to Blockly, and could be factored out into
* a JavaScript framework such as Closure.
* @namespace Blockly.utils.KeyCodes
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.utils.KeyCodes');
/**
* Key codes for common characters.
*
* Copied from Closure's goog.events.KeyCodes
*
* This list is not localized and therefore some of the key codes are not
* correct for non US keyboard layouts. See comments below.
*
* @alias Blockly.utils.KeyCodes
*/
export enum KeyCodes {
WIN_KEY_FF_LINUX = 0,
MAC_ENTER = 3,
BACKSPACE = 8,
TAB = 9,
NUM_CENTER = 12, // NUMLOCK on FF/Safari Mac
ENTER = 13,
SHIFT = 16,
CTRL = 17,
ALT = 18,
PAUSE = 19,
CAPS_LOCK = 20,
ESC = 27,
SPACE = 32,
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, // also NUM_INSERT
DELETE = 46, // also NUM_DELETE
ZERO = 48,
ONE = 49,
TWO = 50,
THREE = 51,
FOUR = 52,
FIVE = 53,
SIX = 54,
SEVEN = 55,
EIGHT = 56,
NINE = 57,
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
// Firefox (Gecko) fires this for # on UK keyboards, rather than
// Shift+SINGLE_QUOTE.
FF_HASH = 163,
QUESTION_MARK = 63, // needs localization
AT_SIGN = 64,
A = 65,
B = 66,
C = 67,
D = 68,
E = 69,
F = 70,
G = 71,
H = 72,
I = 73,
J = 74,
K = 75,
L = 76,
M = 77,
N = 78,
O = 79,
P = 80,
Q = 81,
R = 82,
S = 83,
T = 84,
U = 85,
V = 86,
W = 87,
X = 88,
Y = 89,
Z = 90,
META = 91, // WIN_KEY_LEFT
WIN_KEY_RIGHT = 92,
CONTEXT_MENU = 93,
NUM_ZERO = 96,
NUM_ONE = 97,
NUM_TWO = 98,
NUM_THREE = 99,
NUM_FOUR = 100,
NUM_FIVE = 101,
NUM_SIX = 102,
NUM_SEVEN = 103,
NUM_EIGHT = 104,
NUM_NINE = 105,
NUM_MULTIPLY = 106,
NUM_PLUS = 107,
NUM_MINUS = 109,
NUM_PERIOD = 110,
NUM_DIVISION = 111,
F1 = 112,
F2 = 113,
F3 = 114,
F4 = 115,
F5 = 116,
F6 = 117,
F7 = 118,
F8 = 119,
F9 = 120,
F10 = 121,
F11 = 122,
F12 = 123,
NUMLOCK = 144,
SCROLL_LOCK = 145,
// OS-specific media keys like volume controls and browser controls.
FIRST_MEDIA_KEY = 166,
LAST_MEDIA_KEY = 183,
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, // 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,
// "Reserved for future use". Some programs (e.g. the SlingPlayer 2.4 ActiveX
// control) fire this as a hacky way to disable screensavers.
VK_NONAME = 252,
// We've seen users whose machines fire this keycode at regular one
// second intervals. The common thread among these users is that
// they're all using Dell Inspiron laptops, so we suspect that this
// indicates a hardware/bios problem.
// http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx
PHANTOM = 255,
}