2018-04-21 04:34:02 +08:00
# simple-keyboard
[](https://www.npmjs.com/package/simple-keyboard)
< a href = "https://franciscohodge.com/projects/simple-keyboard/" > < img src = "src/demo/images/simple-keyboard.png" align = "center" > < / a >
> An easily customisable and responsive on-screen virtual keyboard for Javascript projects.
2018-04-23 18:35:37 +08:00
> Want the React.js version? Get [react-simple-keyboard](https://www.npmjs.com/package/react-simple-keyboard) instead!
2018-04-21 04:34:02 +08:00
< img src = "src/demo/images/keyboard.PNG" align = "center" width = "100%" >
< b > [Live Demo](https://franciscohodge.com/simple-keyboard/demo)< / b >
## Installation
2018-04-24 21:38:14 +08:00
### npm
2018-04-21 04:34:02 +08:00
`npm install simple-keyboard --save`
2018-04-24 21:38:14 +08:00
### zip file (self-hosted)
[Click here to download the latest release (zip format). ](https://github.com/hodgef/simple-keyboard/zipball/master )
> Want to use a CDN instead of self-host? Scroll down to the "Usage from CDN" instructions below.
## Usage with npm
2018-04-21 04:34:02 +08:00
### js
````js
import Keyboard from 'simple-keyboard';
import 'simple-keyboard/build/css/index.css';
2018-04-24 21:38:14 +08:00
class App {
constructor(){
document.addEventListener('DOMContentLoaded', this.onDOMLoaded);
}
onDOMLoaded = () => {
this.keyboard = new Keyboard({
onChange: input => this.onChange(input),
onKeyPress: button => this.onKeyPress(button)
});
}
onChange = input => {
console.log("Input changed", input);
}
onKeyPress = button => {
console.log("Button pressed", button);
}
}
export default App;
2018-04-21 04:34:02 +08:00
````
### html
````html
< div class = "simple-keyboard" > < / div >
````
> Need a more extensive example? [Click here](https://github.com/hodgef/simple-keyboard/blob/master/src/demo/App.js).
2018-04-24 21:38:14 +08:00
## Usage from CDN
### html
````html
<!DOCTYPE html>
< html lang = "en" >
< head >
< link rel = "stylesheet" href = "https://cdn.rawgit.com/hodgef/simple-keyboard/d477c35c/build/css/index.css" >
< / head >
< body >
< div class = "simple-keyboard" > < / div >
< script src = "https://cdn.rawgit.com/hodgef/simple-keyboard/d477c35c/build/index.js" > < / script >
2018-04-24 22:06:23 +08:00
< script >
function keyboard_onChange(input){
2018-04-24 22:10:20 +08:00
console.log("Input changed", input);
2018-04-24 22:06:23 +08:00
}
function keyboard_onKeyPress(button){
console.log("Button pressed", button);
}
var myKeyboard = new Keyboard({
onChange: input => keyboard_onChange(input),
onKeyPress: button => keyboard_onKeyPress(button)
});
< / script >
2018-04-24 21:38:14 +08:00
< / body >
< / html >
````
2018-04-21 04:34:02 +08:00
## Options
You can customize the Keyboard by passing options to it.
Here are the available options (the code examples are the defaults):
### layout
> Modify the keyboard layout
```js
layout: {
'default': [
'` 1 2 3 4 5 6 7 8 9 0 - = {bksp}',
'{tab} q w e r t y u i o p [ ] \\',
'{lock} a s d f g h j k l ; \' {enter}',
'{shift} z x c v b n m , . / {shift}',
'.com @ {space}'
],
'shift': [
'~ ! @ # $ % ^ & * ( ) _ + {bksp}',
'{tab} Q W E R T Y U I O P { } |',
'{lock} A S D F G H J K L : " {enter}',
'{shift} Z X C V B N M < > ? {shift}',
'.com @ {space}'
]
}
```
### layoutName
> Specifies which layout should be used.
```js
layoutName: "default"
```
### display
> Replaces variable buttons (such as `{bksp}`) with a human-friendly name (e.g.: "delete").
```js
display: {
'{bksp}': 'delete',
'{enter}': '< enter ' ,
'{shift}': 'shift',
'{s}': 'shift',
'{tab}': 'tab',
'{lock}': 'caps',
'{accept}': 'Submit',
'{space}': ' ',
'{//}': ' '
}
```
### theme
> A prop to add your own css classes. You can add multiple classes separated by a space.
```js
theme: "hg-theme-default"
```
### debug
> Runs a console.log every time a key is pressed. Displays the buttons pressed and the current input.
```js
debug: false
```
### newLineOnEnter
> Specifies whether clicking the "ENTER" button will input a newline (`\n`) or not.
```js
newLineOnEnter: false
```
2018-04-30 23:05:55 +08:00
### inputName
> Allows you to use a single simple-keyboard instance for several inputs.
```js
inputName: "default"
```
2018-05-01 00:47:18 +08:00
### onKeyPress
> Executes the callback function on key press. Returns button layout name (i.e.: "{shift}").
```js
onKeyPress: (button) => console.log(button)
```
### onChange
> Executes the callback function on input change. Returns the current input's string.
```js
onChange: (input) => console.log(input)
```
### onChangeAll
> Executes the callback function on input change. Returns the input object with all defined inputs. This is useful if you're handling several inputs with simple-keyboard, as specified in the "*[Using several inputs](#using-several-inputs)*" guide.
```js
onChangeAll: (inputs) => console.log(inputs)
```
2018-04-21 04:34:02 +08:00
## Methods
2018-04-24 21:38:14 +08:00
simple-keyboard has a few methods you can use to further control it's behavior.
2018-04-21 04:34:02 +08:00
To access these functions, you need the instance the simple-keyboard component, like so:
```js
var keyboard = new Keyboard({
...
});
/>
// Then, use as follows...
keyboard.methodName(params);
```
### clearInput
> Clear the keyboard's input.
```js
2018-05-01 00:47:18 +08:00
// For default input (i.e. if you have only one)
2018-04-21 04:34:02 +08:00
keyboard.clearInput();
2018-05-01 00:47:18 +08:00
// For specific input
// Must have been previously set using the "inputName" prop.
keyboard.clearInput("inputName");
2018-04-21 04:34:02 +08:00
```
### getInput
> Get the keyboard's input (You can also get it from the _onChange_ prop).
```js
2018-05-01 00:47:18 +08:00
// For default input (i.e. if you have only one)
2018-04-21 04:34:02 +08:00
let input = keyboard.getInput();
2018-05-01 00:47:18 +08:00
// For specific input
// Must have been previously set using the "inputName" prop.
let input = keyboard.getInput("inputName");
2018-04-21 04:34:02 +08:00
```
### setInput
> Set the keyboard's input. Useful if you want the keybord to initialize with a default value, for example.
```js
2018-05-01 00:47:18 +08:00
// For default input (i.e. if you have only one)
2018-04-21 04:34:02 +08:00
keyboard.setInput("Hello World!");
2018-05-01 00:47:18 +08:00
// For specific input
// Must have been previously set using the "inputName" prop.
keyboard.setInput("Hello World!", "inputName");
2018-04-21 04:34:02 +08:00
```
2018-04-30 23:05:55 +08:00
### setOptions
> Set new option or modify existing ones after initialization. The changes are applied immediately.
```js
keyboard.setOptions({
theme: "my-custom-theme"
});
```
## Use-cases
### Using several inputs
Set the *[inputName](#inputname)* option for each input you want to handle with simple-keyboard.
For example:
```html
< input class = "input" id = "input1" value = "" / >
< input class = "input" id = "input2" value = "" / >
```
```js
// Initialize simple-keyboard as usual
var keyboard = new Keyboard({
onChange: input => console.log(input),
2018-04-30 23:11:31 +08:00
onKeyPress: button => console.log(button)
2018-04-30 23:05:55 +08:00
});
// Add an event listener for the inputs to be tracked
document.querySelectorAll('.input')
.forEach(input => input.addEventListener('focus', onInputFocus));
// Set the inputName option on the fly !
function onInputFocus(event){
keyboard.setOptions({
inputName: event.target.id
});
}
```
2018-05-01 00:47:18 +08:00
> [See full example](https://github.com/hodgef/simple-keyboard/blob/master/src/demo/MultipleInputsDemo.js).
2018-04-30 23:05:55 +08:00
2018-04-21 04:34:02 +08:00
## Demo
< img src = "src/demo/images/demo.gif" align = "center" width = "600" >
### Live demo
[https://franciscohodge.com/simple-keyboard/demo ](https://franciscohodge.com/simple-keyboard/demo )
### To run demo on your own computer
* Clone this repository
* `npm install`
* `npm start`
* Visit [http://localhost:3000/ ](http://localhost:3000/ )
## Note
This is a work in progress. Feel free to submit any issues you have at:
[https://github.com/hodgef/simple-keyboard/issues ](https://github.com/hodgef/simple-keyboard/issues )
