erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-16 05:39:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
spiegel-keyman/web/docs/engine/reference/events/osk/show.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

769 B
Raw Permalink Blame History

title
osk.show Event

Summary

Called when the OSK is displayed.

Syntax

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

Parameters

obj
Type: object
An object specifying the osk's display state information.

Available display state information:

obj.x
Number
The x-coordinate of the left side of the OSK.
obj.y
Number
The y-coordinate of the top of the OSK.
obj.userLocated
boolean
true if the OSK has been directly placed by the user.

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.

See also