mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00

Marc Durdin d527e3739e docs(web): cleanup of index pages and page titles

Fixes: #16169
Test-bot: skip

2026-07-01 08:06:26 +02:00

title
KeymanWeb Reference

KeymanWeb Overview: KeymanWeb is a cross-browser JavaScript input method solution.

API Reference

keyman: Core APIs for KeymanWeb, including initialization, adding keyboards, focus and element control.
keyman.osk: On-Screen Keyboard module.
keyman.util: Utility functions.
keyman.interface (also KeymanWeb): API surface for keyboards, providing a number of functions for low-level processing of input, context and output.
keyman.ui - Desktop User Interfaces: Four different KeymanWeb user interfaces for desktop browsers are included, allowing users to select and enable keyboard mapping from a list of installed keyboards, and to control the visibility of the On-Screen Keyboard.

API Guides

Initialization Options: The following options can be defined by the site designer in the initialization call to KeymanWeb.
Events: A number of KeymanWeb events are exposed to allow the designer of a user interface to control the appearance and behavior of user interface elements.
Keyboard Properties: Standard properties for a Keyboard object returned from a keyboard .js file.
Touch Layout Specifications: Touch-screen layouts for KeymanWeb are specified as JSON objects containing a member object for each specified device type.