From: systemcrash Date: Tue, 7 Oct 2025 22:56:24 +0000 (+0000) Subject: deploy: 6c5f78ffd2969b3a81807a126ab66be379a96aee X-Git-Url: http://git.openwrt.org/?a=commitdiff_plain;h=20a82c1c47ff439c414bcf6ac718dfea739ea561;p=project%2Fluci.git deploy: 6c5f78ffd2969b3a81807a126ab66be379a96aee --- diff --git a/jsapi/LuCI.baseclass.html b/jsapi/LuCI.baseclass.html index afd26df772..97b9689ba8 100644 --- a/jsapi/LuCI.baseclass.html +++ b/jsapi/LuCI.baseclass.html @@ -3846,7 +3846,7 @@

LuCI.baseclass is the abstract base class all LuCI classes inherit from.

-

It provides simple means to create subclasses of given classes and +

It provides a simple means to create subclasses of given classes and implements prototypal inheritance.

@@ -4603,7 +4603,7 @@ enable inheritance.

Walks up the parent class chain and looks for a class member called key in any of the parent classes this class inherits from. Returns the member value of the superclass or calls the -member as function and returns its return value when the +member as a function and returns its return value when the optional callArgs array is given.

This function has two signatures and is sensitive to the amount of arguments passed to it:

@@ -4698,7 +4698,7 @@ when found within one of the parent classes.

An optional array of function call parameters to use. When this parameter is specified, the found member value is called -as function using the values of this array as arguments.

+as a function using the values of this array as arguments.

@@ -5042,7 +5042,7 @@ and the values extracted from the args array beginning with diff --git a/jsapi/LuCI.dom.html b/jsapi/LuCI.dom.html index de30f7cc9b..ead3a604f5 100644 --- a/jsapi/LuCI.dom.html +++ b/jsapi/LuCI.dom.html @@ -3845,7 +3845,7 @@ dom -

The dom class provides convenience method for creating and +

The dom class provides a convenience method for creating and manipulating DOM elements.

To import the class in views, use 'require dom', to import it in external JavaScript, use L.require("dom").then(...).

@@ -4047,16 +4047,16 @@ external JavaScript, use L.require("dom").then(...).

<

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, +will be either appended as a child element or text node, depending on whether the item is a DOM Node instance or some other non-null value. Non-Node, non-null values will be converted to strings first before being passed as argument to createTextNode().

When children is a function, it will be invoked with -the passed node argument as sole parameter and the append +the passed node argument as the sole parameter and the append function will be invoked again, with the given node argument as first and the return value of the children function as -second parameter.

+the second parameter.

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 @@ -4285,13 +4285,13 @@ depending on the respective value.

Specifies the attribute value or event handler function to add. If the key parameter is an Object, this parameter will be ignored.

-

When val is of type function, it will be registered as event +

When val is of type function, it will be registered as an event handler on the given node with the key parameter being the event name.

When val is of type object, it will be serialized as JSON and -added as attribute to the given node, using the given key -as attribute name.

-

When val is of any other type, it will be added as attribute +added as an attribute to the given node, using the given key +as an attribute name.

+

When val is of any other type, it will be added as an attribute to the given node as-is, with the underlying setAttribute() call implicitly turning it into a string.

@@ -4362,7 +4362,7 @@ call implicitly turning it into a string.

-

Binds the given class instance ot the specified DOM Node.

+

Binds the given class instance to the specified DOM Node.

This function uses the dom.data() facility to attach the passed instance of a Class to a node. This is needed for complex widget elements or similar where the corresponding @@ -4866,16 +4866,16 @@ rules outlined below.

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, +will be either appended as a child element or text node, depending on whether the item is a DOM Node instance or some other non-null value. Non-Node, non-null values will be converted to strings first before being passed as argument to createTextNode().

When children is a function, it will be invoked with -the passed node argument as sole parameter and the append +the passed node argument as the sole parameter and the append function will be invoked again, with the given node argument as first and the return value of the children function as -second parameter.

+the second parameter.

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 @@ -5044,9 +5044,9 @@ type of the second argument.

When the value of html is of type array, a DocumentFragment node is created and each item of the array is first converted to a DOM Node by passing it through create() and then added -as child to the fragment.

+as a child to the fragment.

When the value of html is a DOM Node instance, no new -element will be created but the node will be used as-is.

+element will be created, but the node will be used as-is.

When the value of html is a string starting with <, it will be passed to dom.parse() and the resulting value is used.

When the value of html is any other string, it will be passed @@ -6638,7 +6638,7 @@ ignored, else not.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractElement.html b/jsapi/LuCI.form.AbstractElement.html index 8be5742035..e74037f1c9 100644 --- a/jsapi/LuCI.form.AbstractElement.html +++ b/jsapi/LuCI.form.AbstractElement.html @@ -3845,7 +3845,7 @@ AbstractElement -

The AbstractElement class serves as abstract base for the different form +

The AbstractElement class serves as an abstract base for the different form elements implemented by LuCI.form. It provides the common logic for loading and rendering values, for nesting elements and for defining common properties.

@@ -4439,14 +4439,14 @@ entities decoded.
-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -4629,7 +4629,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractSection.html b/jsapi/LuCI.form.AbstractSection.html index 948355dbd2..89d91859da 100644 --- a/jsapi/LuCI.form.AbstractSection.html +++ b/jsapi/LuCI.form.AbstractSection.html @@ -4616,7 +4616,7 @@ custom implementations.

-

Query underlying option widget input values.

+

Query the underlying option widget input values.

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, the widget input values of all options within this section are returned as a dictionary.

@@ -5972,7 +5972,7 @@ as an identifier to differentiate tabs.

An additional description text for the corresponding tab pane. It is -displayed as text paragraph below the tab but before the tab pane +displayed as a text paragraph below the tab but before the tab pane contents. If omitted, no description will be rendered.

@@ -6338,14 +6338,14 @@ descendant of AbstractValue.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -6528,7 +6528,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractValue.html b/jsapi/LuCI.form.AbstractValue.html index 2936d0eb9a..05eddb376c 100644 --- a/jsapi/LuCI.form.AbstractValue.html +++ b/jsapi/LuCI.form.AbstractValue.html @@ -3845,7 +3845,7 @@ AbstractValue -

The AbstractValue class serves as abstract base for the different form +

The AbstractValue class serves as an abstract base for the different form option styles implemented by LuCI.form. It provides the common logic for handling option input values, for dependencies among options and for validation constraints that should be applied to entered values.

@@ -4057,7 +4057,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4112,7 +4112,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4475,8 +4475,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4580,7 +4580,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5154,7 +5154,7 @@ different way.

- depends(field, value) + depends(field, value)

@@ -5177,12 +5177,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5291,6 +5291,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5318,8 +5323,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7069,14 +7081,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7404,8 +7416,8 @@ constraints.

The method shall return true to accept the given value. Any other -return value is treated as failure, converted to a string and displayed -as error message to the user. +return value is treated as a failure, converted to a string and displayed +as an error message to the user. @@ -7586,7 +7598,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.ButtonValue.html b/jsapi/LuCI.form.ButtonValue.html index c47dd46087..5ce72ad8b1 100644 --- a/jsapi/LuCI.form.ButtonValue.html +++ b/jsapi/LuCI.form.ButtonValue.html @@ -3927,7 +3927,7 @@ renders the underlying UCI option or default value as readonly text.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added to. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4184,13 +4184,13 @@ selected to influence the style of the resulting button.

Override the rendered button caption.

-

By default, the option title - which is passed as fourth argument to the -constructor - is used as caption for the button element. When setting +

By default, the option title - which is passed as the fourth argument to the +constructor - is used as a caption for the button element. When setting this property to a string, it is used as a String.format() pattern with -the underlying UCI section name passed as first format argument. When -set to a function, it is invoked passing the section ID as sole argument +the underlying UCI section name passed as the first format argument. When +set to a function, it is invoked passing the section ID as the sole argument, and the resulting return value is converted to a string before being -used as button caption.

+used as a button caption.

The default of null means the option title is used as caption.

@@ -4245,8 +4245,8 @@ copied into a hidden field tied to the button element and the save action is triggered on the parent form element.

When this property is set to a function, it is invoked instead of performing the default actions. The handler function will receive the -DOM click element as first and the underlying configuration section ID -as second argument.

+DOM click element as the first and the underlying configuration section ID +as the second argument.

@@ -4393,7 +4393,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4448,7 +4448,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4908,8 +4908,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5013,7 +5013,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5593,7 +5593,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5616,12 +5616,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5730,6 +5730,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5757,8 +5762,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7418,14 +7430,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7690,7 +7702,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7909,7 +7921,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.DummyValue.html b/jsapi/LuCI.form.DummyValue.html index 1d91f8e8e7..0bb41782c9 100644 --- a/jsapi/LuCI.form.DummyValue.html +++ b/jsapi/LuCI.form.DummyValue.html @@ -3927,7 +3927,7 @@ renders the underlying UCI option or default value as readonly text.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3958,7 +3958,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4380,7 +4380,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4435,7 +4435,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4895,8 +4895,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5000,7 +5000,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5580,7 +5580,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5603,12 +5603,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5717,6 +5717,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5744,8 +5749,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7405,14 +7417,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7677,7 +7689,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7896,7 +7908,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.DynamicList.html b/jsapi/LuCI.form.DynamicList.html index 8f68a8deec..7d1b3fd9c1 100644 --- a/jsapi/LuCI.form.DynamicList.html +++ b/jsapi/LuCI.form.DynamicList.html @@ -3928,7 +3928,7 @@ predefined choices. It builds upon the -

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3959,7 +3959,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4280,7 +4280,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4335,7 +4335,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4795,8 +4795,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4900,7 +4900,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5480,7 +5480,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5503,12 +5503,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5617,6 +5617,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5644,8 +5649,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7305,14 +7317,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7577,7 +7589,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7796,7 +7808,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.FileUpload.html b/jsapi/LuCI.form.FileUpload.html index e1451cadca..8bc9ff23a0 100644 --- a/jsapi/LuCI.form.FileUpload.html +++ b/jsapi/LuCI.form.FileUpload.html @@ -3927,7 +3927,7 @@ offers the ability to browse, upload and select remote files.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added to. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4227,7 +4227,7 @@ option to the section.

Toggle remote file delete functionality.

-

When set to true, the underlying widget provides a buttons which let +

When set to true, the underlying widget provides buttons which let the user delete files from remote directories. Note that this is merely a cosmetic feature: remote delete permissions are controlled by the session ACL rules.

