Skip to content

Internal APIs for Web's app‐browser artifact

Joshua Horton edited this page Aug 21, 2024 · 1 revision

Known internal APIs in use for Web's app/browser build product:

keyman.views

This object publishes constructors for all OSK variants that app/browser supports. Constructing a new OSK with one of them, then setting it to keyman.osk, will allow use of a non-default OSK type.

This feature is used for Developer's web-keyboard test-host page; InlinedOSKView is the OSK type utilized there.

keyman.keyboardRequisitioner.cache.fetchKeyboard()

keyman.register

This is primarily used for responses from the Keyman repository Cloud API. In such cases, there is an existing query started by Web that the response is associated with.

Additionally, it is used directly by keymanweb.com with a pre-cached "all keyboards" query result.

Clone this wiki locally