Class KeyboardManager

downKeys

moveKeys

panKeys

StaticCONTROL_KEY_STRING

StaticKEYCODE_DISPLAY_MAPPING

StaticMODIFIER_CODES

StaticMODIFIER_KEYS

StaticPRINTABLE_CHAR_REGEX

StaticPROTECTED_KEYS

hasFocus

• get hasFocus(): boolean

  Determines whether an HTMLElement currently has focus, which may influence keybinding actions.

  An element is considered to have focus if:

  1. It has a dataset.keyboardFocus attribute explicitly set to "true" or an empty string ("").
  2. It is an <input>, <select>, or <textarea> element, all of which inherently accept keyboard input.
  3. It has the isContentEditable property set to true, meaning it is an editable element.
  4. It is a <button> element inside a <form>, which suggests interactive use.

  An element is considered not focused if:

  1. There is no currently active element (document.activeElement is not an HTMLElement).
  2. It has a dataset.keyboardFocus attribute explicitly set to "false".

  If none of these conditions are met, the element is assumed to be unfocused.

  Returns boolean

StaticisUniversalMode

• get isUniversalMode(): boolean

  Is logical keybindings active?

  Returns boolean

isCoreActionKeyActive

• isCoreActionKeyActive(action: string): boolean

  Report whether a core action key is currently actively depressed.

  Parameters

  • action: string

    The core action to verify (ex: "target")

  Returns boolean

  Is this core action key currently down (active)?

isModifierActive

• isModifierActive(modifier: string): boolean

  Report whether a modifier in KeyboardManager.MODIFIER_KEYS is currently actively depressed.

  Parameters

  • modifier: string

    A modifier in MODIFIER_KEYS

  Returns boolean

  Is this modifier key currently down (active)?

releaseKeys

• releaseKeys(options?: { force?: boolean }): void

  Emulate a key-up event for any currently down keys. When emulating, we go backwards such that combinations such as "CONTROL + S" emulate the "S" first in order to capture modifiers.

  Parameters

  • Optionaloptions: { force?: boolean } = {}

    Options to configure behavior.

    • Optionalforce?: boolean

      Force the keyup events to be handled.

  Returns void

StaticemulateKeypress

• emulateKeypress(
      up: boolean,
      code: string,
      options?: {
          altKey?: boolean;
          ctrlKey?: boolean;
          force?: boolean;
          repeat?: boolean;
          shiftKey?: boolean;
      },
  ): KeyboardEventContext

  Emulates a key being pressed, triggering the Keyboard event workflow.

  Parameters

  • up: boolean

    If True, emulates the keyup Event. Else, the keydown event

  • code: string

    The KeyboardEvent#code which is being pressed

  • Optionaloptions: {
        altKey?: boolean;
        ctrlKey?: boolean;
        force?: boolean;
        repeat?: boolean;
        shiftKey?: boolean;
    } = {}

    Additional options to configure behavior.

    • OptionalaltKey?: boolean

      Emulate the ALT modifier as pressed

    • OptionalctrlKey?: boolean

      Emulate the CONTROL modifier as pressed

    • Optionalforce?: boolean

      Force the event to be handled.

    • Optionalrepeat?: boolean

      Emulate this as a repeat event

    • OptionalshiftKey?: boolean

      Emulate the SHIFT modifier as pressed

  Returns KeyboardEventContext

StaticgetKeyboardEventContext

• getKeyboardEventContext(
      event: KeyboardEvent,
      up?: boolean,
  ): KeyboardEventContext

  Get a standardized keyboard context for a given event. Every individual keypress is uniquely identified using the KeyboardEvent#code property. A list of possible key codes is documented here: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values

  Parameters

  • event: KeyboardEvent

    The originating keypress event

  • up: boolean = false

    A flag for whether the key is down or up

  Returns KeyboardEventContext

  The standardized context of the event

StaticgetKeycodeDisplayString

• getKeycodeDisplayString(code: string): string

  Format a KeyboardEvent#code into a displayed string.

  Parameters

  • code: string

    The input code

  Returns string

  The displayed string for this code

StatictranslateKey

• translateKey(event: KeyboardEvent): string

  Canonical identifier for a key press.

  Parameters

  • event: KeyboardEvent

  Returns string