@@ -4537,7 +4537,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4592,7 +4592,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -5052,8 +5052,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5157,7 +5157,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5737,7 +5737,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5760,12 +5760,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5874,6 +5874,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5901,8 +5906,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7562,14 +7574,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7834,7 +7846,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -8053,7 +8065,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.FlagValue.html b/jsapi/LuCI.form.FlagValue.html index c7b33c768a..ec3a191ad9 100644 --- a/jsapi/LuCI.form.FlagValue.html +++ b/jsapi/LuCI.form.FlagValue.html @@ -3927,7 +3927,7 @@ implement a simple checkbox element.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3958,7 +3958,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4427,7 +4427,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4482,7 +4482,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4942,8 +4942,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5047,7 +5047,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5627,7 +5627,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5650,12 +5650,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5764,6 +5764,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5791,8 +5796,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7446,14 +7458,14 @@ either a localized Yes or No string, depending on the
-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7718,7 +7730,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7937,7 +7949,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.GridSection.html b/jsapi/LuCI.form.GridSection.html index f2fd7d6fcb..c7501a3058 100644 --- a/jsapi/LuCI.form.GridSection.html +++ b/jsapi/LuCI.form.GridSection.html @@ -3940,7 +3940,7 @@ documentation for details.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by section().

@@ -4110,10 +4110,10 @@ by section().

-

Override the caption used for the section add button at the bottom of +

Override the caption used for the section add a button at the bottom of the section form element. Set to a string, it will be used as-is. Set to a function, the function will be invoked and its return value -is used as caption, after converting it to a string. If this property +is used as a caption, after converting it to a string. If this property is not set, the default is Add.

@@ -4214,7 +4214,7 @@ The default is false.

If set to true, mapped section instances are treated as anonymous UCI sections, which means that section instance elements will be -rendered without title element and that no name is required when adding +rendered without a title element and that no name is required when adding new sections. The default is false.

@@ -4316,11 +4316,11 @@ The default is false.

Enables a per-section instance row Edit button which triggers a certain action when clicked. Set to a string, the string value is used as a String.format() pattern with the name of the underlying UCI section -as first format argument. The result is then interpreted as a URL which +as the first format argument. The result is then interpreted as a URL which LuCI will navigate to when the user clicks the edit button.

-

If set to a function, this function will be registered as click event +

If set to a function, this function will be registered as a click event handler on the rendered edit button, receiving the section instance -name as first and the DOM click event as second argument.

+name as the first and the DOM click event as the second argument.

@@ -4425,9 +4425,9 @@ style when clicked.

Override the per-section instance modal popup title caption shown when clicking the More… button in a section specifying max_cols. Set to a string, it will be used as a String.format() pattern with the name -of the underlying UCI section as first argument. Set to a function, -the function will be invoked with the section name as first argument and -its return value is used as caption, after converting it to a string. +of the underlying UCI section as the first argument. Set to a function, +the function will be invoked with the section name as the first argument, and +its return value is used as a caption after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4477,8 +4477,8 @@ UCI configuration section.

-

Set to true, the header row with the options descriptions will -not be displayed. By default, descriptions row is automatically displayed +

Set to true, the header row with the descriptions of options will +not be displayed. By default, the row of descriptions is automatically displayed when at least one option has a description.

@@ -4628,9 +4628,9 @@ implement these row style classes. The default is false.

Override the per-section instance title caption shown in the first column of the table unless anonymous is set to true. Set to a string, it will be used as a String.format() pattern with the name of -the underlying UCI section as first argument. Set to a function, the -function will be invoked with the section name as first argument and -its return value used as caption, after converting it to a string. +the underlying UCI section as the first argument. Set to a function, the +function will be invoked with the section name as the first argument and +its return value used as a caption, after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4731,7 +4731,7 @@ element.

When set to true, instead of rendering section instances one below -another, treat each instance as separate tab pane and render a tab menu +another, treat each instance as a separate tab pane and render a tab menu at the top of the form section element, allowing the user to switch among instances. The default is false.

@@ -5523,7 +5523,7 @@ custom implementations.

-

Query underlying option widget input values.

+

Query the underlying option widget input values.

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, the widget input values of all options within this section are returned as a dictionary.

@@ -6780,7 +6780,7 @@ as an identifier to differentiate tabs.

An additional description text for the corresponding tab pane. It is -displayed as text paragraph below the tab but before the tab pane +displayed as a text paragraph below the tab but before the tab pane contents. If omitted, no description will be rendered.

@@ -7148,14 +7148,14 @@ descendant of AbstractValue.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7338,7 +7338,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.HiddenValue.html b/jsapi/LuCI.form.HiddenValue.html index 009fc5bede..e82b46b56e 100644 --- a/jsapi/LuCI.form.HiddenValue.html +++ b/jsapi/LuCI.form.HiddenValue.html @@ -3932,7 +3932,7 @@ distorted form layout when rendering the option element.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added to. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4234,7 +4234,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4289,7 +4289,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4749,8 +4749,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4854,7 +4854,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5434,7 +5434,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5457,12 +5457,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5571,6 +5571,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5598,8 +5603,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7259,14 +7271,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7531,7 +7543,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7750,7 +7762,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.JSONMap.html b/jsapi/LuCI.form.JSONMap.html index 2a19d23277..4a48649959 100644 --- a/jsapi/LuCI.form.JSONMap.html +++ b/jsapi/LuCI.form.JSONMap.html @@ -3847,7 +3847,7 @@

A JSONMap class functions similar to LuCI.form.Map but uses a multidimensional JavaScript object instead of UCI configuration -as data source.

+as a data source.

@@ -3925,7 +3925,7 @@ as data source.

-

The JavaScript object to use as data source. Internally, the object is +

The JavaScript object to use as a data source. Internally, the object is converted into an UCI-like format. Its top-level keys are treated like UCI section types while the object or array-of-object values are treated as section contents.

@@ -3990,7 +3990,7 @@ corresponding headline element will not be rendered.

-

The description text of the form which is usually rendered as text +

The description text of the form which is usually rendered as a text paragraph below the form title and before the actual form contents. If omitted, the corresponding paragraph element will not be rendered.

@@ -4261,7 +4261,7 @@ permissions are granted.

Tie another UCI configuration to the map.

By default, a map instance will only load the UCI configuration file -specified in the constructor but sometimes access to values from +specified in the constructor, but sometimes access to values from further configuration files is required. This function allows for such use cases by registering further UCI configuration files which are needed by the map.

@@ -4389,7 +4389,7 @@ parameters. This function is essentially a convenience wrapper around

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, it is used as selector-expression as-is. When two arguments are passed, the first argument is treated -as attribute name, the second one as attribute value to match.

+as an attribute name, the second one as an attribute value to match.

As an example, map.findElement('input') would find the first <input> node while map.findElement('type', 'text') would find the first DOM node with a type="text" attribute.

@@ -4614,7 +4614,7 @@ parameters. This function is essentially a convenience wrapper around

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, it is used as selector-expression as-is. When two arguments are passed, the first argument is treated -as attribute name, the second one as attribute value to match.

+as an attribute name, the second one as an attribute value to match.

As an example, map.findElements('input') would find all <input> nodes while map.findElements('type', 'text') would find any DOM node with a type="text" attribute.

@@ -4902,7 +4902,7 @@ load function of each child element.

Returns a promise resolving once the entire form completed loading all data. The promise may reject with an error if any configuration failed -to load or if any of the child elements' load functions rejected with +to load or if any of the child elements' load functions reject with an error. @@ -5020,8 +5020,8 @@ an error. -

The ID of the UCI section containing the option to look up. May be -omitted if a full ID is passed as first argument.

+

The ID of the UCI section that contains the option to look up. May be +omitted if a full ID is passed as the first argument.

@@ -5121,7 +5121,7 @@ Defaults to the main UCI configuration of the map if omitted.

Returns a two-element array containing the form option instance as -first item and the corresponding UCI section ID as second item. +the first item and the corresponding UCI section ID as the second item. Returns null if the option could not be found. @@ -6018,14 +6018,14 @@ entities decoded.
-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -6208,7 +6208,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.ListValue.html b/jsapi/LuCI.form.ListValue.html index f25ebd9791..667bec3908 100644 --- a/jsapi/LuCI.form.ListValue.html +++ b/jsapi/LuCI.form.ListValue.html @@ -3928,7 +3928,7 @@ It builds upon the LuCI.ui.Select -

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added to. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4379,7 +4379,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4434,7 +4434,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4894,8 +4894,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4999,7 +4999,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5579,7 +5579,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5602,12 +5602,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5716,6 +5716,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5743,8 +5748,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7404,14 +7416,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7921,7 +7933,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Map.html b/jsapi/LuCI.form.Map.html index 74524dac82..0882d3579a 100644 --- a/jsapi/LuCI.form.Map.html +++ b/jsapi/LuCI.form.Map.html @@ -4258,7 +4258,7 @@ permissions are granted.

Tie another UCI configuration to the map.

By default, a map instance will only load the UCI configuration file -specified in the constructor but sometimes access to values from +specified in the constructor, but sometimes access to values from further configuration files is required. This function allows for such use cases by registering further UCI configuration files which are needed by the map.

@@ -4384,7 +4384,7 @@ parameters. This function is essentially a convenience wrapper around

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, it is used as selector-expression as-is. When two arguments are passed, the first argument is treated -as attribute name, the second one as attribute value to match.

+as an attribute name, the second one as an attribute value to match.

As an example, map.findElement('input') would find the first <input> node while map.findElement('type', 'text') would find the first DOM node with a type="text" attribute.

@@ -4607,7 +4607,7 @@ parameters. This function is essentially a convenience wrapper around

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, it is used as selector-expression as-is. When two arguments are passed, the first argument is treated -as attribute name, the second one as attribute value to match.

+as an attribute name, the second one as an attribute value to match.

As an example, map.findElements('input') would find all <input> nodes while map.findElements('type', 'text') would find any DOM node with a type="text" attribute.

@@ -4893,7 +4893,7 @@ load function of each child element.

Returns a promise resolving once the entire form completed loading all data. The promise may reject with an error if any configuration failed -to load or if any of the child elements' load functions rejected with +to load or if any of the child elements' load functions reject with an error. @@ -5009,8 +5009,8 @@ an error. -

The ID of the UCI section containing the option to look up. May be -omitted if a full ID is passed as first argument.

+

The ID of the UCI section that contains the option to look up. May be +omitted if a full ID is passed as the first argument.

@@ -5110,7 +5110,7 @@ Defaults to the main UCI configuration of the map if omitted.

Returns a two-element array containing the form option instance as -first item and the corresponding UCI section ID as second item. +the first item and the corresponding UCI section ID as the second item. Returns null if the option could not be found. @@ -5997,14 +5997,14 @@ entities decoded.
-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -6187,7 +6187,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.MultiValue.html b/jsapi/LuCI.form.MultiValue.html index 0dee51b793..e064325279 100644 --- a/jsapi/LuCI.form.MultiValue.html +++ b/jsapi/LuCI.form.MultiValue.html @@ -3928,7 +3928,7 @@ select dropdown element.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3959,7 +3959,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4179,7 +4179,7 @@ option to the section.

-

Allows to specify the display_items +

Allows specifying the display_items property of the underlying dropdown widget. If omitted, the value of the size property is used or 3 when size is also unspecified.

@@ -4229,7 +4229,7 @@ the size property is used or 3 when size
-

Allows to specify the dropdown_items +

Allows specifying the dropdown_items property of the underlying dropdown widget. If omitted, the value of the size property is used or -1 when size is also unspecified.

