KeyCombo | shortcutjs

Defines a Combo of keys

Hierarchy

KeyCombo

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KeyCombo(keys?: Set<number>, stateKeys?: ComboStateKeys): KeyCombo

- Defined in key-combo.ts:39
Parameters
- Default value keys: Set<number> = new Set<number>()
- Default value stateKeys: ComboStateKeys = new ComboStateKeys()
Returns KeyCombo

Properties

keys

keys: Set<number>

stateKeys

stateKeys: ComboStateKeys

Methods

addEvent

addEvent(ev: KeyboardEvent): boolean

- Defined in key-combo.ts:128
Creates an instance of KeyCombo, given an string.

Parameters
- ev: KeyboardEvent
Returns boolean

hasStateKeys

hasStateKeys(): boolean

- Defined in key-combo.ts:148
Return if the combo has enabled any state key

Returns boolean

fromString

fromString(comboStr: string): KeyCombo

- Defined in key-combo.ts:52
Creates an instance of KeyCombo, given an string.

Parameters
- comboStr: string
Returns KeyCombo

getNonStateKeys

getNonStateKeys(keyArr: number[], stateKeys: IStateKey[]): Array<number>

- Defined in key-combo.ts:114
Returns all non-state keys, given an array of keyCodes

Parameters
- keyArr: number[]
- stateKeys: IStateKey[]
Returns Array<number>

getStateKeys

getStateKeys(keyArr: number[], stateKeys: IStateKey[]): Array<IStateKey>

- Defined in key-combo.ts:107
Returns all state keys, given an array of keyCodes

Parameters
- keyArr: number[]
- stateKeys: IStateKey[]
Returns Array<IStateKey>

isEqual

isEqual(currentCombo: KeyCombo, targetCombo: KeyCombo): boolean

- Defined in key-combo.ts:57
Parameters
- currentCombo: KeyCombo
- targetCombo: KeyCombo
Returns boolean

isStateKey

isStateKey(key: number, stateKeys: IStateKey[]): boolean

- Defined in key-combo.ts:121
Returns whether a keyCode is a state key

Parameters
- key: number
- stateKeys: IStateKey[]
Returns boolean

parse

parse(comboStr: string): IComboSplit

- Defined in key-combo.ts:67
Parses the string and gets the code or codes of it

Parameters
- comboStr: string
Returns IComboSplit

splitCombo

splitCombo(combo: TComboSanitized): IComboSplit

- Defined in key-combo.ts:79
Return a split combo with keys and stateKeys

Parameters
- combo: TComboSanitized
Returns IComboSplit

Generated using TypeDoc