Class HotkeysService

Hierarchy

HotkeysService

Index

Accessors

Methods

Accessors

hotkey$

get hotkey$(): Observable<string>

- Defined in services/hotkeys.service.ts:31
Fired for each recognized hotkey

Returns Observable<string>

hotkeyOff$

get hotkeyOff$(): Observable<string>

- Defined in services/hotkeys.service.ts:36
Fired for once hotkey is released

Returns Observable<string>

key$

get key$(): Observable<string>

- Defined in services/hotkeys.service.ts:41
Fired for each singular key

Returns Observable<string>

keyEvent$

get keyEvent$(): Observable<KeyboardEvent>

- Defined in services/hotkeys.service.ts:46
Fired for each key event

Returns Observable<KeyboardEvent>

keystroke$

get keystroke$(): Observable<string>

- Defined in services/hotkeys.service.ts:51
Fired for each singular key combination

Returns Observable<string>

Methods

clearCurrentKeystrokes

clearCurrentKeystrokes(): void

- Defined in services/hotkeys.service.ts:240
Returns void

disable

disable(): void

- Defined in services/hotkeys.service.ts:256
Returns void

enable

enable(): void

- Defined in services/hotkeys.service.ts:252
Returns void

getCurrentKeystrokes

getCurrentKeystrokes(): string[]

- Defined in services/hotkeys.service.ts:180
Returns string[]

getHotkeyDescription

getHotkeyDescription(id: string): IHotkeyDescription

- Defined in services/hotkeys.service.ts:248
Parameters
- id: string
Returns IHotkeyDescription

getHotkeyDescriptions

getHotkeyDescriptions(): Promise<IHotkeyDescription[]>

- Defined in services/hotkeys.service.ts:264
Returns Promise<IHotkeyDescription[]>

isEnabled

isEnabled(): boolean

- Defined in services/hotkeys.service.ts:260
Returns boolean

matchActiveHotkey

matchActiveHotkey(partial?: boolean): null | string

- Defined in services/hotkeys.service.ts:187
Parameters
- partial: boolean = false
Returns null | string

pushKeyEvent

pushKeyEvent(eventName: string, nativeEvent: KeyboardEvent): void

- Defined in services/hotkeys.service.ts:105
Adds a new key event to the buffer

Parameters
- eventName: string
  DOM event name
- nativeEvent: KeyboardEvent
  event object
Returns void

Generated using TypeDoc