</td>
- <td class="description last">Returns a new LuCI.baseclass sublassed from this class, extended
+ <td class="description last">Returns a new LuCI.baseclass subclassed from this class, extended
by the given properties and with its prototype set to this base
class to enable inheritance. The resulting value represents a
class constructor and can be instantiated with <code>new</code>.</td>
<span class="repeatable">repeatable</span>
- <p>Extra arguments to add to prepend to the resultung array.</p></td>
+ <p>Extra arguments to add to prepend to the resulting array.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
- <p>The childrens to append to the given node.</p>
+ <p>The children to append to the given node.</p>
<p>When <code>children</code> is an array, then each item of the array
will be either appended as child element or text node,
depending on whether the item is a DOM <code>Node</code> instance or
function will be invoked again, with the given <code>node</code> argument
as first and the return value of the <code>children</code> function as
second parameter.</p>
-<p>When <code>children</code> is is a DOM <code>Node</code> instance, it will be
+<p>When <code>children</code> is a DOM <code>Node</code> instance, it will be
appended to the given <code>node</code>.</p>
<p>When <code>children</code> is any other non-<code>null</code> value, it will be
-converted to a string and appened to the <code>innerHTML</code> property
+converted to a string and appended to the <code>innerHTML</code> property
of the given <code>node</code>.</p></td>
</tr>
as attribute name.</p>
<p>When <code>val</code> is of any other type, it will be added as attribute
to the given <code>node</code> as-is, with the underlying <code>setAttribute()</code>
-call implicitely turning it into a string.</p></td>
+call implicitly turning it into a string.</p></td>
</tr>
<div class="description">
<p>Replaces the content of the given node with the given children.</p>
<p>This function first removes any children of the given DOM
-<code>Node</code> and then adds the given given children following the
+<code>Node</code> and then adds the given children following the
rules outlined below.</p>
</div>
- <p>The childrens to replace into the given node.</p>
+ <p>The children to replace into the given node.</p>
<p>When <code>children</code> is an array, then each item of the array
will be either appended as child element or text node,
depending on whether the item is a DOM <code>Node</code> instance or
function will be invoked again, with the given <code>node</code> argument
as first and the return value of the <code>children</code> function as
second parameter.</p>
-<p>When <code>children</code> is is a DOM <code>Node</code> instance, it will be
+<p>When <code>children</code> is a DOM <code>Node</code> instance, it will be
appended to the given <code>node</code>.</p>
<p>When <code>children</code> is any other non-<code>null</code> value, it will be
-converted to a string and appened to the <code>innerHTML</code> property
+converted to a string and appended to the <code>innerHTML</code> property
of the given <code>node</code>.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="nameContainer">
<h4 class="name" id="append">
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>Parse this elements form input.</p>
<p>The <code>parse()</code> function recursively walks the form element tree and
triggers input value reading and validation for each encountered element.</p>
-<p>Elements which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Elements which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<div class="nameContainer">
<h4 class="name" id="stripTags">
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<p>The <code>parse()</code> function recursively walks the section element tree and
triggers input value reading and validation for each encountered child
option element.</p>
-<p>Options which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Options which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<dl>
<dt>
<div class="param-desc">
- <p>Throws an exeption if a tab with the same <code>name</code> already exists.</p>
+ <p>Throws an exception if a tab with the same <code>name</code> already exists.</p>
</div>
</dt>
<dt>
<div class="nameContainer">
<h4 class="name" id="taboption">
- taboption<span class="signature">(tabname, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
+ taboption<span class="signature">(tabName, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
</h4>
<tr>
- <td class="name"><code>tabname</code></td>
+ <td class="name"><code>tabName</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="depends">
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<dd>
<div class="description">
- <p>Set an URL which is opened when clicking on the dummy value text.</p>
+ <p>Set a URL which is opened when clicking on the dummy value text.</p>
<p>By setting this property, the dummy value text is wrapped in an <code><a></code>
element with the property value used as <code>href</code> attribute.</p>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
are displayed in the modal popup.</p>
<p>Another important difference is that the table cells show a readonly text
preview of the corresponding option elements by default, unless the child
-option element is explicitely made writable by setting the <code>editable</code>
+option element is explicitly made writable by setting the <code>editable</code>
property to <code>true</code>.</p>
<p>Additionally, the grid section honours a <code>modalonly</code> property of child
option elements. Refer to the <a href="LuCI.form.AbstractValue.html"><code>AbstractValue</code></a>
</td>
<td class="description last">Return values of this function are ignored but if a promise is returned,
it is run to completion before the rendering is continued, allowing
-custom logic to perform asynchroneous work before the modal dialog
+custom logic to perform asynchronous work before the modal dialog
is shown.</td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<p>The <code>parse()</code> function recursively walks the section element tree and
triggers input value reading and validation for each encountered child
option element.</p>
-<p>Options which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Options which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<dl>
<dt>
<div class="param-desc">
- <p>Throws an exeption if a tab with the same <code>name</code> already exists.</p>
+ <p>Throws an exception if a tab with the same <code>name</code> already exists.</p>
</div>
</dt>
<dt>
<span class="inherited"><a href="LuCI.form.AbstractSection.html#taboption">inherited</a></span>
- taboption<span class="signature">(tabname, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
+ taboption<span class="signature">(tabName, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
</h4>
<tr>
- <td class="name"><code>tabname</code></td>
+ <td class="name"><code>tabName</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<p>The description text of the form which is usually rendered as text
-paragraph below the form title and before the actual form conents.
+paragraph below the form title and before the actual form contents.
If omitted, the corresponding paragraph element will not be rendered.</p></td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Map.html#lookupOption">inherited</a></span>
- lookupOption<span class="signature">(name_or_id, <span class="optional">section_id</span>, <span class="optional">config</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>, string>|null}</span>
+ lookupOption<span class="signature">(name, <span class="optional">section_id</span>, <span class="optional">config_name</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>, string>|null}</span>
</h4>
<tr>
- <td class="name"><code>name_or_id</code></td>
+ <td class="name"><code>name</code></td>
<td class="type">
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>config_name</code></td>
<td class="type">
- <p>The name of the UCI configuration the option instance is belonging to.
+ <p>The name of the UCI configuration the option instance belongs to.
Defaults to the main UCI configuration of the map if omitted.</p></td>
</tr>
<p>Parse the form input values.</p>
<p>The <code>parse()</code> function recursively walks the form element tree and
triggers input value reading and validation for each child element.</p>
-<p>Elements which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Elements which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<p>If set to <code>true</code>, trigger an alert message to the user in case saving
-the form data failes. Otherwise fail silently.</p></td>
+the form data failures. Otherwise fail silently.</p></td>
</tr>
<p>The section class to use for rendering the configuration section.
Note that this value must be the class itself, not a class instance
-obtained from calling <code>new</code>. It must also be a class dervied from
+obtained from calling <code>new</code>. It must also be a class derived from
<code>LuCI.form.AbstractSection</code>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given section class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
</h2>
<div class="class-description"><p>The <code>ListValue</code> class implements a simple static HTML select element
-allowing the user to chose a single value from a set of predefined choices.
+allowing the user chose a single value from a set of predefined choices.
It builds upon the <a href="LuCI.ui.Select.html"><code>LuCI.ui.Select</code></a> widget.</p></div>
</header>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
</h2>
<div class="class-description"><p>The <code>Map</code> class represents one complete form. A form usually maps one UCI
-configuraton file and is divided into multiple sections containing multiple
+configuration file and is divided into multiple sections containing multiple
fields each.</p>
<p>It serves as main entry point into the <code>LuCI.form</code> for typical view code.</p></div>
<p>The description text of the form which is usually rendered as text
-paragraph below the form title and before the actual form conents.
+paragraph below the form title and before the actual form contents.
If omitted, the corresponding paragraph element will not be rendered.</p></td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="lookupOption">
- lookupOption<span class="signature">(name_or_id, <span class="optional">section_id</span>, <span class="optional">config</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>, string>|null}</span>
+ lookupOption<span class="signature">(name, <span class="optional">section_id</span>, <span class="optional">config_name</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>, string>|null}</span>
</h4>
<tr>
- <td class="name"><code>name_or_id</code></td>
+ <td class="name"><code>name</code></td>
<td class="type">
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>config_name</code></td>
<td class="type">
- <p>The name of the UCI configuration the option instance is belonging to.
+ <p>The name of the UCI configuration the option instance belongs to.
Defaults to the main UCI configuration of the map if omitted.</p></td>
</tr>
<p>Parse the form input values.</p>
<p>The <code>parse()</code> function recursively walks the form element tree and
triggers input value reading and validation for each child element.</p>
-<p>Elements which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Elements which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<p>If set to <code>true</code>, trigger an alert message to the user in case saving
-the form data failes. Otherwise fail silently.</p></td>
+the form data failures. Otherwise fail silently.</p></td>
</tr>
<p>The section class to use for rendering the configuration section.
Note that this value must be the class itself, not a class instance
-obtained from calling <code>new</code>. It must also be a class dervied from
+obtained from calling <code>new</code>. It must also be a class derived from
<code>LuCI.form.AbstractSection</code>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given section class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.Value.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<p>The <code>parse()</code> function recursively walks the section element tree and
triggers input value reading and validation for each encountered child
option element.</p>
-<p>Options which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Options which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<dl>
<dt>
<div class="param-desc">
- <p>Throws an exeption if a tab with the same <code>name</code> already exists.</p>
+ <p>Throws an exception if a tab with the same <code>name</code> already exists.</p>
</div>
</dt>
<dt>
<span class="inherited"><a href="LuCI.form.AbstractSection.html#taboption">inherited</a></span>
- taboption<span class="signature">(tabname, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
+ taboption<span class="signature">(tabName, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
</h4>
<tr>
- <td class="name"><code>tabname</code></td>
+ <td class="name"><code>tabName</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.SectionValue.html#value">inherited</a></span>
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
</td>
<td class="description last">Return values of this function are ignored but if a promise is returned,
it is run to completion before the rendering is continued, allowing
-custom logic to perform asynchroneous work before the modal dialog
+custom logic to perform asynchronous work before the modal dialog
is shown.</td>
</tr>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<p>The <code>parse()</code> function recursively walks the section element tree and
triggers input value reading and validation for each encountered child
option element.</p>
-<p>Options which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Options which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractSection.html#taboption">inherited</a></span>
- taboption<span class="signature">(tabname, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
+ taboption<span class="signature">(tabName, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
</h4>
<tr>
- <td class="name"><code>tabname</code></td>
+ <td class="name"><code>tabName</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<p>The <code>parse()</code> function recursively walks the section element tree and
triggers input value reading and validation for each encountered child
option element.</p>
-<p>Options which are hidden due to unsatisified dependencies are skipped.</p>
+<p>Options which are hidden due to unsatisfied dependencies are skipped.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<dl>
<dt>
<div class="param-desc">
- <p>Throws an exeption if a tab with the same <code>name</code> already exists.</p>
+ <p>Throws an exception if a tab with the same <code>name</code> already exists.</p>
</div>
</dt>
<dt>
<span class="inherited"><a href="LuCI.form.AbstractSection.html#taboption">inherited</a></span>
- taboption<span class="signature">(tabname, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
+ taboption<span class="signature">(tabName, optionclass, classargs)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.form.AbstractValue.html">LuCI.form.AbstractValue</a>}</span>
</h4>
<tr>
- <td class="name"><code>tabname</code></td>
+ <td class="name"><code>tabName</code></td>
<td class="type">
<p>The option class to use for rendering the configuration option. Note
that this value must be the class itself, not a class instance obtained
-from calling <code>new</code>. It must also be a class dervied from
+from calling <code>new</code>. It must also be a class derived from
<a href="LuCI.form.AbstractSection.html"><code>LuCI.form.AbstractSection</code></a>.</p></td>
</tr>
<span class="repeatable">repeatable</span>
- <p>Additional arguments which are passed as-is to the contructor of the
+ <p>Additional arguments which are passed as-is to the constructor of the
given option class. Refer to the class specific constructor
documentation for details.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>If set to <code>true</code>, the underlying ui input widget value is not cleared
-from the configuration on unsatisfied depedencies. The default behavior
+from the configuration on unsatisfied dependencies. The default behavior
is to remove the values of all options whose dependencies are not
fulfilled.</p>
</div>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#append">inherited</a></span>
- append<span class="signature">(element)</span>
+ append<span class="signature">(obj)</span>
</h4>
<tr>
- <td class="name"><code>element</code></td>
+ <td class="name"><code>obj</code></td>
<td class="type">
<span class="inherited"><a href="LuCI.form.AbstractValue.html#depends">inherited</a></span>
- depends<span class="signature">(optionname_or_depends, optionvalue|RegExp)</span>
+ depends<span class="signature">(field, value)</span>
</h4>
<div class="description">
- <p>Add a dependency contraint to the option.</p>
+ <p>Add a dependency constraint to the option.</p>
<p>Dependency constraints allow making the presence of option elements
-dependant on the current values of certain other options within the
+dependent on the current values of certain other options within the
same form. An option element with unsatisfied dependencies will be
hidden from the view and its current value is omitted when saving.</p>
<p>Multiple constraints (that is, multiple calls to <code>depends()</code>) are
possible to depend on multiple options simultaneously, allowing to form
a logical "and" expression.</p>
<p>Option names may be given in "dot notation" which allows to reference
-option elements outside of the current form section. If a name without
+option elements outside the current form section. If a name without
dot is specified, it refers to an option within the same configuration
section. If specified as <code>configname.sectionid.optionname</code>,
options anywhere within the same form may be specified.</p>
<tr>
- <td class="name"><code>optionname_or_depends</code></td>
+ <td class="name"><code>field</code></td>
<td class="type">
<td class="description last">
<p>The name of the option to depend on or an object describing multiple
-dependencies which must be satified (a logical "and" expression).</p></td>
+dependencies which must be satisfied (a logical "and" expression).</p></td>
</tr>
<tr>
- <td class="name"><code>optionvalue|RegExp</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
+|
+
+<span class="param-type">RegExp</span>
<span class="inherited"><a href="LuCI.form.AbstractElement.html#stripTags">inherited</a></span>
- stripTags<span class="signature">(input)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ stripTags<span class="signature">(s)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>input</code></td>
+ <td class="name"><code>s</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="value">
- value<span class="signature">(key, value)</span>
+ value<span class="signature">(key, val)</span>
</h4>
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
form
</h2>
- <div class="class-description"><p>The LuCI form class provides high level abstractions for creating creating
+ <div class="class-description"><p>The LuCI form class provides high level abstractions for creating
UCI- or JSON backed configurations forms.</p>
<p>To import the class in views, use <code>'require form'</code>, to import it in
external JavaScript, use <code>L.require("form").then(...)</code>.</p>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<td class="type">
-<span class="param-type">string</span>
+<span class="param-type">"blob"</span>
+|
+
+<span class="param-type">"text"</span>
+|
+
+<span class="param-type">"blob"</span>
<td class="type">
-<span class="param-type">string</span>
+<span class="param-type">"blob"</span>
+|
+
+<span class="param-type">"text"</span>
+|
+
+<span class="param-type">"blob"</span>
<div class="nameContainer">
<h4 class="name" id="remove">
- remove<span class="signature">(The)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<number>}</span>
+ remove<span class="signature">(path)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<number>}</span>
</h4>
<tr>
- <td class="name"><code>The</code></td>
+ <td class="name"><code>path</code></td>
<td class="type">
<td class="description last">
- <p>file path to remove.</p></td>
+ <p>The file path to remove.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>A wrapper around <a href="LuCI.html#raise"><code>raise()</code></a> which also renders
-the error either as modal overlay when <code>ui.js</code> is already loaed
+the error either as modal overlay when <code>ui.js</code> is already loaded
or directly into the view body.</p>
</div>
<div class="description">
- <p>Construct an URL path relative to the media resource path of the
+ <p>Construct a URL path relative to the media resource path of the
LuCI ui (usually <code>/luci-static/$theme_name</code>).</p>
<p>The resulting URL is guaranteed to only contain the characters
<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
- <p>An array of parts to join into an URL path. Parts may contain
+ <p>An array of parts to join into a URL path. Parts may contain
slashes and any of the other characters mentioned above.</p></td>
</tr>
- <p>An array of parts to join into an URL path. Parts may contain
+ <p>An array of parts to join into a URL path. Parts may contain
slashes and any of the other characters mentioned above.</p></td>
</tr>
<div class="description">
- <p>Returns a promise resolving with either the given value or or with
+ <p>Returns a promise resolving with either the given value or with
the given default in case the input value is a rejecting promise.</p>
</div>
<div class="description">
- <p>Construct an URL path relative to the global static resource path
+ <p>Construct a URL path relative to the global static resource path
of the LuCI ui (usually <code>/luci-static/resources</code>).</p>
<p>The resulting URL is guaranteed to only contain the characters
<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
- <p>An array of parts to join into an URL path. Parts may contain
+ <p>An array of parts to join into a URL path. Parts may contain
slashes and any of the other characters mentioned above.</p></td>
</tr>
<span class="param-type">string</span>
+|
+
+<span class="param-type">null</span>
<td class="type">
-<span class="param-type">string</span>
+<span class="param-type">"addr"</span>
+|
+
+<span class="param-type">"num"</span>
- <p>May be either <code>addr</code> or <code>num</code> to override the natural
+ <p>Can be either <code>addr</code> or <code>num</code> to override the natural
lexicographic sorting with a sorting suitable for IP/MAC style
addresses or numeric values respectively.</p></td>
</tr>
<div class="description">
- <p>Construct an URL pathrelative to the script path of the server
+ <p>Construct a URL with path relative to the script path of the server
side LuCI application (usually <code>/cgi-bin/luci</code>).</p>
<p>The resulting URL is guaranteed to only contain the characters
<code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, <code>_</code>, <code>.</code>, <code>%</code>, <code>,</code>, <code>;</code>, and <code>-</code> as well
- <p>An array of parts to join into an URL path. Parts may contain
+ <p>An array of parts to join into a URL path. Parts may contain
slashes and any of the other characters mentioned above.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
</td>
- <td class="description last">Returns an array of of <code>Network.Device</code> class instances representing
+ <td class="description last">Returns an array of <code>Network.Device</code> class instances representing
the sub-devices attached to this logical interface or <code>null</code> if the
logical interface does not support sub-devices, e.g. because it is
virtual and not a bridge.</td>
<div class="description">
- <p>Return a human readable description for the protcol, such as
+ <p>Return a human readable description for the protocol, such as
<code>Static address</code> or <code>DHCP client</code>.</p>
<p>This function should be overwritten by subclasses.</p>
</div>
<div class="description">
- <p>Get the associared Linux network device of this network.</p>
+ <p>Get the associated Linux network device of this network.</p>
</div>
</td>
<td class="description last">Returns the name of the opkg package required for the protocol to
-function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> prototocol.</td>
+function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> protocol.</td>
</tr>
</tbody>
<div class="description">
<p>Checks whether this protocol is "floating".</p>
<p>A "floating" protocol is a protocol which spawns its own interfaces
-on demand, like a virtual one but which relies on an existinf lower
+on demand, like a virtual one but which relies on an existing lower
level interface to initiate the connection.</p>
<p>An example for such a protocol is "pppoe".</p>
<p>This function exists for backwards compatibility with older code
<p>A "virtual" protocol is a protocol which spawns its own interfaces
on demand instead of using existing physical interfaces.</p>
<p>Examples for virtual protocols are <code>6in4</code> which <code>gre</code> spawn tunnel
-network device on startup, examples for non-virtual protcols are
+network device on startup, examples for non-virtual protocols are
<code>dhcp</code> or <code>static</code> which apply IP configuration to existing interfaces.</p>
<p>This function should be overwritten by subclasses.</p>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
</td>
<td class="description last">Returns a promise resolving to an array of scan result objects
-describing the networks found in the vincinity.</td>
+describing the networks found in the vicinity.</td>
</tr>
</tbody>
</td>
<td class="description last">Returns a promise resolving to an array of <code>Network.WifiNetwork</code>
-instances respresenting the wireless networks associated with this
+instances representing the wireless networks associated with this
radio device.</td>
</tr>
<div class="nameContainer">
<h4 class="name" id="set">
- set<span class="signature">(opt, val)</span>
+ set<span class="signature">(opt, value)</span>
</h4>
<tr>
- <td class="name"><code>val</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
- <p>Specifies whether to deauthenticate (<code>true</code>) or disassociate (<code>false</code>)
+ <p>Specifies whether to de-authenticate (<code>true</code>) or disassociate (<code>false</code>)
the client.</p></td>
</tr>
<p>Specifies the amount of milliseconds to ban the client from
reconnecting. By default, no ban time is set which allows the client
-to reassociate / reauthenticate immediately.</p></td>
+to re-associate / reauthenticate immediately.</p></td>
</tr>
</td>
- <td class="description last">Returns a string describing the current encryption or <code>-</code> if the the
+ <td class="description last">Returns a string describing the current encryption or <code>-</code> if the
encryption state could not be found in <code>ubus</code> runtime information.</td>
</tr>
</td>
<td class="description last">Returns a <code>Network.Device</code> instance representing the Linux network
-device associted with this wireless network.</td>
+device associated with this wireless network.</td>
</tr>
</tbody>
<div class="description">
<p>Get the internal network ID of this wireless network.</p>
-<p>The network ID is a LuCI specific identifer in the form
+<p>The network ID is a LuCI specific identifier in the form
<code>radio#.network#</code> to identify wireless networks by their corresponding
radio and network index numbers.</p>
</div>
<div class="description">
- <p>Check whether this wifi network supports deauthenticating clients.</p>
+ <p>Check whether this wifi network supports de-authenticating clients.</p>
</div>
</td>
<td class="description last">Returns <code>true</code> when this wifi network instance supports forcibly
-deauthenticating clients, otherwise <code>false</code>.</td>
+de-authenticating clients, otherwise <code>false</code>.</td>
</tr>
</tbody>
<div class="nameContainer">
<h4 class="name" id="set">
- set<span class="signature">(opt, val)</span>
+ set<span class="signature">(opt, value)</span>
</h4>
<tr>
- <td class="name"><code>val</code></td>
+ <td class="name"><code>value</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
- <p>Obtains the the network device name of the given object.</p>
+ <p>Obtains the network device name of the given object.</p>
</div>
- <p>The netmask to convert into a bit count.</p></td>
+ <p>The netmask to convert into a bits count.</p></td>
</tr>
<dd>
<div class="description">
- <p>Describes an swconfig switch topology by specifying the CPU
+ <p>Describes a swconfig switch topology by specifying the CPU
connections and external port labels of a switch.</p>
</div>
<td class="description last"><p>The <code>ports</code> property points to an array describing the populated
ports of the switch in the external label order. Each array item is
-an object containg the following keys:</p>
+an object containing the following keys:</p>
<ul>
<li><code>num</code> - the internal switch port number</li>
<li><code>label</code> - the label of the port, e.g. <code>LAN 1</code> or <code>CPU (eth0)</code></li>
- <td class="description last"><p>The powersafe mode for all non-peer neigbours, may be an empty
+ <td class="description last"><p>The powersafe mode for all non-peer neighbours, may be an empty
string (<code>''</code>) or absent if not applicable or supported by the driver.</p>
<p>The following modes are known:</p>
<ul>
- <td class="description last"><p>The amount of failed tranmission attempts. Only applicable to
+ <td class="description last"><p>The amount of failed transmission attempts. Only applicable to
transmit rates.</p></td>
</tr>
- <td class="description last"><p>Specifies whether the tranmission rate used 40MHz wide channel.
+ <td class="description last"><p>Specifies whether the transmission rate used 40MHz wide channel.
Only applicable to HT or VHT rates.</p>
<p>Note: this option exists for backwards compatibility only and its
use is discouraged. The <code>mhz</code> field should be used instead to
<div class="description">
<p>A wireless scan result object describes a neighbouring wireless
-network found in the vincinity.</p>
+network found in the vicinity.</p>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="description">
<p>Add a new operation to the polling loop. If the polling loop is not
-already started at this point, it will be implicitely started.</p>
+already started at this point, it will be implicitly started.</p>
</div>
<div class="description">
- <p>Remove an operation from the polling loop. If no further operatons
-are registered, the polling loop is implicitely stopped.</p>
+ <p>Remove an operation from the polling loop. If no further operations
+are registered, the polling loop is implicitly stopped.</p>
</div>
</td>
- <td class="description last">Returns <code>true</code> if polling has been stopped or <code>false</code> if it din't
+ <td class="description last">Returns <code>true</code> if polling has been stopped or <code>false</code> if it didn't
run to begin with.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="nameContainer">
<h4 class="name" id="get">
- get<span class="signature">(target, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.response.html">LuCI.response</a>>}</span>
+ get<span class="signature">(url, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.response.html">LuCI.response</a>>}</span>
</h4>
<tr>
- <td class="name"><code>target</code></td>
+ <td class="name"><code>url</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="post">
- post<span class="signature">(target, <span class="optional">data</span>, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.response.html">LuCI.response</a>>}</span>
+ post<span class="signature">(url, <span class="optional">data</span>, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.response.html">LuCI.response</a>>}</span>
</h4>
<tr>
- <td class="name"><code>target</code></td>
+ <td class="name"><code>url</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
poll
</h2>
- <div class="class-description"><p>The <code>Request.poll</code> class provides some convience wrappers around
+ <div class="class-description"><p>The <code>Request.poll</code> class provides some convince wrappers around
<a href="LuCI.poll.html"><code>LuCI.poll</code></a> mainly to simplify registering repeating HTTP
request calls as polling functions.</p></div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<td class="description last">
- <p>The inteceptor function to register.</p></td>
+ <p>The interceptor function to register.</p></td>
</tr>
<td class="description last">
- <p>The inteceptor function to remove.</p></td>
+ <p>The interceptor function to remove.</p></td>
</tr>
<div class="nameContainer">
<h4 class="name" id="setBaseURL">
- setBaseURL<span class="signature">(sid)</span>
+ setBaseURL<span class="signature">(url)</span>
</h4>
<tr>
- <td class="name"><code>sid</code></td>
+ <td class="name"><code>url</code></td>
<td class="type">
the corresponding args object sent to the remote procedure will be
<code>{ foo: true, bar: false }</code>.</li>
<li><code>params: [ "test" ], filter: function(reply, args, extra) { ... }</code> -
-When the resultung generated function is invoked with
+When the resulting generated function is invoked with
<code>fn("foo", "bar", "baz")</code> then <code>{ "test": "foo" }</code> will be sent as
argument to the remote procedure and the filter function will be
invoked with <code>filterFn(reply, [ "foo" ], "bar", "baz")</code></li>
</td>
- <td class="description last"><p>Specfies an optional filter function which is invoked to transform the
+ <td class="description last"><p>Specifies an optional filter function which is invoked to transform the
received reply data before it is returned to the caller.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>LuCI.uci</code> class utilizes <a href="LuCI.rpc.html"><code>LuCI.rpc</code></a> to declare low level
remote UCI <code>ubus</code> procedures and implements a local caching and data
-manipulation layer on top to allow for synchroneous operations on
+manipulation layer on top to allow for synchronous operations on
UCI configuration data.</p></div>
</header>
<div class="nameContainer">
<h4 class="name" id="add">
- add<span class="signature">(config, type, <span class="optional">name</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ add<span class="signature">(conf, type, <span class="optional">name</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="createSID">
- createSID<span class="signature">(config)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
+ createSID<span class="signature">(conf)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="get">
- get<span class="signature">(config, sid, <span class="optional">option</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span>
+ get<span class="signature">(conf, sid, <span class="optional">opt</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="get_first">
- get_first<span class="signature">(config, <span class="optional">type</span>, <span class="optional">option</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span>
+ get_first<span class="signature">(conf, <span class="optional">type</span>, <span class="optional">opt</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>|<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>}</span>
</h4>
<div class="description">
<p>Gets the value of the given option or the entire section object of
the first found section of the specified type or the first found
-section of the entire configuration if no type is specfied.</p>
+section of the entire configuration if no type is specified.</p>
</div>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="load">
- load<span class="signature">(config)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<string>>}</span>
+ load<span class="signature">(packages)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<string>>}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>packages</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="move">
- move<span class="signature">(config, sid1, <span class="optional">sid2</span>, <span class="optional">after</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
+ move<span class="signature">(conf, sid1, <span class="optional">sid2</span>, <span class="optional">after</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="remove">
- remove<span class="signature">(config, sid)</span>
+ remove<span class="signature">(conf, sid)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="resolveSID">
- resolveSID<span class="signature">(config, sid)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string|null}</span>
+ resolveSID<span class="signature">(conf, sid)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string|null}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="sections">
- sections<span class="signature">(config, <span class="optional">type</span>, <span class="optional">cb</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>>}</span>
+ sections<span class="signature">(conf, <span class="optional">type</span>, <span class="optional">cb</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.uci.html#.SectionObject">LuCI.uci.SectionObject</a>>}</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="set">
- set<span class="signature">(config, sid, option, value)</span>
+ set<span class="signature">(conf, sid, opt, val)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="set_first">
- set_first<span class="signature">(config, <span class="optional">type</span>, option, value)</span>
+ set_first<span class="signature">(conf, <span class="optional">type</span>, opt, val)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<tr>
- <td class="name"><code>value</code></td>
+ <td class="name"><code>val</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="unload">
- unload<span class="signature">(config)</span>
+ unload<span class="signature">(packages)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>packages</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="unset">
- unset<span class="signature">(config, sid, option)</span>
+ unset<span class="signature">(conf, sid, opt)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="unset_first">
- unset_first<span class="signature">(config, <span class="optional">type</span>, option)</span>
+ unset_first<span class="signature">(conf, <span class="optional">type</span>, opt)</span>
</h4>
<tr>
- <td class="name"><code>config</code></td>
+ <td class="name"><code>conf</code></td>
<td class="type">
<tr>
- <td class="name"><code>option</code></td>
+ <td class="name"><code>opt</code></td>
<td class="type">
<p>A section object represents the options and their corresponding values
enclosed within a configuration section, as well as some additional
meta data such as sort indexes and internal ID.</p>
-<p>Any internal metadata fields are prefixed with a dot which is isn't
+<p>Any internal metadata fields are prefixed with a dot which isn't
an allowed character for normal option names.</p>
</div>
- <td class="description last"><p>The <code>.index</code> property specifes the sort order of the section.</p></td>
+ <td class="description last"><p>The <code>.index</code> property specifies the sort order of the section.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
setting values, for checking the validity state and for wiring up required
events.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.AbstractElement</code>. To import
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>Checkbox</code> class implements a simple checkbox input field.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Checkbox</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>ComboButton</code> class implements a button element which can be expanded
into a dropdown to chose from a set of different action choices.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.ComboButton</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<div class="description">
<p>ComboButtons support the same properties as
<a href="LuCI.ui.Dropdown.html#.InitOptions"><code>Dropdown.InitOptions</code></a> but enforce
-specific values for some properties and add aditional button specific
+specific values for some properties and add additional button specific
properties.</p>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
widget type in LuCI but nowadays they are direct aliases of dropdown widgets
with a set of enforced default properties for easier instantiation.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Combobox</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>Dropdown</code> class implements a rich, stylable dropdown menu which
supports non-text choice labels.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Dropdown</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
an arbitrary amount of input values, either from free formed text input or
from a set of predefined choices.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.DynamicList</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<dd>
<div class="description">
- <p>In case choices are passed to the dynamic list contructor, the widget
+ <p>In case choices are passed to the dynamic list constructor, the widget
supports the same properties as <a href="LuCI.ui.Dropdown.html#.InitOptions"><code>Dropdown.InitOptions</code></a>
but enforces specific values for some dropdown properties.</p>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>FileUpload</code> class implements a widget which allows the user to upload,
browse, select and delete files beneath a predefined remote directory.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.FileUpload</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<td class="description last"><p>Specifies the remote directory the upload and file browsing actions take
-place in. Browsing to directories outside of the root directory is
+place in. Browsing to directories outside the root directory is
prevented by the widget. Note that this is not a security feature.
-Whether remote directories are browseable or not solely depends on the
+Whether remote directories are browsable or not solely depends on the
ACL setup for the current session.</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>Hiddenfield</code> class implements an HTML <code><input type="hidden"></code> field
which allows to store form data without exposing it to the user.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Hiddenfield</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
or a group of checkboxes or radio buttons, depending on whether multiple
values are enabled or not.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Select</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<td class="type">
-<span class="param-type">string</span>
+<span class="param-type">"select"</span>
+|
+
+<span class="param-type">"individual"</span>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>Textarea</code> class implements a multiline text area input field.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Textarea</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="class-description"><p>The <code>Textfield</code> class implements a standard single line text input field.</p>
<p>UI widget instances are usually not supposed to be created by view code
-directly, instead they're implicitely created by <code>LuCI.form</code> when
+directly, instead they're implicitly created by <code>LuCI.form</code> when
instantiating CBI forms.</p>
<p>This class is automatically instantiated as part of <code>LuCI.ui</code>. To use it
in views, use <code>'require ui'</code> and refer to <code>ui.Textfield</code>. To import it in
</td>
<td class="description last">Returns <code>true</code> if the input value has been altered by the user or
-<code>false</code> if it is unchaged. Note that if the user modifies the initial
+<code>false</code> if it is unchanged. Note that if the user modifies the initial
value and changes it back to the original state, it is still reported
as changed.</td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="nameContainer">
<h4 class="name" id="setIndicator">
- setIndicator<span class="signature">(numChanges)</span>
+ setIndicator<span class="signature">(n)</span>
</h4>
<tr>
- <td class="name"><code>numChanges</code></td>
+ <td class="name"><code>n</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<div class="nameContainer">
<h4 class="name" id="addNotification">
- addNotification<span class="signature">(<span class="optional">title</span>, contents, <span class="optional">classes</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span>
+ addNotification<span class="signature">(<span class="optional">title</span>, children, <span class="optional">classes</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span>
</h4>
<div class="description">
<p>Add a notification banner at the top of the current view.</p>
<p>A notification banner is an alert message usually displayed at the
-top of the current view, spanning the entire availibe width.
+top of the current view, spanning the entire available width.
Notification banners will stay in place until dismissed by the user.
Multiple banners may be shown at the same time.</p>
-<p>Additional CSS class names may be passed to influence the appearence of
+<p>Additional CSS class names may be passed to influence the appearance of
the banner. Valid values for the classes depend on the underlying theme.</p>
</div>
<tr>
- <td class="name"><code>contents</code></td>
+ <td class="name"><code>children</code></td>
<td class="type">
<div class="description">
- <p>Remove an header area indicator.</p>
+ <p>Remove a header area indicator.</p>
<p>This function removes the given indicator label from the header indicator
area. When the given indicator is not found, this function does nothing.</p>
</div>
<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>
+caught and rendered using <a href="LuCI.html#error"><code>LuCI.error()</code></a>.</p>
</div>
<code><strong></code> element and the value corresponding to the label are
subsequently wrapped into a <code><span class="nowrap"></code> element.</p>
<p>The resulting <code><span></code> element tuples are joined by the given separators
-to form the final markup which is appened to the given parent DOM node.</p>
+to form the final markup which is appended to the given parent DOM node.</p>
</div>
<div class="nameContainer">
<h4 class="name" id="pingDevice">
- pingDevice<span class="signature">(<span class="optional">proto</span>, <span class="optional">host</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Event>}</span>
+ pingDevice<span class="signature">(<span class="optional">proto</span>, <span class="optional">ipaddr</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Event>}</span>
</h4>
<div class="description">
<p>Perform a device connectivity test.</p>
-<p>Attempt to fetch a well known ressource from the remote device via HTTP
+<p>Attempt to fetch a well known resource from the remote device via HTTP
in order to test connectivity. This function is mainly useful to wait
for the router to come back online after a reboot or reconfiguration.</p>
</div>
<tr>
- <td class="name"><code>host</code></td>
+ <td class="name"><code>ipaddr</code></td>
<td class="type">
<div class="description">
- <p>Display or update an header area indicator.</p>
+ <p>Display or update a header area indicator.</p>
<p>An indicator is a small label displayed in the header area of the screen
providing few amounts of status information such as item counts or state
toggle indicators.</p>
<td class="type">
-<span class="param-type">string</span>
+<span class="param-type">"active"</span>
+|
+
+<span class="param-type">"inactive"</span>
<div class="nameContainer">
<h4 class="name" id="showModal">
- showModal<span class="signature">(<span class="optional">title</span>, contents, <span class="optional">classes</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span>
+ showModal<span class="signature">(<span class="optional">title</span>, children, <span class="optional">classes</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Node}</span>
</h4>
with the underlying view contents. Only one modal dialog instance can
be opened. Invoking showModal() while a modal dialog is already open will
replace the open dialog with a new one having the specified contents.</p>
-<p>Additional CSS class names may be passed to influence the appearence of
+<p>Additional CSS class names may be passed to influence the appearance of
the dialog. Valid values for the classes depend on the underlying theme.</p>
</div>
<tr>
- <td class="name"><code>contents</code></td>
+ <td class="name"><code>children</code></td>
<td class="type">
<div class="nameContainer">
<h4 class="name" id="uploadFile">
- uploadFile<span class="signature">(path, <span class="optional">progessStatusNode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.ui.html#.FileUploadReply">LuCI.ui.FileUploadReply</a>>}</span>
+ uploadFile<span class="signature">(path, <span class="optional">progressStatusNode</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.ui.html#.FileUploadReply">LuCI.ui.FileUploadReply</a>>}</span>
</h4>
<tr>
- <td class="name"><code>progessStatusNode</code></td>
+ <td class="name"><code>progressStatusNode</code></td>
<td class="type">
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<td class="type">
-<span class="param-type">satisified</span>
+<span class="param-type">satisfied</span>
- <td class="description last"><p>Boolean indicating whether the menu enries dependencies are satisfied</p></td>
+ <td class="description last"><p>Boolean indicating whether the menu entries dependencies are satisfied</p></td>
</tr>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<td class="description last">Any return values of this function are discarded, but
passed through <code>Promise.resolve()</code> to ensure that any
returned promise runs to completion before the button
-is reenabled.</td>
+is re-enabled.</td>
</tr>
</tbody>
<td class="description last">Any return values of this function are discarded, but
passed through <code>Promise.resolve()</code> to ensure that any
returned promise runs to completion before the button
-is reenabled.</td>
+is re-enabled.</td>
</tr>
</tbody>
<td class="description last">Any return values of this function are discarded, but
passed through <code>Promise.resolve()</code> to ensure that any
returned promise runs to completion before the button
-is reenabled.</td>
+is re-enabled.</td>
</tr>
</tbody>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:33 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
/**
* Add another form element as children to this element.
*
- * @param {AbstractElement} element
+ * @param {AbstractElement} obj
* The form element to add.
*/
append: function(obj) {
* The `parse()` function recursively walks the form element tree and
* triggers input value reading and validation for each encountered element.
*
- * Elements which are hidden due to unsatisified dependencies are skipped.
+ * Elements which are hidden due to unsatisfied dependencies are skipped.
*
* @returns {Promise<void>}
* Returns a promise resolving once this element's value and the values of
/**
* Strip any HTML tags from the given input string.
*
- * @param {string} input
+ * @param {string} s
* The input string to clean.
*
* @returns {string}
* @classdesc
*
* The `Map` class represents one complete form. A form usually maps one UCI
- * configuraton file and is divided into multiple sections containing multiple
+ * configuration file and is divided into multiple sections containing multiple
* fields each.
*
* It serves as main entry point into the `LuCI.form` for typical view code.
*
* @param {string} [description]
* The description text of the form which is usually rendered as text
- * paragraph below the form title and before the actual form conents.
+ * paragraph below the form title and before the actual form contents.
* If omitted, the corresponding paragraph element will not be rendered.
*/
var CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ {
* @param {LuCI.form.AbstractSection} sectionclass
* The section class to use for rendering the configuration section.
* Note that this value must be the class itself, not a class instance
- * obtained from calling `new`. It must also be a class dervied from
+ * obtained from calling `new`. It must also be a class derived from
* `LuCI.form.AbstractSection`.
*
* @param {...string} classargs
- * Additional arguments which are passed as-is to the contructor of the
+ * Additional arguments which are passed as-is to the constructor of the
* given section class. Refer to the class specific constructor
* documentation for details.
*
* The `parse()` function recursively walks the form element tree and
* triggers input value reading and validation for each child element.
*
- * Elements which are hidden due to unsatisified dependencies are skipped.
+ * Elements which are hidden due to unsatisfied dependencies are skipped.
*
* @returns {Promise<void>}
* Returns a promise resolving once the entire form completed parsing all
*
* @param {boolean} [silent=false]
* If set to `true`, trigger an alert message to the user in case saving
- * the form data failes. Otherwise fail silently.
+ * the form data failures. Otherwise fail silently.
*
* @returns {Promise<void>}
* Returns a promise resolving once the entire save operation is complete.
/**
* Find a form option element instance.
*
- * @param {string} name_or_id
+ * @param {string} name
* The name or the full ID of the option element to look up.
*
* @param {string} [section_id]
* The ID of the UCI section containing the option to look up. May be
* omitted if a full ID is passed as first argument.
*
- * @param {string} [config]
- * The name of the UCI configuration the option instance is belonging to.
+ * @param {string} [config_name]
+ * The name of the UCI configuration the option instance belongs to.
* Defaults to the main UCI configuration of the map if omitted.
*
* @returns {Array<LuCI.form.AbstractValue,string>|null}
*
* @param {string} [description]
* The description text of the form which is usually rendered as text
- * paragraph below the form title and before the actual form conents.
+ * paragraph below the form title and before the actual form contents.
* If omitted, the corresponding paragraph element will not be rendered.
*/
var CBIJSONMap = CBIMap.extend(/** @lends LuCI.form.JSONMap.prototype */ {
* triggers input value reading and validation for each encountered child
* option element.
*
- * Options which are hidden due to unsatisified dependencies are skipped.
+ * Options which are hidden due to unsatisfied dependencies are skipped.
*
* @returns {Promise<void>}
* Returns a promise resolving once the values of all child elements have
* contents. If omitted, no description will be rendered.
*
* @throws {Error}
- * Throws an exeption if a tab with the same `name` already exists.
+ * Throws an exception if a tab with the same `name` already exists.
*/
tab: function(name, title, description) {
if (this.tabs && this.tabs[name])
* @param {LuCI.form.AbstractValue} optionclass
* The option class to use for rendering the configuration option. Note
* that this value must be the class itself, not a class instance obtained
- * from calling `new`. It must also be a class dervied from
+ * from calling `new`. It must also be a class derived from
* [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}.
*
* @param {...*} classargs
- * Additional arguments which are passed as-is to the contructor of the
+ * Additional arguments which are passed as-is to the constructor of the
* given option class. Refer to the class specific constructor
* documentation for details.
*
/**
* Add a configuration option widget to a tab of the section.
*
- * @param {string} tabname
+ * @param {string} tabName
* The name of the section tab to add the option element to.
*
* @param {LuCI.form.AbstractValue} optionclass
* The option class to use for rendering the configuration option. Note
* that this value must be the class itself, not a class instance obtained
- * from calling `new`. It must also be a class dervied from
+ * from calling `new`. It must also be a class derived from
* [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}.
*
* @param {...*} classargs
- * Additional arguments which are passed as-is to the contructor of the
+ * Additional arguments which are passed as-is to the constructor of the
* given option class. Refer to the class specific constructor
* documentation for details.
*
/**
* If set to `true`, the underlying ui input widget value is not cleared
- * from the configuration on unsatisfied depedencies. The default behavior
+ * from the configuration on unsatisfied dependencies. The default behavior
* is to remove the values of all options whose dependencies are not
* fulfilled.
*
*/
/**
- * Add a dependency contraint to the option.
+ * Add a dependency constraint to the option.
*
* Dependency constraints allow making the presence of option elements
- * dependant on the current values of certain other options within the
+ * dependent on the current values of certain other options within the
* same form. An option element with unsatisfied dependencies will be
* hidden from the view and its current value is omitted when saving.
*
* a logical "and" expression.
*
* Option names may be given in "dot notation" which allows to reference
- * option elements outside of the current form section. If a name without
+ * option elements outside the current form section. If a name without
* dot is specified, it refers to an option within the same configuration
* section. If specified as <code>configname.sectionid.optionname</code>,
* options anywhere within the same form may be specified.
* </li>
* </ul>
*
- * @param {string|Object<string, string|RegExp>} optionname_or_depends
+ * @param {string|Object<string, string|RegExp>} field
* The name of the option to depend on or an object describing multiple
- * dependencies which must be satified (a logical "and" expression).
+ * dependencies which must be satisfied (a logical "and" expression).
*
- * @param {string} optionvalue|RegExp
+ * @param {string|RegExp} value
* When invoked with a plain option name as first argument, this parameter
* specifies the expected value. In case an object is passed as first
* argument, this parameter is ignored.
* @returns {*|Promise<*>}
* Return values of this function are ignored but if a promise is returned,
* it is run to completion before the rendering is continued, allowing
- * custom logic to perform asynchroneous work before the modal dialog
+ * custom logic to perform asynchronous work before the modal dialog
* is shown.
*/
addModalOptions: function(modalSection, section_id, ev) {
*
* Another important difference is that the table cells show a readonly text
* preview of the corresponding option elements by default, unless the child
- * option element is explicitely made writable by setting the `editable`
+ * option element is explicitly made writable by setting the `editable`
* property to `true`.
*
* Additionally, the grid section honours a `modalonly` property of child
* contents. If omitted, no description will be rendered.
*
* @throws {Error}
- * Throws an exeption if a tab with the same `name` already exists.
+ * Throws an exception if a tab with the same `name` already exists.
*/
tab: function(name, title, description) {
CBIAbstractSection.prototype.tab.call(this, name, title, description);
* @param {string} key
* The choice value to add.
*
- * @param {Node|string} value
+ * @param {Node|string} val
* The caption for the choice value. May be a DOM node, a document fragment
* or a plain text string. If omitted, the `key` value is used as caption.
*/
* @classdesc
*
* The `ListValue` class implements a simple static HTML select element
- * allowing the user to chose a single value from a set of predefined choices.
+ * allowing the user chose a single value from a set of predefined choices.
* It builds upon the {@link LuCI.ui.Select} widget.
*
* @param {LuCI.form.Map|LuCI.form.JSONMap} form
__name__: 'CBI.DummyValue',
/**
- * Set an URL which is opened when clicking on the dummy value text.
+ * Set a URL which is opened when clicking on the dummy value text.
*
* By setting this property, the dummy value text is wrapped in an `<a>`
* element with the property value used as `href` attribute.
* @hideconstructor
* @classdesc
*
- * The LuCI form class provides high level abstractions for creating creating
+ * The LuCI form class provides high level abstractions for creating
* UCI- or JSON backed configurations forms.
*
* To import the class in views, use `'require form'`, to import it in
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
/**
* Unlink the given file.
*
- * @param {string}
+ * @param {string} path
* The file path to remove.
*
* @returns {Promise<number>}
* @param {string} path
* The file path to read.
*
- * @param {string} [type=text]
+ * @param {"blob"|"text"|"blob"} [type=text]
* The expected type of read file contents. Valid values are `text` to
* interpret the contents as string, `json` to parse the contents as JSON
* or `blob` to return the contents as Blob instance.
* @param {string[]} [params]
* The arguments to pass to the command.
*
- * @param {string} [type=text]
+ * @param {"blob"|"text"|"blob"} [type=text]
* The expected output type of the invoked program. Valid values are
* `text` to interpret the output as string, `json` to parse the output
* as JSON or `blob` to return the output as Blob instance.
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
<footer>
- Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
* subclass.
*
* @returns {LuCI.baseclass}
- * Returns a new LuCI.baseclass sublassed from this class, extended
+ * Returns a new LuCI.baseclass subclassed from this class, extended
* by the given properties and with its prototype set to this base
* class to enable inheritance. The resulting value represents a
* class constructor and can be instantiated with `new`.
* would copy all values till the end.
*
* @param {...*} [extra_args]
- * Extra arguments to add to prepend to the resultung array.
+ * Extra arguments to add to prepend to the resulting array.
*
* @returns {Array<*>}
* Returns a new array consisting of the optional extra arguments
*
* @instance
* @memberof LuCI.request
- * @param {string} target
+ * @param {string} url
* The URL to request.
*
* @param {LuCI.request.RequestOptions} [options]
*
* @instance
* @memberof LuCI.request
- * @param {string} target
+ * @param {string} url
* The URL to request.
*
* @param {*} [data]
* @hideconstructor
* @classdesc
*
- * The `Request.poll` class provides some convience wrappers around
+ * The `Request.poll` class provides some convince wrappers around
* {@link LuCI.poll} mainly to simplify registering repeating HTTP
* request calls as polling functions.
*/
/**
* Add a new operation to the polling loop. If the polling loop is not
- * already started at this point, it will be implicitely started.
+ * already started at this point, it will be implicitly started.
*
* @instance
* @memberof LuCI.poll
},
/**
- * Remove an operation from the polling loop. If no further operatons
- * are registered, the polling loop is implicitely stopped.
+ * Remove an operation from the polling loop. If no further operations
+ * are registered, the polling loop is implicitly stopped.
*
* @instance
* @memberof LuCI.poll
* @instance
* @memberof LuCI.poll
* @returns {boolean}
- * Returns `true` if polling has been stopped or `false` if it din't
+ * Returns `true` if polling has been stopped or `false` if it didn't
* run to begin with.
*/
stop: function() {
* The `Node` argument to append the children to.
*
* @param {*} [children]
- * The childrens to append to the given node.
+ * The children to append to the given node.
*
* When `children` is an array, then each item of the array
* will be either appended as child element or text node,
* as first and the return value of the `children` function as
* second parameter.
*
- * When `children` is is a DOM `Node` instance, it will be
+ * When `children` is a DOM `Node` instance, it will be
* appended to the given `node`.
*
* When `children` is any other non-`null` value, it will be
- * converted to a string and appened to the `innerHTML` property
+ * converted to a string and appended to the `innerHTML` property
* of the given `node`.
*
* @returns {Node|null}
* Replaces the content of the given node with the given children.
*
* This function first removes any children of the given DOM
- * `Node` and then adds the given given children following the
+ * `Node` and then adds the given children following the
* rules outlined below.
*
* @instance
* The `Node` argument to replace the children of.
*
* @param {*} [children]
- * The childrens to replace into the given node.
+ * The children to replace into the given node.
*
* When `children` is an array, then each item of the array
* will be either appended as child element or text node,
* as first and the return value of the `children` function as
* second parameter.
*
- * When `children` is is a DOM `Node` instance, it will be
+ * When `children` is a DOM `Node` instance, it will be
* appended to the given `node`.
*
* When `children` is any other non-`null` value, it will be
- * converted to a string and appened to the `innerHTML` property
+ * converted to a string and appended to the `innerHTML` property
* of the given `node`.
*
* @returns {Node|null}
*
* When `val` is of any other type, it will be added as attribute
* to the given `node` as-is, with the underlying `setAttribute()`
- * call implicitely turning it into a string.
+ * call implicitly turning it into a string.
*/
attr: function(node, key, val) {
if (!this.elem(node))
* Any return values of this function are discarded, but
* passed through `Promise.resolve()` to ensure that any
* returned promise runs to completion before the button
- * is reenabled.
+ * is re-enabled.
*/
handleSave: function(ev) {
var tasks = [];
* Any return values of this function are discarded, but
* passed through `Promise.resolve()` to ensure that any
* returned promise runs to completion before the button
- * is reenabled.
+ * is re-enabled.
*/
handleSaveApply: function(ev, mode) {
return this.handleSave(ev).then(function() {
* Any return values of this function are discarded, but
* passed through `Promise.resolve()` to ensure that any
* returned promise runs to completion before the button
- * is reenabled.
+ * is re-enabled.
*/
handleReset: function(ev) {
var tasks = [];
/**
* A wrapper around {@link LuCI#raise raise()} which also renders
- * the error either as modal overlay when `ui.js` is already loaed
+ * the error either as modal overlay when `ui.js` is already loaded
* or directly into the view body.
*
* @instance
* omitted, it defaults to an empty string.
*
* @param {string[]} [parts]
- * An array of parts to join into an URL path. Parts may contain
+ * An array of parts to join into a URL path. Parts may contain
* slashes and any of the other characters mentioned above.
*
* @return {string}
},
/**
- * Construct an URL pathrelative to the script path of the server
+ * Construct a URL with path relative to the script path of the server
* side LuCI application (usually `/cgi-bin/luci`).
*
* The resulting URL is guaranteed to only contain the characters
* @memberof LuCI
*
* @param {string[]} [parts]
- * An array of parts to join into an URL path. Parts may contain
+ * An array of parts to join into a URL path. Parts may contain
* slashes and any of the other characters mentioned above.
*
* @return {string}
},
/**
- * Construct an URL path relative to the global static resource path
+ * Construct a URL path relative to the global static resource path
* of the LuCI ui (usually `/luci-static/resources`).
*
* The resulting URL is guaranteed to only contain the characters
* @memberof LuCI
*
* @param {string[]} [parts]
- * An array of parts to join into an URL path. Parts may contain
+ * An array of parts to join into a URL path. Parts may contain
* slashes and any of the other characters mentioned above.
*
* @return {string}
},
/**
- * Construct an URL path relative to the media resource path of the
+ * Construct a URL path relative to the media resource path of the
* LuCI ui (usually `/luci-static/$theme_name`).
*
* The resulting URL is guaranteed to only contain the characters
* @memberof LuCI
*
* @param {string[]} [parts]
- * An array of parts to join into an URL path. Parts may contain
+ * An array of parts to join into a URL path. Parts may contain
* slashes and any of the other characters mentioned above.
*
* @return {string}
* The object to extract the keys from. If the given value is
* not an object, the function will return an empty array.
*
- * @param {string} [key]
+ * @param {string|null} [key]
* Specifies the key to order by. This is mainly useful for
* nested objects of objects or objects of arrays when sorting
* shall not be performed by the primary object keys but by
* some other key pointing to a value within the nested values.
*
- * @param {string} [sortmode]
- * May be either `addr` or `num` to override the natural
+ * @param {"addr"|"num"} [sortmode]
+ * Can be either `addr` or `num` to override the natural
* lexicographic sorting with a sorting suitable for IP/MAC style
* addresses or numeric values respectively.
*
},
/**
- * Returns a promise resolving with either the given value or or with
+ * Returns a promise resolving with either the given value or with
* the given default in case the input value is a rejecting promise.
*
* @instance
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
var s = uci.get('wireless', sid);
if (s != null && s['.type'] == 'wifi-iface') {
var radioname = s.device;
- if (typeof(s.device) == 'string') {
- var i = 0, netid = null, sections = uci.sections('wireless', 'wifi-iface');
+ if (typeof(radioname) == 'string') {
+ var sections = uci.sections('wireless', 'wifi-iface');
for (var i = 0, n = 0; i < sections.length; i++) {
if (sections[i].device != s.device)
continue;
* @method
*
* @param {string} netmask
- * The netmask to convert into a bit count.
+ * The netmask to convert into a bits count.
*
* @param {boolean} [v6=false]
* Whether to parse the given netmask as IPv4 (`false`) or IPv6 (`true`)
},
/**
- * Describes an swconfig switch topology by specifying the CPU
+ * Describes a swconfig switch topology by specifying the CPU
* connections and external port labels of a switch.
*
* @typedef {Object<string, Object|Array>} SwitchTopology
* @property {Array<Object<string, boolean|number|string>>} ports
* The `ports` property points to an array describing the populated
* ports of the switch in the external label order. Each array item is
- * an object containg the following keys:
+ * an object containing the following keys:
* - `num` - the internal switch port number
* - `label` - the label of the port, e.g. `LAN 1` or `CPU (eth0)`
* - `device` - the connected Linux network device name (CPU ports only)
},
/**
- * Obtains the the network device name of the given object.
+ * Obtains the network device name of the given object.
*
* @param {LuCI.network.Protocol|LuCI.network.Device|LuCI.network.WifiDevice|LuCI.network.WifiNetwork|string} obj
* The object to get the device name from.
},
/**
- * Get the associared Linux network device of this network.
+ * Get the associated Linux network device of this network.
*
* @returns {null|string}
* Returns the name of the associated network device or `null` if
},
/**
- * Return a human readable description for the protcol, such as
+ * Return a human readable description for the protocol, such as
* `Static address` or `DHCP client`.
*
* This function should be overwritten by subclasses.
*
* @returns {string}
* Returns the name of the opkg package required for the protocol to
- * function, e.g. `odhcp6c` for the `dhcpv6` prototocol.
+ * function, e.g. `odhcp6c` for the `dhcpv6` protocol.
*/
getOpkgPackage: function() {
return null;
* on demand instead of using existing physical interfaces.
*
* Examples for virtual protocols are `6in4` which `gre` spawn tunnel
- * network device on startup, examples for non-virtual protcols are
+ * network device on startup, examples for non-virtual protocols are
* `dhcp` or `static` which apply IP configuration to existing interfaces.
*
* This function should be overwritten by subclasses.
* Checks whether this protocol is "floating".
*
* A "floating" protocol is a protocol which spawns its own interfaces
- * on demand, like a virtual one but which relies on an existinf lower
+ * on demand, like a virtual one but which relies on an existing lower
* level interface to initiate the connection.
*
* An example for such a protocol is "pppoe".
* interface.
*
* @returns {null|Array<LuCI.network.Device>}
- * Returns an array of of `Network.Device` class instances representing
+ * Returns an array of `Network.Device` class instances representing
* the sub-devices attached to this logical interface or `null` if the
* logical interface does not support sub-devices, e.g. because it is
* virtual and not a bridge.
* @param {string} opt
* The name of the UCI option to set.
*
- * @param {null|string|string[]} val
+ * @param {null|string|string[]} value
* The value to set or `null` to remove the given option from the
* configuration.
*/
/**
* A wireless scan result object describes a neighbouring wireless
- * network found in the vincinity.
+ * network found in the vicinity.
*
* @typedef {Object<string, number|string|LuCI.network.WifiEncryption>} WifiScanResult
* @memberof LuCI.network
*
* @returns {Promise<Array<LuCI.network.WifiScanResult>>}
* Returns a promise resolving to an array of scan result objects
- * describing the networks found in the vincinity.
+ * describing the networks found in the vicinity.
*/
getScanList: function() {
return callIwinfoScan(this.sid);
*
* @returns {Promise<Array<LuCI.network.WifiNetwork>>}
* Returns a promise resolving to an array of `Network.WifiNetwork`
- * instances respresenting the wireless networks associated with this
+ * instances representing the wireless networks associated with this
* radio device.
*/
getWifiNetworks: function() {
* @param {string} opt
* The name of the UCI option to set.
*
- * @param {null|string|string[]} val
+ * @param {null|string|string[]} value
* The value to set or `null` to remove the given option from the
* configuration.
*/
/**
* Get the internal network ID of this wireless network.
*
- * The network ID is a LuCI specific identifer in the form
+ * The network ID is a LuCI specific identifier in the form
* `radio#.network#` to identify wireless networks by their corresponding
* radio and network index numbers.
*
* Query the current encryption settings from runtime information.
*
* @returns {string}
- * Returns a string describing the current encryption or `-` if the the
+ * Returns a string describing the current encryption or `-` if the
* encryption state could not be found in `ubus` runtime information.
*/
getActiveEncryption: function() {
* - `UNKNOWN`
*
* @property {number} [mesh non-peer PS]
- * The powersafe mode for all non-peer neigbours, may be an empty
+ * The powersafe mode for all non-peer neighbours, may be an empty
* string (`''`) or absent if not applicable or supported by the driver.
*
* The following modes are known:
* The amount of bytes that have been received or sent.
*
* @property {number} [failed]
- * The amount of failed tranmission attempts. Only applicable to
+ * The amount of failed transmission attempts. Only applicable to
* transmit rates.
*
* @property {number} [retries]
* HT or VHT rates.
*
* @property {number} [40mhz]
- * Specifies whether the tranmission rate used 40MHz wide channel.
+ * Specifies whether the transmission rate used 40MHz wide channel.
* Only applicable to HT or VHT rates.
*
* Note: this option exists for backwards compatibility only and its
*
* @returns {LuCI.network.Device}
* Returns a `Network.Device` instance representing the Linux network
- * device associted with this wireless network.
+ * device associated with this wireless network.
*/
getDevice: function() {
return Network.prototype.instantiateDevice(this.getIfname());
},
/**
- * Check whether this wifi network supports deauthenticating clients.
+ * Check whether this wifi network supports de-authenticating clients.
*
* @returns {boolean}
* Returns `true` when this wifi network instance supports forcibly
- * deauthenticating clients, otherwise `false`.
+ * de-authenticating clients, otherwise `false`.
*/
isClientDisconnectSupported: function() {
return L.isObject(this.ubus('hostapd', 'del_client'));
* The MAC address of the client to disconnect.
*
* @param {boolean} [deauth=false]
- * Specifies whether to deauthenticate (`true`) or disassociate (`false`)
+ * Specifies whether to de-authenticate (`true`) or disassociate (`false`)
* the client.
*
* @param {number} [reason=1]
* @param {number} [ban_time=0]
* Specifies the amount of milliseconds to ban the client from
* reconnecting. By default, no ban time is set which allows the client
- * to reassociate / reauthenticate immediately.
+ * to re-associate / reauthenticate immediately.
*
* @returns {Promise<number>}
* Returns a promise resolving to the underlying ubus call result code
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
* the corresponding args object sent to the remote procedure will be
* `{ foo: true, bar: false }`.
* - `params: [ "test" ], filter: function(reply, args, extra) { ... }` -
- * When the resultung generated function is invoked with
+ * When the resulting generated function is invoked with
* `fn("foo", "bar", "baz")` then `{ "test": "foo" }` will be sent as
* argument to the remote procedure and the filter function will be
* invoked with `filterFn(reply, [ "foo" ], "bar", "baz")`
* be returned as default instead.
*
* @property {LuCI.rpc~filterFn} [filter]
- * Specfies an optional filter function which is invoked to transform the
+ * Specifies an optional filter function which is invoked to transform the
* received reply data before it is returned to the caller.
*
* @property {boolean} [reject=false]
/**
* Set the RPC base URL to use.
*
- * @param {string} sid
+ * @param {string} url
* Sets the RPC URL endpoint to issue requests against.
*/
setBaseURL: function(url) {
* Registers a new interceptor function.
*
* @param {LuCI.rpc~interceptorFn} interceptorFn
- * The inteceptor function to register.
+ * The interceptor function to register.
*
* @returns {LuCI.rpc~interceptorFn}
* Returns the given function value.
* Removes a registered interceptor function.
*
* @param {LuCI.rpc~interceptorFn} interceptorFn
- * The inteceptor function to remove.
+ * The interceptor function to remove.
*
* @returns {boolean}
* Returns `true` if the given function has been removed or `false`
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
*
* The `LuCI.uci` class utilizes {@link LuCI.rpc} to declare low level
* remote UCI `ubus` procedures and implements a local caching and data
- * manipulation layer on top to allow for synchroneous operations on
+ * manipulation layer on top to allow for synchronous operations on
* UCI configuration data.
*/
return baseclass.extend(/** @lends LuCI.uci.prototype */ {
* identifier in the form `cfgXXXXXX` once the configuration is saved
* by the remote `ubus` UCI api.
*
- * @param {string} config
+ * @param {string} conf
* The configuration to generate the new section ID for.
*
* @returns {string}
* Resolves a given section ID in extended notation to the internal
* section ID value.
*
- * @param {string} config
+ * @param {string} conf
* The configuration to resolve the section ID for.
*
* @param {string} sid
* To force reloading a configuration, it has to be unloaded with
* {@link LuCI.uci#unload uci.unload()} first.
*
- * @param {string|string[]} config
+ * @param {string|string[]} packages
* The name of the configuration or an array of configuration
* names to load.
*
/**
* Unloads the given UCI configurations from the local cache.
*
- * @param {string|string[]} config
+ * @param {string|string[]} packages
* The name of the configuration or an array of configuration
* names to unload.
*/
* Adds a new section of the given type to the given configuration,
* optionally named according to the given name.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to add the section to.
*
* @param {string} type
/**
* Removes the section with the given ID from the given configuration.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to remove the section from.
*
* @param {string} sid
* enclosed within a configuration section, as well as some additional
* meta data such as sort indexes and internal ID.
*
- * Any internal metadata fields are prefixed with a dot which is isn't
+ * Any internal metadata fields are prefixed with a dot which isn't
* an allowed character for normal option names.
*
* @typedef {Object<string, boolean|number|string|string[]>} SectionObject
* anonymous (`true`) or named (`false`).
*
* @property {number} .index
- * The `.index` property specifes the sort order of the section.
+ * The `.index` property specifies the sort order of the section.
*
* @property {string} .name
* The `.name` property holds the name of the section object. It may be
* Enumerates the sections of the given configuration, optionally
* filtered by type.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to enumerate the sections for.
*
* @param {string} [type]
* of the given configuration or the entire section object if the
* option name is omitted.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to read the value from.
*
* @param {string} sid
* The name or ID of the section to read.
*
- * @param {string} [option]
+ * @param {string} [opt]
* The option name to read the value from. If the option name is
* omitted or `null`, the entire section is returned instead.
*
* If either config, section or option is null, or if `option` begins
* with a dot, the function will do nothing.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to set the option value in.
*
* @param {string} sid
* The name or ID of the section to set the option value in.
*
- * @param {string} option
+ * @param {string} opt
* The option name to set the value for.
*
- * @param {null|string|string[]} value
+ * @param {null|string|string[]} val
* The option value to set. If the value is `null` or an empty string,
* the option will be removed, otherwise it will be set or overwritten
* with the given value.
* This function is a convenience wrapper around
* `uci.set(config, section, option, null)`.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to remove the option from.
*
* @param {string} sid
* The name or ID of the section to remove the option from.
*
- * @param {string} option
+ * @param {string} opt
* The name of the option to remove.
*/
unset: function(conf, sid, opt) {
/**
* Gets the value of the given option or the entire section object of
* the first found section of the specified type or the first found
- * section of the entire configuration if no type is specfied.
+ * section of the entire configuration if no type is specified.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to read the value from.
*
* @param {string} [type]
* section of the entire config is read, otherwise the first section
* matching the given type.
*
- * @param {string} [option]
+ * @param {string} [opt]
* The option name to read the value from. If the option name is
* omitted or `null`, the entire section is returned instead.
*
* If either config, type or option is null, or if `option` begins
* with a dot, the function will do nothing.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to set the option value in.
*
* @param {string} [type]
* section of the entire config is written to, otherwise the first
* section matching the given type is used.
*
- * @param {string} option
+ * @param {string} opt
* The option name to set the value for.
*
- * @param {null|string|string[]} value
+ * @param {null|string|string[]} val
* The option value to set. If the value is `null` or an empty string,
* the option will be removed, otherwise it will be set or overwritten
* with the given value.
* This function is a convenience wrapper around
* `uci.set_first(config, type, option, null)`.
*
- * @param {string} config
+ * @param {string} conf
* The name of the configuration to set the option value in.
*
* @param {string} [type]
* section of the entire config is written to, otherwise the first
* section matching the given type is used.
*
- * @param {string} option
+ * @param {string} opt
* The option name to set the value for.
*/
unset_first: function(conf, type, opt) {
* Move the first specified section within the given configuration
* before or after the second specified section.
*
- * @param {string} config
+ * @param {string} conf
* The configuration to move the section within.
*
* @param {string} sid1
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>
* events.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* @memberof LuCI.ui.AbstractElement
* @returns {boolean}
* Returns `true` if the input value has been altered by the user or
- * `false` if it is unchaged. Note that if the user modifies the initial
+ * `false` if it is unchanged. Note that if the user modifies the initial
* value and changes it back to the original state, it is still reported
* as changed.
*/
* The `Textfield` class implements a standard single line text input field.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* The `Textarea` class implements a multiline text area input field.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* The `Checkbox` class implements a simple checkbox input field.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* values are enabled or not.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* @property {boolean} [multiple=false]
* Specifies whether multiple choice values may be selected.
*
- * @property {string} [widget=select]
+ * @property {"select"|"individual"} [widget=select]
* Specifies the kind of widget to render. May be either `select` or
* `individual`. When set to `select` an HTML `<select>` element will be
* used, otherwise a group of checkbox or radio button elements is created,
* supports non-text choice labels.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* with a set of enforced default properties for easier instantiation.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* into a dropdown to chose from a set of different action choices.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
/**
* ComboButtons support the same properties as
* [Dropdown.InitOptions]{@link LuCI.ui.Dropdown.InitOptions} but enforce
- * specific values for some properties and add aditional button specific
+ * specific values for some properties and add additional button specific
* properties.
*
* @typedef {LuCI.ui.Dropdown.InitOptions} InitOptions
* from a set of predefined choices.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
*/
var UIDynamicList = UIElement.extend(/** @lends LuCI.ui.DynamicList.prototype */ {
/**
- * In case choices are passed to the dynamic list contructor, the widget
+ * In case choices are passed to the dynamic list constructor, the widget
* supports the same properties as [Dropdown.InitOptions]{@link LuCI.ui.Dropdown.InitOptions}
* but enforces specific values for some dropdown properties.
*
* which allows to store form data without exposing it to the user.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
* browse, select and delete files beneath a predefined remote directory.
*
* UI widget instances are usually not supposed to be created by view code
- * directly, instead they're implicitely created by `LuCI.form` when
+ * directly, instead they're implicitly created by `LuCI.form` when
* instantiating CBI forms.
*
* This class is automatically instantiated as part of `LuCI.ui`. To use it
*
* @property {string} [root_directory=/etc/luci-uploads]
* Specifies the remote directory the upload and file browsing actions take
- * place in. Browsing to directories outside of the root directory is
+ * place in. Browsing to directories outside the root directory is
* prevented by the widget. Note that this is not a security feature.
- * Whether remote directories are browseable or not solely depends on the
+ * Whether remote directories are browsable or not solely depends on the
* ACL setup for the current session.
*/
__init__: function(value, options) {
* @property {string} name - The internal name of the node, as used in the URL
* @property {number} order - The sort index of the menu node
* @property {string} [title] - The title of the menu node, `null` if the node should be hidden
- * @property {satisified} boolean - Boolean indicating whether the menu enries dependencies are satisfied
+ * @property {satisfied} boolean - Boolean indicating whether the menu entries dependencies are satisfied
* @property {readonly} [boolean] - Boolean indicating whether the menu entries underlying ACLs are readonly
* @property {LuCI.ui.menu.MenuNode[]} [children] - Array of child menu nodes.
*/
* be opened. Invoking showModal() while a modal dialog is already open will
* replace the open dialog with a new one having the specified contents.
*
- * Additional CSS class names may be passed to influence the appearence of
+ * Additional CSS class names may be passed to influence the appearance of
* the dialog. Valid values for the classes depend on the underlying theme.
*
* @see LuCI.dom.content
* @param {string} [title]
* The title of the dialog. If `null`, no title element will be rendered.
*
- * @param {*} contents
+ * @param {*} children
* The contents to add to the modal dialog. This should be a DOM node or
* a document fragment in most cases. The value is passed as-is to the
* `dom.content()` function - refer to its documentation for applicable
* Add a notification banner at the top of the current view.
*
* A notification banner is an alert message usually displayed at the
- * top of the current view, spanning the entire availibe width.
+ * top of the current view, spanning the entire available width.
* Notification banners will stay in place until dismissed by the user.
* Multiple banners may be shown at the same time.
*
- * Additional CSS class names may be passed to influence the appearence of
+ * Additional CSS class names may be passed to influence the appearance of
* the banner. Valid values for the classes depend on the underlying theme.
*
* @see LuCI.dom.content
* The title of the notification banner. If `null`, no title element
* will be rendered.
*
- * @param {*} contents
+ * @param {*} children
* The contents to add to the notification banner. This should be a DOM
* node or a document fragment in most cases. The value is passed as-is
* to the `dom.content()` function - refer to its documentation for
},
/**
- * Display or update an header area indicator.
+ * Display or update a header area indicator.
*
* An indicator is a small label displayed in the header area of the screen
* providing few amounts of status information such as item counts or state
* Note that this parameter only applies to new indicators, when updating
* existing labels it is ignored.
*
- * @param {string} [style=active]
+ * @param {"active"|"inactive"} [style=active]
* The indicator style to use. May be either `active` or `inactive`.
*
* @returns {boolean}
},
/**
- * Remove an header area indicator.
+ * Remove a header area indicator.
*
* This function removes the given indicator label from the header indicator
* area. When the given indicator is not found, this function does nothing.
* subsequently wrapped into a `<span class="nowrap">` element.
*
* The resulting `<span>` element tuples are joined by the given separators
- * to form the final markup which is appened to the given parent DOM node.
+ * to form the final markup which is appended to the given parent DOM node.
*
* @param {Node} node
* The parent DOM node to append the markup to. Any previous child elements
* @param {string} path
* The remote file path to upload the local file to.
*
- * @param {Node} [progessStatusNode]
+ * @param {Node} [progressStatusNode]
* An optional DOM text node whose content text is set to the progress
* percentage value during file upload.
*
/**
* Perform a device connectivity test.
*
- * Attempt to fetch a well known ressource from the remote device via HTTP
+ * Attempt to fetch a well known resource from the remote device via HTTP
* in order to test connectivity. This function is mainly useful to wait
* for the router to come back online after a reboot or reconfiguration.
*
* The protocol to use for fetching the resource. May be either `http`
* (the default) or `https`.
*
- * @param {string} [host=window.location.host]
+ * @param {string} [ipaddr=window.location.host]
* Override the host address to probe. By default the current host as seen
* in the address bar is probed.
*
*
* @instance
* @memberof LuCI.ui.changes
- * @param {number} numChanges
+ * @param {number} n
* The number of changes to indicate.
*/
setIndicator: function(n) {
*
* By instantiating the view class, its corresponding contents are
* rendered and included into the view area. Any runtime errors are
- * catched and rendered using [LuCI.error()]{@link LuCI#error}.
+ * caught and rendered using [LuCI.error()]{@link LuCI#error}.
*
* @param {string} path
* The view path to render.
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:47:32 GMT+0000 (Coordinated Universal Time)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Tue Sep 26 2023 07:48:05 GMT+0000 (Coordinated Universal Time)
</footer>
</div>
</div>