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

Docs update

Browse Source
This commit is contained in:
Francisco Hodge 2018-10-30 23:33:29 -04:00
parent 288fcf3507
commit e7284b0e38
16 changed files with 136331 additions and 113895 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

1895
docs/ast/source/lib/services/KeyboardLayout.js.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

60870
docs/ast/source/lib/services/Utilities.js.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

16
docs/class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html
View File

@ -79,8 +79,9 @@
</div>
<div data-ice="staticMemberSummary"><h2>Static Member Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Members</td></tr></thead>
<div data-ice="staticMethodSummary"><h2>Static Method Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Methods</td></tr></thead>
<tbody>
<tr data-ice="target">
@ -97,7 +98,7 @@
<span class="code" data-ice="name"><span><a href="class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html#static-member-getDefaultLayout">getDefaultLayout</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>: <span>*</span></span>
<span class="code" data-ice="name"><span><a href="class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html#static-method-getDefaultLayout">getDefaultLayout</a></span></span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
</p>
</div>
<div>
@ -122,21 +123,21 @@
<div data-ice="staticMemberDetails"><h2 data-ice="title">Static Public Members</h2>
<div data-ice="staticMethodDetails"><h2 data-ice="title">Static Public Methods</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-member-getDefaultLayout">
<h3 data-ice="anchor" id="static-method-getDefaultLayout">
<span class="access" data-ice="access">public</span>
<span data-ice="static">static</span>
<span class="code" data-ice="name">getDefaultLayout</span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>: <span>*</span></span>
<span class="code" data-ice="name">getDefaultLayout</span><span class="code" data-ice="signature">(): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/services/KeyboardLayout.js.html#lineNumber10">source</a></span></span>
<span data-ice="source"><span><a href="file/src/lib/services/KeyboardLayout.js.html#lineNumber9">source</a></span></span>
</span>
</h3>
@ -185,7 +186,6 @@
</div>
<footer class="footer">

275
docs/class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html
View File

@ -135,7 +135,42 @@
<span class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-getSimpleKeyboardLayoutKey">getSimpleKeyboardLayoutKey</a></span></span><span class="code" data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span>*</span></span>
<span class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-simpleKeyboardInstance">simpleKeyboardInstance</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="methodSummary"><h2>Method Summary</h2><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Public Methods</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 class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-method-getSimpleKeyboardLayoutKey">getSimpleKeyboardLayoutKey</a></span></span><span class="code" data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span>*</span></span>
</p>
</div>
<div>
@ -164,7 +199,7 @@
<span class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-initKeyboardListener">initKeyboardListener</a></span></span><span class="code" data-ice="signature">: <span>*</span></span>
<span class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-method-initKeyboardListener">initKeyboardListener</a></span></span><span class="code" data-ice="signature">()</span>
</p>
</div>
<div>
@ -177,34 +212,6 @@
<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 class="code" data-ice="name"><span><a href="class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-simpleKeyboardInstance">simpleKeyboardInstance</a></span></span><span class="code" data-ice="signature">: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
@ -215,7 +222,6 @@
<div data-ice="constructorDetails"><h2 data-ice="title">Public Constructors</h2>
<div class="detail" data-ice="detail">
@ -265,94 +271,6 @@
</div>
<div data-ice="memberDetails"><h2 data-ice="title">Public Members</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-member-getSimpleKeyboardLayoutKey">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">getSimpleKeyboardLayoutKey</span><span class="code" data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/services/PhysicalKeyboard.js.html#lineNumber57">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Transforms a KeyboardEvent&apos;s &quot;key.code&quot; string into a simple-keyboard layout format</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-member-initKeyboardListener">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">initKeyboardListener</span><span class="code" data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/services/PhysicalKeyboard.js.html#lineNumber20">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Initializes key event listeners</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-member-simpleKeyboardInstance">
<span class="access" data-ice="access">public</span>
@ -397,7 +315,126 @@
</div>
</div>
<div data-ice="methodDetails"><h2 data-ice="title">Public Methods</h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-getSimpleKeyboardLayoutKey">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">getSimpleKeyboardLayoutKey</span><span class="code" data-ice="signature">(event: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span>): <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/services/PhysicalKeyboard.js.html#lineNumber66">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Transforms a KeyboardEvent&apos;s &quot;key.code&quot; string into a simple-keyboard layout format</p>
</div>
<div data-ice="properties"><div data-ice="properties">
<h4 data-ice="title">Params:</h4>
<table class="params">
<thead>
<tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
</thead>
<tbody>
<tr data-ice="property" data-depth="0">
<td data-ice="name" class="code" data-depth="0">event</td>
<td data-ice="type" class="code"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a></span></td>
<td data-ice="appendix"></td>
<td data-ice="description"><p>The KeyboardEvent</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="return-params" data-ice="returnParams">
<h4>Return:</h4>
<table>
<tbody>
<tr>
<td class="return-type code" data-ice="returnType"><span>*</span></td>
</tr>
</tbody>
</table>
<div data-ice="returnProperties">
</div>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="instance-method-initKeyboardListener">
<span class="access" data-ice="access">public</span>
<span class="code" data-ice="name">initKeyboardListener</span><span class="code" data-ice="signature">()</span>
<span class="right-info">
<span data-ice="source"><span><a href="file/src/lib/services/PhysicalKeyboard.js.html#lineNumber29">source</a></span></span>
</span>
</h3>
<div data-ice="description"><p>Initializes key event listeners</p>
</div>
<div data-ice="properties">
</div>
</div>
</div>
</div>
<footer class="footer">

