simple-keyboard/README.md

<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://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" />
  </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://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>

> The slick virtual keyboard for Javascript. Compatible with your JS, React, Angular or Vue projects.

## 🚀 Demo
[Demo Showcase (Vanilla, Angular, React, Vue)](https://simple-keyboard.com/demo)

## 📦 Installation & Usage
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 to begin.

## 📖 Documentation
Check out the [simple-keyboard documentation](https://simple-keyboard.com/documentation) site.

Feel free to browse the [Questions & Answers (FAQ)](https://simple-keyboard.com/qa-use-cases/) page for common use-cases.


### To run demo on your own computer

* Clone this repository
* `npm install`
* `npm start`
* Visit [http://localhost:3000/](http://localhost:3000/)

### Other versions

* [React.js](https://github.com/hodgef/react-simple-keyboard)
* [Angular](https://simple-keyboard.com/demo)
* [Vue.js](https://simple-keyboard.com/demo)

### 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>

## ✳️ Modules

You can extend simple-keyboard's functionality with [modules](https://franciscohodge.com/projects/simple-keyboard/modules/). Such as:

* [Autocorrect](https://franciscohodge.com/projects/simple-keyboard/demo-showcase/module-autocorrect/)
* [Input Mask](https://franciscohodge.com/projects/simple-keyboard/demo-showcase/module-input-mask/)
* [Key Navigation](https://franciscohodge.com/projects/simple-keyboard/demo-showcase/module-key-navigation/)
* [Swipe Keyboard](https://franciscohodge.com/projects/simple-keyboard/demo-showcase/module-swipe-keyboard/)

Want to create your own module? Check out the [Modules page](https://franciscohodge.com/projects/simple-keyboard/modules/) for instructions.

## 🎯 Compatibility

> Simple-keyboard is intended for modern, standards-compliant browsers.
> Internet Explorer is sadly not one of them, and since its 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).

## ✅ 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)