spiegel-keyman/web/docs/engine/reference/core/activatingUI.md at d34f238eebc83054fe7bf582a29830da71299565

mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00

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

671 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.

671 B Raw Blame History