KeyController

KeyController

new KeyController(containeropt)

Source:

KeyController.ts, line 76

Name	Type	Default	Description
`container`?	Window \| Document \| HTMLElement	`window`

Extends

EventEmitter

Members

(static) global

Source:

KeyController.ts, line 82

altKey

Source:

KeyController.ts, line 93

ctrlKey

Source:

KeyController.ts, line 90

metaKey

Source:

KeyController.ts, line 101

shiftKey

Source:

KeyController.ts, line 97

Methods

(static) getCombi(e, keyopt) → {string[]}

Source:

KeyController.ts, line 31

Name	Type	Default	Description
`e`	KeyboardEvent
`key`?	string	`getKey(e.keyCode, e.key)`

Returns:

Type: string[]

(static) getKey(keyCode, keyNameopt) → {string}

Source:

KeyController.ts, line 19

Name	Type	Description
`keyCode`	number
`keyName`?	string

Returns:

Type: string

(static) getModifierCombi(e) → {string[]}

Source:

KeyController.ts, line 41

Name	Type	Description
`e`	KeyboardEvent

Returns:

Type: string[]

destroy()

Source:

KeyController.ts, line 122

keydown(comb, callbackopt) → {this}

Source:

KeyController.ts, line 136

Name	Type	Description
`comb`	string \| string[] \| ((e: KeyControllerEvent) => void) \| ...
`callback`?	(e: KeyControllerEvent) => void

keydown(comb, callback) → {this}

Name	Type	Description
`comb`	string \| string[]
`callback`	(e: KeyControllerEvent) => void

keydown(callback) → {this}

Name	Type	Description
`callback`	(e: KeyControllerEvent) => void

Returns:

Type: this

keyup(comb, callbackopt) → {this}

Source:

KeyController.ts, line 169

Name	Type	Description
`comb`	string \| string[] \| ((e: KeyControllerEvent) => void) \| ...
`callback`?	(e: KeyControllerEvent) => void

keyup(comb, callback) → {this}

Name	Type	Description
`comb`	string \| string[]
`callback`	(e: KeyControllerEvent) => void

keyup(callback) → {this}

Name	Type	Description
`callback`	(e: KeyControllerEvent) => void

Returns:

Type: this

offKeydown(comb, callbackopt) → {this}

Source:

KeyController.ts, line 147

Name	Type	Description
`comb`	string \| string[] \| ((e: KeyControllerEvent) => void) \| ...
`callback`?	(e: KeyControllerEvent) => void

offKeydown(comb, callback) → {this}

Name	Type	Description
`comb`	string \| string[]
`callback`?	(e: KeyControllerEvent) => void

offKeydown(callback) → {this}

Name	Type	Description
`callback`	(e: KeyControllerEvent) => void

Returns:

Type: this

offKeyup(comb, callbackopt) → {this}

Source:

KeyController.ts, line 158

Name	Type	Description
`comb`	string \| string[] \| ((e: KeyControllerEvent) => void) \| ...
`callback`?	(e: KeyControllerEvent) => void

offKeyup(comb, callback) → {this}

Name	Type	Description
`comb`	string \| string[]
`callback`?	(e: KeyControllerEvent) => void

offKeyup(callback) → {this}

Name	Type	Description
`callback`	(e: KeyControllerEvent) => void

Returns:

Type: this

Type Definitions

KeyControllerEvent

Source:

KeyController.ts, line 62

Properties:

Name	Type	Description
`inputEvent`	KeyboardEvent
`isToggle`	boolean
`key`	string
`keyCode`	number
`ctrlKey`	boolean
`altKey`	boolean
`shiftKey`	boolean
`metaKey`	boolean

Type:

TSInterface