github/simple-keyboard
github/simple-keyboard
4
0
Fork 0
mirror of https://github.com/hodgef/simple-keyboard.git synced 2025-03-13 14:41:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Francisco Hodge 2018-11-01 00:14:02 -04:00
parent b7636841f7
commit 40e50108ae
7 changed files with 37289 additions and 34168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

141
docs/class/src/lib/components/Keyboard.js~SimpleKeyboard.html
View File

@ -1062,6 +1062,35 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span class="code" data-ice="name"><span><a href="class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onModulesLoaded">onModulesLoaded</a></span></span><span class="code" data-ice="signature">()</span>
</p>
</div>
<div>
<div data-ice="description"><p>Executes the callback function once all modules have been loaded</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> <span class="override" data-ice="override"></span>
</td> </td>
<td> <td>
@ -1316,7 +1345,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber120">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber121">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1359,7 +1388,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber512">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber513">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1404,7 +1433,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber578">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber591">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1448,7 +1477,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber588">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber601">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1492,7 +1521,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber258">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber259">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1535,7 +1564,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber222">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber223">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1578,7 +1607,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber725">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber738">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1622,7 +1651,7 @@ As keys are pressed, text will be added/removed at that position within the inpu
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber109">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber110">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1702,7 +1731,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber217">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber218">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1789,7 +1818,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber115">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber116">source</a></span></span>
</span> </span>
</h3> </h3>
@ -1875,7 +1904,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber149">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber150">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2119,7 +2148,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber144">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber145">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2163,7 +2192,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber548">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber557">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2207,7 +2236,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber332">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber333">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2298,7 +2327,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber368">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber369">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2378,7 +2407,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber501">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber502">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2438,7 +2467,7 @@ keyboard.clearInput();</code></pre>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber342">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber343">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2483,7 +2512,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber277">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber278">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2544,7 +2573,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber352">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber353">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2617,7 +2646,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber470">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber471">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2690,7 +2719,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber292">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber293">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2763,7 +2792,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber157">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber158">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2836,7 +2865,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber254">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber255">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2896,7 +2925,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber213">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber214">source</a></span></span>
</span> </span>
</h3> </h3>
@ -2962,7 +2991,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber244">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber245">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3006,7 +3035,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber488">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber489">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3050,7 +3079,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber558">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber567">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3094,7 +3123,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber523">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber524">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3125,6 +3154,50 @@ Used interally between re-renders.</p>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-onModulesLoaded">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">onModulesLoaded</span><span class="code" data-ice="signature">()</span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber549">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Executes the callback function once all modules have been loaded</p>
</div>
<div data-ice="properties">
</div>
</div> </div>
<div class="detail" data-ice="detail"> <div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-onRender"> <h3 data-ice="anchor" id="instance-method-onRender">
@ -3138,7 +3211,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber540">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber541">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3182,7 +3255,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber418">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber419">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3262,7 +3335,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber595">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber608">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3306,7 +3379,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber324">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber325">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3367,7 +3440,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber309">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber310">source</a></span></span>
</span> </span>
</h3> </h3>
@ -3435,7 +3508,7 @@ Used interally between re-renders.</p>
<span class="right-info"> <span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber267">source</a></span></span> <span data-ice="source"><span><a href="file/src/lib/components/Keyboard.js.html#lineNumber268">source</a></span></span>
</span> </span>
</h3> </h3>

8
docs/coverage.json
View File

