2018-10-21 02:21:40 +08:00
|
|
|
[](https://github.com/hodgef/simple-keyboard/blob/master/LICENSE)
|
|
|
|
|
[](https://www.npmjs.com/package/simple-keyboard)
|
2018-10-15 10:52:00 +08:00
|
|
|
[](https://travis-ci.org/hodgef/simple-keyboard)
|
2018-10-17 06:00:21 +08:00
|
|
|
[](https://codecov.io/gh/hodgef/simple-keyboard)
|
2018-10-15 06:58:03 +08:00
|
|
|
[](http://franciscohodge.com/simple-keyboard/chat/join)
|
2018-07-19 22:13:09 +08:00
|
|
|
|
2018-10-21 02:21:40 +08:00
|
|
|
<a href="https://simple-keyboard.com/demo" title="View Demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/simplekeyboard-banner_B.png" align="center" width="100%"></a>
|
|
|
|
|
<a href="https://simple-keyboard.com/demo" title="View Demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/simple-keyboard-10172018.gif" align="center" width="100%"></a>
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-05-31 11:15:01 +08:00
|
|
|
> The easily customisable and responsive on-screen virtual keyboard for Javascript projects.
|
2018-04-21 04:34:02 +08:00
|
|
|
|
|
|
|
|
## Installation
|
2018-10-21 02:21:40 +08:00
|
|
|
You can use simple-keyboard as a <script> tag from a CDN, or install it from npm.
|
|
|
|
|
|
|
|
|
|
Check out the [**Getting Started**](https://simple-keyboard.com/getting-started) docs for more info.
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-10-21 02:21:40 +08:00
|
|
|
## Usage
|
|
|
|
|
You can find the **simple-keyboard documentation** [on the website](https://simple-keyboard.com/documentation).
|
2018-04-24 21:38:14 +08:00
|
|
|
|
2018-10-21 02:21:40 +08:00
|
|
|
Feel free to browse the [Q&A / Use-cases](https://simple-keyboard.com/qa-use-cases/) page for advanced use-cases.
|
2018-09-25 03:52:54 +08:00
|
|
|
|
2018-04-21 04:34:02 +08:00
|
|
|
## Demo
|
|
|
|
|
|
|
|
|
|
[https://franciscohodge.com/simple-keyboard/demo](https://franciscohodge.com/simple-keyboard/demo)
|
|
|
|
|
|
2018-10-15 06:58:03 +08:00
|
|
|
<a href="https://codesandbox.io/s/github/hodgef/demo_npm_simple-keyboard" title="run demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/rundemo200.png" width="150" align="center"></a>
|
2018-05-31 10:28:51 +08:00
|
|
|
|
2018-04-21 04:34:02 +08:00
|
|
|
### To run demo on your own computer
|
|
|
|
|
|
|
|
|
|
* Clone this repository
|
|
|
|
|
* `npm install`
|
|
|
|
|
* `npm start`
|
|
|
|
|
* Visit [http://localhost:3000/](http://localhost:3000/)
|
|
|
|
|
|
2018-06-08 22:59:11 +08:00
|
|
|
### Other versions
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-06-08 22:59:11 +08:00
|
|
|
* ReactJS - [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard)
|
|
|
|
|
|
2018-10-09 07:12:51 +08:00
|
|
|
### Questions?
|
|
|
|
|
|
|
|
|
|
<a href="http://franciscohodge.com/simple-keyboard/chat/join" title="Join our Discord chat" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/discord.png" align="center" width="200"></a>
|
|
|
|
|
|
2018-06-08 22:59:11 +08:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
PR's and issues are welcome. Feel free to submit any issues you have at:
|
2018-04-21 04:34:02 +08:00
|
|
|
[https://github.com/hodgef/simple-keyboard/issues](https://github.com/hodgef/simple-keyboard/issues)
|
