erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/web/docs/engine/reference/core/addHotKey.md
Marc Durdin 1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup 
Deprecate the following obsolete functions and properties:
* `keyman.helpURL`
* `keyman.util.rgba`
* `keyman.util.toFloat`
* `keyman.util.toNumber`
* `keyman.util.toNzString`

Use correct language for code blocks in Keyman Engine for Web
documentation.

Test-bot: skip
2026-08-12 16:07:22 +02:00

678 B
Raw Blame History

title
addHotKey

Summary

Add hot key handler to array of document-level hotkeys triggered by key-up event.

Syntax

keyman.addHotKey(keyCode, shiftState, handler);

Parameters

keyCode
Type: number
The base key of the hotkey
shiftState
Type: number
shiftState is a bitwise combination of SHIFT (0x10), CTRL (0x20) and ALT (0x40).
handler
Type: function
The function to be called when the hotkey is triggered. It should not expect any parameters.

Return Value

undefined

Description

Used to support custom hotkeys within a web document. Only one handler function may exist per hotkey combination.