@ -1,7 +1,7 @@
{ {
"coverage": "100%", "coverage": "100%",
"expectCount": 76, "expectCount": 77,
"actualCount": 76, "actualCount": 77,
"files": { "files": {
"src/demo/App.js": { "src/demo/App.js": {
"expectCount": 8, "expectCount": 8,
@ -9,8 +9,8 @@
"undocumentLines": [] "undocumentLines": []
}, },
"src/lib/components/Keyboard.js": { "src/lib/components/Keyboard.js": {
"expectCount": 40, "expectCount": 41,
"actualCount": 40, "actualCount": 41,
"undocumentLines": [] "undocumentLines": []
}, },
"src/lib/services/KeyboardLayout.js": { "src/lib/services/KeyboardLayout.js": {

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

@ -133,6 +133,7 @@ class SimpleKeyboard {
this.handleButtonMouseUp = this.handleButtonMouseUp.bind(this); this.handleButtonMouseUp = this.handleButtonMouseUp.bind(this);
this.handleButtonMouseDown = this.handleButtonMouseDown.bind(this); this.handleButtonMouseDown = this.handleButtonMouseDown.bind(this);
this.handleButtonHold = this.handleButtonHold.bind(this); this.handleButtonHold = this.handleButtonHold.bind(this);
this.onModulesLoaded = this.onModulesLoaded.bind(this);
/** /**
* simple-keyboard uses a non-persistent internal input to keep track of the entered string (the variable `keyboard.input`). * simple-keyboard uses a non-persistent internal input to keep track of the entered string (the variable `keyboard.input`).
@ -584,6 +585,14 @@ class SimpleKeyboard {
this.options.onRender(); this.options.onRender();
} }
/**
* Executes the callback function once all modules have been loaded
*/
onModulesLoaded(){
if(typeof this.options.onModulesLoaded === &quot;function&quot;)
this.options.onModulesLoaded();
}
/** /**
* Register module * Register module
*/ */
@ -608,9 +617,13 @@ class SimpleKeyboard {
this.keyboardPluginClasses = this.keyboardPluginClasses + ` ${classStr}`; this.keyboardPluginClasses = this.keyboardPluginClasses + ` ${classStr}`;
} }
this.render();
module.init(this); module.init(this);
}); });
this.keyboardPluginClasses = this.keyboardPluginClasses + &apos; modules-loaded&apos;;
this.render();
this.onModulesLoaded();
} }
} }

295
docs/index.json
View File

File diff suppressed because one or more lines are too long

6
docs/script/search_index.js
View File

@ -545,6 +545,12 @@ window.esdocSearchIndex = [
"src/lib/components/Keyboard.js~SimpleKeyboard#onInit", "src/lib/components/Keyboard.js~SimpleKeyboard#onInit",
"method" "method"
], ],
[
"src/lib/components/keyboard.js~simplekeyboard#onmodulesloaded",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onModulesLoaded",
"src/lib/components/Keyboard.js~SimpleKeyboard#onModulesLoaded",
"method"
],
[ [
"src/lib/components/keyboard.js~simplekeyboard#onrender", "src/lib/components/keyboard.js~simplekeyboard#onrender",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onRender", "class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onRender",

10
docs/source.html
View File

@ -39,7 +39,7 @@
</div> </div>
</nav> </nav>
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">76/76</span></h1> <div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">77/77</span></h1>
<table class="files-summary" data-ice="files" data-use-coverage="true"> <table class="files-summary" data-ice="files" data-use-coverage="true">
<thead> <thead>
@ -73,10 +73,10 @@
<tr data-ice="file"> <tr data-ice="file">
<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="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 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">40/40</span></td> <td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">41/41</span></td>
<td style="display: none;" data-ice="size">23899 byte</td> <td style="display: none;" data-ice="size">24287 byte</td>
<td style="display: none;" data-ice="lines">740</td> <td style="display: none;" data-ice="lines">753</td>
<td style="display: none;" data-ice="updated">2018-10-04 23:40:48 (UTC)</td> <td style="display: none;" data-ice="updated">2018-11-05 03:56:31 (UTC)</td>
</tr> </tr>
<tr data-ice="file"> <tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/lib/index.js.html">src/lib/index.js</a></span></td> <td data-ice="filePath"><span><a href="file/src/lib/index.js.html">src/lib/index.js</a></span></td>