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

37 lines
694 B
Markdown

---
title: keyman.keyboardchange Event
---
## Summary
Called when keyboard input language changed.
## Syntax
```js
keyman.addEventListener('keyboardchange', function(keyboardProperties) {
...
});
```
### Parameters
`keyboardProperties`
: Type: `object`
: An object with the following properties:
: - `internalName` - the keyboard's name
: - `languageCode` - its BCP 47 language code.
### 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 utilized by the various non-mobile UI elements included
with KeymanWeb.