spiegel-keyman/web/docs/engine/reference/events/osk/show.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

752 B

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.

Description

...