Class KeyCode

constructor

• new KeyCode(schema): KeyCode

• Parameters

  • schema: KeyCodeSchema

  Returns KeyCode

Readonly alt

Readonly character

Readonly ctrl

Readonly key

Readonly meta

Readonly shift

equals

• equals(other): boolean

• Return true if the given KeyCode is equal to this one.

  Parameters

  • other: KeyCode

  Returns boolean

isModifierOnly

• isModifierOnly(): boolean

• Return true if this KeyCode only contains modifiers.

  Returns boolean

toString

• toString(): string

• Returns string

Static createKeyCode

• createKeyCode(input, eventDispatch?): KeyCode

• Create a KeyCode from one of several input types.

  Parameters

  • input: string | Keystroke | KeyCodeSchema | KeyboardEvent
  • eventDispatch: "code" | "keyCode" = 'code'

  Returns KeyCode

Static parse

• parse(keybinding): KeyCode

• Parses a string and returns a KeyCode object.

  Parameters

  • keybinding: string

    String representation of a keybinding

  Returns KeyCode

Static resetKeyBindings

• resetKeyBindings(): void

• Returns void