erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-06 08:55:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/web/docs/engine/reference/events/keyman/beforekeyboardchange.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

680 B
Raw Blame History

title
keyman.beforekeyboardchange Event

Summary

Called when keyboard input language is about to change.

Syntax

keyman.addEventListener('beforekeyboardchange', 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 designed to be used with UI modules.