mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
6c145cb775
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
25 lines
907 B
Markdown
25 lines
907 B
Markdown
---
|
|
title: Overview
|
|
---
|
|
|
|
*KeymanWeb* is a cross-browser JavaScript input method solution.
|
|
|
|
The *KeymanWeb 17 API* provides JavaScript functions to allow a website developer to integrate the use of
|
|
*KeymanWeb* multi-lingual keyboard mapping into a website, using either a standard or a custom-designed user-interface. The functions are exposed as API calls to the *KeymanWeb* core, the
|
|
*On-Screen Keyboard* module, a *Utility function* library, or one of the standard *User Interface* modules.
|
|
|
|
A *KeymanWeb* instance is automatically constructed when you include the compiled KeymanWeb script (kmw-release.js) in your web page source.
|
|
|
|
The *KeymanWeb API* comprises the following objects:
|
|
|
|
- *Core*
|
|
: Exposed as [`keyman`](core).
|
|
|
|
- *On-Screen Keyboard*
|
|
: Exposed as [`keyman.osk`](osk).
|
|
|
|
- *Utility Functions*
|
|
: Exposed as [`keyman.util`](util).
|
|
|
|
- *User Interface*
|
|
: Exposed as [`keyman.ui`](ui).
|