2019-08-13 01:19:13 -04:00
|
|
|
<p>
|
|
|
|
|
<a href="https://simple-keyboard.com/demo">
|
|
|
|
|
<img alt="simple-keyboard: Javscript Virtual Keyboard" src="https://i.imgur.com/Po6659n.gif">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a href="https://www.npmjs.com/package/simple-keyboard">
|
|
|
|
|
<img src="https://badgen.net/npm/v/simple-keyboard?color=blue" alt="npm version">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a href="https://bundlephobia.com/result?p=simple-keyboard">
|
|
|
|
|
<img src="https://badgen.net/bundlephobia/minzip/simple-keyboard/?color=green" alt="install size">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a href="https://travis-ci.org/hodgef/simple-keyboard">
|
|
|
|
|
<img src="https://api.travis-ci.org/hodgef/simple-keyboard.svg?branch=master"
|
|
|
|
|
alt="build status">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a href="https://david-dm.org/hodgef/simple-keyboard">
|
|
|
|
|
<img src="https://badgen.net/david/dep/hodgef/simple-keyboard" alt="coverage">
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<a href="https://codecov.io/gh/hodgef/simple-keyboard">
|
|
|
|
|
<img src="https://badgen.net/codecov/c/github/hodgef/simple-keyboard" alt="coverage">
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2019-08-13 11:14:44 -04:00
|
|
|
> The slick virtual keyboard for Javascript. Compatible with your JS, React, Angular or Vue projects.
|
|
|
|
|
|
2019-08-13 01:28:28 -04:00
|
|
|
## 🚀 Demo
|
|
|
|
|
[Demo Showcase (Vanilla, Angular, React, Vue)](https://simple-keyboard.com/demo)
|
|
|
|
|
|
2018-10-29 11:02:21 -04:00
|
|
|
## 📦 Installation & Usage
|
2018-10-20 14:37:06 -04:00
|
|
|
You can use simple-keyboard as a `<script>` tag from a CDN, or install it from npm.
|
2018-10-20 14:21:40 -04:00
|
|
|
|
2018-10-20 14:47:31 -04:00
|
|
|
Check out the [Getting Started](https://simple-keyboard.com/getting-started) docs to begin.
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-10-29 11:02:21 -04:00
|
|
|
## 📖 Documentation
|
2018-10-20 14:47:31 -04:00
|
|
|
Check out the [simple-keyboard documentation](https://simple-keyboard.com/documentation) site.
|
2018-04-24 09:38:14 -04:00
|
|
|
|
2018-10-20 14:21:40 -04:00
|
|
|
Feel free to browse the [Q&A / Use-cases](https://simple-keyboard.com/qa-use-cases/) page for advanced use-cases.
|
2018-09-24 15:52:54 -04:00
|
|
|
|
2018-05-30 22:28:51 -04:00
|
|
|
|
2018-04-20 16:34:02 -04: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 10:59:11 -04:00
|
|
|
### Other versions
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-11-25 20:15:15 -05:00
|
|
|
* [React.js](https://github.com/hodgef/react-simple-keyboard)
|
|
|
|
|
* [Angular](https://simple-keyboard.com/demo)
|
|
|
|
|
* [Vue.js](https://simple-keyboard.com/demo)
|
2018-06-08 10:59:11 -04:00
|
|
|
|
2018-10-08 19:12:51 -04: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-10-29 11:02:21 -04:00
|
|
|
## ✅ Contributing
|
2018-06-08 10:59:11 -04:00
|
|
|
|
|
|
|
|
PR's and issues are welcome. Feel free to submit any issues you have at:
|
2018-04-20 16:34:02 -04:00
|
|
|
[https://github.com/hodgef/simple-keyboard/issues](https://github.com/hodgef/simple-keyboard/issues)
|
