summaryrefslogtreecommitdiffhomepage
path: root/docs/jsapi/LuCI.ui.html
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2020-04-03 13:28:38 +0200
committerJo-Philipp Wich <jo@mein.io>2020-04-03 13:28:38 +0200
commit0c3152c88d108a39b6f235300dd56fac81748aa6 (patch)
treeb2671b3ad5a931836a1f18e5e732b0e6b528818e /docs/jsapi/LuCI.ui.html
parentf9d61213fbfde66ffc6f8ca0e112d6445c6c4695 (diff)
docs: update js api docs
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'docs/jsapi/LuCI.ui.html')
-rw-r--r--docs/jsapi/LuCI.ui.html156
1 files changed, 155 insertions, 1 deletions
diff --git a/docs/jsapi/LuCI.ui.html b/docs/jsapi/LuCI.ui.html
index 8551512531..0d2768f8ff 100644
--- a/docs/jsapi/LuCI.ui.html
+++ b/docs/jsapi/LuCI.ui.html
@@ -1048,6 +1048,8 @@
<li data-name="LuCI.ui#hideModal"><a href="LuCI.ui.html#hideModal">hideModal</a></li>
+ <li data-name="LuCI.ui#instantiateView"><a href="LuCI.ui.html#instantiateView">instantiateView</a></li>
+
<li data-name="LuCI.ui#itemlist"><a href="LuCI.ui.html#itemlist">itemlist</a></li>
<li data-name="LuCI.ui#pingDevice"><a href="LuCI.ui.html#pingDevice">pingDevice</a></li>
@@ -2980,6 +2982,158 @@ handler as-is without the need to bind it first.</p>
<dt>
<div class="nameContainer">
+ <h4 class="name" id="instantiateView">
+
+ instantiateView<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.&lt;<a href="LuCI.view.html">LuCI.view</a>>}</span>
+ </h4>
+
+
+ <div class="tag-source">
+ <a href="ui.js.html">ui.js</a>, <a href="ui.js.html#line4289">line 4289</a>
+ </div>
+
+ </div>
+
+
+</dt>
+<dd>
+
+
+ <div class="description">
+ <p>Load specified view class path and set it up.</p>
+<p>Transforms the given view path into a class name, requires it
+using <a href="LuCI.html#require"><code>LuCI.require()</code></a> and asserts that the
+resulting class instance is a descendant of
+<a href="LuCI.view.html"><code>LuCI.view</code></a>.</p>
+<p>By instantiating the view class, its corresponding contents are
+rendered and included into the view area. Any runtime errors are
+catched and rendered using <a href="LuCI.html#error"><code>LuCI.error()</code></a>.</p>
+ </div>
+
+
+
+
+
+
+
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>path</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type">string</span>
+
+
+
+ </td>
+
+
+
+ <td class="description last">
+
+ <p>The view path to render.</p></td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+ <h5>Returns:</h5>
+
+
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Type</th>
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+
+ <td class="type">
+
+ Promise.&lt;<a href="LuCI.view.html">LuCI.view</a>>
+
+
+ </td>
+ <td class="description last">Returns a promise resolving to the loaded view instance.</td>
+ </tr>
+
+ </tbody>
+</table>
+
+
+
+
+</dd>
+
+
+
+<dt>
+ <div class="nameContainer">
<h4 class="name" id="itemlist">
itemlist<span class="signature">(node, items, <span class="optional">separators</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span>
@@ -4290,7 +4444,7 @@ cancelled by the user.</td>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Apr 02 2020 21:30:57 GMT+0200 (Central European Summer Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Apr 03 2020 13:28:08 GMT+0200 (Central European Summer Time)
</footer>
</div>
</div>