Product Support

Keyboard Support

Developer Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com
Other versions
Version 4.0 (current version)Version 3.0Version 2.0

On this page

You are viewing an old version of this documentation. Click here to open the current version, 4.0.

API object - Keyboard

The Keyboard object contains the following members:

name
string
Name of keyboard
id
string
ID of the keyboard, always matches the filename of the keyboard.
filename
string
Name of the keyboard .js file which should be combined with options.keyboardBaseUri.
default
boolean optional
true if the keyboard is the recommended default for the language. false if absent.
rtl
boolean optional
true if the keyboard targets a right-to-left script. false if absent.
lastModified
string|number
Date the keyboard was last updated.
fileSize
number
Size of the keyboard file, in bytes.
minVersion
string optional
Minimum build version of KeymanWeb that the keyboard will work with.
maxVersion
string optional
Maximum build version of KeymanWeb that the keyboard will work with.
languages
Array optional
An array of Language objects linked to the keyboard.
font
Object optional
Font object describing font for input fields (and OSK, if oskFont is not present). Only present when a Keyboard object is a child of a Language object.
oskFont
Object optional
Font object describing font for the OSK. Only present when a Keyboard object is a child of a Language object.
example
Object optional
Example object. Only present when a Keyboard object is the child of a Language object.

Example case

The following is extracted from https://api.keyman.com/cloud/2.0/keyboards/hebrew.

"keyboard": {
  "id":           "hebrew",
  "name":         "Hebrew",
  "filename":     "hebrew.js",
  "lastModified": "2016-06-17T07:51:52+10:00",
  "rtl":          true,
  "languages":    [
                    {
    "id":             "heb",
    "name":           "Hebrew",
                    }
                  ]
}

Keep me updated