2019-08-13 13:19:13 +08:00
< p >
< a href = "https://simple-keyboard.com/demo" >
< img alt = "simple-keyboard: Javscript Virtual Keyboard" src = "https://i.imgur.com/Po6659n.gif" >
< / a >
2019-08-27 11:20:28 +08:00
2019-08-13 13:19:13 +08:00
< a href = "https://www.npmjs.com/package/simple-keyboard" >
< img src = "https://badgen.net/npm/v/simple-keyboard?color=blue" alt = "npm version" >
< / a >
2019-08-27 11:20:28 +08:00
< a href = "https://actions-badge.atrox.dev/hodgef/simple-keyboard/goto" >
< img alt = "Build Status" src = "https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fhodgef%2Fsimple-keyboard%2Fbadge&style=flat" / >
2019-08-13 13:19:13 +08:00
< / a >
2019-08-27 11:20:28 +08:00
< a href = "https://bundlephobia.com/result?p=simple-keyboard" >
< img src = "https://badgen.net/bundlephobia/minzip/simple-keyboard/?color=green" alt = "install size" >
2019-08-13 13:19:13 +08:00
< / 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-21 04:34:02 +08:00
2019-08-13 23:14:44 +08:00
> The slick virtual keyboard for Javascript. Compatible with your JS, React, Angular or Vue projects.
2019-08-13 13:28:28 +08:00
## 🚀 Demo
[Demo Showcase (Vanilla, Angular, React, Vue) ](https://simple-keyboard.com/demo )
2018-10-29 23:02:21 +08:00
## 📦 Installation & Usage
2018-10-21 02:37:06 +08:00
You can use simple-keyboard as a `<script>` tag from a CDN, or install it from npm.
2018-10-21 02:21:40 +08:00
2018-10-21 02:47:31 +08:00
Check out the [Getting Started ](https://simple-keyboard.com/getting-started ) docs to begin.
2018-04-21 04:34:02 +08:00
2018-10-29 23:02:21 +08:00
## 📖 Documentation
2018-10-21 02:47:31 +08:00
Check out the [simple-keyboard documentation ](https://simple-keyboard.com/documentation ) site.
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-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-11-26 09:15:15 +08: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 22:59:11 +08:00
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 >
2019-09-25 23:41:12 +08:00
## :dart: Compatibility
2019-09-25 23:34:23 +08:00
> Simple-keyboard is intended for modern, standards-compliant browsers.
> Internet Explorer is sadly not one of them, and since it's market-share is negligible (~2% for IE11), resources won't be spent in trying to support it.
>
> To learn more about the rationale for not supporting IE, check out [this link](https://techcommunity.microsoft.com/t5/Windows-IT-Pro-Blog/The-perils-of-using-Internet-Explorer-as-your-default-browser/ba-p/331732).
2019-09-25 23:41:12 +08:00
## ✅ Contributing
PR's and issues are welcome. Feel free to submit any issues you have at:
[https://github.com/hodgef/simple-keyboard/issues ](https://github.com/hodgef/simple-keyboard/issues )
