Keyboard Support

Contact and Search Homepage

Header bottom

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

On this page

Guide: build a system keyboard app

In part 1 of this series, we looked at the steps involved in creating a basic Android app which included a Keyman in-app keyboard. In this post, we'll work with the second sample included in the Keyman Engine for Android package, which is a very basic System Keyboard app. This post builds on concepts and setup from the first post, so be sure you are familiar with that before you start on this one.

1. Basic configuration

If exists from the downloaded Keyman Engine for Android, extract it to a new folder. Otherwise, the KMSample2 project can be found at Samples/KMSample2

2. Run the sample app

The KMSample2 app includes the Tamil 99 Basic keyboard as an example keyboard. Without any further modifications, the app should run and you'll be able to configure your device to use your app as the system keyboard.


3. Extending the app

From here, you will no doubt want to replace the keyboard with your own one; again, follow the instructions from Part 1 to make this change.

You can also customise the look and feel of the on screen keyboard by including a custom CSS file in your keyboard through Keyman Developer.


The CSS rules required to style your keyboard are beyond the scope of this post, but the kmwosk.css file included in the Keyman Developer 15.0 distribution and in the KeymanWeb 15.0 source is a good place to start. See this reference for more information about the On-Screen Keyboard.

Do take the time to read through the source of KMSample2, as it includes some boilerplate code required to link Keyman Engine through to the Android Input Method services and vice versa.

Finally, you will want to improve the style and branding of the main activity in KMSample2. The sample includes just two buttons to link to the Android Input Method Settings and Input Method Menu, as a pointer to the two configuration steps that your users will need to undertake in order to start using your keyboard.


You will probably want to make that a lot prettier, and include more detailed instructions!

That's all there is to creating a System Keyboard with Keyman Engine for Android. We've taken care of all the complex details of keyboarding in the Keyman Engine, so you can focus on the look and feel and the layout of your keyboard.

Further links