mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-06 08:55:34 +00:00
6c145cb775
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
31 lines
501 B
Markdown
31 lines
501 B
Markdown
---
|
|
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.
|