github/simple-keyboard
github/simple-keyboard
3
0
Fork 0
mirror of https://github.com/hodgef/simple-keyboard.git synced 2025-02-07 23:03:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updating README

Browse Source
This commit is contained in:
Francisco Hodge 2018-10-06 19:00:30 -04:00
parent 53611310c0
commit 0b1a25c8d9
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -6,6 +6,10 @@
> The easily customisable and responsive on-screen virtual keyboard for Javascript projects. > The easily customisable and responsive on-screen virtual keyboard for Javascript projects.
This package works with <a href="https://codesandbox.io/s/krzkx19rr" title="View Vanilla JS Demo" target="_blank">**Vanilla JS**</a> projects, yet it is also compatible with <a href="https://codesandbox.io/s/48qqy8mn84" title="View Angular Demo" target="_blank">**Angular**</a>, <a href="https://codesandbox.io/s/53orr7mmq4" title="View Vue Demo" target="_blank">**Vue**</a>, and other libraries and frameworks.
Looking for **React** support? Check out [react-simple-keyboard](https://www.npmjs.com/package/react-simple-keyboard) !
## Installation ## Installation
### npm ### npm
@ -407,6 +411,8 @@ keyboard.dispatch(instance => {
}); });
``` ```
[![Edit simple-keyboard dispatch demo - npm](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/rjnlp4pp2q?module=%2Fsrc%2Findex.js)
### getButtonElement ### getButtonElement
> Get the DOM Element of a button. If there are several buttons with the same name, an array of the DOM Elements is returned. > Get the DOM Element of a button. If there are several buttons with the same name, an array of the DOM Elements is returned.
@ -438,8 +444,6 @@ Unlike the `buttonTheme` property, which replaces entries, `removeButtonTheme` r
this.keyboard.removeButtonTheme("b c", "myClass1 myClass2"); this.keyboard.removeButtonTheme("b c", "myClass1 myClass2");
``` ```
[![Edit simple-keyboard dispatch demo - npm](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/rjnlp4pp2q?module=%2Fsrc%2Findex.js)
## Q&A / Use-cases ## Q&A / Use-cases
### How to give a different base class to my keyboard ### How to give a different base class to my keyboard