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/setActiveKeyboard.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

871 B
Raw Blame History

title
setActiveKeyboard

Summary

Change the currently active keyboard.

Syntax

keyman.setActiveKeyboard(keyboardName, languageCode);

Parameters

keyboardName
Type: string
The ID (internal name) of the keyboard to be set as active.
languageCode
Type: string optional
The BCP 47 code for the keyboard's language.

Return Value

Promise
A JavaScript Promise fulfilled upon successfully linking and activating the keyboard.

Description

Calls to setActiveKeyboard are asynchronous for keyboards not previously set as active.

Use the internalName and languageCode keyboard variables. If languageCode is defaulted, setActiveKeyboard will select the language code for the first matching keyboard stub.