Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeyboardShortcutObserver

Keyboard Shortcut Observer Observe keyboard events on the document, if the event.key combination matches the pattern provided invoke the provided handler.

Hierarchy

  • KeyboardShortcutObserver

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new KeyboardShortcutObserver(pattern: string | RegExp, __onTriggerHandler: function, name?: string): KeyboardShortcutObserver

  • Construct a new observer to listen to the keyboard

    Parameters

    • pattern: string | RegExp

      the keyboard pattern to look for, examples are "Shift P", "Control m", "Meta s"

    • __onTriggerHandler: function

      the handler to invoke when a match is found

    • Default value name: string = "unnamed"

      a name to identify the shortcut

    Returns KeyboardShortcutObserver

Properties

allowPropagation

allowPropagation: boolean = false

name

name: string

a name to identify the shortcut

Accessors

pattern

  • get pattern(): string | RegExp
  • set pattern(s: string | RegExp): void

  • Returns string | RegExp

  • Parameters

    • s: string | RegExp

    Returns void

Methods

connect

  • connect(): void

  • Returns void

disconnect

  • disconnect(): void

  • Returns void

isConnected

  • isConnected(): boolean

  • Returns boolean