Skip to content

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@tdumitrescu
tdumitrescu committed Mar 18, 2018
1 parent b8687bf commit 534a30d
Show file tree
Hide file tree
Showing 10 changed files with 268 additions and 171 deletions.
249 changes: 139 additions & 110 deletions docs/Component.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<label for="nav-trigger" class="overlay"></label>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Component.html">Component</a><ul class='methods'><li data-type='method'><a href="Component.html#child">child</a></li><li data-type='method'><a href="Component.html#findPanelParentByTagName">findPanelParentByTagName</a></li><li data-type='method'><a href="Component.html#getConfig">getConfig</a></li><li data-type='method'><a href="Component.html#isStateShared">isStateShared</a></li><li data-type='method'><a href="Component.html#navigate">navigate</a></li><li data-type='method'><a href="Component.html#setConfig">setConfig</a></li><li data-type='method'><a href="Component.html#shouldUpdate">shouldUpdate</a></li><li data-type='method'><a href="Component.html#update">update</a></li><li data-type='method'><a href="Component.html#updateApp">updateApp</a></li></ul></li><li><a href="module.exports.html">exports</a></li></ul><h3>Modules</h3><ul><li><a href="module-isorender_dom-shims.html">isorender/dom-shims</a></li><li><a href="module-panel.html">panel</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Component.html">Component</a><ul class='methods'><li data-type='method'><a href="Component.html#child">child</a></li><li data-type='method'><a href="Component.html#findPanelParentByTagName">findPanelParentByTagName</a></li><li data-type='method'><a href="Component.html#getConfig">getConfig</a></li><li data-type='method'><a href="Component.html#navigate">navigate</a></li><li data-type='method'><a href="Component.html#setConfig">setConfig</a></li><li data-type='method'><a href="Component.html#shouldUpdate">shouldUpdate</a></li><li data-type='method'><a href="Component.html#update">update</a></li><li data-type='method'><a href="Component.html#updateApp">updateApp</a></li></ul></li><li><a href="module.exports.html">exports</a></li></ul><h3>Modules</h3><ul><li><a href="module-isorender_dom-shims.html">isorender/dom-shims</a></li><li><a href="module-panel.html">panel</a></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -152,7 +152,7 @@ <h5>Examples</h5>

<p class="code-caption">Registering the custom element definition for the DOM</p>

<pre class="prettyprint"><code>document.registerElement('my-widget', MyWidget);</code></pre>
<pre class="prettyprint"><code>customElements.define('my-widget', MyWidget);</code></pre>

<p class="code-caption">Adding an instance of the element to the DOM</p>

Expand Down Expand Up @@ -424,6 +424,132 @@ <h5 class="subsection-title">Properties:</h5>



<tr>

<td class="name"><code>hooks</code></td>


<td class="type">


<span class="param-type">object</span>



</td>


<td class="attributes">

&lt;optional><br>



</td>



<td class="default">

{}

</td>


<td class="description last">extra rendering/lifecycle callbacks
<h6>Properties</h6>

<table class="props">
<thead>
<tr>

<th>Name</th>


<th>Type</th>


<th>Attributes</th>




<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>preUpdate</code></td>


<td class="type">


<span class="param-type">function</span>



</td>


<td class="attributes">

&lt;optional><br>



</td>




<td class="description last">called before an update is applied</td>
</tr>



<tr>

<td class="name"><code>postUpdate</code></td>


<td class="type">


<span class="param-type">function</span>



</td>


<td class="attributes">

&lt;optional><br>



</td>




<td class="description last">called after an update is applied</td>
</tr>


</tbody>
</table>

</td>
</tr>



<tr>

<td class="name"><code>updateSync</code></td>
Expand Down Expand Up @@ -570,7 +696,7 @@ <h5 class="subsection-title">Properties:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line65">line 65</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line68">line 68</a>
</li></ul></dd>


Expand Down Expand Up @@ -657,7 +783,7 @@ <h5>Type:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line78">line 78</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line81">line 81</a>
</li></ul></dd>


Expand Down Expand Up @@ -848,7 +974,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line92">line 92</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line95">line 95</a>
</li></ul></dd>


Expand Down Expand Up @@ -1007,7 +1133,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line106">line 106</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line109">line 109</a>
</li></ul></dd>


Expand Down Expand Up @@ -1178,7 +1304,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line124">line 124</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line127">line 127</a>
</li></ul></dd>


Expand Down Expand Up @@ -1224,103 +1350,6 @@ <h5>Example</h5>



<h4 class="name" id="isStateShared"><span class="type-signature"></span>isStateShared<span class="signature">()</span><span class="type-signature"></span></h4>





<div class="description">
Returns whether this.state is shared with other components (the default).
</div>













<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line134">line 134</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>


<div class="param-desc">
true if this.state is shared, false if this.appState is the shared store
</div>






<h5>Example</h5>

<pre class="prettyprint"><code>myWidget.isStateShared()</code></pre>








<h4 class="name" id="navigate"><span class="type-signature"></span>navigate<span class="signature">(fragment, stateUpdate<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>


Expand Down Expand Up @@ -1478,7 +1507,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line147">line 147</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line140">line 140</a>
</li></ul></dd>


Expand Down Expand Up @@ -1633,7 +1662,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line159">line 159</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line152">line 152</a>
</li></ul></dd>


Expand Down Expand Up @@ -1772,7 +1801,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line176">line 176</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line169">line 169</a>
</li></ul></dd>


Expand Down Expand Up @@ -1956,7 +1985,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line189">line 189</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line182">line 182</a>
</li></ul></dd>


Expand Down Expand Up @@ -2116,7 +2145,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line203">line 203</a>
<a href="component.js.html">component.js</a>, <a href="component.js.html#line196">line 196</a>
</li></ul></dd>


Expand Down Expand Up @@ -2165,7 +2194,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Dec 13 2017 15:37:12 GMT-0800 (PST) using the Minami theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Mar 17 2018 22:05:33 GMT-0700 (PDT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
Loading

0 comments on commit 534a30d

Please sign in to comment.