erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-19 23:07:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
spiegel-keyman/web/docs/engine/reference/interface/registerStub.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

802 B
Raw Blame History

title
registerStub (KRS)

Summary

Registers the keyboard stub or returns true if already registered.

Syntax

keyman.interface.registerStub(Pstub);

or

KeymanWeb.KRS(Pstub); // Shorthand

Parameters

Pstub
Type: Object
A keyboard stub object representing the keyboard's basic lookup parameters.

Return Value

optional number
1 if the keyboard is preregistered, otherwise null.

Description

Note: This only registers the stub with KeymanWeb, allowing it to later request the keyboard from the server or filesystem upon demand in order to complete the linking process.

The keyman.interface.registerStub function is typically called on the user's behalf by the keyman.addKeyboards() function.