Skip to main content

CommonKey

Namespace with helper functions for validating key presses.

Index

Variables

Functions

Variables

readonlyALT

ALT: 1 = 1

Bitmask component for the KeyboardEvent.altKey modifier

readonlyCTRL

CTRL: 2 = 2

Bitmask component for the KeyboardEvent.ctrlKey modifier

readonlyMETA

META: 4 = 4

Bitmask component for the KeyboardEvent.metaKey modifier

readonlySHIFT

SHIFT: 8 = 8

Bitmask component for the KeyboardEvent.shiftKey modifier

Functions

readonlyGetModifiers

  • GetModifiers(event): number

  • Parameters

    • event: KeyboardEvent

      The keyboard event in question

    Returns number

    • The bitmask of keyboard modifiers

readonlyInputKeyDown

  • InputKeyDown(inputElem, ev, options): boolean

  • Parameters

    • inputElem: HTMLInputElement | HTMLTextAreaElement

      The input or textarea element in question

    • ev: KeyboardEvent

      The keydown event

    • options: { allowCtrlA?: boolean } = null
      • optionalallowCtrlA: boolean

    Returns boolean

    • Whether the keypress was processed

readonlyInputPaste

  • InputPaste(inputElem, ev): void

  • Parameters

    • inputElem: HTMLInputElement | HTMLTextAreaElement

      helper function for automatically forwarding paste actions to the passed input element.

    • ev: ClipboardEvent

      The paste event

    Returns void

readonlyIsPressed

  • IsPressed(event, key, modifiers): boolean

  • Parameters

    • event: KeyboardEvent

      The keyboard event in question

    • key: string

      The expected key (see KeyboardEvent.prototype.key)

    • modifiers: number = null

      An optional bit mask of all expected modifiers (see examples)

    Returns boolean

    • Whether the expected key and all its modifiers were pressed

readonlyNavigationKeyDown

  • NavigationKeyDown(scrollableElem, event, getArrowScrollDistance): boolean

  • Parameters

    • scrollableElem: Element

      The scrollable element

    • event: KeyboardEvent

      The keydown event

    • getArrowScrollDistance: (scrollableElem) => number

      A callback for computing the (absolute) scroll distance for up/down arrow key presses

      Returns boolean

      • Whether a navigation key was (successfuly pressed)
    Page Options