2018-10-25 06:18:24 +08:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< base data-ice = "baseUrl" >
< title data-ice = "title" > Home | simple-keyboard< / title >
< link type = "text/css" rel = "stylesheet" href = "css/style.css" >
< link type = "text/css" rel = "stylesheet" href = "css/prettify-tomorrow.css" >
< script src = "script/prettify/prettify.js" > < / script >
< script src = "script/manual.js" > < / script >
< meta name = "description" content = "On-screen Javascript Virtual Keyboard" > < meta property = "twitter:card" content = "summary" > < meta property = "twitter:title" content = "simple-keyboard" > < meta property = "twitter:description" content = "On-screen Javascript Virtual Keyboard" > < / head >
< body class = "layout-container" data-ice = "rootContainer" >
< header >
< a href = "./" > Home< / a >
< a href = "identifiers.html" > Reference< / a >
< a href = "source.html" > Source< / a >
< div class = "search-box" >
< span >
< img src = "./image/search.png" >
< span class = "search-input-edge" > < / span > < input class = "search-input" > < span class = "search-input-edge" > < / span >
< / span >
< ul class = "search-result" > < / ul >
< / div >
< a style = "position:relative; top:3px;" href = "https://github.com/hodgef/simple-keyboard" > < img width = "20px" src = "./image/github.png" > < / a > < / header >
< nav class = "navigation" data-ice = "nav" > < div >
< ul >
< li data-ice = "doc" > < a data-ice = "dirPath" class = "nav-dir-path" href = "identifiers.html#demo" > demo< / a > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/demo/App.js~App.html" > App< / a > < / span > < / span > < / li >
< li data-ice = "doc" > < a data-ice = "dirPath" class = "nav-dir-path" href = "identifiers.html#lib-components" > lib/components< / a > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/lib/components/Keyboard.js~SimpleKeyboard.html" > SimpleKeyboard< / a > < / span > < / span > < / li >
< li data-ice = "doc" > < a data-ice = "dirPath" class = "nav-dir-path" href = "identifiers.html#lib-services" > lib/services< / a > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html" > KeyboardLayout< / a > < / span > < / span > < / li >
< li data-ice = "doc" > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html" > PhysicalKeyboard< / a > < / span > < / span > < / li >
< li data-ice = "doc" > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/lib/services/Utilities.js~Utilities.html" > Utilities< / a > < / span > < / span > < / li >
< li data-ice = "doc" > < a data-ice = "dirPath" class = "nav-dir-path" href = "identifiers.html#lib-tests" > lib/tests< / a > < span data-ice = "kind" class = "kind-class" > C< / span > < span data-ice = "name" > < span > < a href = "class/src/lib/tests/TestUtility.js~TestUtility.html" > TestUtility< / a > < / span > < / span > < / li >
< / ul >
< / div >
< / nav >
2018-10-29 23:47:56 +08:00
< div class = "content" data-ice = "content" > < div data-ice = "index" class = "github-markdown" > < p > < div >
< 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" 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" width = "100%" > < / a >
< blockquote> The easily customisable and responsive on-screen virtual keyboard for Javascript projects.< /blockquote>
< p > < a href = "https://github.com/hodgef/simple-keyboard/blob/master/LICENSE" target = "_blank" > < img src = "https://img.shields.io/badge/license-MIT-blue.svg" > < / a >
< a href = "https://www.npmjs.com/package/simple-keyboard" target = "_blank" > < img src = "https://img.shields.io/npm/v/simple-keyboard.svg?style=flat" > < / a >
< a href = "https://travis-ci.org/hodgef/simple-keyboard" target = "_blank" > < img src = "https://travis-ci.org/hodgef/simple-keyboard.svg?branch=master" > < / a >
< a href = "https://codecov.io/gh/hodgef/simple-keyboard" target = "_blank" > < img src = "https://img.shields.io/codecov/c/github/hodgef/simple-keyboard/master.svg?style=flat" > < / a >
< a href = "https://doc.esdoc.org/github.com/hodgef/simple-keyboard" target = "_blank" > < img src = "https://doc.esdoc.org/github.com/hodgef/simple-keyboard/badge.svg" > < / a >
< / p >
< / div >
< / p >
< h2 id = "📦-installation--amp--usage" > 📦 Installation & Usage< / h2 > < p > You can use simple-keyboard as a < code > < script> < / code > tag from a CDN, or install it from npm.< / p >
2018-10-25 06:18:24 +08:00
< p > Check out the < a href = "https://simple-keyboard.com/getting-started" > Getting Started< / a > docs to begin.< / p >
2018-10-29 23:47:56 +08:00
< h2 id = "📖-documentation" > 📖 Documentation< / h2 > < p > Check out the < a href = "https://simple-keyboard.com/documentation" > simple-keyboard documentation< / a > site.< / p >
2018-10-25 06:18:24 +08:00
< p > Feel free to browse the < a href = "https://simple-keyboard.com/qa-use-cases/" > Q& A / Use-cases< / a > page for advanced use-cases.< / p >
2018-10-29 23:47:56 +08:00
< h2 id = "🚀-demo" > 🚀 Demo< / h2 > < p > < a href = "https://simple-keyboard.com/demo" > https://simple-keyboard.com/demo< / a > < / p >
2018-10-25 06:18:24 +08:00
< h3 id = "to-run-demo-on-your-own-computer" > To run demo on your own computer< / h3 > < ul >
< li > Clone this repository< / li >
< li > < code > npm install< / code > < / li >
< li > < code > npm start< / code > < / li >
< li > Visit < a href = "http://localhost:3000/" > http://localhost:3000/< / a > < / li >
< / ul >
< h3 id = "other-versions" > Other versions< / h3 > < ul >
< li > ReactJS - < a href = "https://github.com/hodgef/react-simple-keyboard" > react-simple-keyboard< / a > < / li >
< / ul >
< h3 id = "questions-" > Questions?< / h3 > < p > < 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" width = "200" > < / a > < / p >
2018-10-29 23:47:56 +08:00
< h2 id = "✅-contributing" > ✅ Contributing< / h2 > < p > PR' s and issues are welcome. Feel free to submit any issues you have at:
2018-10-25 06:18:24 +08:00
< a href = "https://github.com/hodgef/simple-keyboard/issues" > https://github.com/hodgef/simple-keyboard/issues< / a > < / p >
< / div >
< / div >
< footer class = "footer" >
Generated by < a href = "https://esdoc.org" > ESDoc< span data-ice = "esdocVersion" > (1.1.0)< / span > < img src = "./image/esdoc-logo-mini-black.png" > < / a >
< / footer >
< script src = "script/search_index.js" > < / script >
< script src = "script/search.js" > < / script >
< script src = "script/pretty-print.js" > < / script >
< script src = "script/inherited-summary.js" > < / script >
< script src = "script/test-summary.js" > < / script >
< script src = "script/inner-link.js" > < / script >
< script src = "script/patch-for-local.js" > < / script >
< / body >
< / html >
