spiegel-keyman/web/docs/engine/reference/events/osk/hide.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

33 lines
543 B
Markdown

---
title: osk.hide Event
---
## Summary
Called when the OSK is hidden.
## Syntax
```
keyman.osk.addEventListener('hide', function(param) {
...
});
```
### Parameters
`param`
: Type: `Object`
: An object with field HiddenByUser, a `boolean` which indicates if
the OSK was hidden directly by the user's actions.
### 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
...