@@ -4428,7 +4428,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4483,7 +4483,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4943,8 +4943,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5048,7 +5048,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5628,7 +5628,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5651,12 +5651,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5765,6 +5765,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5792,8 +5797,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7453,14 +7465,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7725,7 +7737,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7944,7 +7956,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.NamedSection.html b/jsapi/LuCI.form.NamedSection.html index 97b68adb2b..3cd0896dda 100644 --- a/jsapi/LuCI.form.NamedSection.html +++ b/jsapi/LuCI.form.NamedSection.html @@ -3929,7 +3929,7 @@ specified when constructing the class instance.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added to. It is automatically passed by section().

@@ -4412,7 +4412,7 @@ this property will hold a reference to the parent option instance.

The NamedSection class overrides the generic cfgsections() implementation to return a one-element array containing the mapped -section ID as sole element. User code should not normally change this.

+section ID as a sole element. User code should not normally change this.

@@ -4866,7 +4866,7 @@ custom implementations.

-

Query underlying option widget input values.

+

Query the underlying option widget input values.

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, the widget input values of all options within this section are returned as a dictionary.

@@ -6234,7 +6234,7 @@ as an identifier to differentiate tabs.

An additional description text for the corresponding tab pane. It is -displayed as text paragraph below the tab but before the tab pane +displayed as a text paragraph below the tab but before the tab pane contents. If omitted, no description will be rendered.

@@ -6602,14 +6602,14 @@ descendant of AbstractValue.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -6792,7 +6792,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.RangeSliderValue.html b/jsapi/LuCI.form.RangeSliderValue.html index 09d647a69f..3dd61dddcc 100644 --- a/jsapi/LuCI.form.RangeSliderValue.html +++ b/jsapi/LuCI.form.RangeSliderValue.html @@ -3929,7 +3929,7 @@ values. The currently chosen value is displayed to the side of the slider.

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3960,7 +3960,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4527,7 +4527,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4582,7 +4582,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -5042,8 +5042,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5147,7 +5147,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5727,7 +5727,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5750,12 +5750,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5864,6 +5864,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5891,8 +5896,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7521,14 +7533,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7793,7 +7805,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -8012,7 +8024,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.RichListValue.html b/jsapi/LuCI.form.RichListValue.html index 23bb2cd9ec..e354a9e847 100644 --- a/jsapi/LuCI.form.RichListValue.html +++ b/jsapi/LuCI.form.RichListValue.html @@ -3929,7 +3929,7 @@ It builds upon the LuCI.form.ListValue< -

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3960,7 +3960,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4380,7 +4380,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4435,7 +4435,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4993,8 +4993,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5098,7 +5098,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5729,7 +5729,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5752,12 +5752,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5866,6 +5866,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5893,8 +5898,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7554,14 +7566,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -8073,7 +8085,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.SectionValue.html b/jsapi/LuCI.form.SectionValue.html index 665f1ae54f..6ef461dc2a 100644 --- a/jsapi/LuCI.form.SectionValue.html +++ b/jsapi/LuCI.form.SectionValue.html @@ -3927,7 +3927,7 @@ element container, allowing to nest form sections into other sections.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3958,7 +3958,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4282,7 +4282,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4337,7 +4337,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4797,8 +4797,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4902,7 +4902,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5479,7 +5479,7 @@ its cfgvalue() implementation will always return null. inherited - depends(field, value) + depends(field, value) @@ -5502,12 +5502,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5616,6 +5616,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5643,8 +5648,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7296,14 +7308,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7566,7 +7578,7 @@ its value() implementation is a no-op.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7777,7 +7789,7 @@ its write() implementation is a no-op.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TableSection.html b/jsapi/LuCI.form.TableSection.html index 320bc72675..c7bb4232b1 100644 --- a/jsapi/LuCI.form.TableSection.html +++ b/jsapi/LuCI.form.TableSection.html @@ -3932,7 +3932,7 @@ value of the addremove property.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by section().

@@ -4105,11 +4105,11 @@ by section().

Enables a per-section instance row Edit button which triggers a certain action when clicked. Set to a string, the string value is used as a String.format() pattern with the name of the underlying UCI section -as first format argument. The result is then interpreted as a URL which +as the first format argument. The result is then interpreted as a URL which LuCI will navigate to when the user clicks the edit button.

-

If set to a function, this function will be registered as click event +

If set to a function, this function will be registered as a click event handler on the rendered edit button, receiving the section instance -name as first and the DOM click event as second argument.

+name as the first and the DOM click event as the second argument.

@@ -4214,9 +4214,9 @@ style when clicked.

Override the per-section instance modal popup title caption shown when clicking the More… button in a section specifying max_cols. Set to a string, it will be used as a String.format() pattern with the name -of the underlying UCI section as first argument. Set to a function, -the function will be invoked with the section name as first argument and -its return value is used as caption, after converting it to a string. +of the underlying UCI section as the first argument. Set to a function, +the function will be invoked with the section name as the first argument, and +its return value is used as a caption after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4266,8 +4266,8 @@ UCI configuration section.

-

Set to true, the header row with the options descriptions will -not be displayed. By default, descriptions row is automatically displayed +

Set to true, the header row with the descriptions of options will +not be displayed. By default, the row of descriptions is automatically displayed when at least one option has a description.

@@ -4369,9 +4369,9 @@ implement these row style classes. The default is false.

Override the per-section instance title caption shown in the first column of the table unless anonymous is set to true. Set to a string, it will be used as a String.format() pattern with the name of -the underlying UCI section as first argument. Set to a function, the -function will be invoked with the section name as first argument and -its return value used as caption, after converting it to a string. +the underlying UCI section as the first argument. Set to a function, the +function will be invoked with the section name as the first argument and +its return value used as a caption, after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4471,10 +4471,10 @@ element.

-

Override the caption used for the section add button at the bottom of +

Override the caption used for the section add a button at the bottom of the section form element. Set to a string, it will be used as-is. Set to a function, the function will be invoked and its return value -is used as caption, after converting it to a string. If this property +is used as a caption, after converting it to a string. If this property is not set, the default is Add.

@@ -4575,7 +4575,7 @@ The default is false.

If set to true, mapped section instances are treated as anonymous UCI sections, which means that section instance elements will be -rendered without title element and that no name is required when adding +rendered without a title element and that no name is required when adding new sections. The default is false.

@@ -4723,7 +4723,7 @@ this property will hold a reference to the parent option instance.

When set to true, instead of rendering section instances one below -another, treat each instance as separate tab pane and render a tab menu +another, treat each instance as a separate tab pane and render a tab menu at the top of the form section element, allowing the user to switch among instances. The default is false.

@@ -5513,7 +5513,7 @@ custom implementations.

-

Query underlying option widget input values.

+

Query the underlying option widget input values.

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, the widget input values of all options within this section are returned as a dictionary.

@@ -6767,7 +6767,7 @@ as an identifier to differentiate tabs.

An additional description text for the corresponding tab pane. It is -displayed as text paragraph below the tab but before the tab pane +displayed as a text paragraph below the tab but before the tab pane contents. If omitted, no description will be rendered.

@@ -7120,14 +7120,14 @@ descendant of AbstractValue.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7310,7 +7310,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TextValue.html b/jsapi/LuCI.form.TextValue.html index aee5ce2852..8ff0acb9cc 100644 --- a/jsapi/LuCI.form.TextValue.html +++ b/jsapi/LuCI.form.TextValue.html @@ -3927,7 +3927,7 @@ -

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -3958,7 +3958,7 @@ option to the section.

-

The configuration section this option is added to. It is automatically passed +

The configuration section to which this option is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4130,7 +4130,7 @@ option to the section.

-

Allows to specify the cols +

Allows specifying the cols property of the underlying textarea widget.

@@ -4228,7 +4228,7 @@ to true.

-

Allows to specify the rows +

Allows specifying the rows property of the underlying textarea widget.

@@ -4277,7 +4277,7 @@ property of the underlying textarea widget.

-

Allows to specify the wrap +

Allows specifying the wrap property of the underlying textarea widget.

@@ -4425,7 +4425,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4480,7 +4480,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4940,8 +4940,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -5045,7 +5045,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5625,7 +5625,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5648,12 +5648,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5762,6 +5762,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5789,8 +5794,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7450,14 +7462,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7793,7 +7805,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TypedSection.html b/jsapi/LuCI.form.TypedSection.html index e33b7b5bac..ae29dcaf58 100644 --- a/jsapi/LuCI.form.TypedSection.html +++ b/jsapi/LuCI.form.TypedSection.html @@ -3932,7 +3932,7 @@ value of the addremove property.

-

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by section().

@@ -4102,10 +4102,10 @@ by section().

-

Override the caption used for the section add button at the bottom of +

Override the caption used for the section add a button at the bottom of the section form element. Set to a string, it will be used as-is. Set to a function, the function will be invoked and its return value -is used as caption, after converting it to a string. If this property +is used as a caption, after converting it to a string. If this property is not set, the default is Add.

@@ -4206,7 +4206,7 @@ The default is false.

If set to true, mapped section instances are treated as anonymous UCI sections, which means that section instance elements will be -rendered without title element and that no name is required when adding +rendered without a title element and that no name is required when adding new sections. The default is false.

@@ -4306,7 +4306,7 @@ The default is false.

When set to true, instead of rendering section instances one below -another, treat each instance as separate tab pane and render a tab menu +another, treat each instance as a separate tab pane and render a tab menu at the top of the form section element, allowing the user to switch among instances. The default is false.

@@ -5073,7 +5073,7 @@ custom implementations.

-

Query underlying option widget input values.

+

Query the underlying option widget input values.

This function is sensitive to the amount of arguments passed to it; if only one argument is specified, the widget input values of all options within this section are returned as a dictionary.

@@ -6441,7 +6441,7 @@ as an identifier to differentiate tabs.

An additional description text for the corresponding tab pane. It is -displayed as text paragraph below the tab but before the tab pane +displayed as a text paragraph below the tab but before the tab pane contents. If omitted, no description will be rendered.

@@ -6809,14 +6809,14 @@ descendant of AbstractValue.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -6999,7 +6999,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Value.html b/jsapi/LuCI.form.Value.html index 46937ffb87..7107bebf4e 100644 --- a/jsapi/LuCI.form.Value.html +++ b/jsapi/LuCI.form.Value.html @@ -3928,7 +3928,7 @@ -

The configuration form this section is added to. It is automatically passed +

The configuration form to which this section is added. It is automatically passed by option() or taboption() when adding the option to the section.

@@ -4327,7 +4327,7 @@ option element is marked as invalid.

-

Mark grid section option element as editable.

+

Mark the grid section option element as editable.

Options which are displayed in the table portion of a GridSection instance are rendered as readonly text by default. By setting the editable property of a child option element to true, that element @@ -4382,7 +4382,7 @@ section elements.

-

Move grid section option element into the table, the modal popup or both.

+

Move the grid section option element into the table, the modal popup or both.

If this property is null (the default), the option element is displayed in both the table preview area and the per-section instance modal popup of a grid section. When it is set to false the option @@ -4745,8 +4745,8 @@ By setting this property, a deviating configuration may be specified.

