erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
spiegel-keyman/web/docs/engine/reference/interface/registerStub.md
Eberhard Beilharz c1113ac21d
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Details
chore(web): address code review comments 
Also change a few places that I missed.
2026-06-08 19:27:12 +02:00

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