<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl"> <title data-ice="title">Reference | 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> <div class="content" data-ice="content"><h1>References</h1> <div class="identifiers-wrap"> <div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="demo">demo</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/demo/App.js~App.html">App</a></span></span> </p> </div> <div> <div data-ice="description"><p>simple-keyboard demo</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="lib-components">lib/components</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/lib/components/Keyboard.js~SimpleKeyboard.html">SimpleKeyboard</a></span></span> </p> </div> <div> <div data-ice="description"><p>Root class for simple-keyboard This class:</p> <ul> <li>Parses the options</li> <li>Renders the rows and buttons</li> <li>Handles button functionality</li> </ul> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="lib-services">lib/services</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html">KeyboardLayout</a></span></span> </p> </div> <div> <div data-ice="description"><p>Keyboard Layout Service</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html">PhysicalKeyboard</a></span></span> </p> </div> <div> <div data-ice="description"><p>Physical Keyboard Service</p> </div> </div> </td> <td> </td> </tr> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/lib/services/Utilities.js~Utilities.html">Utilities</a></span></span> </p> </div> <div> <div data-ice="description"><p>Utility Service</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> <div data-ice="dirSummaryWrap"> <h2 data-ice="dirPath" id="lib-tests">lib/tests</h2> <div data-ice="dirSummary"><table class="summary" data-ice="summary"> <thead><tr><td data-ice="title" colspan="3">summary</td></tr></thead> <tbody> <tr data-ice="target"> <td> <span class="access" data-ice="access">public</span> <span class="override" data-ice="override"></span> </td> <td> <div> <p> <span data-ice="kind-icon" class="kind-class">C</span> <span class="code" data-ice="name"><span><a href="class/src/lib/tests/TestUtility.js~TestUtility.html">TestUtility</a></span></span> </p> </div> <div> <div data-ice="description"><p>Test Utility Functions</p> </div> </div> </td> <td> </td> </tr> </tbody> </table> </div> </div> </div> <div class="identifier-dir-tree" data-ice="dirTreeWrap"> <div class="identifier-dir-tree-header">Directories</div> <div class="identifier-dir-tree-content" data-ice="dirTree"><div style="padding-left: 0em"><a href="#demo">demo</a></div> <div style="padding-left: 1em"><a href="#lib-components">components</a></div> <div style="padding-left: 1em"><a href="#lib-services">services</a></div> <div style="padding-left: 1em"><a href="#lib-tests">tests</a></div></div> </div> </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>