1269
docs/class/src/lib/services/Utilities.js~Utilities.html
View File

File diff suppressed because it is too large Load Diff

8
docs/coverage.json
View File

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

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

@ -105,6 +105,31 @@ class SimpleKeyboard {
this.options.theme = this.options.theme || &quot;hg-theme-default&quot;;
this.options.inputName = this.options.inputName || &quot;default&quot;;
/**
* Module namespace
*/
this.modules = {};
/**
* Bindings
*/
this.handleButtonClicked = this.handleButtonClicked.bind(this);
this.syncInstanceInputs = this.syncInstanceInputs.bind(this);
this.clearInput = this.clearInput.bind(this);
this.getInput = this.getInput.bind(this);
this.setInput = this.setInput.bind(this);
this.replaceInput = this.replaceInput.bind(this);
this.clear = this.clear.bind(this);
this.dispatch = this.dispatch.bind(this);
this.addButtonTheme = this.addButtonTheme.bind(this);
this.removeButtonTheme = this.removeButtonTheme.bind(this);
this.getButtonElement = this.getButtonElement.bind(this);
this.handleCaret = this.handleCaret.bind(this);
this.caretEventHandler = this.caretEventHandler.bind(this);
this.onInit = this.onInit.bind(this);
this.onRender = this.onRender.bind(this);
this.render = this.render.bind(this);
/**
* simple-keyboard uses a non-persistent internal input to keep track of the entered string (the variable `keyboard.input`).
* This removes any dependency to input DOM elements. You can type and directly display the value in a div element, for example.
@ -160,7 +185,7 @@ class SimpleKeyboard {
* Handles clicks made to keyboard buttons
* @param {string} button The button&apos;s layout name.
*/
handleButtonClicked = (button) =&gt; {
handleButtonClicked(button){
let debug = this.options.debug;
/**
@ -215,7 +240,7 @@ class SimpleKeyboard {
/**
* Send a command to all simple-keyboard instances (if you have several instances).
*/
syncInstanceInputs = () =&gt; {
syncInstanceInputs(){
this.dispatch((instance) =&gt; {
instance.replaceInput(this.input);
});
@ -225,7 +250,7 @@ class SimpleKeyboard {
* Clear the keyboard&#x2019;s input.
* @param {string} [inputName] optional - the internal input to select
*/
clearInput = (inputName) =&gt; {
clearInput(inputName){
inputName = inputName || this.options.inputName;
this.input[this.options.inputName] = &apos;&apos;;
@ -240,7 +265,7 @@ class SimpleKeyboard {
* Get the keyboard&#x2019;s input (You can also get it from the onChange prop).
* @param {string} [inputName] optional - the internal input to select
*/
getInput = (inputName) =&gt; {
getInput(inputName){
inputName = inputName || this.options.inputName;
/**
@ -257,7 +282,7 @@ class SimpleKeyboard {
* @param {string} input the input value
* @param {string} inputName optional - the internal input to select
*/
setInput = (input, inputName) =&gt; {
setInput(input, inputName){
inputName = inputName || this.options.inputName;
this.input[inputName] = input;
@ -272,7 +297,7 @@ class SimpleKeyboard {
* Replace the input object (`keyboard.input`)
* @param {object} inputObj The input object
*/
replaceInput = (inputObj) =&gt; {
replaceInput(inputObj){
this.input = inputObj;
}
@ -290,7 +315,7 @@ class SimpleKeyboard {
* Remove all keyboard rows and reset keyboard values.
* Used interally between re-renders.
*/
clear = () =&gt; {
clear(){
this.keyboardDOM.innerHTML = &apos;&apos;;
this.keyboardDOM.className = this.keyboardDOMClass;
this.buttonElements = {};
@ -300,7 +325,7 @@ class SimpleKeyboard {
* Send a command to all simple-keyboard instances at once (if you have multiple instances).
* @param {function(instance: object, key: string)} callback Function to run on every instance
*/
dispatch = (callback) =&gt; {
dispatch(callback){
if(!window[&apos;SimpleKeyboardInstances&apos;]){
console.warn(`SimpleKeyboardInstances is not defined. Dispatch cannot be called.`);
throw new Error(&quot;INSTANCES_VAR_ERROR&quot;);
@ -316,7 +341,7 @@ class SimpleKeyboard {
* @param {string} buttons List of buttons to select (separated by a space).
* @param {string} className Classes to give to the selected buttons (separated by space).
*/
addButtonTheme = (buttons, className) =&gt; {
addButtonTheme(buttons, className){
if(!className || !buttons)
return false;
@ -366,7 +391,7 @@ class SimpleKeyboard {
* @param {string} buttons List of buttons to select (separated by a space).
* @param {string} className Classes to give to the selected buttons (separated by space).
*/
removeButtonTheme = (buttons, className) =&gt; {
removeButtonTheme(buttons, className){
/**
* When called with empty parameters, remove all button themes
*/
@ -418,7 +443,7 @@ class SimpleKeyboard {
* Get the DOM Element of a button. If there are several buttons with the same name, an array of the DOM Elements is returned.
* @param {string} button The button layout name to select
*/
getButtonElement = (button) =&gt; {
getButtonElement(button){
let output;
let buttonArr = this.buttonElements[button];
@ -436,7 +461,7 @@ class SimpleKeyboard {
/**
* Retrieves the current cursor position within a input or textarea (if any)
*/
handleCaret = () =&gt; {
handleCaret(){
if(this.options.debug){
console.log(&quot;Caret handling started&quot;);
}
@ -449,7 +474,7 @@ class SimpleKeyboard {
/**
* Called by {@link handleCaret} when an event that warrants a cursor position update is triggered
*/
caretEventHandler = (event) =&gt; {
caretEventHandler(event){
let targetTagName = event.target.tagName.toLowerCase();
if(
@ -471,7 +496,7 @@ class SimpleKeyboard {
/**
* Executes the callback function once simple-keyboard is rendered for the first time (on initialization).
*/
onInit = () =&gt; {
onInit(){
if(this.options.debug){
console.log(&quot;Initialized&quot;);
}
@ -488,15 +513,41 @@ class SimpleKeyboard {
/**
* Executes the callback function every time simple-keyboard is rendered (e.g: when you change layouts).
*/
onRender = () =&gt; {
onRender(){
if(typeof this.options.onRender === &quot;function&quot;)
this.options.onRender();
}
/**
* Register module
*/
registerModule = (name, initCallback) =&gt; {
this.modules[name] = {};
initCallback(this.modules[name]);
}
/**
* Get module prop
*/
getModuleProp = (name, prop) =&gt; {
if(!this.modules[name])
return false;
return this.modules[name][prop];
}
/**
* getModulesList
*/
getModulesList = () =&gt; {
return Object.keys(this.modules);
}
/**
* Renders rows and buttons as per options
*/
render = () =&gt; {
render(){
/**
* Clear keyboard
*/

3
docs/file/src/lib/services/KeyboardLayout.js.html
View File

@ -44,12 +44,11 @@
* Keyboard Layout Service
*/
class KeyboardLayout {
/**
* Get default simple-keyboard layout
* @return {object} The default layout (US-QWERTY)
*/
static getDefaultLayout = () =&gt; {
static getDefaultLayout(){
return {
&apos;default&apos;: [
&apos;` 1 2 3 4 5 6 7 8 9 0 - = {bksp}&apos;,

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

@ -53,13 +53,22 @@ class PhysicalKeyboard {
*/
this.simpleKeyboardInstance = simpleKeyboardInstance;
/**
* Bindings
*/
this.initKeyboardListener = this.initKeyboardListener.bind(this);
this.getSimpleKeyboardLayoutKey = this.getSimpleKeyboardLayoutKey.bind(this);
/**
* Initialize key listeners
*/
this.initKeyboardListener();
}
/**
* Initializes key event listeners
*/
initKeyboardListener = () =&gt; {
initKeyboardListener(){
// Adding button style on keydown
document.addEventListener(&quot;keydown&quot;, (event) =&gt; {
if(this.simpleKeyboardInstance.options.physicalKeyboardHighlight){
@ -96,7 +105,7 @@ class PhysicalKeyboard {
* Transforms a KeyboardEvent&apos;s &quot;key.code&quot; string into a simple-keyboard layout format
* @param {object} event The KeyboardEvent
*/
getSimpleKeyboardLayoutKey = (event) =&gt; {
getSimpleKeyboardLayoutKey(event){
let output;
if(

25
docs/file/src/lib/services/Utilities.js.html
View File

@ -52,6 +52,17 @@ class Utilities {
* @type {object} A simple-keyboard instance
*/
this.simpleKeyboardInstance = simpleKeyboardInstance;
/**
* Bindings
*/
this.getButtonClass = this.getButtonClass.bind(this);
this.getButtonDisplayName = this.getButtonDisplayName.bind(this);
this.getUpdatedInput = this.getUpdatedInput.bind(this);
this.updateCaretPos = this.updateCaretPos.bind(this);
this.isMaxLengthReached = this.isMaxLengthReached.bind(this);
this.camelCase = this.camelCase.bind(this);
this.countInArray = this.countInArray.bind(this);
}
/**
@ -60,7 +71,7 @@ class Utilities {
* @param {string} button The button&apos;s layout name
* @return {string} The classes to be added to the button
*/
getButtonClass = button =&gt; {
getButtonClass(button){
let buttonTypeClass = (button.includes(&quot;{&quot;) &amp;&amp; button.includes(&quot;}&quot;) &amp;&amp; button !== &apos;{//}&apos;) ? &quot;functionBtn&quot; : &quot;standardBtn&quot;;
let buttonWithoutBraces = button.replace(&quot;{&quot;, &quot;&quot;).replace(&quot;}&quot;, &quot;&quot;);
let buttonNormalized = &apos;&apos;;
@ -144,7 +155,7 @@ class Utilities {
* @param {object} display The provided display option
* @param {boolean} mergeDisplay Whether the provided param value should be merged with the default one.
*/
getButtonDisplayName = (button, display, mergeDisplay) =&gt; {
getButtonDisplayName(button, display, mergeDisplay){
if(mergeDisplay){
display = Object.assign({}, this.getDefaultDiplay(), display);
} else {
@ -163,7 +174,7 @@ class Utilities {
* @param {object} options The simple-keyboard options object
* @param {number} caretPos The cursor&apos;s current position
*/
getUpdatedInput = (button, input, options, caretPos) =&gt; {
getUpdatedInput(button, input, options, caretPos){
let output = input;
@ -210,7 +221,7 @@ class Utilities {
* @param {number} length Represents by how many characters the input should be moved
* @param {boolean} minus Whether the cursor should be moved to the left or not.
*/
updateCaretPos = (length, minus) =&gt; {
updateCaretPos(length, minus){
if(minus){
if(this.simpleKeyboardInstance.caretPosition &gt; 0)
this.simpleKeyboardInstance.caretPosition = this.simpleKeyboardInstance.caretPosition - length
@ -356,7 +367,7 @@ class Utilities {
/**
* Gets the current value of maxLengthReached
*/
isMaxLengthReached = () =&gt; {
isMaxLengthReached(){
return Boolean(this.maxLengthReached);
}
@ -365,7 +376,7 @@ class Utilities {
*
* @param {string} string The string to transform.
*/
camelCase = (string) =&gt; {
camelCase(string){
return string.toLowerCase().trim().split(/[.\-_\s]/g).reduce((string, word) =&gt; string + word[0].toUpperCase() + word.slice(1));
};
@ -375,7 +386,7 @@ class Utilities {
* @param {Array} array The haystack to search in
* @param {string} value The needle to search for
*/
countInArray = (array, value) =&gt; {
countInArray(array, value){
return array.reduce((n, x) =&gt; n + (x === value), 0);
}

483
docs/index.json
View File

File diff suppressed because one or more lines are too long

130
docs/script/search_index.js
View File

@ -379,9 +379,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/components/keyboard.js~simplekeyboard#addbuttontheme",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-addButtonTheme",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-addButtonTheme",
"src/lib/components/Keyboard.js~SimpleKeyboard#addButtonTheme",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#buttonelements",
@ -391,9 +391,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/components/keyboard.js~simplekeyboard#careteventhandler",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-caretEventHandler",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-caretEventHandler",
"src/lib/components/Keyboard.js~SimpleKeyboard#caretEventHandler",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#caretposition",
@ -403,15 +403,15 @@ window.esdocSearchIndex = [
],
[
"src/lib/components/keyboard.js~simplekeyboard#clear",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-clear",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-clear",
"src/lib/components/Keyboard.js~SimpleKeyboard#clear",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#clearinput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-clearInput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-clearInput",
"src/lib/components/Keyboard.js~SimpleKeyboard#clearInput",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#constructor",
@ -421,33 +421,45 @@ window.esdocSearchIndex = [
],
[
"src/lib/components/keyboard.js~simplekeyboard#dispatch",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-dispatch",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-dispatch",
"src/lib/components/Keyboard.js~SimpleKeyboard#dispatch",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#getbuttonelement",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-getButtonElement",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-getButtonElement",
"src/lib/components/Keyboard.js~SimpleKeyboard#getButtonElement",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#getinput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-getInput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-getInput",
"src/lib/components/Keyboard.js~SimpleKeyboard#getInput",
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#getmoduleprop",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-getModuleProp",
"src/lib/components/Keyboard.js~SimpleKeyboard#getModuleProp",
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#getmoduleslist",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-getModulesList",
"src/lib/components/Keyboard.js~SimpleKeyboard#getModulesList",
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#handlebuttonclicked",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-handleButtonClicked",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-handleButtonClicked",
"src/lib/components/Keyboard.js~SimpleKeyboard#handleButtonClicked",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#handlecaret",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-handleCaret",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-handleCaret",
"src/lib/components/Keyboard.js~SimpleKeyboard#handleCaret",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#initialized",
@ -474,16 +486,22 @@ window.esdocSearchIndex = [
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#oninit",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-onInit",
"src/lib/components/Keyboard.js~SimpleKeyboard#onInit",
"src/lib/components/keyboard.js~simplekeyboard#modules",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-modules",
"src/lib/components/Keyboard.js~SimpleKeyboard#modules",
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#oninit",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onInit",
"src/lib/components/Keyboard.js~SimpleKeyboard#onInit",
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#onrender",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-onRender",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-onRender",
"src/lib/components/Keyboard.js~SimpleKeyboard#onRender",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#options",
@ -498,28 +516,34 @@ window.esdocSearchIndex = [
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#removebuttontheme",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-removeButtonTheme",
"src/lib/components/Keyboard.js~SimpleKeyboard#removeButtonTheme",
"src/lib/components/keyboard.js~simplekeyboard#registermodule",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-registerModule",
"src/lib/components/Keyboard.js~SimpleKeyboard#registerModule",
"member"
],
[
"src/lib/components/keyboard.js~simplekeyboard#removebuttontheme",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-removeButtonTheme",
"src/lib/components/Keyboard.js~SimpleKeyboard#removeButtonTheme",
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#render",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-render",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-render",
"src/lib/components/Keyboard.js~SimpleKeyboard#render",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#replaceinput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-replaceInput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-replaceInput",
"src/lib/components/Keyboard.js~SimpleKeyboard#replaceInput",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#setinput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-setInput",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-setInput",
"src/lib/components/Keyboard.js~SimpleKeyboard#setInput",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#setoptions",
@ -529,9 +553,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/components/keyboard.js~simplekeyboard#syncinstanceinputs",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-member-syncInstanceInputs",
"class/src/lib/components/Keyboard.js~SimpleKeyboard.html#instance-method-syncInstanceInputs",
"src/lib/components/Keyboard.js~SimpleKeyboard#syncInstanceInputs",
"member"
"method"
],
[
"src/lib/components/keyboard.js~simplekeyboard#utilities",
@ -553,9 +577,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/keyboardlayout.js~keyboardlayout.getdefaultlayout",
"class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html#static-member-getDefaultLayout",
"class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html#static-method-getDefaultLayout",
"src/lib/services/KeyboardLayout.js~KeyboardLayout.getDefaultLayout",
"member"
"method"
],
[
"src/lib/services/physicalkeyboard.js",
@ -571,15 +595,15 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/physicalkeyboard.js~physicalkeyboard#getsimplekeyboardlayoutkey",
"class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-getSimpleKeyboardLayoutKey",
"class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-method-getSimpleKeyboardLayoutKey",
"src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard#getSimpleKeyboardLayoutKey",
"member"
"method"
],
[
"src/lib/services/physicalkeyboard.js~physicalkeyboard#initkeyboardlistener",
"class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-member-initKeyboardListener",
"class/src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard.html#instance-method-initKeyboardListener",
"src/lib/services/PhysicalKeyboard.js~PhysicalKeyboard#initKeyboardListener",
"member"
"method"
],
[
"src/lib/services/physicalkeyboard.js~physicalkeyboard#simplekeyboardinstance",
@ -601,9 +625,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/utilities.js~utilities#camelcase",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-camelCase",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-camelCase",
"src/lib/services/Utilities.js~Utilities#camelCase",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#constructor",
@ -613,21 +637,21 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/utilities.js~utilities#countinarray",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-countInArray",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-countInArray",
"src/lib/services/Utilities.js~Utilities#countInArray",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#getbuttonclass",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-getButtonClass",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-getButtonClass",
"src/lib/services/Utilities.js~Utilities#getButtonClass",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#getbuttondisplayname",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-getButtonDisplayName",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-getButtonDisplayName",
"src/lib/services/Utilities.js~Utilities#getButtonDisplayName",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#getdefaultdiplay",
@ -637,9 +661,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/utilities.js~utilities#getupdatedinput",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-getUpdatedInput",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-getUpdatedInput",
"src/lib/services/Utilities.js~Utilities#getUpdatedInput",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#handlemaxlength",
@ -649,9 +673,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/utilities.js~utilities#ismaxlengthreached",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-isMaxLengthReached",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-isMaxLengthReached",
"src/lib/services/Utilities.js~Utilities#isMaxLengthReached",
"member"
"method"
],
[
"src/lib/services/utilities.js~utilities#maxlengthreached",
@ -673,9 +697,9 @@ window.esdocSearchIndex = [
],
[
"src/lib/services/utilities.js~utilities#updatecaretpos",
"class/src/lib/services/Utilities.js~Utilities.html#instance-member-updateCaretPos",
"class/src/lib/services/Utilities.js~Utilities.html#instance-method-updateCaretPos",
"src/lib/services/Utilities.js~Utilities#updateCaretPos",
"member"
"method"
],
[
"src/lib/tests/testutility.js",

28
docs/source.html
View File

@ -39,7 +39,7 @@
</div>
</nav>
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">64/64</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">68/68</span></h1>
<table class="files-summary" data-ice="files" data-use-coverage="true">
<thead>
@ -73,10 +73,10 @@
<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="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">20069 byte</td>
<td style="display: none;" data-ice="lines">596</td>
<td style="display: none;" data-ice="updated">2018-10-04 23:59:06 (UTC)</td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">32/32</span></td>
<td style="display: none;" data-ice="size">21368 byte</td>
<td style="display: none;" data-ice="lines">647</td>
<td style="display: none;" data-ice="updated">2018-10-04 03:15:23 (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>
@ -90,25 +90,25 @@
<td data-ice="filePath"><span><a href="file/src/lib/services/KeyboardLayout.js.html">src/lib/services/KeyboardLayout.js</a></span></td>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/lib/services/KeyboardLayout.js~KeyboardLayout.html">KeyboardLayout</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">2/2</span></td>
<td style="display: none;" data-ice="size">755 byte</td>
<td style="display: none;" data-ice="lines">29</td>
<td style="display: none;" data-ice="updated">2018-10-04 21:39:14 (UTC)</td>
<td style="display: none;" data-ice="size">746 byte</td>
<td style="display: none;" data-ice="lines">28</td>
<td style="display: none;" data-ice="updated">2018-10-03 02:14:58 (UTC)</td>
</tr>
<tr data-ice="file">
<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">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>
<td style="display: none;" data-ice="size">2879 byte</td>
<td style="display: none;" data-ice="lines">96</td>
<td style="display: none;" data-ice="updated">2018-10-03 02:15:56 (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>
<td data-ice="identifier" class="identifiers"><span><a href="class/src/lib/services/Utilities.js~Utilities.html">Utilities</a></span></td>
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">15/15</span></td>
<td style="display: none;" data-ice="size">10156 byte</td>
<td style="display: none;" data-ice="lines">341</td>
<td style="display: none;" data-ice="updated">2018-10-04 22:07:29 (UTC)</td>
<td style="display: none;" data-ice="size">10567 byte</td>
<td style="display: none;" data-ice="lines">352</td>
<td style="display: none;" data-ice="updated">2018-10-03 17:11:36 (UTC)</td>
</tr>
<tr data-ice="file">
<td data-ice="filePath"><span><a href="file/src/lib/tests/TestUtility.js.html">src/lib/tests/TestUtility.js</a></span></td>