tw5-typed / modules/keyboard / KeyboardManager

Interface: KeyboardManager

modules/keyboard.KeyboardManager

Table of contents

Properties

• checkKeyDescriptor
• checkKeyDescriptors
• detectNewShortcuts
• getEventModifierKeyDescriptor
• getMatchingKeyDescriptor
• getModifierKeys
• getPrintableShortcuts
• getShortcutTiddlerList
• handleKeydownEvent
• handleShortcutChanges
• keyNames
• lookupNames
• metaKeyName
• namedKeys
• parseKeyDescriptor
• parseKeyDescriptors
• shortcutActionList
• shortcutKeysList
• shortcutParsedList
• shortcutPriorityList
• updateShortcutLists

Properties

checkKeyDescriptor

• checkKeyDescriptor: (event: any, keyInfo: KeyInfo) => boolean

Type declaration

▸ (event, keyInfo): boolean

Parameters

Name	Type
event	any
keyInfo	KeyInfo

Returns

boolean

Defined in

src/modules/keyboard.d.ts:13

---

checkKeyDescriptors

• checkKeyDescriptors: (event: any, keyInfoArray: KeyInfo[]) => boolean

Type declaration

▸ (event, keyInfoArray): boolean

Parameters

Name	Type
event	any
keyInfoArray	KeyInfo[]

Returns

boolean

Defined in

src/modules/keyboard.d.ts:14

---

detectNewShortcuts

• detectNewShortcuts: (changedTiddlers: Record<string, any>) => boolean | string[]

Type declaration

▸ (changedTiddlers): boolean | string[]

Parameters

Name	Type
changedTiddlers	Record<string, any>

Returns

boolean | string[]

Defined in

src/modules/keyboard.d.ts:15

---

getEventModifierKeyDescriptor

• getEventModifierKeyDescriptor: (event: any) => string

Type declaration

▸ (event): string

Parameters

Name	Type
event	any

Returns

string

Defined in

src/modules/keyboard.d.ts:18

---

getMatchingKeyDescriptor

• getMatchingKeyDescriptor: (event: any, keyInfoArray: KeyInfo[]) => KeyInfo

Type declaration

▸ (event, keyInfoArray): KeyInfo

Parameters

Name	Type
event	any
keyInfoArray	KeyInfo[]

Returns

KeyInfo

Defined in

src/modules/keyboard.d.ts:19

---

getModifierKeys

• getModifierKeys: () => number[]

Type declaration

▸ (): number[]

Returns

number[]

Defined in

src/modules/keyboard.d.ts:23

---

getPrintableShortcuts

• getPrintableShortcuts: (keyInfoArray: KeyInfo[]) => string[]

Type declaration

▸ (keyInfoArray): string[]

Parameters

Name	Type
keyInfoArray	KeyInfo[]

Returns

string[]

Defined in

src/modules/keyboard.d.ts:24

---

getShortcutTiddlerList

• getShortcutTiddlerList: () => string[]

Type declaration

▸ (): string[]

Returns

string[]

Defined in

src/modules/keyboard.d.ts:25

---

handleKeydownEvent

• handleKeydownEvent: (event: any, options?: { onlyPriority?: boolean }) => boolean

Type declaration

▸ (event, options?): boolean

Parameters

Name	Type
event	any
options?	Object
options.onlyPriority?	boolean

Returns

boolean

Defined in

src/modules/keyboard.d.ts:26

---

handleShortcutChanges

• handleShortcutChanges: (changedTiddlers: Record<string, any>) => void

Type declaration

▸ (changedTiddlers): void

Parameters

Name	Type
changedTiddlers	Record<string, any>

Returns

void

Defined in

src/modules/keyboard.d.ts:30

---

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: string, options?: { keyDescriptor?: string }) => KeyInfo

Type declaration

▸ (keyDescriptor, options?): KeyInfo

Parameters

Name	Type
keyDescriptor	string
options?	Object
options.keyDescriptor?	string

Returns

KeyInfo

Defined in

src/modules/keyboard.d.ts:35

---

parseKeyDescriptors

• parseKeyDescriptors: (keyDescriptors: string | string[], options?: { stack?: string[] ; wiki?: any }) => KeyInfo[]

Type declaration

▸ (keyDescriptors, options?): KeyInfo[]

Parameters

Name	Type
keyDescriptors	string | string[]
options?	Object
options.stack?	string[]
options.wiki?	any

Returns

KeyInfo[]

Defined in

src/modules/keyboard.d.ts:39

---

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: string[]) => void

Type declaration

▸ (tiddlerList): void

Parameters

Name	Type
tiddlerList	string[]

Returns

void

Defined in

src/modules/keyboard.d.ts:47