erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/web/docs/engine/reference/core/setActiveKeyboard.md
Marc Durdin 6c145cb775 refactor(web): move web engine help to app repo 
Note: build.sh updated to make sure that test:help build action:target
doesn't also call test.sh by adding `:_all` meta-target.

Note: CI will need a new help-keyman-com.sh build step to deploy web
engine help.

Fixes: #12347
2024-10-31 11:00:06 +07:00

870 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.