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

649 B

title
keyman.keyboardloaded Event

Summary

Called when keyboard code loaded.

Syntax

keyman.addEventListener('keyboardloaded', function(keyboardProperties) {
  ...
});

Parameters

keyboardProperties
Type: object
An object with the following property:
  • keyboardName - the keyboard's name.

Return Value

boolean
true if the event should continue processing, false if it should not. Your event handler should return true aside from exceptional circumstances.

Description

This event is only raised once a keyboard has been fully loaded and processed, ready for active use.