Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xxzefgh/vue-geokbd

Vue.js georgian keyboard directive
https://github.com/xxzefgh/vue-geokbd

vue

Last synced: 3 months ago
JSON representation

Vue.js georgian keyboard directive

Awesome Lists containing this project

README

        

# vue-geokbd - Vue.js georgian keyboard directive

Simple directive to convert english characters to georgian in `` and `` fields

[Demo](https://rawgit.com/brunjick/vue-geokbd/master/example.html)

### Installation

#### Bower
```bash
bower install vue-geokbd --save
```

#### NPM
```bash
npm install vue-geokbd --save
```

### Getting Started

#### Styling
You can import styles from ```dist/css/vue-geokbd.min.css``` however you want.
If you aren't happy with default styling, copy ```dist/css/vue-geokbd.css``` and adjust it to your needs.

#### Loading & Initializing
##### HTML
```html

// Vue object should be available here, see example.html for proper usage
Vue.use(window['vue-geokbd']);

```

##### ES6 Modules
```js
import Vue from 'vue';
import geokbd from 'vue-geokbd';

Vue.use(geokbd);
```

#### Usage
Apply `v-geokbd` directive to either `` or ``
```html

```

#### Options
You can pass initialization options like this
```js
// These options are default
Vue.use(geokbd, {
// Enable conversion by default, until user switches on/off state
enabled: false,
// Global on/off state switcher hotkey
hotkey: '~',
// Show status message when focus is on element
statusMessage: true
});
```