github/simple-keyboard
github/simple-keyboard
3
0
Fork 0
mirror of https://github.com/hodgef/simple-keyboard.git synced 2025-02-21 00:23:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Francisco Hodge 2018-10-24 20:20:28 -04:00
parent b4b0a3bb38
commit 222629abdd
10 changed files with 11418 additions and 12901 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2730
docs/ast/source/demo/App.js.json
View File

File diff suppressed because it is too large Load Diff

16164
docs/ast/source/lib/components/Keyboard.js.json
View File

File diff suppressed because it is too large Load Diff

5366
docs/ast/source/lib/services/PhysicalKeyboard.js.json
View File

File diff suppressed because it is too large Load Diff

12
docs/class/src/demo/App.js~App.html
View File

@ -141,7 +141,8 @@
<div>
<div data-ice="description"><p>Handles shift functionality</p>
</div>
</div>
</td>
<td>
@ -335,14 +336,15 @@
<span class="right-info">
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber56">source</a></span></span>
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber54">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Handles shift functionality</p>
</div>
@ -422,7 +424,7 @@
<span class="right-info">
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber68">source</a></span></span>
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber66">source</a></span></span>
</span>
</h3>
@ -510,7 +512,7 @@
<span class="right-info">
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber75">source</a></span></span>
<span data-ice="source"><span><a href="file/src/demo/App.js.html#lineNumber73">source</a></span></span>
</span>
</h3>

4
docs/file/src/demo/App.js.html
View File

@ -88,12 +88,10 @@ class App {
document.querySelector(&apos;.input&apos;).addEventListener(&apos;change&apos;, (event) =&gt; {
this.keyboard.setInput(event.target.value);
});
console.log(this.keyboard);
}
/**
*
* Handles shift functionality
*/
handleShiftButton = () =&gt; {
let layoutName = this.layoutName;

2
docs/file/src/lib/components/Keyboard.js.html
View File

@ -223,7 +223,7 @@ class SimpleKeyboard {
/**
* Clear the keyboard&#x2019;s input.
* @param {string} [inputName] optional - the internal input to select
* @param {string} [inputName] optional - the internal input to select
*/
clearInput = (inputName) =&gt; {
inputName = inputName || this.options.inputName;

4
docs/file/src/lib/services/PhysicalKeyboard.js.html
View File

@ -97,10 +97,6 @@ class PhysicalKeyboard {
* @param {object} event The KeyboardEvent
*/
getSimpleKeyboardLayoutKey = (event) =&gt; {
if(this.simpleKeyboardInstance.options.debug){
console.log(event);
}
let output;
if(

3
docs/index.html
View File

@ -43,13 +43,14 @@
<a href="https://www.npmjs.com/package/simple-keyboard"><img src="https://img.shields.io/npm/v/simple-keyboard.svg?style=flat" alt="npm version"></a>
<a href="https://travis-ci.org/hodgef/simple-keyboard"><img src="https://travis-ci.org/hodgef/simple-keyboard.svg?branch=master" alt="Build Status"></a>
<a href="https://codecov.io/gh/hodgef/simple-keyboard"><img src="https://codecov.io/gh/hodgef/simple-keyboard/branch/master/graph/badge.svg" alt="codecov"></a>
<a href="https://doc.esdoc.org/github.com/hodgef/simple-keyboard"><img src="https://doc.esdoc.org/github.com/hodgef/simple-keyboard/badge.svg" alt="Documentation Status"></a>
<a href="http://franciscohodge.com/simple-keyboard/chat/join"><img src="https://img.shields.io/badge/discord--chat-join-green.svg?longCache=true&amp;style=flat-square&amp;colorB=7289DA&amp;logo=discord" alt=""></a> </p>
<p><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></p>
<blockquote>
<p>The easily customisable and responsive on-screen virtual keyboard for Javascript projects.</p>
</blockquote>
<h2 id="installation">Installation</h2><p>You can use simple-keyboard as a <code>&lt;script&gt;</code> tag from a CDN, or install it from npm.</p>
<h2 id="installation--amp--usage">Installation &amp; Usage</h2><p>You can use simple-keyboard as a <code>&lt;script&gt;</code> tag from a CDN, or install it from npm.</p>
<p>Check out the <a href="https://simple-keyboard.com/getting-started">Getting Started</a> docs to begin.</p>
<h2 id="documentation">Documentation</h2><p>Check out the <a href="https://simple-keyboard.com/documentation">simple-keyboard documentation</a> site.</p>
<p>Feel free to browse the <a href="https://simple-keyboard.com/qa-use-cases/">Q&amp;A / Use-cases</a> page for advanced use-cases.</p>

18
docs/index.json
View File

File diff suppressed because one or more lines are too long

16
docs/source.html
View File

@ -58,9 +58,9 @@
<td data-ice="filePath"><span><a href="file/src/demo/App.js.html">src/demo/App.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/demo/App.js~App.html">App</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">8/8</span></td>
<td style="display: none;" data-ice="size">1927 byte</td>
<td style="display: none;" data-ice="lines">86</td>
<td style="display: none;" data-ice="updated">2018-10-04 21:35:25 (UTC)</td>
<td style="display: none;" data-ice="size">1919 byte</td>
<td style="display: none;" data-ice="lines">84</td>
<td style="display: none;" data-ice="updated">2018-10-04 23:21:26 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/demo/index.js.html">src/demo/index.js</a></span></td>
@ -74,9 +74,9 @@
<td data-ice="filePath"><span><a href="file/src/lib/components/Keyboard.js.html">src/lib/components/Keyboard.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/lib/components/Keyboard.js~SimpleKeyboard.html">SimpleKeyboard</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">28/28</span></td>
<td style="display: none;" data-ice="size">20070 byte</td>
<td style="display: none;" data-ice="size">20069 byte</td>
<td style="display: none;" data-ice="lines">596</td>
<td style="display: none;" data-ice="updated">2018-10-04 21:20:37 (UTC)</td>
<td style="display: none;" data-ice="updated">2018-10-04 23:59:06 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/lib/index.js.html">src/lib/index.js</a></span></td>
@ -98,9 +98,9 @@
<td data-ice="filePath"><span><a href="file/src/lib/services/PhysicalKeyboard.js.html">src/lib/services/PhysicalKeyboard.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html">PhysicalKeyboard</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">5/5</span></td>
<td style="display: none;" data-ice="size">2743 byte</td>
<td style="display: none;" data-ice="lines">91</td>
<td style="display: none;" data-ice="updated">2018-10-04 21:47:26 (UTC)</td>
<td style="display: none;" data-ice="size">2651 byte</td>
<td style="display: none;" data-ice="lines">87</td>
<td style="display: none;" data-ice="updated">2018-10-04 22:43:31 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/lib/services/Utilities.js.html">src/lib/services/Utilities.js</a></span></td>