Override the UCI option name to read the value from.

-

By default, the elements name, which is passed as third argument to -the constructor, is used as UCI option name. By setting this property, +

By default, the elements name, which is passed as the third argument to +the constructor, is used as the UCI option name. By setting this property, a deviating UCI option may be specified.

The default of null means use the option element name.

@@ -4850,7 +4850,7 @@ By setting this property, a deviating section may be specified.

Specifies a custom validation function to test the user input for validity. The validation function must return true to accept the value. Any other return value type is converted to a string and -displayed to the user as validation error message.

+displayed to the user as a validation error message.

If the user entered input does not pass the validation function, the option element is marked as invalid.

@@ -5430,7 +5430,7 @@ different way.

inherited - depends(field, value) + depends(field, value) @@ -5453,12 +5453,12 @@ same form. An option element with unsatisfied dependencies will be hidden from the view and its current value omitted when saving.

Multiple constraints (that is, multiple calls to depends()) are treated as alternatives, forming a logical "or" expression.

-

By passing an object of name => value pairs as first argument, it is +

By passing an object of name => value pairs as the first argument, it is possible to depend on multiple options simultaneously, forming a logical "and" expression.

-

Option names may be given in "dot notation" which allows to reference +

Option names may be given in "dot notation" which allows referencing option elements outside the current form section. If a name without -dot is specified, it refers to an option within the same configuration +a dot is specified, it refers to an option within the same configuration section. If specified as configname.sectionid.optionname, options anywhere within the same form may be specified.

The object notation also allows for a number of special keys which are @@ -5567,6 +5567,11 @@ is ignored. The recognized tags are:

+ + + + +

The name of the option to depend on or an object describing multiple dependencies which must be satisfied (a logical "and" expression).

@@ -5594,8 +5599,15 @@ dependencies which must be satisfied (a logical "and" expression).

-

When invoked with a plain option name as first argument, this parameter -specifies the expected value. In case an object is passed as first + + optional + + + + + +

When invoked with a plain option name as the first argument, this parameter +specifies the expected value. In case an object is passed as the first argument, this parameter is ignored.

@@ -7363,14 +7375,14 @@ state of checkbox elements.

-

Format the given named property as title string.

+

Format the given named property as a title string.

This function looks up the given named property and formats its value -suitable for use as element caption or description string. It also +suitable for use as an element caption or description string. It also strips any HTML tags from the result.

If the property value is a string, it is passed to String.format() along with any additional parameters passed to titleFn().

If the property value is a function, it is invoked with any additional -titleFn() parameters as arguments and the obtained return value is +titleFn() parameters as arguments, and the obtained return value is converted to a string.

In all other cases, null is returned.

@@ -7633,7 +7645,7 @@ custom value.

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.

+or a plain text string. If omitted, the key value is used as a caption.

