mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 08:25:32 +00:00
c1113ac21d
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Also change a few places that I missed.
39 lines
804 B
Markdown
39 lines
804 B
Markdown
---
|
|
title: registerStub (KRS)
|
|
---
|
|
|
|
## Summary
|
|
|
|
Registers the keyboard stub or returns true if already registered.
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
keyman.interface.registerStub(Pstub);
|
|
```
|
|
|
|
or
|
|
|
|
```js
|
|
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()`](../core/addKeyboards) function.
|