Virtual KeyboardAPI/ExamplesGithub

Generates and replace the native keyboard.

Browser Support

Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
Yes 8+ Yes Yes Yes


  • Changes the key to english, korean, number, and symbol.
  • Shuffles the keys.
  • Supports callback functions for each key event.
  • Supports mobile devices using touch events.
  • Supoorts templates.


  • Basic : Example of using default options.
  • Mobile UI : Example of the keyboard UI when used on a mobile device.


TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

Via Package Manager

TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

$ npm install --save tui-virtual-keyboard # Latest version
$ npm install --save tui-virtual-keyboard@<version> # Specific version
$ bower install tui-virtual-keyboard # Latest version
$ bower install tui-virtual-keyboard#<tag> # Specific version

Via Contents Delivery Network (CDN)

TOAST UI products are available over a CDN powered by TOAST Cloud.

You can use CDN as below.

<script src=""></script>

If you want to use a specific version, use the tag name instead of latest in the url's path.

The CDN directory has the following structure.

├─ latest
│  ├─ tui-virtual-keyboard.js
│  ├─ tui-virtual-keyboard.min.js
├─ v2.0.1/
│  ├─ ...

Download Source Files



Add the container element to create the component.

<ul id="tui-virtual-keyboard-container"></ul>


This can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.

Using namespace in browser environment
var VirtualKeyboard = tui.VirtualKeyboard;
Using module format in node environment
var VirtualKeyboard = require('tui-virtual-keyboard'); /* CommonJS */
import VirtualKeyboard from 'tui-virtual-keyboard'; /* ES6 */

You can create an instance with options and call various APIs after creating an instance.

var container = document.getElementById('tui-virtual-keyboard-container');
var instance = new VirtualKeyboard(container, { ... });


For more information about the API, please see here.


You can also see the older versions of API page on the releases page.



This software is licensed under the MIT © NHN.