spiegel-keyman/web/docs/engine/reference/core/getUIState.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

531 B

title
getUIState

Summary

Get the KeymanWeb user interface activation state.

Syntax

keyman.getUIState()

Parameters

None.

Return Value

Object
A 'ui_state' object specifying the UI's current activation state. Please see below for more details.

Description

The ui_state object contains the following members:

activationPending
boolean
Indicates that the KeymanWeb UI is being activated.
activated
boolean
Indicates that the KeymanUI is presently active.