Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0Version 2.0

On this page

kmw.keyboardregistered Event


Called when a keyboard 'stub' is processed (for listing as available keyboard).


keyman.addEventListener('keyboardregistered', function(keyboardProperties) {


Type: object
An object with the following properties:
  • internalName - the keyboard's id
  • language - its corresponding language.
  • keyboardName - the keyboard's name
  • languageCode - its BCP 47 language code.

Return Value

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


This event is used by all the UI elements in order to update the list of available keyboards as soon as a new keyboard stub has been registered, before any attempt to load it has been made.