Skip to main content

Key

Represents keyboard keys that aren’t text, and that can be used with the interaction to Press.

Note: Modifier keys like Key.Shift, Key.Alt and Key.Meta (a.k.a. “Command” on Mac) will stay pressed, so there’s no need to depress them.

Learn more

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Key(devtoolsName: string, utf16codePoint: string, isModifier?: boolean): Key

  • Parameters

    • devtoolsName: string
    • utf16codePoint: string
    • isModifier: boolean = false

    Returns Key

Properties

publicstaticAlt

Alt: Key = ...

publicstaticArrowDown

ArrowDown: Key = ...

publicstaticArrowLeft

ArrowLeft: Key = ...

publicstaticArrowRight

ArrowRight: Key = ...

publicstaticArrowUp

ArrowUp: Key = ...

publicstaticBackspace

Backspace: Key = ...

publicstaticCancel

Cancel: Key = ...

publicstaticClear

Clear: Key = ...

publicstaticControl

Control: Key = ...

publicstaticDelete

Delete: Key = ...

publicstaticEnd

End: Key = ...

publicstaticEnter

Enter: Key = ...

publicstaticEscape

Escape: Key = ...

publicstaticF1

F1: Key = ...

publicstaticF2

F2: Key = ...

publicstaticF3

F3: Key = ...

publicstaticF4

F4: Key = ...

publicstaticF5

F5: Key = ...

publicstaticF6

F6: Key = ...

publicstaticF7

F7: Key = ...

publicstaticF8

F8: Key = ...

publicstaticF9

F9: Key = ...

publicstaticF10

F10: Key = ...

publicstaticF11

F11: Key = ...

publicstaticF12

F12: Key = ...

publicstaticHelp

Help: Key = ...

publicstaticHome

Home: Key = ...

publicstaticInsert

Insert: Key = ...

publicstaticMeta

Meta: Key = ...

publicstaticNumpad0

Numpad0: Key = ...

publicstaticNumpad1

Numpad1: Key = ...

publicstaticNumpad2

Numpad2: Key = ...

publicstaticNumpad3

Numpad3: Key = ...

publicstaticNumpad4

Numpad4: Key = ...

publicstaticNumpad5

Numpad5: Key = ...

publicstaticNumpad6

Numpad6: Key = ...

publicstaticNumpad7

Numpad7: Key = ...

publicstaticNumpad8

Numpad8: Key = ...

publicstaticNumpad9

Numpad9: Key = ...

publicstaticNumpadAdd

NumpadAdd: Key = ...

publicstaticNumpadDecimal

NumpadDecimal: Key = ...

publicstaticNumpadDivide

NumpadDivide: Key = ...

publicstaticNumpadEqual

NumpadEqual: Key = ...

publicstaticNumpadMultiply

NumpadMultiply: Key = ...

publicstaticNumpadSubtract

NumpadSubtract: Key = ...

publicstaticPageDown

PageDown: Key = ...

publicstaticPageUp

PageUp: Key = ...

publicstaticPause

Pause: Key = ...

publicstaticSemicolon

Semicolon: Key = ...

publicstaticShift

Shift: Key = ...

publicstaticSpace

Space: Key = ...

publicstaticTab

Tab: Key = ...

publicreadonlydevtoolsName

devtoolsName: string

publicreadonlyutf16codePoint

utf16codePoint: string

publicreadonlyisModifier

isModifier: boolean = false

Methods

publicstaticisKey

  • isKey(maybeKey: unknown): maybeKey is Key

  • Parameters

    • maybeKey: unknown

    Returns maybeKey is Key

toString

  • toString(): string

  • Returns string