erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-15 21:29:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/web/docs/engine/reference/core/getUIState.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

532 B
Raw Blame History

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.