2019-08-13 13:19:13 +08:00
< p >
< a href = "https://simple-keyboard.com/demo" >
2021-03-22 02:25:13 +08:00
< img alt = "simple-keyboard: Javascript Virtual Keyboard" src = "https://i.imgur.com/PrpbdIu.png" >
2019-08-13 13:19:13 +08:00
< / 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-10-14 00:03:48 +08:00
< a href = "https://github.com/hodgef/simple-keyboard/actions" >
< img alt = "Build Status" src = "https://github.com/hodgef/simple-keyboard/workflows/Build/badge.svg?color=green" / >
< / a >
< a href = "https://github.com/hodgef/simple-keyboard/actions" >
< img alt = "Publish Status" src = "https://github.com/hodgef/simple-keyboard/workflows/Publish/badge.svg?color=green" / >
2019-08-13 13:19:13 +08:00
< / a >
< / p >
2018-04-21 04:34:02 +08:00
2021-03-19 10:43:29 +08:00
< blockquote > Virtual Keyboard for Javascript. Compatible with your JS, React, Angular or Vue projects.< / blockquote >
2019-08-13 23:14:44 +08:00
2021-03-26 23:42:11 +08:00
## 🚀 Demo
2021-03-16 12:41:42 +08:00
2019-08-13 13:28:28 +08:00
[Demo Showcase (Vanilla, Angular, React, Vue) ](https://simple-keyboard.com/demo )
2021-03-26 23:42:11 +08:00
## 📦 Installation & Usage
2021-03-16 12:41:42 +08:00
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.
2021-03-16 12:41:42 +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
2021-03-26 23:42:11 +08:00
## 📖 Documentation
2021-03-16 12:41:42 +08:00
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
2019-11-04 09:26:45 +08:00
Feel free to browse the [Questions & Answers (FAQ) ](https://simple-keyboard.com/qa-use-cases/ ) page for common use-cases.
2018-09-25 03:52:54 +08:00
2018-04-21 04:34:02 +08:00
### To run demo on your own computer
2021-03-16 12:41:42 +08:00
- Clone this repository
- `npm install`
- `npm start`
- Visit [http://localhost:3000/ ](http://localhost:3000/ )
2018-04-21 04:34:02 +08:00
2018-06-08 22:59:11 +08:00
### Other versions
2018-04-21 04:34:02 +08:00
2021-03-16 12:41:42 +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
2020-05-28 13:12:00 +08:00
### Questions? Join the chat
2018-10-09 07:12:51 +08:00
2020-06-14 03:38:34 +08:00
< a href = "https://discordapp.com/invite/SJexsCG" title = "Join our Discord chat" target = "_blank" > < img src = "https://discordapp.com/api/guilds/498978399801573396/widget.png?style=banner2" align = "center" > < / a >
2018-10-09 07:12:51 +08:00
2021-03-26 23:42:11 +08:00
## ✳️ Modules
2019-10-16 05:00:15 +08:00
2020-05-28 13:10:55 +08:00
You can extend simple-keyboard's functionality with [modules ](https://hodgef.com/simple-keyboard/modules/ ). Such as:
2019-10-16 05:00:15 +08:00
2021-03-16 12:41:42 +08:00
- [Autocorrect ](https://hodgef.com/simple-keyboard/modules/autocorrect/ )
- [Input Mask ](https://hodgef.com/simple-keyboard/modules/input-mask/ )
- [Key Navigation ](https://hodgef.com/simple-keyboard/modules/key-navigation/ )
- [Swipe Keyboard ](https://hodgef.com/simple-keyboard/modules/swipe-keyboard/ )
2019-10-16 05:00:15 +08:00
2020-05-28 13:10:55 +08:00
Want to create your own module? Check out the [Modules page ](https://hodgef.com/simple-keyboard/modules/ ) for instructions.
2019-10-16 05:00:15 +08:00
2021-03-26 23:42:11 +08:00
## 🎯 Compatibility
2021-03-18 12:11:23 +08:00
2021-03-16 12:41:42 +08:00
- Internet Explorer 11
- Edge (Spartan) 16+
- Edge (Anaheim/Edge Chromium) 79+
- Chrome 49+
- Safari 9+
- Firefox 57+
- iOS 9+
2019-09-25 23:34:23 +08:00
2021-10-13 16:52:09 +08:00
> Note: If you don't want to support old browsers, you can use the Modern Browsers bundle ([index.modern.js](https://github.com/hodgef/simple-keyboard/blob/master/build)).
2021-10-13 12:40:31 +08:00
2021-03-26 23:42:11 +08:00
## ✅ Contributing
2019-09-25 23:41:12 +08:00
2020-08-26 12:54:56 +08:00
PRs and issues are always welcome. Feel free to submit any issues you have at:
2019-09-25 23:41:12 +08:00
[https://github.com/hodgef/simple-keyboard/issues ](https://github.com/hodgef/simple-keyboard/issues )
