Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 17.0 (current version)Version 16.0Version 15.0Version 14.0Version 13.0Version 12.0Version 11.0Version 10.0Version 2.0

On this page

KeymanWeb 16.0 Reference

KeymanWeb Overview
KeymanWeb is a cross-browser JavaScript input method solution.
KeymanWeb Core Module
The KeymanWeb core module is exposed to the developer as window.keyman.
On-Screen Keyboard Module
The On-Screen Keyboard module is exposed to the developer as window.keyman.osk.
KeymanWeb Utility Module
The KeymanWeb Utility Function module is exposed to the developer as window.keyman.util.
KeymanWeb Output Functions
KeymanWeb exposes its keyboard interface object through window.keyman.interface, providing a number of functions for low-level processing of input, context and output.
KeymanWeb Compatibility Functions
The following KeymanWeb core functions have been retained for compatibility with existing custom keyboards, but should not be used in any new keyboards or user interfaces. Equivalent new function calls are indicated.
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.
KeymanWeb Initialization Options
The following options can be defined by the site designer in the initialization call to KeymanWeb.
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. Standard event-processing requires all arguments to be passed as an array (object) with named member variables.
KeymanWeb Keyboard Properties
Most keyboards are generated automatically from the Keyman keyboard source by Keyman Developer and contain properties used by KeymanWeb during keyboard mapping.
KeymanWeb Layout Designer
One of the main features of KeymanWeb is its ability to support distinct, user-customizable layouts for touch-screen keyboards on phones and tablets.
KeymanWeb Layout Specifications
Touch-screen layouts for KeymanWeb are specified as JSON objects containing a member object for each specified device type.
KeymanWeb Keyboard Development Reference
Information on how to explicitly support KeymanWeb in custom keyboards.