packages/shared/lib/interfaces/Hotkeys.ts

   1 // The following enum was initially taken from
   2 // https://github.com/ashubham/w3c-keys/blob/master/dist/index.d.ts
   3 export enum KeyboardKey {
   4     Backspace = 'Backspace',
   5     Tab = 'Tab',
   6     Enter = 'Enter',
   7     Shift = 'Shift',
   8     Control = 'Control',
   9     Alt = 'Alt',
  10     CapsLock = 'CapsLock',
  11     Escape = 'Escape',
  12     Space = ' ',
  13     Spacebar = ' ',
  14     PageUp = 'PageUp',
  15     PageDown = 'PageDown',
  16     End = 'End',
  17     Home = 'Home',
  18     ArrowLeft = 'ArrowLeft',
  19     ArrowUp = 'ArrowUp',
  20     ArrowRight = 'ArrowRight',
  21     ArrowDown = 'ArrowDown',
  22     Left = 'Left',
  23     Up = 'Up',
  24     Right = 'Right',
  25     Down = 'Down',
  26     Insert = 'Insert',
  27     Delete = 'Delete',
  28     Zero = '0',
  29     ClosedParen = ')',
  30     One = '1',
  31     ExclamationMark = '!',
  32     Two = '2',
  33     AtSign = '@',
  34     Three = '3',
  35     PoundSign = '\u00A3',
  36     Hash = '#',
  37     Four = '4',
  38     DollarSign = '$',
  39     Five = '5',
  40     PercentSign = '%',
  41     Six = '6',
  42     Caret = '^',
  43     Hat = '^',
  44     Seven = '7',
  45     Ampersand = '&',
  46     Eight = '8',
  47     Star = '*',
  48     Asterisk = '*',
  49     Nine = '9',
  50     OpenParen = '(',
  51     a = 'a',
  52     b = 'b',
  53     c = 'c',
  54     d = 'd',
  55     e = 'e',
  56     f = 'f',
  57     g = 'g',
  58     h = 'h',
  59     i = 'i',
  60     j = 'j',
  61     k = 'k',
  62     l = 'l',
  63     m = 'm',
  64     n = 'n',
  65     o = 'o',
  66     p = 'p',
  67     q = 'q',
  68     r = 'r',
  69     s = 's',
  70     t = 't',
  71     u = 'u',
  72     v = 'v',
  73     w = 'w',
  74     x = 'x',
  75     y = 'y',
  76     z = 'z',
  77     A = 'A',
  78     B = 'B',
  79     C = 'C',
  80     D = 'D',
  81     E = 'E',
  82     F = 'F',
  83     G = 'G',
  84     H = 'H',
  85     I = 'I',
  86     J = 'J',
  87     K = 'K',
  88     L = 'L',
  89     M = 'M',
  90     N = 'N',
  91     O = 'O',
  92     P = 'P',
  93     Q = 'Q',
  94     R = 'R',
  95     S = 'S',
  96     T = 'T',
  97     U = 'U',
  98     V = 'V',
  99     W = 'W',
 100     X = 'X',
 101     Y = 'Y',
 102     Z = 'Z',
 103     Meta = 'Meta',
 104     LeftWindowKey = 'Meta',
 105     RightWindowKey = 'Meta',
 106     Numpad0 = '0',
 107     Numpad1 = '1',
 108     Numpad2 = '2',
 109     Numpad3 = '3',
 110     Numpad4 = '4',
 111     Numpad5 = '5',
 112     Numpad6 = '6',
 113     Numpad7 = '7',
 114     Numpad8 = '8',
 115     Numpad9 = '9',
 116     Multiply = '*',
 117     Add = '+',
 118     Subtract = '-',
 119     DecimalPoint = '.',
 120     MSDecimalPoint = 'Decimal',
 121     Divide = '/',
 122     F1 = 'F1',
 123     F2 = 'F2',
 124     F3 = 'F3',
 125     F4 = 'F4',
 126     F5 = 'F5',
 127     F6 = 'F6',
 128     F7 = 'F7',
 129     F8 = 'F8',
 130     F9 = 'F9',
 131     F10 = 'F10',
 132     F11 = 'F11',
 133     F12 = 'F12',
 134     NumLock = 'NumLock',
 135     ScrollLock = 'ScrollLock',
 136     SemiColon = ';',
 137     Equals = '=',
 138     Comma = ',',
 139     Dash = '-',
 140     Period = '.',
 141     UnderScore = '_',
 142     PlusSign = '+',
 143     Slash = '/',
 144     ForwardSlash = '/',
 145     Tilde = '~',
 146     GraveAccent = '`',
 147     OpenBracket = '[',
 148     ClosedBracket = ']',
 149     Quote = "'",
 150     QuestionMark = '?',
 151 }
 152
 153 export type KeyboardKeyType = keyof typeof KeyboardKey | KeyboardKey;