erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-21 15:57:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12
spiegel-keyman/web/docs/engine/reference/events/osk/helpclick.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

501 B
Raw Blame History

title
osk.helpclick Event

Summary

Called upon user request for the UI to present a help page.

Syntax

keyman.osk.addEventListener('helpclick', function() {
  ...
});

Parameters

None.

Return Value

boolean
true if the event should continue processing, false if it should not. Your event handler should return true aside from exceptional circumstances.

Description

This event is raised whenever the user wishes to access help information.