geokbd.js

2.2.2 • Public • Published

geokbd.js - Demo

Georgian virtual keyboard

Installation:

With script tag:

<link href="/path/to/package/dist/css/themes/default.min.css" rel="stylesheet" /> <!-- optional -->
<script src="/path/to/package/dist/js/geokbd.min.js"></script>
<script>
  var GeoKBD = window['geokbd'];
</script>

With package manager:

npm install geokbd.js --save or yarn add geokbd.js

import GeoKBD from 'geokbd.js';

If you want to use default theme, you should include dist/css/themes/default.min.css in your bundle however you like.

Usage:

var targetElement = document.getElementById('target-element');

GeoKBD.initialize();
GeoKBD.attach(targetElement);

API:

registerTheme(name: string, theme: any) - Register custom theme.

name: string - Theme name

theme: any - Theme class, which implements the following interface:

abstract class AbstractTheme {
  constructor(config: GlobalConfig) {}
  public abstract onAttach(target: TargetElement): void;
  public abstract onConfigurationChange(config: GlobalConfig): void;
  public abstract onDetach(target: TargetElement): void;
  public abstract onDestroy(): void;
}
initialize(config: Object) - Perform one time initialization

config: Object - Configuration object.

{
  theme: 'default',
  hotkey: '`',
  enabled: 'true'
}
attach(target: Element) - Attach functionality to target element

target: Element - HTMLInputElement | HTMLTextAreaElement

detach(target: Element) - Detach functionality from target element

target: Element - HTMLInputElement | HTMLTextAreaElement

Using custom themes:

WIP

Package Sidebar

Install

npm i geokbd.js

Weekly Downloads

1

Version

2.2.2

License

MIT

Unpacked Size

106 kB

Total Files

19

Last publish

Collaborators

  • thisdotvoid