erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-16 13:49:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
spiegel-keyman/web/docs/engine/reference/events/keyman/unloaduserinterface.md
Marc Durdin b40c4b376b fix(web): cleanup loaduserinterface and unloaduserinterface events 
The `loaduserinterface` and `unloaduserinterface` events were
incompletely implemented, and the documentation was incomplete. This
change:

1. ensures `loaduserinterface` is called any time a UI is set, either
   during initialization or when the property is set later.
2. ensures `unloaduserinterface` is called immediately before a UI is
   shutdown.
3. updates documentation
4. removes misleading commented code in kmwuifloat.ts

Test-bot: skip
2026-08-12 15:51:55 +02:00

651 B
Raw Blame History

title
keyman.unloaduserinterface Event

Summary

Called when a KeymanWeb UI is about to be unloaded.

Syntax

keyman.addEventListener('unloaduserinterface', function() {
  ...
});

Parameters

None.

Return Value

boolean
true if the next event handler should be called, false if it should not. Your event handler should return true aside from exceptional circumstances.

Description

Called when the ui is about to be unloaded, allowing cleanup of resources if necessary.

It is not possible to stop the UI being unloaded; returning false only stops further event handlers from being called.