@@ -7852,7 +7864,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.html b/jsapi/LuCI.form.html index 9971b39aa9..8c77571107 100644 --- a/jsapi/LuCI.form.html +++ b/jsapi/LuCI.form.html @@ -4054,7 +4054,7 @@ m.render().then((node) => {
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.fs.html b/jsapi/LuCI.fs.html index d52aa3ca01..0bccfdea0e 100644 --- a/jsapi/LuCI.fs.html +++ b/jsapi/LuCI.fs.html @@ -6237,7 +6237,7 @@ the failure reason.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.headers.html b/jsapi/LuCI.headers.html index 789f38845d..99f1409e8d 100644 --- a/jsapi/LuCI.headers.html +++ b/jsapi/LuCI.headers.html @@ -4253,7 +4253,7 @@ Note: Header-Names are case-insensitive.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.html b/jsapi/LuCI.html index 9aebb84034..33b38a25db 100644 --- a/jsapi/LuCI.html +++ b/jsapi/LuCI.html @@ -4138,7 +4138,7 @@ to request the LuCI.dom class.

The env object holds environment settings used by LuCI, such -as request timeouts, base URLs etc.

+as request timeouts, base URLs, etc.

@@ -4183,10 +4183,10 @@ as request timeouts, base URLs etc.

-

Compares two values numerically and returns -1, 0 or 1 depending -on whether the first value is smaller, equal to or larger than the +

Compares two values numerically and returns -1, 0, or 1 depending +on whether the first value is smaller, equal to, or larger than the second one respectively.

-

This function is meant to be used as comparator function for +

This function is meant to be used as a comparator function for Array.sort().

@@ -5369,7 +5369,7 @@ browser window.

-

The feature to test. For detailed list of known feature flags, +

The feature to test. For a detailed list of known feature flags, see /modules/luci-base/root/usr/share/rpcd/ucode/luci.

@@ -5886,7 +5886,7 @@ standard Array.isArray() function.

- Returns true if the given value is of type object and + Returns true if the given value is of a type object and not null, else returns false. @@ -6572,7 +6572,7 @@ requests, they'll be added to the request body.

When set to false or not specified, poll requests will be made using the GET method. When set to true, POST requests will be -issued. In case of POST requests, the request body will contain +issued. In the case of POST requests, the request body will contain an argument token with the current value of LuCI.env.token by default, regardless of the parameters specified with args.

@@ -6894,7 +6894,7 @@ by default.

Captures the current stack trace and throws an error of the specified type as a new exception. Also logs the exception as -error to the debug console if it is available.

+an error to the debug console if it is available.

@@ -8353,11 +8353,11 @@ it could not be found.

Converts the given value to an array. If the given value is of -type array, it is returned as-is, values of type object are +type array, it is returned as-is, values of a type object are returned as one-element array containing the object, empty -strings and null values are returned as empty array, all other +strings and null values are returned as an empty array, all other values are converted using String(), trimmed, split on white -space and returned as array.

+space and returned as an array.

@@ -8502,7 +8502,7 @@ space and returned as array.

-

Construct a URL with path relative to the script path of the server +

Construct a URL with a path relative to the script path of the server side LuCI application (usually /cgi-bin/luci).

The resulting URL is guaranteed to contain only the characters a-z, A-Z, 0-9, _, ., %, ,, ;, and - as well @@ -8829,7 +8829,7 @@ else null.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Device.html b/jsapi/LuCI.network.Device.html index 95b72df9ed..2c22b00f97 100644 --- a/jsapi/LuCI.network.Device.html +++ b/jsapi/LuCI.network.Device.html @@ -6619,7 +6619,7 @@ when it is down or absent.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Hosts.html b/jsapi/LuCI.network.Hosts.html index fa7a5a1796..bd5b4ed701 100644 --- a/jsapi/LuCI.network.Hosts.html +++ b/jsapi/LuCI.network.Hosts.html @@ -5179,7 +5179,7 @@ is used as hint.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Protocol.html b/jsapi/LuCI.network.Protocol.html index a2298d1fca..fd31b80230 100644 --- a/jsapi/LuCI.network.Protocol.html +++ b/jsapi/LuCI.network.Protocol.html @@ -3845,7 +3845,7 @@ Protocol -

The Network.Protocol class serves as base for protocol specific +

The Network.Protocol class serves as the base for protocol-specific subclasses which describe logical UCI networks defined by config interface sections in /etc/config/network.

@@ -5295,7 +5295,7 @@ until the lease expires.

- Returns the amount of seconds until the lease expires or -1 + Returns the number of seconds until the lease expires or -1 if it isn't applicable to the associated protocol. @@ -7712,7 +7712,7 @@ or false when the logical interface is no bridge. - Returns a promise resolving if new interface is creatable, else + Returns a promise resolving if a new interface is creatable, else rejects with an error message string. @@ -7747,8 +7747,8 @@ rejects with an error message string.

Checks whether this logical interface is dynamic.

-

A dynamic interface is an interface which has been created at runtime, -e.g. as sub-interface of another interface, but which is not backed by +

A dynamic interface is an interface that has been created at runtime. +E.g. as a sub-interface of another interface, but which is not backed by any user configuration. Such dynamic interfaces cannot be edited but only brought down or restarted.

@@ -8268,7 +8268,7 @@ returns true.

Checks whether this protocol is "virtual".

A "virtual" protocol is a protocol which spawns its own interfaces on demand instead of using existing physical interfaces.

-

Examples for virtual protocols are 6in4 which gre spawn tunnel +

Examples for virtual protocols are 6in4 which gre spawn a tunnel 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.

@@ -8515,7 +8515,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiDevice.html b/jsapi/LuCI.network.WifiDevice.html index dbe1c6218a..5c22cf02ce 100644 --- a/jsapi/LuCI.network.WifiDevice.html +++ b/jsapi/LuCI.network.WifiDevice.html @@ -4821,7 +4821,7 @@ known mode values are: Returns the UCI section name (e.g. radio0) of the corresponding -radio configuration which also serves as unique logical identifier +radio configuration, which also serves as a unique logical identifier for the wireless phy. @@ -5556,7 +5556,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiNetwork.html b/jsapi/LuCI.network.WifiNetwork.html index a810fed3c6..87ef90c74b 100644 --- a/jsapi/LuCI.network.WifiNetwork.html +++ b/jsapi/LuCI.network.WifiNetwork.html @@ -4131,7 +4131,7 @@ with. Default is 1 which corresponds to Unspecified reasonSpecifies the amount of milliseconds to ban the client from +

Specifies the number of milliseconds to ban the client from reconnecting. By default, no ban time is set which allows the client to re-associate / reauthenticate immediately.

@@ -5005,7 +5005,7 @@ with this network.
-

Query the current average bit-rate of all peers associated to this +

Query the current average bit-rate of all peers associated with this wireless network.

@@ -5076,7 +5076,7 @@ wireless network.

- Returns the average bit rate among all peers associated to the network + Returns the average bit rate among all peers associated with the network as reported by ubus runtime information or null if the information is not available. @@ -8240,7 +8240,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiVlan.html b/jsapi/LuCI.network.WifiVlan.html index 750b16fc39..06ae72d6e6 100644 --- a/jsapi/LuCI.network.WifiVlan.html +++ b/jsapi/LuCI.network.WifiVlan.html @@ -4458,7 +4458,7 @@ if it is different than the vlan id
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.html b/jsapi/LuCI.network.html index 55ba44578a..20f90dff6a 100644 --- a/jsapi/LuCI.network.html +++ b/jsapi/LuCI.network.html @@ -5293,7 +5293,7 @@ class instance describing the found hosts.

- Returns a Hosts instance describing host known on the system. + Returns a Hosts instance describing a host known on the system. @@ -6144,7 +6144,7 @@ the layout.

Get IPv6 wan networks.

This function looks up all networks having a default ::/0 route -and returns them as array.

+and returns them as an array.

@@ -6247,7 +6247,7 @@ instances describing the found IPv6 default route interfaces.

Get IPv4 wan networks.

This function looks up all networks having a default 0.0.0.0/0 route -and returns them as array.

+and returns them as an array.

@@ -6970,7 +6970,7 @@ and which are unsuitable for use in network configuration.

- Returns true if the given name is in the ignore pattern list, + Returns true if the given name is in the ignore-pattern list, else returns false. @@ -7471,7 +7471,7 @@ error code.

-

The message to use as translation for the given protocol error code.

+

The message to use as a translation for the given protocol error code.

@@ -7691,7 +7691,7 @@ such as 6in4-wan or tun0.

Registers a new Protocol subclass with the given methods and returns the resulting subclass value.

-

This functions internally calls +

This function internally calls Class.extend() on the Network.Protocol base class.

@@ -8587,7 +8587,7 @@ supported by the driver.

-

The amount of milliseconds the peer has been inactive, e.g. due +

The number of milliseconds the peer has been inactive, e.g. due to power-saving.

@@ -8617,7 +8617,7 @@ to power-saving.

-

The amount of milliseconds the peer is associated to this network.

+

The number of milliseconds the peer is associated to this network.

@@ -9519,7 +9519,7 @@ HT or VHT rates.

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 +

Note: this option exists for backwards compatibility only, and its use is discouraged. The mhz field should be used instead to determine the channel width.

@@ -9742,8 +9742,8 @@ Only applicable to HE rates.

-

Specifies whether the guard interval used for the transmission. -Only applicable to EHT rates.

+

Specifies whether the guard interval is used for the transmission. +Only applicable to EHT rates.

@@ -10086,7 +10086,7 @@ conjunction with quality to calculate a quality percentage.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/LuCI.poll.html b/jsapi/LuCI.poll.html index e1eb2b78d5..a238ef67d0 100644 --- a/jsapi/LuCI.poll.html +++ b/jsapi/LuCI.poll.html @@ -3846,7 +3846,7 @@

The Poll class allows registering and unregistering poll actions, -as well as starting, stopping and querying the state of the polling +as well as starting, stopping, and querying the state of the polling loop.

@@ -4636,7 +4636,7 @@ run to begin with.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.request.html b/jsapi/LuCI.request.html index b4d9958f00..0cfff21498 100644 --- a/jsapi/LuCI.request.html +++ b/jsapi/LuCI.request.html @@ -5571,7 +5571,7 @@ instances as sole argument during the HTTP request transfer.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.request.poll.html b/jsapi/LuCI.request.poll.html index d0cfcb813c..7dfbabd3a3 100644 --- a/jsapi/LuCI.request.poll.html +++ b/jsapi/LuCI.request.poll.html @@ -4755,7 +4755,7 @@ else null.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.response.html b/jsapi/LuCI.response.html index 467dd9a436..4b4653dda8 100644 --- a/jsapi/LuCI.response.html +++ b/jsapi/LuCI.response.html @@ -4713,7 +4713,7 @@ using String() and treated as response text.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.rpc.html b/jsapi/LuCI.rpc.html index 237eb78b41..b711cecf0a 100644 --- a/jsapi/LuCI.rpc.html +++ b/jsapi/LuCI.rpc.html @@ -6044,7 +6044,7 @@ to the expect and filter declarations.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.session.html b/jsapi/LuCI.session.html index 6d7bc2fbe7..e37f11b65e 100644 --- a/jsapi/LuCI.session.html +++ b/jsapi/LuCI.session.html @@ -4483,7 +4483,7 @@ being put in the session store.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.uci.html b/jsapi/LuCI.uci.html index aab1dfa48a..bba5303854 100644 --- a/jsapi/LuCI.uci.html +++ b/jsapi/LuCI.uci.html @@ -8020,7 +8020,7 @@ associated name as arguments.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.AbstractElement.html b/jsapi/LuCI.ui.AbstractElement.html index 9e8e9f3c62..efed083252 100644 --- a/jsapi/LuCI.ui.AbstractElement.html +++ b/jsapi/LuCI.ui.AbstractElement.html @@ -5587,7 +5587,7 @@ and are displayed in a slightly faded style.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Checkbox.html b/jsapi/LuCI.ui.Checkbox.html index 118adf4863..e3ca0fca8b 100644 --- a/jsapi/LuCI.ui.Checkbox.html +++ b/jsapi/LuCI.ui.Checkbox.html @@ -5701,7 +5701,7 @@ it is required for HTML based form submissions.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.ComboButton.html b/jsapi/LuCI.ui.ComboButton.html index 283600f76b..dea612b533 100644 --- a/jsapi/LuCI.ui.ComboButton.html +++ b/jsapi/LuCI.ui.ComboButton.html @@ -5731,7 +5731,7 @@ choice value as second argument.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Combobox.html b/jsapi/LuCI.ui.Combobox.html index d3a7edbea8..d0b115704d 100644 --- a/jsapi/LuCI.ui.Combobox.html +++ b/jsapi/LuCI.ui.Combobox.html @@ -5634,7 +5634,7 @@ forcibly set to true.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Dropdown.html b/jsapi/LuCI.ui.Dropdown.html index b688cabb47..16de26f80d 100644 --- a/jsapi/LuCI.ui.Dropdown.html +++ b/jsapi/LuCI.ui.Dropdown.html @@ -6432,7 +6432,7 @@ expression. Only applicable when create is true.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/LuCI.ui.DynamicList.html b/jsapi/LuCI.ui.DynamicList.html index a0398680cd..72a876200c 100644 --- a/jsapi/LuCI.ui.DynamicList.html +++ b/jsapi/LuCI.ui.DynamicList.html @@ -5809,7 +5809,7 @@ it to remain unselected.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.FileUpload.html b/jsapi/LuCI.ui.FileUpload.html index fe8b2c01fb..48c5e22a01 100644 --- a/jsapi/LuCI.ui.FileUpload.html +++ b/jsapi/LuCI.ui.FileUpload.html @@ -5732,7 +5732,7 @@ ACL setup for the current session.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Hiddenfield.html b/jsapi/LuCI.ui.Hiddenfield.html index 9c76f61fc4..f71d5d6ea9 100644 --- a/jsapi/LuCI.ui.Hiddenfield.html +++ b/jsapi/LuCI.ui.Hiddenfield.html @@ -5412,7 +5412,7 @@ trigger validation runs, e.g. when programmatically altering values.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.RangeSlider.html b/jsapi/LuCI.ui.RangeSlider.html index ad9c93df75..1fcfb67d4a 100644 --- a/jsapi/LuCI.ui.RangeSlider.html +++ b/jsapi/LuCI.ui.RangeSlider.html @@ -5751,7 +5751,7 @@ arbitrary precision floating point numbers.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Select.html b/jsapi/LuCI.ui.Select.html index d684034535..f67e5cecf3 100644 --- a/jsapi/LuCI.ui.Select.html +++ b/jsapi/LuCI.ui.Select.html @@ -5764,7 +5764,7 @@ selected yet. Only applicable to the select widget type.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Textarea.html b/jsapi/LuCI.ui.Textarea.html index b288c27e7a..615a782e8e 100644 --- a/jsapi/LuCI.ui.Textarea.html +++ b/jsapi/LuCI.ui.Textarea.html @@ -5710,7 +5710,7 @@ contents.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Textfield.html b/jsapi/LuCI.ui.Textfield.html index db8cf53bfa..0a311bb03a 100644 --- a/jsapi/LuCI.ui.Textfield.html +++ b/jsapi/LuCI.ui.Textfield.html @@ -5638,7 +5638,7 @@ corresponding <input> element is empty.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.changes.html b/jsapi/LuCI.ui.changes.html index 1406830ac3..1f5a6825e0 100644 --- a/jsapi/LuCI.ui.changes.html +++ b/jsapi/LuCI.ui.changes.html @@ -4490,7 +4490,7 @@ is removed.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.html b/jsapi/LuCI.ui.html index b93db884ca..2ba69628ea 100644 --- a/jsapi/LuCI.ui.html +++ b/jsapi/LuCI.ui.html @@ -6852,7 +6852,7 @@ cancelled by the user.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.menu.html b/jsapi/LuCI.ui.menu.html index 3e5d91c4e0..360b71d36e 100644 --- a/jsapi/LuCI.ui.menu.html +++ b/jsapi/LuCI.ui.menu.html @@ -4537,7 +4537,7 @@ internal root node if omitted.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.tabs.html b/jsapi/LuCI.ui.tabs.html index 57034e9fb2..48655586d1 100644 --- a/jsapi/LuCI.ui.tabs.html +++ b/jsapi/LuCI.ui.tabs.html @@ -4237,7 +4237,7 @@ DOM node.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.view.html b/jsapi/LuCI.view.html index 47c0805f4a..0dbfc79581 100644 --- a/jsapi/LuCI.view.html +++ b/jsapi/LuCI.view.html @@ -4572,7 +4572,7 @@ is re-enabled.

The invocation of this function is wrapped by Promise.resolve() so it may return Promises if needed.

The return value of the function (or the resolved values -of the promise returned by it) will be passed as first +of the promise returned by it) will be passed as the first argument to render().

This function is supposed to be overwritten by subclasses, the default implementation does nothing.

@@ -4841,7 +4841,7 @@ to a Node value.
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.xhr.html b/jsapi/LuCI.xhr.html index c6315d6c2c..59e4a97fa0 100644 --- a/jsapi/LuCI.xhr.html +++ b/jsapi/LuCI.xhr.html @@ -3846,7 +3846,7 @@

The LuCI.xhr class is a legacy compatibility shim for the -functionality formerly provided by xhr.js. It is registered as global +functionality formerly provided by xhr.js. It is registered as a global window.XHR symbol for compatibility with legacy code.

New code should use LuCI.request instead to implement HTTP request handling.

@@ -4805,7 +4805,7 @@ when invoked.

- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:19 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/form.js.html b/jsapi/form.js.html index bc6c718705..f551edeb69 100644 --- a/jsapi/form.js.html +++ b/jsapi/form.js.html @@ -4029,7 +4029,7 @@ const CBIJSONConfig = baseclass.extend({ * @hideconstructor * @classdesc * - * The `AbstractElement` class serves as abstract base for the different form + * The `AbstractElement` class serves as an abstract base for the different form * elements implemented by `LuCI.form`. It provides the common logic for * loading and rendering values, for nesting elements and for defining common * properties. @@ -4140,17 +4140,17 @@ const CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement }, /** - * Format the given named property as title string. + * Format the given named property as a title string. * * This function looks up the given named property and formats its value - * suitable for use as element caption or description string. It also + * suitable for use as an element caption or description string. It also * strips any HTML tags from the result. * * If the property value is a string, it is passed to `String.format()` * along with any additional parameters passed to `titleFn()`. * * If the property value is a function, it is invoked with any additional - * `titleFn()` parameters as arguments and the obtained return value is + * `titleFn()` parameters as arguments, and the obtained return value is * converted to a string. * * In all other cases, `null` is returned. @@ -4241,7 +4241,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * This function is sensitive to the amount of arguments passed to it; * if only one argument is specified, it is used as selector-expression * as-is. When two arguments are passed, the first argument is treated - * as attribute name, the second one as attribute value to match. + * as an attribute name, the second one as an attribute value to match. * * As an example, `map.findElements('input')` would find all `<input>` * nodes while `map.findElements('type', 'text')` would find any DOM node @@ -4284,7 +4284,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * This function is sensitive to the amount of arguments passed to it; * if only one argument is specified, it is used as selector-expression * as-is. When two arguments are passed, the first argument is treated - * as attribute name, the second one as attribute value to match. + * as an attribute name, the second one as an attribute value to match. * * As an example, `map.findElement('input')` would find the first `<input>` * node while `map.findElement('type', 'text')` would find the first DOM @@ -4315,7 +4315,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * Tie another UCI configuration to the map. * * By default, a map instance will only load the UCI configuration file - * specified in the constructor but sometimes access to values from + * specified in the constructor, but sometimes access to values from * further configuration files is required. This function allows for such * use cases by registering further UCI configuration files which are * needed by the map. @@ -4375,7 +4375,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * @returns {Promise<void>} * Returns a promise resolving once the entire form completed loading all * data. The promise may reject with an error if any configuration failed - * to load or if any of the child elements' load functions rejected with + * to load or if any of the child elements' load functions reject with * an error. */ load() { @@ -4535,8 +4535,8 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * 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. + * The ID of the UCI section that contains the option to look up. May be + * omitted if a full ID is passed as the first argument. * * @param {string} [config_name] * The name of the UCI configuration the option instance belongs to. @@ -4544,7 +4544,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @returns {Array<LuCI.form.AbstractValue,string>|null} * Returns a two-element array containing the form option instance as - * first item and the corresponding UCI section ID as second item. + * the first item and the corresponding UCI section ID as the second item. * Returns `null` if the option could not be found. */ lookupOption(name, section_id, config_name) { @@ -4628,10 +4628,10 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * A `JSONMap` class functions similar to [LuCI.form.Map]{@link LuCI.form.Map} * but uses a multidimensional JavaScript object instead of UCI configuration - * as data source. + * as a data source. * * @param {Object<string, Object<string, *>|Array<Object<string, *>>>} data - * The JavaScript object to use as data source. Internally, the object is + * The JavaScript object to use as a data source. Internally, the object is * converted into an UCI-like format. Its top-level keys are treated like UCI * section types while the object or array-of-object values are treated as * section contents. @@ -4642,7 +4642,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * corresponding headline element will not be rendered. * * @param {string} [description] - * The description text of the form which is usually rendered as text + * The description text of the form which is usually rendered as a text * paragraph below the form title and before the actual form contents. * If omitted, the corresponding paragraph element will not be rendered. */ @@ -4809,7 +4809,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * @param {string} [description] * An additional description text for the corresponding tab pane. It is - * displayed as text paragraph below the tab but before the tab pane + * displayed as a text paragraph below the tab but before the tab pane * contents. If omitted, no description will be rendered. * * @throws {Error} @@ -4940,7 +4940,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra }, /** - * Query underlying option widget input values. + * Query the underlying option widget input values. * * This function is sensitive to the amount of arguments passed to it; * if only one argument is specified, the widget input values of all @@ -5097,9 +5097,9 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra for (let i = 0, sid = sids[0]; (sid = sids[i]) != null; i++) { for (let j = 0, o = this.children[0]; (o = this.children[j]) != null; j++) { let isActive = o.isActive(sid); - const isSatisified = o.checkDepends(sid); + const isSatisfied = o.checkDepends(sid); - if (isActive != isSatisified) { + if (isActive != isSatisfied) { o.setActive(sid, !isActive); isActive = !isActive; changed = true; @@ -5177,7 +5177,7 @@ function isContained(x, y) { * @hideconstructor * @classdesc * - * The `AbstractValue` class serves as abstract base for the different form + * The `AbstractValue` class serves as an abstract base for the different form * option styles implemented by `LuCI.form`. It provides the common logic for * handling option input values, for dependencies among options and for * validation constraints that should be applied to entered values. @@ -5257,7 +5257,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * Specifies a custom validation function to test the user input for * validity. The validation function must return `true` to accept the * value. Any other return value type is converted to a string and - * displayed to the user as validation error message. + * displayed to the user as a validation error message. * * If the user entered input does not pass the validation function, the * option element is marked as invalid. @@ -5296,8 +5296,8 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract /** * Override the UCI option name to read the value from. * - * By default, the elements name, which is passed as third argument to - * the constructor, is used as UCI option name. By setting this property, + * By default, the elements name, which is passed as the third argument to + * the constructor, is used as the UCI option name. By setting this property, * a deviating UCI option may be specified. * * The default of null means use the option element name. @@ -5308,7 +5308,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract */ /** - * Mark grid section option element as editable. + * Mark the grid section option element as editable. * * Options which are displayed in the table portion of a `GridSection` * instance are rendered as readonly text by default. By setting the @@ -5325,7 +5325,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract */ /** - * Move grid section option element into the table, the modal popup or both. + * Move the grid section option element into the table, the modal popup or both. * * If this property is `null` (the default), the option element is * displayed in both the table preview area and the per-section instance @@ -5396,13 +5396,13 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * Multiple constraints (that is, multiple calls to `depends()`) are * treated as alternatives, forming a logical "or" expression. * - * By passing an object of name => value pairs as first argument, it is + * By passing an object of name => value pairs as the first argument, it is * possible to depend on multiple options simultaneously, forming * a logical "and" expression. * - * Option names may be given in "dot notation" which allows to reference + * Option names may be given in "dot notation" which allows referencing * option elements outside the current form section. If a name without - * dot is specified, it refers to an option within the same configuration + * a 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. * @@ -5471,9 +5471,9 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * The name of the option to depend on or an object describing multiple * dependencies which must be satisfied (a logical "and" expression). * - * @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 + * @param {string|RegExp} [value] + * When invoked with a plain option name as the first argument, this parameter + * specifies the expected value. In case an object is passed as the first * argument, this parameter is ignored. */ depends(field, value) { @@ -5555,7 +5555,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract const config_name = this.uciconfig ?? this.section.uciconfig ?? this.map.config; const cfgvalue = L.toArray(this.cfgvalue(section_id))[0]; let default_defval = null; - let satisified_defval = null; + let satisfied_defval = null; for (const value in this.defaults) { if (!this.defaults[value] || this.defaults[value].length == 0) { @@ -5563,19 +5563,19 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract continue; } else if (this.map.isDependencySatisfied(this.defaults[value], config_name, section_id)) { - satisified_defval = value; + satisfied_defval = value; break; } } - if (satisified_defval == null) - satisified_defval = default_defval; + if (satisfied_defval == null) + satisfied_defval = default_defval; const node = this.map.findElement('id', this.cbid(section_id)); - if (node && node.getAttribute('data-changed') != 'true' && satisified_defval != null && cfgvalue == null) - dom.callClassMethod(node, 'setValue', satisified_defval); + if (node && node.getAttribute('data-changed') != 'true' && satisfied_defval != null && cfgvalue == null) + dom.callClassMethod(node, 'setValue', satisfied_defval); - this.default = satisified_defval; + this.default = satisfied_defval; }, /** @@ -5753,8 +5753,8 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * @returns {*} * The method shall return `true` to accept the given value. Any other - * return value is treated as failure, converted to a string and displayed - * as error message to the user. + * return value is treated as a failure, converted to a string and displayed + * as an error message to the user. */ validate(section_id, value) { return true; @@ -5970,7 +5970,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * value of the `addremove` property. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [section()]{@link LuCI.form.Map#section}. * * @param {string} section_type @@ -5998,7 +5998,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect /** * If set to `true`, mapped section instances are treated as anonymous * UCI sections, which means that section instance elements will be - * rendered without title element and that no name is required when adding + * rendered without a title element and that no name is required when adding * new sections. The default is `false`. * * @name LuCI.form.TypedSection.prototype#anonymous @@ -6008,7 +6008,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect /** * When set to `true`, instead of rendering section instances one below - * another, treat each instance as separate tab pane and render a tab menu + * another, treat each instance as a separate tab pane and render a tab menu * at the top of the form section element, allowing the user to switch * among instances. The default is `false`. * @@ -6018,10 +6018,10 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect */ /** - * Override the caption used for the section add button at the bottom of + * Override the caption used for the section add a button at the bottom of * the section form element. Set to a string, it will be used as-is. * Set to a function, the function will be invoked and its return value - * is used as caption, after converting it to a string. If this property + * is used as a caption, after converting it to a string. If this property * is not set, the default is `Add`. * * @name LuCI.form.TypedSection.prototype#addbtntitle @@ -6209,7 +6209,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect * value of the `addremove` property. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [section()]{@link LuCI.form.Map#section}. * * @param {string} section_type @@ -6228,9 +6228,9 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * Override the per-section instance title caption shown in the first * column of the table unless `anonymous` is set to true. Set to a * string, it will be used as a `String.format()` pattern with the name of - * the underlying UCI section as first argument. Set to a function, the - * function will be invoked with the section name as first argument and - * its return value used as caption, after converting it to a string. + * the underlying UCI section as the first argument. Set to a function, the + * function will be invoked with the section name as the first argument and + * its return value used as a caption, after converting it to a string. * If this property is not set, the default is the name of the underlying * UCI configuration section. * @@ -6243,9 +6243,9 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * Override the per-section instance modal popup title caption shown when * clicking the `More…` button in a section specifying `max_cols`. Set * to a string, it will be used as a `String.format()` pattern with the name - * of the underlying UCI section as first argument. Set to a function, - * the function will be invoked with the section name as first argument and - * its return value is used as caption, after converting it to a string. + * of the underlying UCI section as the first argument. Set to a function, + * the function will be invoked with the section name as the first argument, and + * its return value is used as a caption after converting it to a string. * If this property is not set, the default is the name of the underlying * UCI configuration section. * @@ -6292,12 +6292,12 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * Enables a per-section instance row `Edit` button which triggers a certain * action when clicked. Set to a string, the string value is used * as a `String.format()` pattern with the name of the underlying UCI section - * as first format argument. The result is then interpreted as a URL which + * as the first format argument. The result is then interpreted as a URL which * LuCI will navigate to when the user clicks the edit button. * - * If set to a function, this function will be registered as click event + * If set to a function, this function will be registered as a click event * handler on the rendered edit button, receiving the section instance - * name as first and the DOM click event as second argument. + * name as the first and the DOM click event as the second argument. * * @name LuCI.form.TableSection.prototype#extedit * @type string|function @@ -6315,8 +6315,8 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection */ /** - * Set to `true`, the header row with the options descriptions will - * not be displayed. By default, descriptions row is automatically displayed + * Set to `true`, the header row with the descriptions of options will + * not be displayed. By default, the row of descriptions is automatically displayed * when at least one option has a description. * * @name LuCI.form.TableSection.prototype#nodescriptions @@ -7159,7 +7159,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * Layout wise, a grid section looks mostly identical to table sections. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [section()]{@link LuCI.form.Map#section}. * * @param {string} section_type @@ -7194,7 +7194,7 @@ const CBIGridSection = CBITableSection.extend(/** @lends LuCI.form.GridSection.p * * @param {string} [description] * An additional description text for the corresponding tab pane. It is - * displayed as text paragraph below the tab but before the tab pane + * displayed as a text paragraph below the tab but before the tab pane * contents. If omitted, no description will be rendered. * * @throws {Error} @@ -7320,7 +7320,7 @@ const CBIGridSection = CBITableSection.extend(/** @lends LuCI.form.GridSection.p * `TypedSection` which allows exactly one section node. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added to. It is automatically passed * by [section()]{@link LuCI.form.Map#section}. * * @param {string} section_id @@ -7367,7 +7367,7 @@ const CBINamedSection = CBIAbstractSection.extend(/** @lends LuCI.form.NamedSect /** * The `NamedSection` class overrides the generic `cfgsections()` * implementation to return a one-element array containing the mapped - * section ID as sole element. User code should not normally change this. + * section ID as a sole element. User code should not normally change this. * * @returns {string[]} * Returns a one-element array containing the mapped section ID. @@ -7470,7 +7470,7 @@ const CBINamedSection = CBIAbstractSection.extend(/** @lends LuCI.form.NamedSect * {@link LuCI.ui.Combobox} class as underlying widget. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -7521,7 +7521,7 @@ const CBIValue = CBIAbstractValue.extend(/** @lends LuCI.form.Value.prototype */ * * @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. + * or a plain text string. If omitted, the `key` value is used as a caption. */ value(key, val) { this.keylist ??= []; @@ -7683,13 +7683,13 @@ const CBIValue = CBIAbstractValue.extend(/** @lends LuCI.form.Value.prototype */ * predefined choices. It builds upon the {@link LuCI.ui.DynamicList} widget. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -7750,7 +7750,7 @@ const CBIDynamicList = CBIValue.extend(/** @lends LuCI.form.DynamicList.prototyp * It builds upon the {@link LuCI.ui.Select} widget. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added to. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -7843,13 +7843,13 @@ const CBIListValue = CBIValue.extend(/** @lends LuCI.form.ListValue.prototype */ * It builds upon the {@link LuCI.form.ListValue} widget. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -7972,13 +7972,13 @@ const CBIRichListValue = CBIListValue.extend(/** @lends LuCI.form.ListValue.prot * values. The currently chosen value is displayed to the side of the slider. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8098,13 +8098,13 @@ const CBIRangeSliderValue = CBIValue.extend(/** @lends LuCI.form.RangeSliderValu * implement a simple checkbox element. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8256,13 +8256,13 @@ const CBIFlagValue = CBIValue.extend(/** @lends LuCI.form.FlagValue.prototype */ * select dropdown element. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8293,7 +8293,7 @@ const CBIMultiValue = CBIDynamicList.extend(/** @lends LuCI.form.MultiValue.prot */ /** - * Allows to specify the [display_items]{@link LuCI.ui.Dropdown.InitOptions} + * Allows specifying the [display_items]{@link LuCI.ui.Dropdown.InitOptions} * property of the underlying dropdown widget. If omitted, the value of * the `size` property is used or `3` when `size` is also unspecified. * @@ -8303,7 +8303,7 @@ const CBIMultiValue = CBIDynamicList.extend(/** @lends LuCI.form.MultiValue.prot */ /** - * Allows to specify the [dropdown_items]{@link LuCI.ui.Dropdown.InitOptions} + * Allows specifying the [dropdown_items]{@link LuCI.ui.Dropdown.InitOptions} * property of the underlying dropdown widget. If omitted, the value of * the `size` property is used or `-1` when `size` is also unspecified. * @@ -8345,13 +8345,13 @@ const CBIMultiValue = CBIDynamicList.extend(/** @lends LuCI.form.MultiValue.prot * {@link LuCI.ui.Textarea}. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8381,7 +8381,7 @@ const CBITextValue = CBIValue.extend(/** @lends LuCI.form.TextValue.prototype */ */ /** - * Allows to specify the [cols]{@link LuCI.ui.Textarea.InitOptions} + * Allows specifying the [cols]{@link LuCI.ui.Textarea.InitOptions} * property of the underlying textarea widget. * * @name LuCI.form.TextValue.prototype#cols @@ -8390,7 +8390,7 @@ const CBITextValue = CBIValue.extend(/** @lends LuCI.form.TextValue.prototype */ */ /** - * Allows to specify the [rows]{@link LuCI.ui.Textarea.InitOptions} + * Allows specifying the [rows]{@link LuCI.ui.Textarea.InitOptions} * property of the underlying textarea widget. * * @name LuCI.form.TextValue.prototype#rows @@ -8399,7 +8399,7 @@ const CBITextValue = CBIValue.extend(/** @lends LuCI.form.TextValue.prototype */ */ /** - * Allows to specify the [wrap]{@link LuCI.ui.Textarea.InitOptions} + * Allows specifying the [wrap]{@link LuCI.ui.Textarea.InitOptions} * property of the underlying textarea widget. * * @name LuCI.form.TextValue.prototype#wrap @@ -8439,13 +8439,13 @@ const CBITextValue = CBIValue.extend(/** @lends LuCI.form.TextValue.prototype */ * renders the underlying UCI option or default value as readonly text. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8533,7 +8533,7 @@ const CBIDummyValue = CBIValue.extend(/** @lends LuCI.form.DummyValue.prototype * renders the underlying UCI option or default value as readonly text. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added to. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8559,13 +8559,13 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp /** * Override the rendered button caption. * - * By default, the option title - which is passed as fourth argument to the - * constructor - is used as caption for the button element. When setting + * By default, the option title - which is passed as the fourth argument to the + * constructor - is used as a caption for the button element. When setting * this property to a string, it is used as a `String.format()` pattern with - * the underlying UCI section name passed as first format argument. When - * set to a function, it is invoked passing the section ID as sole argument + * the underlying UCI section name passed as the first format argument. When + * set to a function, it is invoked passing the section ID as the sole argument, * and the resulting return value is converted to a string before being - * used as button caption. + * used as a button caption. * * The default of `null` means the option title is used as caption. * @@ -8599,8 +8599,8 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp * * When this property is set to a function, it is invoked instead of * performing the default actions. The handler function will receive the - * DOM click element as first and the underlying configuration section ID - * as second argument. + * DOM click element as the first and the underlying configuration section ID + * as the second argument. * * @name LuCI.form.ButtonValue.prototype#onclick * @type function @@ -8656,7 +8656,7 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp * distorted form layout when rendering the option element. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added to. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8700,7 +8700,7 @@ const CBIHiddenValue = CBIValue.extend(/** @lends LuCI.form.HiddenValue.prototyp * offers the ability to browse, upload and select remote files. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added to. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -8775,7 +8775,7 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype /** * Toggle remote file delete functionality. * - * When set to `true`, the underlying widget provides a buttons which let + * When set to `true`, the underlying widget provides buttons which let * the user delete files from remote directories. Note that this is merely * a cosmetic feature: remote delete permissions are controlled by the * session ACL rules. @@ -8840,13 +8840,13 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype * element container, allowing to nest form sections into other sections. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form - * The configuration form this section is added to. It is automatically passed + * The configuration form to which this section is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. * * @param {LuCI.form.AbstractSection} section - * The configuration section this option is added to. It is automatically passed + * The configuration section to which this option is added. It is automatically passed * by [option()]{@link LuCI.form.AbstractSection#option} or * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the * option to the section. @@ -9033,7 +9033,7 @@ return baseclass.extend(/** @lends LuCI.form.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/fs.js.html b/jsapi/fs.js.html index 2f6392294e..2db3fc86ce 100644 --- a/jsapi/fs.js.html +++ b/jsapi/fs.js.html @@ -4279,7 +4279,7 @@ return FileSystem;
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/global.html b/jsapi/global.html index 3bbb13ecb5..c0b7c086a3 100644 --- a/jsapi/global.html +++ b/jsapi/global.html @@ -4117,7 +4117,7 @@
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/index.html b/jsapi/index.html index 809256fd48..08cb3d542c 100644 --- a/jsapi/index.html +++ b/jsapi/index.html @@ -3866,7 +3866,7 @@ is the central JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/luci.js.html b/jsapi/luci.js.html index 1ff3de2443..56eeb3d10c 100644 --- a/jsapi/luci.js.html +++ b/jsapi/luci.js.html @@ -3868,7 +3868,7 @@ * * `LuCI.baseclass` is the abstract base class all LuCI classes inherit from. * - * It provides simple means to create subclasses of given classes and + * It provides a simple means to create subclasses of given classes and * implements prototypal inheritance. */ const superContext = {}; @@ -4031,7 +4031,7 @@ * Walks up the parent class chain and looks for a class member * called `key` in any of the parent classes this class inherits * from. Returns the member value of the superclass or calls the - * member as function and returns its return value when the + * member as a function and returns its return value when the * optional `callArgs` array is given. * * This function has two signatures and is sensitive to the @@ -4052,7 +4052,7 @@ * @param {Array<*>} [callArgs] * An optional array of function call parameters to use. When * this parameter is specified, the found member value is called - * as function using the values of this array as arguments. + * as a function using the values of this array as arguments. * * @throws {ReferenceError} * Throws a `ReferenceError` when `callArgs` are specified and @@ -4839,7 +4839,7 @@ * @classdesc * * The `Poll` class allows registering and unregistering poll actions, - * as well as starting, stopping and querying the state of the polling + * as well as starting, stopping, and querying the state of the polling * loop. */ const Poll = Class.singleton(/** @lends LuCI.poll.prototype */ { @@ -5004,7 +5004,7 @@ * @hideconstructor * @classdesc * - * The `dom` class provides convenience method for creating and + * The `dom` class provides a convenience method for creating and * manipulating DOM elements. * * To import the class in views, use `'require dom'`, to import it in @@ -5125,17 +5125,17 @@ * 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, + * will be either appended as a child element or text node, * depending on whether the item is a DOM `Node` instance or * some other non-`null` value. Non-`Node`, non-`null` values * will be converted to strings first before being passed as * argument to `createTextNode()`. * * When `children` is a function, it will be invoked with - * the passed `node` argument as sole parameter and the `append` + * the passed `node` argument as the sole parameter and the `append` * function will be invoked again, with the given `node` argument * as first and the return value of the `children` function as - * second parameter. + * the second parameter. * * When `children` is a DOM `Node` instance, it will be * appended to the given `node`. @@ -5192,17 +5192,17 @@ * 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, + * will be either appended as a child element or text node, * depending on whether the item is a DOM `Node` instance or * some other non-`null` value. Non-`Node`, non-`null` values * will be converted to strings first before being passed as * argument to `createTextNode()`. * * When `children` is a function, it will be invoked with - * the passed `node` argument as sole parameter and the `append` + * the passed `node` argument as the sole parameter and the `append` * function will be invoked again, with the given `node` argument * as first and the return value of the `children` function as - * second parameter. + * the second parameter. * * When `children` is a DOM `Node` instance, it will be * appended to the given `node`. @@ -5252,15 +5252,15 @@ * If the `key` parameter is an `Object`, this parameter will be * ignored. * - * When `val` is of type function, it will be registered as event + * When `val` is of type function, it will be registered as an event * handler on the given `node` with the `key` parameter being the * event name. * * When `val` is of type object, it will be serialized as JSON and - * added as attribute to the given `node`, using the given `key` - * as attribute name. + * added as an attribute to the given `node`, using the given `key` + * as an attribute name. * - * When `val` is of any other type, it will be added as attribute + * When `val` is of any other type, it will be added as an attribute * to the given `node` as-is, with the underlying `setAttribute()` * call implicitly turning it into a string. */ @@ -5311,10 +5311,10 @@ * When the value of `html` is of type array, a `DocumentFragment` * node is created and each item of the array is first converted * to a DOM `Node` by passing it through `create()` and then added - * as child to the fragment. + * as a child to the fragment. * * When the value of `html` is a DOM `Node` instance, no new - * element will be created but the node will be used as-is. + * element will be created, but the node will be used as-is. * * When the value of `html` is a string starting with `<`, it will * be passed to `dom.parse()` and the resulting value is used. @@ -5478,7 +5478,7 @@ }, /** - * Binds the given class instance ot the specified DOM `Node`. + * Binds the given class instance to the specified DOM `Node`. * * This function uses the `dom.data()` facility to attach the * passed instance of a Class to a node. This is needed for @@ -5758,7 +5758,7 @@ * `Promise.resolve()` so it may return Promises if needed. * * The return value of the function (or the resolved values - * of the promise returned by it) will be passed as first + * of the promise returned by it) will be passed as the first * argument to `render()`. * * This function is supposed to be overwritten by subclasses, @@ -6009,7 +6009,7 @@ let sysFeatures = null; let preloadClasses = null; - /* "preload" builtin classes to make the available via require */ + /* "preload" builtin classes to make them available via require */ const classes = { baseclass: Class, dom: DOM, @@ -6061,7 +6061,7 @@ /** * Captures the current stack trace and throws an error of the * specified type as a new exception. Also logs the exception as - * error to the debug console if it is available. + * an error to the debug console if it is available. * * @instance * @memberof LuCI @@ -6430,7 +6430,7 @@ * @memberof LuCI * * @param {string} feature - * The feature to test. For detailed list of known feature flags, + * The feature to test. For a detailed list of known feature flags, * see `/modules/luci-base/root/usr/share/rpcd/ucode/luci`. * * @param {string} [subfeature] @@ -6545,7 +6545,7 @@ /** * The `env` object holds environment settings used by LuCI, such - * as request timeouts, base URLs etc. + * as request timeouts, base URLs, etc. * * @instance * @memberof LuCI @@ -6623,7 +6623,7 @@ }, /** - * Construct a URL with path relative to the script path of the server + * Construct a URL with a path relative to the script path of the server * side LuCI application (usually `/cgi-bin/luci`). * * The resulting URL is guaranteed to contain only the characters @@ -6720,7 +6720,7 @@ * The value to test * * @return {boolean} - * Returns `true` if the given value is of type object and + * Returns `true` if the given value is of a type object and * not `null`, else returns `false`. */ isObject(val) { @@ -6792,11 +6792,11 @@ }, /** - * Compares two values numerically and returns -1, 0 or 1 depending - * on whether the first value is smaller, equal to or larger than the + * Compares two values numerically and returns -1, 0, or 1 depending + * on whether the first value is smaller, equal to, or larger than the * second one respectively. * - * This function is meant to be used as comparator function for + * This function is meant to be used as a comparator function for * Array.sort(). * * @type {function} @@ -6835,11 +6835,11 @@ /** * Converts the given value to an array. If the given value is of - * type array, it is returned as-is, values of type object are + * type array, it is returned as-is, values of a type object are * returned as one-element array containing the object, empty - * strings and `null` values are returned as empty array, all other + * strings and `null` values are returned as an empty array, all other * values are converted using `String()`, trimmed, split on white - * space and returned as array. + * space and returned as an array. * * @instance * @memberof LuCI @@ -6989,7 +6989,7 @@ * @param {boolean} [post=false] * When set to `false` or not specified, poll requests will be made * using the GET method. When set to `true`, POST requests will be - * issued. In case of POST requests, the request body will contain + * issued. In the case of POST requests, the request body will contain * an argument `token` with the current value of `LuCI.env.token` by * default, regardless of the parameters specified with `args`. * @@ -7137,7 +7137,7 @@ * @classdesc * * The `LuCI.xhr` class is a legacy compatibility shim for the - * functionality formerly provided by `xhr.js`. It is registered as global + * functionality formerly provided by `xhr.js`. It is registered as a global * `window.XHR` symbol for compatibility with legacy code. * * New code should use {@link LuCI.request} instead to implement HTTP @@ -7287,7 +7287,7 @@
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/network.js.html b/jsapi/network.js.html index 07b9d9ceac..e7c9fa469e 100644 --- a/jsapi/network.js.html +++ b/jsapi/network.js.html @@ -4644,7 +4644,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * Registers a new {@link LuCI.network.Protocol Protocol} subclass * with the given methods and returns the resulting subclass value. * - * This functions internally calls + * This function internally calls * {@link LuCI.Class.extend Class.extend()} on the `Network.Protocol` * base class. * @@ -4712,7 +4712,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * `NO_DEVICE`. * * @param {string} message - * The message to use as translation for the given protocol error code. + * The message to use as a translation for the given protocol error code. * * @returns {boolean} * Returns `true` if the error code description has been added or `false` @@ -5174,7 +5174,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * The device name to test. * * @returns {boolean} - * Returns `true` if the given name is in the ignore pattern list, + * Returns `true` if the given name is in the ignore-pattern list, * else returns `false`. */ isIgnoredDevice: function(name) { @@ -5405,7 +5405,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * Get IPv4 wan networks. * * This function looks up all networks having a default `0.0.0.0/0` route - * and returns them as array. + * and returns them as an array. * * @returns {Promise<Array<LuCI.network.Protocol>>} * Returns a promise resolving to an array of `Protocol` subclass @@ -5430,7 +5430,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * Get IPv6 wan networks. * * This function looks up all networks having a default `::/0` route - * and returns them as array. + * and returns them as an array. * * @returns {Promise<Array<LuCI.network.Protocol>>} * Returns a promise resolving to an array of `Protocol` subclass @@ -5606,7 +5606,7 @@ Network = baseclass.extend(/** @lends LuCI.network.prototype */ { * class instance describing the found hosts. * * @returns {Promise<LuCI.network.Hosts>} - * Returns a `Hosts` instance describing host known on the system. + * Returns a `Hosts` instance describing a host known on the system. */ getHostHints: function() { return initNetworkState().then(function() { @@ -5823,7 +5823,7 @@ Hosts = baseclass.extend(/** @lends LuCI.network.Hosts.prototype */ { * @hideconstructor * @classdesc * - * The `Network.Protocol` class serves as base for protocol specific + * The `Network.Protocol` class serves as the base for protocol-specific * subclasses which describe logical UCI networks defined by `config * interface` sections in `/etc/config/network`. */ @@ -5977,7 +5977,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * until the lease expires. * * @returns {number} - * Returns the amount of seconds until the lease expires or `-1` + * Returns the number of seconds until the lease expires or `-1` * if it isn't applicable to the associated protocol. */ getExpiry: function() { @@ -6320,7 +6320,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * The name of the interface to be created. * * @returns {Promise<void>} - * Returns a promise resolving if new interface is creatable, else + * Returns a promise resolving if a new interface is creatable, else * rejects with an error message string. */ isCreateable: function(ifname) { @@ -6349,7 +6349,7 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { * A "virtual" protocol is a protocol which spawns its own interfaces * on demand instead of using existing physical interfaces. * - * Examples for virtual protocols are `6in4` which `gre` spawn tunnel + * Examples for virtual protocols are `6in4` which `gre` spawn a tunnel * network device on startup, examples for non-virtual protocols are * `dhcp` or `static` which apply IP configuration to existing interfaces. * @@ -6387,8 +6387,8 @@ Protocol = baseclass.extend(/** @lends LuCI.network.Protocol.prototype */ { /** * Checks whether this logical interface is dynamic. * - * A dynamic interface is an interface which has been created at runtime, - * e.g. as sub-interface of another interface, but which is not backed by + * A dynamic interface is an interface that has been created at runtime. + * E.g. as a sub-interface of another interface, but which is not backed by * any user configuration. Such dynamic interfaces cannot be edited but * only brought down or restarted. * @@ -7222,7 +7222,7 @@ WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ { * * @returns {string} * Returns the UCI section name (e.g. `radio0`) of the corresponding - * radio configuration which also serves as unique logical identifier + * radio configuration, which also serves as a unique logical identifier * for the wireless phy. */ getName: function() { @@ -7823,11 +7823,11 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * supported by the driver. * * @property {number} inactive - * The amount of milliseconds the peer has been inactive, e.g. due + * The number of milliseconds the peer has been inactive, e.g. due * to power-saving. * * @property {number} connected_time - * The amount of milliseconds the peer is associated to this network. + * The number of milliseconds the peer is associated to this network. * * @property {number} [thr] * The estimated throughput of the peer, May be `0` or absent if not @@ -7958,7 +7958,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * 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 + * Note: this option exists for backwards compatibility only, and its * use is discouraged. The `mhz` field should be used instead to * determine the channel width. * @@ -7985,8 +7985,8 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * Specifies whether this rate is an EHT (IEEE 802.11be) rate. * * @property {number} [eht_gi] - * Specifies whether the guard interval used for the transmission. - * Only applicable to EHT rates. + * Specifies whether the guard interval is used for the transmission. + * Only applicable to EHT rates. * * @property {number} [eht_dcm] * Specifies whether dual concurrent modulation is used for the transmission. @@ -8056,11 +8056,11 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ }, /** - * Query the current average bit-rate of all peers associated to this + * Query the current average bit-rate of all peers associated with this * wireless network. * * @returns {null|number} - * Returns the average bit rate among all peers associated to the network + * Returns the average bit rate among all peers associated with the network * as reported by `ubus` runtime information or `null` if the information * is not available. */ @@ -8289,7 +8289,7 @@ WifiNetwork = baseclass.extend(/** @lends LuCI.network.WifiNetwork.prototype */ * with. Default is `1` which corresponds to `Unspecified reason`. * * @param {number} [ban_time=0] - * Specifies the amount of milliseconds to ban the client from + * Specifies the number of milliseconds to ban the client from * reconnecting. By default, no ban time is set which allows the client * to re-associate / reauthenticate immediately. * @@ -8400,7 +8400,7 @@ return Network;
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/rpc.js.html b/jsapi/rpc.js.html index aad3d1b925..72709493aa 100644 --- a/jsapi/rpc.js.html +++ b/jsapi/rpc.js.html @@ -4335,7 +4335,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/uci.js.html b/jsapi/uci.js.html index 13d0fe4d49..d349d4d4c6 100644 --- a/jsapi/uci.js.html +++ b/jsapi/uci.js.html @@ -4909,7 +4909,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 14:17:18 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Tue Oct 07 2025 22:56:21 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/ui.js.html b/jsapi/ui.js.html index 7a78d6edc8..0357bac6ff 100644 --- a/jsapi/ui.js.html +++ b/jsapi/ui.js.html @@ -9187,7 +9187,7 @@ return UI;