TOAST UI Component : Virtual Keyboard

Component that creates a virtual keyboard that replacing the native keyboard of the browser.

GitHub release npm GitHub license PRs welcome code with hearth by NHN Entertainment

🚩 Table of Contents

🌏 Browser Support

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

🎨 Features

  • 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.

🐾 Examples

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

💾 Install

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

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

bower

$ 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="https://uicdn.toast.com/tui.virtual-keyboard/latest/tui-virtual-keyboard.js"></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.

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

Download Source Files

🔨 Usage

HTML

Add the container element to create the component.

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

JavaScript

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, { ... });

instance.shuffle();

For more information about the API, please see here.

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{your-personal-repo}/tui.virtual-keyboard.git
$ cd tui.virtual-keyboard
$ npm install
$ npm run test

Develop

Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8

Run karma test

$ npm run test

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

For more information on PR's step, please see links of Contributing section.

📙 Documents

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

💬 Contributing

🔩 Dependency

📜 License

This software is licensed under the MIT © NHN Entertainment.