Skip to main content

KeyboardManager

tw5-typed

tw5-typed / modules/keyboard / KeyboardManager

Interface: KeyboardManager

Defined in: src/modules/keyboard.d.ts:12

Properties​

checkKeyDescriptor()​

checkKeyDescriptor: (event, keyInfo) => boolean

Defined in: src/modules/keyboard.d.ts:13

Parameters​

event​

KeyboardEvent

keyInfo​

KeyInfo

Returns​

boolean

checkKeyDescriptors()​

checkKeyDescriptors: (event, keyInfoArray) => boolean

Defined in: src/modules/keyboard.d.ts:14

Parameters​

event​

KeyboardEvent

keyInfoArray​

KeyInfo[]

Returns​

boolean

detectNewShortcuts()​

detectNewShortcuts: (changedTiddlers) => boolean | string[]

Defined in: src/modules/keyboard.d.ts:15

Parameters​

changedTiddlers​

Record<string, unknown>

Returns​

boolean | string[]

getEventModifierKeyDescriptor()​

getEventModifierKeyDescriptor: (event) => string

Defined in: src/modules/keyboard.d.ts:18

Parameters​

event​

KeyboardEvent

Returns​

string

getMatchingKeyDescriptor()​

getMatchingKeyDescriptor: (event, keyInfoArray) => KeyInfo

Defined in: src/modules/keyboard.d.ts:19

Parameters​

event​

KeyboardEvent

keyInfoArray​

KeyInfo[]

Returns​

KeyInfo

getModifierKeys()​

getModifierKeys: () => number[]

Defined in: src/modules/keyboard.d.ts:23

Returns​

number[]

getPrintableShortcuts()​

getPrintableShortcuts: (keyInfoArray) => string[]

Defined in: src/modules/keyboard.d.ts:24

Parameters​

keyInfoArray​

KeyInfo[]

Returns​

string[]

getShortcutTiddlerList()​

getShortcutTiddlerList: () => string[]

Defined in: src/modules/keyboard.d.ts:25

Returns​

string[]

handleKeydownEvent()​

handleKeydownEvent: (event, options?) => boolean

Defined in: src/modules/keyboard.d.ts:26

Parameters​

event​

KeyboardEvent

options?​
onlyPriority?​

boolean

Returns​

boolean

handleShortcutChanges()​

handleShortcutChanges: (changedTiddlers) => void

Defined in: src/modules/keyboard.d.ts:30

Parameters​

changedTiddlers​

Record<string, unknown>

Returns​

void

keyNames​

keyNames: string[]

Defined in: src/modules/keyboard.d.ts:31

lookupNames​

lookupNames: string[]

Defined in: src/modules/keyboard.d.ts:32

metaKeyName​

metaKeyName: string

Defined in: src/modules/keyboard.d.ts:33

namedKeys​

namedKeys: Record<string, number>

Defined in: src/modules/keyboard.d.ts:34

parseKeyDescriptor()​

parseKeyDescriptor: (keyDescriptor, options?) => KeyInfo

Defined in: src/modules/keyboard.d.ts:35

Parameters​

keyDescriptor​

string

options?​
keyDescriptor?​

string

Returns​

KeyInfo

parseKeyDescriptors()​

parseKeyDescriptors: (keyDescriptors, options?) => KeyInfo[]

Defined in: src/modules/keyboard.d.ts:39

Parameters​

keyDescriptors​

string | string[]

options?​
stack?​

string[]

wiki?​

Wiki

Returns​

KeyInfo[]

shortcutActionList​

shortcutActionList: string[]

Defined in: src/modules/keyboard.d.ts:43

shortcutKeysList​

shortcutKeysList: string[]

Defined in: src/modules/keyboard.d.ts:44

shortcutParsedList​

shortcutParsedList: KeyInfo[][]

Defined in: src/modules/keyboard.d.ts:45

shortcutPriorityList​

shortcutPriorityList: boolean[]

Defined in: src/modules/keyboard.d.ts:46

updateShortcutLists()​

updateShortcutLists: (tiddlerList) => void

Defined in: src/modules/keyboard.d.ts:47

Parameters​

tiddlerList​

string[]

Returns​

void