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/core/activatingUI.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

672 B
Raw Blame History

title
activatingUI

Summary

Sets an internal flag to notify KeymanWeb of change in UI activation state.

Syntax

keyman.activatingUI(state);

Parameters

state
Type: boolean|number
Used to signify if the user is interacting with KeymanWeb UI elements.

Return Value

undefined

Description

This function is used by the various non-mobile UI implementations to aid the KeymanWeb engine with internal bookkeeping. In particular, it is necessary for accurately tracking effects related to the active control when interacting with UI elements.

As a result, this function should only ever be utilized within custom UI code.