From: systemcrash Date: Mon, 9 Jun 2025 22:45:31 +0000 (+0000) Subject: deploy: fabaa87666d69741b2091228548e36861571b5ab X-Git-Url: http://git.openwrt.org/?a=commitdiff_plain;h=5a49ea183fed59fc68c6bbe8f558c84e6360d7a4;p=project%2Fluci.git deploy: fabaa87666d69741b2091228548e36861571b5ab --- diff --git a/jsapi/LuCI.baseclass.html b/jsapi/LuCI.baseclass.html index bff01a0ca8..9e16e9fc64 100644 --- a/jsapi/LuCI.baseclass.html +++ b/jsapi/LuCI.baseclass.html @@ -4886,7 +4886,7 @@ and the values extracted from the args array beginning with diff --git a/jsapi/LuCI.dom.html b/jsapi/LuCI.dom.html index bc663688e4..75230755f3 100644 --- a/jsapi/LuCI.dom.html +++ b/jsapi/LuCI.dom.html @@ -6482,7 +6482,7 @@ ignored, else not.

diff --git a/jsapi/LuCI.form.AbstractElement.html b/jsapi/LuCI.form.AbstractElement.html index 9e71b8d659..8ec3b30d65 100644 --- a/jsapi/LuCI.form.AbstractElement.html +++ b/jsapi/LuCI.form.AbstractElement.html @@ -3924,7 +3924,7 @@ properties.

-

Parse this elements form input.

+

Parse this element's form input.

The parse() function recursively walks the form element tree and triggers input value reading and validation for each encountered element.

Elements which are hidden due to unsatisfied dependencies are skipped.

@@ -3996,7 +3996,7 @@ triggers input value reading and validation for each encountered element.

Returns a promise resolving once this element's value and the values of all child elements have been parsed. The returned promise is rejected -if any parsed values are not meeting the validation constraints of their +if any parsed values do not meet the validation constraints of their respective elements. @@ -4473,7 +4473,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.AbstractSection.html b/jsapi/LuCI.form.AbstractSection.html index 2c10c184f9..690c9f024c 100644 --- a/jsapi/LuCI.form.AbstractSection.html +++ b/jsapi/LuCI.form.AbstractSection.html @@ -3689,10 +3689,10 @@ AbstractSection -

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

The AbstractSection class serves as an abstract base for the different form section styles implemented by LuCI.form. It provides the common logic for enumerating underlying configuration section instances, for registering -form options and for handling tabs to segment child options.

+form options and for handling tabs in order to segment child options.

This class is private and not directly accessible by user code.

@@ -4115,7 +4115,7 @@ The sections will be rendered in the same order as the returned array.

Query underlying option configuration values.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the configuration value of the specified option only.

@@ -4313,7 +4313,7 @@ on the amount of passed arguments. and controls whether the given UCI section is rendered or ignored by the form section element.

The default implementation always returns true. User code or -classes extending AbstractSection may overwrite this function with +classes extending AbstractSection may override this function with custom implementations.

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

Query 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 dictionary.

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the widget input value of the specified option only.

@@ -4659,7 +4659,7 @@ on the amount of passed arguments.

Obtain underlying option objects.

This function is sensitive to the amount of arguments passed to it; if no option name is specified, all options within this section are -returned as dictionary.

+returned as a dictionary.

If an option name is supplied, this function returns the matching LuCI.form.AbstractValue instance only.

@@ -4824,7 +4824,7 @@ depending on the amount of passed arguments.

Obtain underlying option LuCI.ui widget instances.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the LuCI.ui widget instance value of the specified option only.

@@ -5085,7 +5085,7 @@ invokes the load function of each child option element.

Returns a promise resolving once the values of all child elements have been loaded. The promise may reject with an error if any of the child -elements load functions rejected with an error. +elements' load functions rejected with an error. @@ -5405,8 +5405,8 @@ option element.

Returns a promise resolving once the values of all child elements have -been parsed. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +been parsed. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -6372,7 +6372,7 @@ was neither a string nor a function. diff --git a/jsapi/LuCI.form.AbstractValue.html b/jsapi/LuCI.form.AbstractValue.html index f4b6579bd0..fcacc23b17 100644 --- a/jsapi/LuCI.form.AbstractValue.html +++ b/jsapi/LuCI.form.AbstractValue.html @@ -3905,7 +3905,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4012,8 +4012,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4117,8 +4117,8 @@ or selected by the user.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4270,7 +4270,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4322,7 +4322,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4373,7 +4373,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -4841,7 +4841,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5018,11 +5018,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5236,7 +5236,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6026,8 +6026,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6359,7 +6359,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -6734,10 +6734,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7110,7 +7110,7 @@ was neither a string nor a function.

This method is invoked whenever incremental validation is performed on the user input, e.g. on keyup or blur events.

The default implementation of this method does nothing and always -returns true. User code may overwrite this method to provide +returns true. User code may override this method to provide additional validation logic which is not covered by data type constraints.

@@ -7289,7 +7289,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7430,7 +7430,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.ButtonValue.html b/jsapi/LuCI.form.ButtonValue.html index a6f083dc12..7040774cd1 100644 --- a/jsapi/LuCI.form.ButtonValue.html +++ b/jsapi/LuCI.form.ButtonValue.html @@ -3689,7 +3689,7 @@ ButtonValue -

The DummyValue element wraps an LuCI.ui.Hiddenfield widget and +

The ButtonValue element wraps a LuCI.ui.Hiddenfield widget and renders the underlying UCI option or default value as readonly text.

@@ -3709,7 +3709,7 @@ renders the underlying UCI option or default value as readonly text.

- form.js, line 4554 + form.js, line 4556
@@ -3979,7 +3979,7 @@ option to the section.

selected to influence the style of the resulting button.

Suitable values which are implemented by most themes are positive, negative and primary.

-

The default is null, means a neutral button styling is used.

+

The default of null means a neutral button styling is used.

@@ -4030,12 +4030,12 @@ 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 -this property to a string, it is used as String.format() pattern with +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 and the resulting return value is converted to a string before being used as button caption.

-

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

+

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

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4348,8 +4348,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4450,8 +4450,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4550,8 +4550,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4703,7 +4703,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4755,7 +4755,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4806,7 +4806,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5278,7 +5278,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5457,11 +5457,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5677,7 +5677,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6477,8 +6477,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6814,7 +6814,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7083,10 +7083,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7612,7 +7612,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7753,7 +7753,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.DummyValue.html b/jsapi/LuCI.form.DummyValue.html index 7f2914e310..4ac867c0a1 100644 --- a/jsapi/LuCI.form.DummyValue.html +++ b/jsapi/LuCI.form.DummyValue.html @@ -3689,7 +3689,7 @@ DummyValue -

The DummyValue element wraps an LuCI.ui.Hiddenfield widget and +

The DummyValue element wraps a LuCI.ui.Hiddenfield widget and renders the underlying UCI option or default value as readonly text.

@@ -3974,8 +3974,9 @@ option to the section.

-

Render the UCI option value as hidden using the HTML display: none style property.

-

By default, the value is displayed

+

Render the UCI option value as hidden using the HTML 'display: none' +style property.

+

By default, the value is displayed.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4334,8 +4335,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4436,8 +4437,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4536,8 +4537,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4689,7 +4690,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4741,7 +4742,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4792,7 +4793,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5264,7 +5265,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5443,11 +5444,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5663,7 +5664,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6463,8 +6464,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6783,7 +6784,7 @@ validation constraints.
- form.js, line 4548 + form.js, line 4550
@@ -6800,7 +6801,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7069,10 +7070,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7580,7 +7581,7 @@ or a plain text string. If omitted, the key value is used as captio
- form.js, line 4551 + form.js, line 4553
@@ -7598,7 +7599,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7739,7 +7740,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.DynamicList.html b/jsapi/LuCI.form.DynamicList.html index d766372ec6..04bc336241 100644 --- a/jsapi/LuCI.form.DynamicList.html +++ b/jsapi/LuCI.form.DynamicList.html @@ -3689,7 +3689,7 @@ DynamicList -

The DynamicList class represents a multi value widget allowing the user +

The DynamicList class represents a multi-value widget allowing the user to enter multiple unique values, optionally selected from a set of predefined choices. It builds upon the LuCI.ui.DynamicList widget.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4235,8 +4235,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4337,8 +4337,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4437,8 +4437,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4590,7 +4590,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4642,7 +4642,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4693,7 +4693,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5165,7 +5165,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5344,11 +5344,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5564,7 +5564,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6364,8 +6364,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6701,7 +6701,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -6970,10 +6970,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7499,7 +7499,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7640,7 +7640,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.FileUpload.html b/jsapi/LuCI.form.FileUpload.html index f971f089b1..12cc6f2ccd 100644 --- a/jsapi/LuCI.form.FileUpload.html +++ b/jsapi/LuCI.form.FileUpload.html @@ -3689,7 +3689,7 @@ FileUpload -

The FileUpload element wraps an LuCI.ui.FileUpload widget and +

The FileUpload element wraps a LuCI.ui.FileUpload widget and offers the ability to browse, upload and select remote files.

@@ -3709,7 +3709,7 @@ offers the ability to browse, upload and select remote files.

- form.js, line 4721 + form.js, line 4723
@@ -4073,7 +4073,7 @@ option to the section.

Toggle remote file delete functionality.

When set to true, the underlying widget provides a 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 +a cosmetic feature: remote delete permissions are controlled by the session ACL rules.

The default is true, means file removal buttons are displayed.

@@ -4126,9 +4126,9 @@ session ACL rules.

Toggle file upload functionality.

When set to true, the underlying widget provides a button which lets the user select and upload local files to the remote system. -Note that this is merely a cosmetic feature, remote upload access is +Note that this is merely a cosmetic feature: remote upload access is controlled by the session ACL rules.

-

The default is true, means file upload functionality is displayed.

+

The default of true means file upload functionality is displayed.

@@ -4178,8 +4178,8 @@ controlled by the session ACL rules.

Specify the root directory for file browsing.

This property defines the topmost directory the file browser widget may -navigate to, the UI will not allow browsing directories outside this -prefix. Note that this is merely a cosmetic feature, remote file access +navigate to. The UI will not allow browsing directories outside this +prefix. Note that this is merely a cosmetic feature: remote file access and directory listing permissions are controlled by the session ACL rules.

The default is /etc/luci-uploads.

@@ -4232,9 +4232,9 @@ rules.

Toggle display of hidden files.

Display hidden files when rendering the remote directory listing. -Note that this is merely a cosmetic feature, hidden files are always +Note that this is merely a cosmetic feature: hidden files are always included in received remote file listings.

-

The default is false, means hidden files are not displayed.

+

The default of false means hidden files are not displayed.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4492,8 +4492,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4594,8 +4594,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4694,8 +4694,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4847,7 +4847,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4899,7 +4899,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4950,7 +4950,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5422,7 +5422,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5601,11 +5601,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5821,7 +5821,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6621,8 +6621,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6958,7 +6958,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7227,10 +7227,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7756,7 +7756,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7897,7 +7897,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.FlagValue.html b/jsapi/LuCI.form.FlagValue.html index 39975245e3..19242b1223 100644 --- a/jsapi/LuCI.form.FlagValue.html +++ b/jsapi/LuCI.form.FlagValue.html @@ -4071,8 +4071,8 @@ option to the section.

Set a tooltip for the flag option.

-

If set to a string, it will be used as-is as a tooltip.

-

If set to a function, the function will be invoked and the return +

Set to a string, it will be used as-is as a tooltip.

+

Set to a function, the function will be invoked and the return value will be shown as a tooltip. If the return value of the function is null no tooltip will be set.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4382,8 +4382,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4484,8 +4484,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4584,8 +4584,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4737,7 +4737,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4789,7 +4789,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4840,7 +4840,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5312,7 +5312,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5491,11 +5491,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -6510,8 +6510,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6847,7 +6847,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7640,7 +7640,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7781,7 +7781,7 @@ before it is written.

diff --git a/jsapi/LuCI.form.GridSection.html b/jsapi/LuCI.form.GridSection.html index 23ffe3811a..3fd70d23e7 100644 --- a/jsapi/LuCI.form.GridSection.html +++ b/jsapi/LuCI.form.GridSection.html @@ -3689,7 +3689,7 @@ GridSection -

The GridSection class maps all or - if filter() is overwritten - a +

The GridSection class maps all or - if filter() is overridden - a subset of the underlying UCI configuration sections of a given type.

A grid section functions similar to a LuCI.form.TableSection but supports tabbing in the modal overlay. Option elements added with @@ -3698,7 +3698,7 @@ elements added with tabopti are displayed in the modal popup.

Another important difference is that the table cells show a readonly text preview of the corresponding option elements by default, unless the child -option element is explicitly made writable by setting the editable +option element is explicitly made writeable by setting the editable property to true.

Additionally, the grid section honours a modalonly property of child option elements. Refer to the AbstractValue @@ -3955,8 +3955,8 @@ by section().

Override the caption used for the section add button at the bottom of -the section form element. If set to a string, it will be used as-is, -if set to a function, the function will be invoked and its return value +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 not set, the default is Add.

@@ -4007,7 +4007,7 @@ is not set, the default is Add.

If set to true, the user may add or remove instances from the form -section widget, otherwise only preexisting sections may be edited. +section widget, otherwise only pre-existing sections may be edited. The default is false.

@@ -4158,9 +4158,9 @@ The default is false.

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

If set to a function, this function will be registered as click event handler on the rendered edit button, receiving the section instance @@ -4267,9 +4267,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. If set -to a string, it will be used as String.format() pattern with the name -of the underlying UCI section as first argument, if set to a function, +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. If this property is not set, the default is the name of the underlying @@ -4321,7 +4321,7 @@ UCI configuration section.

-

If set to true, the header row with the options descriptions will +

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

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

-

If set to true, alternating cbi-rowstyle-1 and cbi-rowstyle-2 CSS +

Set to true, alternating cbi-rowstyle-1 and cbi-rowstyle-2 CSS classes are added to the table row elements. Not all LuCI themes implement these row style classes. The default is false.

@@ -4470,11 +4470,11 @@ 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. If set to a -string, it will be used as String.format() pattern with the name of -the underlying UCI section as first argument, if set to a function, the +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 is used as caption, after converting it to a string. +its return value used as caption, after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4524,7 +4524,7 @@ UCI configuration section.

-

If set to true, a sort button is added to the last column, allowing +

Set to true, a sort button is added to the last column, allowing the user to reorder the section instances mapped by the section form element.

@@ -4628,7 +4628,7 @@ among instances. The default is false.

Override the UCI configuration name to read the section IDs from. By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified. -The default is null, means inheriting from the parent form.

+The default of null means inherit from the parent form.

@@ -4695,7 +4695,7 @@ The default is null, means inheriting from the parent form.

Add further options to the per-section instanced modal popup.

-

This function may be overwritten by user code to perform additional +

This function may be overridden by user code to perform additional setup steps before displaying the more options modal which is useful to e.g. query additional data or to inject further option elements.

The default implementation of this function does nothing.

@@ -5018,7 +5018,7 @@ is shown.

Query underlying option configuration values.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the configuration value of the specified option only.

@@ -5218,7 +5218,7 @@ on the amount of passed arguments. and controls whether the given UCI section is rendered or ignored by the form section element.

The default implementation always returns true. User code or -classes extending AbstractSection may overwrite this function with +classes extending AbstractSection may override this function with custom implementations.

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

Query 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 dictionary.

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the widget input value of the specified option only.

@@ -5568,7 +5568,7 @@ on the amount of passed arguments.

Obtain underlying option objects.

This function is sensitive to the amount of arguments passed to it; if no option name is specified, all options within this section are -returned as dictionary.

+returned as a dictionary.

If an option name is supplied, this function returns the matching LuCI.form.AbstractValue instance only.

@@ -5735,7 +5735,7 @@ depending on the amount of passed arguments.

Obtain underlying option LuCI.ui widget instances.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the LuCI.ui widget instance value of the specified option only.

@@ -5998,7 +5998,7 @@ invokes the load function of each child option element.

Returns a promise resolving once the values of all child elements have been loaded. The promise may reject with an error if any of the child -elements load functions rejected with an error. +elements' load functions rejected with an error. @@ -6322,8 +6322,8 @@ option element.

Returns a promise resolving once the values of all child elements have -been parsed. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +been parsed. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -6510,7 +6510,7 @@ entities decoded. tabs to provide a better overview to the user.

Before options can be moved into a tab pane, the corresponding tab has to be defined first, which is done by calling this function.

-

Note that tabs are only effective in modal popups, options added with +

Note that tabs are only effective in modal popups. Options added with option() will not be assigned to a specific tab and are rendered in the table view only.

@@ -7182,7 +7182,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.HiddenValue.html b/jsapi/LuCI.form.HiddenValue.html index 0d86cd5860..95f8adeb8c 100644 --- a/jsapi/LuCI.form.HiddenValue.html +++ b/jsapi/LuCI.form.HiddenValue.html @@ -3689,7 +3689,7 @@ HiddenValue -

The HiddenValue element wraps an LuCI.ui.Hiddenfield widget.

+

The HiddenValue element wraps a LuCI.ui.Hiddenfield widget.

Hidden value widgets used to be necessary in legacy code which actually submitted the underlying HTML form the server. With client side handling of forms, there are more efficient ways to store hidden state data.

@@ -3714,7 +3714,7 @@ distorted form layout when rendering the option element.

- form.js, line 4670 + form.js, line 4672
@@ -4082,7 +4082,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4189,8 +4189,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4291,8 +4291,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4391,8 +4391,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4544,7 +4544,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4596,7 +4596,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4647,7 +4647,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5119,7 +5119,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5298,11 +5298,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5518,7 +5518,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6318,8 +6318,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6655,7 +6655,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -6924,10 +6924,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7453,7 +7453,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7594,7 +7594,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.JSONMap.html b/jsapi/LuCI.form.JSONMap.html index 2c3cb5ca22..95b752a341 100644 --- a/jsapi/LuCI.form.JSONMap.html +++ b/jsapi/LuCI.form.JSONMap.html @@ -3770,7 +3770,7 @@ as data source.

The JavaScript object to use as data source. Internally, the object is -converted into an UCI-like format. Its toplevel keys are treated like UCI +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.

@@ -3802,7 +3802,7 @@ section contents.

-

The title caption of the form. A form title is usually rendered as separate +

The title caption of the form. A form title is usually rendered as a separate headline element before the actual form contents. If omitted, the corresponding headline element will not be rendered.

@@ -4156,7 +4156,7 @@ needed by the map.

The additional UCI configuration file to tie to the map. If the given -config already is in the list of required files, it will be ignored.

+config is in the list of required files already, it will be ignored.

@@ -4227,7 +4227,7 @@ config already is in the list of required files, it will be ignored.

-

Find the first DOM node within this Map which matches the given search +

Return the first DOM node within this Map which matches the given search parameters. This function is essentially a convenience wrapper around findElements() which only returns the first found node.

This function is sensitive to the amount of arguments passed to it; @@ -4452,7 +4452,7 @@ passed.

-

Find all DOM nodes within this Map which match the given search +

Return all DOM nodes within this Map which match the given search parameters. This function is essentially a convenience wrapper around querySelectorAll().

This function is sensitive to the amount of arguments passed to it; @@ -4746,7 +4746,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 rejected with an error. @@ -5072,8 +5072,8 @@ triggers input value reading and validation for each child element.

Returns a promise resolving once the entire form completed parsing all -input values. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +input values. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -5175,7 +5175,7 @@ not meeting the validation constraints of their respective elements. - Returns a promise resolving to the toplevel form DOM node once the + Returns a promise resolving to the top-level form DOM node once the rendering is complete. @@ -5279,7 +5279,7 @@ unsaved user inputs to their initial form state.

- Returns a promise resolving to the toplevel form DOM node once the + Returns a promise resolving to the top-level form DOM node once the re-rendering is complete. @@ -5416,7 +5416,7 @@ additional data manipulation steps before saving the changes.

If set to true, trigger an alert message to the user in case saving -the form data failures. Otherwise fail silently.

+the form data fails. Otherwise fail silently.

@@ -5519,8 +5519,8 @@ failed.

Add a configuration section to the map.

-

LuCI forms follow the structure of the underlying UCI configurations, -means that a map, which represents a single UCI configuration, is +

LuCI forms follow the structure of the underlying UCI configurations. +This means that a map, which represents a single UCI configuration, is divided into multiple sections which in turn contain an arbitrary number of options.

While UCI itself only knows two kinds of sections - named and anonymous @@ -6052,7 +6052,7 @@ was neither a string nor a function.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.ListValue.html b/jsapi/LuCI.form.ListValue.html index 5b3ac246ca..d7b3b09cc0 100644 --- a/jsapi/LuCI.form.ListValue.html +++ b/jsapi/LuCI.form.ListValue.html @@ -4227,7 +4227,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4334,8 +4334,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4436,8 +4436,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4536,8 +4536,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4689,7 +4689,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4741,7 +4741,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4792,7 +4792,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5264,7 +5264,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5443,11 +5443,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5663,7 +5663,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6463,8 +6463,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6800,7 +6800,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7069,10 +7069,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7624,7 +7624,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7765,7 +7765,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Map.html b/jsapi/LuCI.form.Map.html index 24dd032d2a..66da8b9a86 100644 --- a/jsapi/LuCI.form.Map.html +++ b/jsapi/LuCI.form.Map.html @@ -3692,7 +3692,7 @@

The Map class represents one complete form. A form usually maps one UCI configuration file and is divided into multiple sections containing multiple fields each.

-

It serves as main entry point into the LuCI.form for typical view code.

+

It serves as the main entry point into the LuCI.form for typical view code.

@@ -3770,7 +3770,7 @@ fields each.

-

The UCI configuration to map. It is automatically loaded along when the +

The UCI configuration to map. It is automatically loaded along with the resulting map instance.

@@ -3801,7 +3801,7 @@ resulting map instance.

-

The title caption of the form. A form title is usually rendered as separate +

The title caption of the form. A form title is usually rendered as a separate headline element before the actual form contents. If omitted, the corresponding headline element will not be rendered.

@@ -3833,7 +3833,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.

@@ -4153,7 +4153,7 @@ needed by the map.

The additional UCI configuration file to tie to the map. If the given -config already is in the list of required files, it will be ignored.

+config is in the list of required files already, it will be ignored.

@@ -4222,7 +4222,7 @@ config already is in the list of required files, it will be ignored.

-

Find the first DOM node within this Map which matches the given search +

Return the first DOM node within this Map which matches the given search parameters. This function is essentially a convenience wrapper around findElements() which only returns the first found node.

This function is sensitive to the amount of arguments passed to it; @@ -4445,7 +4445,7 @@ passed.

-

Find all DOM nodes within this Map which match the given search +

Return all DOM nodes within this Map which match the given search parameters. This function is essentially a convenience wrapper around querySelectorAll().

This function is sensitive to the amount of arguments passed to it; @@ -4737,7 +4737,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 rejected with an error. @@ -5059,8 +5059,8 @@ triggers input value reading and validation for each child element.

Returns a promise resolving once the entire form completed parsing all -input values. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +input values. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -5160,7 +5160,7 @@ not meeting the validation constraints of their respective elements. - Returns a promise resolving to the toplevel form DOM node once the + Returns a promise resolving to the top-level form DOM node once the rendering is complete. @@ -5262,7 +5262,7 @@ unsaved user inputs to their initial form state.

- Returns a promise resolving to the toplevel form DOM node once the + Returns a promise resolving to the top-level form DOM node once the re-rendering is complete. @@ -5397,7 +5397,7 @@ additional data manipulation steps before saving the changes.

If set to true, trigger an alert message to the user in case saving -the form data failures. Otherwise fail silently.

+the form data fails. Otherwise fail silently.

@@ -5498,8 +5498,8 @@ failed.

Add a configuration section to the map.

-

LuCI forms follow the structure of the underlying UCI configurations, -means that a map, which represents a single UCI configuration, is +

LuCI forms follow the structure of the underlying UCI configurations. +This means that a map, which represents a single UCI configuration, is divided into multiple sections which in turn contain an arbitrary number of options.

While UCI itself only knows two kinds of sections - named and anonymous @@ -6031,7 +6031,7 @@ was neither a string nor a function.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.MultiValue.html b/jsapi/LuCI.form.MultiValue.html index b9b597071d..17b2e6637d 100644 --- a/jsapi/LuCI.form.MultiValue.html +++ b/jsapi/LuCI.form.MultiValue.html @@ -4025,7 +4025,7 @@ option to the section.

Allows to specify the display_items property of the underlying dropdown widget. If omitted, the value of -the size property is used or 3 when size is unspecified as well.

+the size property is used or 3 when size is also unspecified.

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

Allows to specify the dropdown_items property of the underlying dropdown widget. If omitted, the value of -the size property is used or -1 when size is unspecified as well.

+the size property is used or -1 when size is also unspecified.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4383,8 +4383,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4485,8 +4485,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4585,8 +4585,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4738,7 +4738,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4790,7 +4790,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4841,7 +4841,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5313,7 +5313,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5492,11 +5492,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5712,7 +5712,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6512,8 +6512,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6849,7 +6849,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7118,10 +7118,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7647,7 +7647,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7788,7 +7788,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.NamedSection.html b/jsapi/LuCI.form.NamedSection.html index 0da7319acf..f42bbd2341 100644 --- a/jsapi/LuCI.form.NamedSection.html +++ b/jsapi/LuCI.form.NamedSection.html @@ -3971,9 +3971,9 @@ by section().

-

If set to true, the user may remove or recreate the sole mapped +

Set to true, the user may remove or recreate the sole mapped configuration instance from the form section widget, otherwise only a -preexisting section may be edited. The default is false.

+pre-existing section may be edited. The default is false.

@@ -4024,7 +4024,7 @@ preexisting section may be edited. The default is false.

Override the UCI configuration name to read the section IDs from. By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified. -The default is null, means inheriting from the parent form.

+The default of null means inherit from the parent form.

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

-

The NamedSection class overwrites the generic cfgsections() +

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.

@@ -4361,7 +4361,7 @@ section ID as sole element. User code should not normally change this.

Query underlying option configuration values.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the configuration value of the specified option only.

@@ -4561,7 +4561,7 @@ on the amount of passed arguments. and controls whether the given UCI section is rendered or ignored by the form section element.

The default implementation always returns true. User code or -classes extending AbstractSection may overwrite this function with +classes extending AbstractSection may override this function with custom implementations.

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

Query 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 dictionary.

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the widget input value of the specified option only.

@@ -4911,7 +4911,7 @@ on the amount of passed arguments.

Obtain underlying option objects.

This function is sensitive to the amount of arguments passed to it; if no option name is specified, all options within this section are -returned as dictionary.

+returned as a dictionary.

If an option name is supplied, this function returns the matching LuCI.form.AbstractValue instance only.

@@ -5078,7 +5078,7 @@ depending on the amount of passed arguments.

Obtain underlying option LuCI.ui widget instances.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the LuCI.ui widget instance value of the specified option only.

@@ -5341,7 +5341,7 @@ invokes the load function of each child option element.

Returns a promise resolving once the values of all child elements have been loaded. The promise may reject with an error if any of the child -elements load functions rejected with an error. +elements' load functions rejected with an error. @@ -5665,8 +5665,8 @@ option element.

Returns a promise resolving once the values of all child elements have -been parsed. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +been parsed. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -6636,7 +6636,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.RichListValue.html b/jsapi/LuCI.form.RichListValue.html index 542cc02ddc..aa7f4af167 100644 --- a/jsapi/LuCI.form.RichListValue.html +++ b/jsapi/LuCI.form.RichListValue.html @@ -4228,7 +4228,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4335,8 +4335,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4487,8 +4487,8 @@ widget types.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4587,8 +4587,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4788,7 +4788,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4840,7 +4840,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4891,7 +4891,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5414,7 +5414,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

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

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5813,7 +5813,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6613,8 +6613,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6950,7 +6950,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7219,10 +7219,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7776,7 +7776,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7917,7 +7917,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.SectionValue.html b/jsapi/LuCI.form.SectionValue.html index 6879a5c0c1..049e4953ea 100644 --- a/jsapi/LuCI.form.SectionValue.html +++ b/jsapi/LuCI.form.SectionValue.html @@ -3709,7 +3709,7 @@ element container, allowing to nest form sections into other sections.

- form.js, line 4861 + form.js, line 4863
@@ -4130,7 +4130,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4237,8 +4237,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4339,8 +4339,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4439,8 +4439,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4592,7 +4592,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4644,7 +4644,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4695,7 +4695,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5153,7 +5153,7 @@ within the given specific section.

- form.js, line 4973 + form.js, line 4975
@@ -5343,11 +5343,11 @@ its cfgvalue() implementation will always return null.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5549,7 +5549,7 @@ argument, this parameter is ignored.

- form.js, line 4982 + form.js, line 4984
@@ -6347,7 +6347,7 @@ returns false.
- form.js, line 4922 + form.js, line 4924
@@ -6361,8 +6361,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6530,7 +6530,7 @@ so it may return promises if overridden by user code.
- form.js, line 4927 + form.js, line 4929
@@ -6681,7 +6681,7 @@ validation constraints.
- form.js, line 4964 + form.js, line 4966
@@ -6961,10 +6961,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7324,7 +7324,7 @@ was neither a string nor a function.
- form.js, line 4948 + form.js, line 4950
@@ -7470,7 +7470,7 @@ or a plain text string. If omitted, the key value is used as captio
- form.js, line 4956 + form.js, line 4958
@@ -7621,7 +7621,7 @@ its write() implementation is a no-op.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TableSection.html b/jsapi/LuCI.form.TableSection.html index fd3665e24b..784c6779a9 100644 --- a/jsapi/LuCI.form.TableSection.html +++ b/jsapi/LuCI.form.TableSection.html @@ -3689,7 +3689,7 @@ TableSection -

The TableSection class maps all or - if filter() is overwritten - a +

The TableSection class maps all or - if filter() is overridden - a subset of the underlying UCI configuration sections of a given type.

Layout wise, the configuration section instances mapped by the section element (sometimes referred to as "section nodes") are rendered as rows @@ -3947,9 +3947,9 @@ by section().

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

If set to a function, this function will be registered as click event handler on the rendered edit button, receiving the section instance @@ -4056,9 +4056,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. If set -to a string, it will be used as String.format() pattern with the name -of the underlying UCI section as first argument, if set to a function, +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. If this property is not set, the default is the name of the underlying @@ -4110,7 +4110,7 @@ UCI configuration section.

-

If set to true, the header row with the options descriptions will +

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

@@ -4160,7 +4160,7 @@ when at least one option has a description.

-

If set to true, alternating cbi-rowstyle-1 and cbi-rowstyle-2 CSS +

Set to true, alternating cbi-rowstyle-1 and cbi-rowstyle-2 CSS classes are added to the table row elements. Not all LuCI themes implement these row style classes. The default is false.

@@ -4211,11 +4211,11 @@ 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. If set to a -string, it will be used as String.format() pattern with the name of -the underlying UCI section as first argument, if set to a function, the +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 is used as caption, after converting it to a string. +its return value used as caption, after converting it to a string. If this property is not set, the default is the name of the underlying UCI configuration section.

@@ -4265,7 +4265,7 @@ UCI configuration section.

-

If set to true, a sort button is added to the last column, allowing +

Set to true, a sort button is added to the last column, allowing the user to reorder the section instances mapped by the section form element.

@@ -4316,8 +4316,8 @@ element.

Override the caption used for the section add button at the bottom of -the section form element. If set to a string, it will be used as-is, -if set to a function, the function will be invoked and its return value +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 not set, the default is Add.

@@ -4368,7 +4368,7 @@ is not set, the default is Add.

If set to true, the user may add or remove instances from the form -section widget, otherwise only preexisting sections may be edited. +section widget, otherwise only pre-existing sections may be edited. The default is false.

@@ -4620,7 +4620,7 @@ among instances. The default is false.

Override the UCI configuration name to read the section IDs from. By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified. -The default is null, means inheriting from the parent form.

+The default of null means inherit from the parent form.

@@ -4685,7 +4685,7 @@ The default is null, means inheriting from the parent form.

Add further options to the per-section instanced modal popup.

-

This function may be overwritten by user code to perform additional +

This function may be overridden by user code to perform additional setup steps before displaying the more options modal which is useful to e.g. query additional data or to inject further option elements.

The default implementation of this function does nothing.

@@ -5008,7 +5008,7 @@ is shown.

Query underlying option configuration values.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the configuration value of the specified option only.

@@ -5208,7 +5208,7 @@ on the amount of passed arguments. and controls whether the given UCI section is rendered or ignored by the form section element.

The default implementation always returns true. User code or -classes extending AbstractSection may overwrite this function with +classes extending AbstractSection may override this function with custom implementations.

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

Query 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 dictionary.

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the widget input value of the specified option only.

@@ -5558,7 +5558,7 @@ on the amount of passed arguments.

Obtain underlying option objects.

This function is sensitive to the amount of arguments passed to it; if no option name is specified, all options within this section are -returned as dictionary.

+returned as a dictionary.

If an option name is supplied, this function returns the matching LuCI.form.AbstractValue instance only.

@@ -5725,7 +5725,7 @@ depending on the amount of passed arguments.

Obtain underlying option LuCI.ui widget instances.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the LuCI.ui widget instance value of the specified option only.

@@ -5988,7 +5988,7 @@ invokes the load function of each child option element.

Returns a promise resolving once the values of all child elements have been loaded. The promise may reject with an error if any of the child -elements load functions rejected with an error. +elements' load functions rejected with an error. @@ -6312,8 +6312,8 @@ option element.

Returns a promise resolving once the values of all child elements have -been parsed. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +been parsed. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -7154,7 +7154,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TextValue.html b/jsapi/LuCI.form.TextValue.html index aa6366777b..f4b810bf20 100644 --- a/jsapi/LuCI.form.TextValue.html +++ b/jsapi/LuCI.form.TextValue.html @@ -4273,7 +4273,7 @@ option element is marked as invalid.

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4380,8 +4380,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4482,8 +4482,8 @@ or selected by the user.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

@@ -4582,8 +4582,8 @@ as plain text input.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4735,7 +4735,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4787,7 +4787,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4838,7 +4838,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5310,7 +5310,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5489,11 +5489,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5709,7 +5709,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6509,8 +6509,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6846,7 +6846,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7115,10 +7115,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7496,7 +7496,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7637,7 +7637,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.TypedSection.html b/jsapi/LuCI.form.TypedSection.html index 4c13125a42..7518c25e6f 100644 --- a/jsapi/LuCI.form.TypedSection.html +++ b/jsapi/LuCI.form.TypedSection.html @@ -3689,7 +3689,7 @@ TypedSection -

The TypedSection class maps all or - if filter() is overwritten - a +

The TypedSection class maps all or - if filter() is overridden - a subset of the underlying UCI configuration sections of a given type.

Layout wise, the configuration section instances mapped by the section element (sometimes referred to as "section nodes") are stacked beneath @@ -3947,8 +3947,8 @@ by section().

Override the caption used for the section add button at the bottom of -the section form element. If set to a string, it will be used as-is, -if set to a function, the function will be invoked and its return value +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 not set, the default is Add.

@@ -3999,7 +3999,7 @@ is not set, the default is Add.

If set to true, the user may add or remove instances from the form -section widget, otherwise only preexisting sections may be edited. +section widget, otherwise only pre-existing sections may be edited. The default is false.

@@ -4203,7 +4203,7 @@ among instances. The default is false.

Override the UCI configuration name to read the section IDs from. By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified. -The default is null, means inheriting from the parent form.

+The default of null means inherit from the parent form.

@@ -4568,7 +4568,7 @@ The sections will be rendered in the same order as the returned array.

Query underlying option configuration values.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the configuration value of the specified option only.

@@ -4768,7 +4768,7 @@ on the amount of passed arguments. and controls whether the given UCI section is rendered or ignored by the form section element.

The default implementation always returns true. User code or -classes extending AbstractSection may overwrite this function with +classes extending AbstractSection may override this function with custom implementations.

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

Query 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 dictionary.

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the widget input value of the specified option only.

@@ -5118,7 +5118,7 @@ on the amount of passed arguments.

Obtain underlying option objects.

This function is sensitive to the amount of arguments passed to it; if no option name is specified, all options within this section are -returned as dictionary.

+returned as a dictionary.

If an option name is supplied, this function returns the matching LuCI.form.AbstractValue instance only.

@@ -5285,7 +5285,7 @@ depending on the amount of passed arguments.

Obtain underlying option LuCI.ui widget instances.

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

+options within this section are returned as a dictionary.

If both the section ID and an option name are supplied, this function returns the LuCI.ui widget instance value of the specified option only.

@@ -5548,7 +5548,7 @@ invokes the load function of each child option element.

Returns a promise resolving once the values of all child elements have been loaded. The promise may reject with an error if any of the child -elements load functions rejected with an error. +elements' load functions rejected with an error. @@ -5872,8 +5872,8 @@ option element.

Returns a promise resolving once the values of all child elements have -been parsed. The returned promise is rejected if any parsed values are -not meeting the validation constraints of their respective elements. +been parsed. The returned promise is rejected if any parsed values do +not meet the validation constraints of their respective elements. @@ -6843,7 +6843,7 @@ was neither a string nor a function.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.Value.html b/jsapi/LuCI.form.Value.html index ad35439064..ece11ee421 100644 --- a/jsapi/LuCI.form.Value.html +++ b/jsapi/LuCI.form.Value.html @@ -3975,8 +3975,8 @@ option to the section.

-

If set to true, the field is rendered as password input, otherwise -as plain text input.

+

If set to true, the field is rendered as a password input, otherwise +as a plain text input.

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

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 -is rendered as full input widget within its cell instead of a text only +is rendered as a full input widget within its cell instead of a text only preview.

This property has no effect on options that are not children of grid section elements.

@@ -4282,8 +4282,8 @@ section elements.

Register a custom value change handler.

-

If this property is set to a function value, the function is invoked -whenever the value of the underlying UI input element is changing.

+

If this property is set to a function, it is invoked +whenever the value of the underlying UI input element changes.

The invoked handler function will receive the DOM click element as first and the underlying configuration section ID as well as the input value as second and third argument respectively.

@@ -4387,8 +4387,8 @@ or selected by the user.

Make option element readonly.

This property defaults to the readonly state of the parent form element. When set to true, the underlying widget is rendered in disabled state, -means its contents cannot be changed and the widget cannot be interacted -with.

+meaning its contents cannot be changed and the widget cannot be +interacted with.

@@ -4540,7 +4540,7 @@ dependency constraints.

Override the UCI configuration name to read the option value from.

By default, the configuration name is inherited from the parent Map. By setting this property, a deviating configuration may be specified.

-

The default is null, means inheriting from the parent form.

+

The default of null means inherit from the parent form.

@@ -4592,7 +4592,7 @@ By setting this property, a deviating configuration may be specified.

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

-

The default is null, means using the option element name.

+

The default of null means use the option element name.

@@ -4643,7 +4643,7 @@ a deviating UCI option may be specified.

Override the UCI section name to read the option value from.

By default, the section ID is inherited from the parent section element. By setting this property, a deviating section may be specified.

-

The default is null, means inheriting from the parent section.

+

The default of null means inherit from the parent section.

@@ -5115,7 +5115,7 @@ within the given specific section.

Query the underlying configuration value.

The default implementation of this method returns the cached return value of load(). It may be -overwritten by user code to obtain the configuration value in a +overridden by user code to obtain the configuration value in a different way.

@@ -5294,11 +5294,11 @@ different way.

Dependency constraints allow making the presence of option elements dependent on the current values of certain other options within the same form. An option element with unsatisfied dependencies will be -hidden from the view and its current value is omitted when saving.

+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 -possible to depend on multiple options simultaneously, allowing to form +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 elements outside the current form section. If a name without @@ -5514,7 +5514,7 @@ argument, this parameter is ignored.

Query the current form input value.

The default implementation of this method returns the current input value of the underlying LuCI.ui widget. -It may be overwritten by user code to handle input values differently.

+It may be overridden by user code to handle input values differently.

@@ -6314,8 +6314,8 @@ returns false.

Load the underlying configuration value.

The default implementation of this method reads and returns the underlying UCI option value (or the related JavaScript property for -JSONMap instances). It may be overwritten by user code to load data -from nonstandard sources.

+JSONMap instances). It may be overridden by user code to load data +from non-standard sources.

@@ -6651,7 +6651,7 @@ element has been hidden due to unsatisfied dependencies or when the user cleared the input value and the option is marked optional.

The default implementation simply removes the associated option from the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative removal logic, e.g. to retain the original value.

@@ -7028,10 +7028,10 @@ entities decoded.

Obtain a textual input representation.

-

The default implementation of this method returns the HTML escaped +

The default implementation of this method returns the HTML-escaped current input value of the underlying LuCI.ui widget. User code or specific -option element implementations may overwrite this function to apply a +option element implementations may override this function to apply a different logic, e.g. to return Yes or No depending on the checked state of checkbox elements.

@@ -7555,7 +7555,7 @@ the initial value returned by cfgvalue().

The default implementation simply sets the given input value in the UCI configuration (or the associated JavaScript object property in -case of JSONMap forms). It may be overwritten by user code to +case of JSONMap forms). It may be overridden by user code to implement alternative save logic, e.g. to transform the input value before it is written.

@@ -7696,7 +7696,7 @@ before it is written.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.form.html b/jsapi/LuCI.form.html index a698184a09..572f682412 100644 --- a/jsapi/LuCI.form.html +++ b/jsapi/LuCI.form.html @@ -3739,7 +3739,7 @@ m.render().then((node) => {
- form.js, line 4985 + form.js, line 4987
@@ -3895,7 +3895,7 @@ m.render().then((node) => {
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.fs.html b/jsapi/LuCI.fs.html index 0e250a4bf9..c9bd41e247 100644 --- a/jsapi/LuCI.fs.html +++ b/jsapi/LuCI.fs.html @@ -6081,7 +6081,7 @@ the failure reason.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.headers.html b/jsapi/LuCI.headers.html index 22950ef056..f7613ce238 100644 --- a/jsapi/LuCI.headers.html +++ b/jsapi/LuCI.headers.html @@ -4097,7 +4097,7 @@ Note: Header-Names are case-insensitive.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.html b/jsapi/LuCI.html index 5be7a4b4ee..bcafdc433e 100644 --- a/jsapi/LuCI.html +++ b/jsapi/LuCI.html @@ -8673,7 +8673,7 @@ else null.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Device.html b/jsapi/LuCI.network.Device.html index 63fa4936f5..5dd84d9609 100644 --- a/jsapi/LuCI.network.Device.html +++ b/jsapi/LuCI.network.Device.html @@ -6462,7 +6462,7 @@ when it is down or absent.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Hosts.html b/jsapi/LuCI.network.Hosts.html index df0bf685b0..61cbb75803 100644 --- a/jsapi/LuCI.network.Hosts.html +++ b/jsapi/LuCI.network.Hosts.html @@ -5023,7 +5023,7 @@ is used as hint.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.Protocol.html b/jsapi/LuCI.network.Protocol.html index af28cd8f46..c92d4b3d36 100644 --- a/jsapi/LuCI.network.Protocol.html +++ b/jsapi/LuCI.network.Protocol.html @@ -8359,7 +8359,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiDevice.html b/jsapi/LuCI.network.WifiDevice.html index d1f8c840e4..624470b377 100644 --- a/jsapi/LuCI.network.WifiDevice.html +++ b/jsapi/LuCI.network.WifiDevice.html @@ -5400,7 +5400,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiNetwork.html b/jsapi/LuCI.network.WifiNetwork.html index f08a319865..2e01109edf 100644 --- a/jsapi/LuCI.network.WifiNetwork.html +++ b/jsapi/LuCI.network.WifiNetwork.html @@ -8084,7 +8084,7 @@ configuration.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.WifiVlan.html b/jsapi/LuCI.network.WifiVlan.html index 2451ca2db7..8953f4bb1d 100644 --- a/jsapi/LuCI.network.WifiVlan.html +++ b/jsapi/LuCI.network.WifiVlan.html @@ -4302,7 +4302,7 @@ if it is different than the vlan id
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.network.html b/jsapi/LuCI.network.html index bae51e5973..b437b9f7ea 100644 --- a/jsapi/LuCI.network.html +++ b/jsapi/LuCI.network.html @@ -9930,7 +9930,7 @@ conjunction with quality to calculate a quality percentage.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/LuCI.poll.html b/jsapi/LuCI.poll.html index a9c5fb1447..060aafc635 100644 --- a/jsapi/LuCI.poll.html +++ b/jsapi/LuCI.poll.html @@ -4480,7 +4480,7 @@ run to begin with.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.request.html b/jsapi/LuCI.request.html index 8e66c73bb4..61ac57f95e 100644 --- a/jsapi/LuCI.request.html +++ b/jsapi/LuCI.request.html @@ -5415,7 +5415,7 @@ instances as sole argument during the HTTP request transfer.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.request.poll.html b/jsapi/LuCI.request.poll.html index 3bc9b5319b..43de4e300d 100644 --- a/jsapi/LuCI.request.poll.html +++ b/jsapi/LuCI.request.poll.html @@ -4599,7 +4599,7 @@ else null.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.response.html b/jsapi/LuCI.response.html index 4b6809c6ff..593ab89f6d 100644 --- a/jsapi/LuCI.response.html +++ b/jsapi/LuCI.response.html @@ -4557,7 +4557,7 @@ using String() and treated as response text.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.rpc.html b/jsapi/LuCI.rpc.html index 962a4f640d..4354f79c50 100644 --- a/jsapi/LuCI.rpc.html +++ b/jsapi/LuCI.rpc.html @@ -5888,7 +5888,7 @@ to the expect and filter declarations.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.session.html b/jsapi/LuCI.session.html index 31cb033661..f513354c6c 100644 --- a/jsapi/LuCI.session.html +++ b/jsapi/LuCI.session.html @@ -4327,7 +4327,7 @@ being put in the session store.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.uci.html b/jsapi/LuCI.uci.html index 55b190d35f..8cb98b4625 100644 --- a/jsapi/LuCI.uci.html +++ b/jsapi/LuCI.uci.html @@ -7864,7 +7864,7 @@ associated name as arguments.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.AbstractElement.html b/jsapi/LuCI.ui.AbstractElement.html index 2bef729596..c96e971706 100644 --- a/jsapi/LuCI.ui.AbstractElement.html +++ b/jsapi/LuCI.ui.AbstractElement.html @@ -5431,7 +5431,7 @@ and are displayed in a slightly faded style.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Checkbox.html b/jsapi/LuCI.ui.Checkbox.html index aa90b9b70a..21035b0a81 100644 --- a/jsapi/LuCI.ui.Checkbox.html +++ b/jsapi/LuCI.ui.Checkbox.html @@ -5545,7 +5545,7 @@ it is required for HTML based form submissions.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.ComboButton.html b/jsapi/LuCI.ui.ComboButton.html index 0cdf61a022..ff347d1e76 100644 --- a/jsapi/LuCI.ui.ComboButton.html +++ b/jsapi/LuCI.ui.ComboButton.html @@ -5575,7 +5575,7 @@ choice value as second argument.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Combobox.html b/jsapi/LuCI.ui.Combobox.html index e10798ad03..ae299c9248 100644 --- a/jsapi/LuCI.ui.Combobox.html +++ b/jsapi/LuCI.ui.Combobox.html @@ -5478,7 +5478,7 @@ forcibly set to true.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Dropdown.html b/jsapi/LuCI.ui.Dropdown.html index 59cd077837..6ebedb55ac 100644 --- a/jsapi/LuCI.ui.Dropdown.html +++ b/jsapi/LuCI.ui.Dropdown.html @@ -6276,7 +6276,7 @@ expression. Only applicable when create is true.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/LuCI.ui.DynamicList.html b/jsapi/LuCI.ui.DynamicList.html index 70b18c10d5..b0e74da5a4 100644 --- a/jsapi/LuCI.ui.DynamicList.html +++ b/jsapi/LuCI.ui.DynamicList.html @@ -5653,7 +5653,7 @@ it to remain unselected.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.FileUpload.html b/jsapi/LuCI.ui.FileUpload.html index 9ab679cd15..952b99db37 100644 --- a/jsapi/LuCI.ui.FileUpload.html +++ b/jsapi/LuCI.ui.FileUpload.html @@ -5576,7 +5576,7 @@ ACL setup for the current session.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Hiddenfield.html b/jsapi/LuCI.ui.Hiddenfield.html index f094f694e1..68ac9ee137 100644 --- a/jsapi/LuCI.ui.Hiddenfield.html +++ b/jsapi/LuCI.ui.Hiddenfield.html @@ -5256,7 +5256,7 @@ trigger validation runs, e.g. when programmatically altering values.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Select.html b/jsapi/LuCI.ui.Select.html index da9580b1c5..17ba1d695b 100644 --- a/jsapi/LuCI.ui.Select.html +++ b/jsapi/LuCI.ui.Select.html @@ -5608,7 +5608,7 @@ selected yet. Only applicable to the select widget type.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Textarea.html b/jsapi/LuCI.ui.Textarea.html index 5be77e6c6c..b444f87e0e 100644 --- a/jsapi/LuCI.ui.Textarea.html +++ b/jsapi/LuCI.ui.Textarea.html @@ -5554,7 +5554,7 @@ contents.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.Textfield.html b/jsapi/LuCI.ui.Textfield.html index b49b376364..6686282fd3 100644 --- a/jsapi/LuCI.ui.Textfield.html +++ b/jsapi/LuCI.ui.Textfield.html @@ -5482,7 +5482,7 @@ corresponding <input> element is empty.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.changes.html b/jsapi/LuCI.ui.changes.html index 97ffd23ac2..712c1ec07e 100644 --- a/jsapi/LuCI.ui.changes.html +++ b/jsapi/LuCI.ui.changes.html @@ -4334,7 +4334,7 @@ is removed.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.html b/jsapi/LuCI.ui.html index 720e3d44c7..68c97c3fef 100644 --- a/jsapi/LuCI.ui.html +++ b/jsapi/LuCI.ui.html @@ -6693,7 +6693,7 @@ cancelled by the user.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.menu.html b/jsapi/LuCI.ui.menu.html index afe21c7ee0..0eb4bc04d5 100644 --- a/jsapi/LuCI.ui.menu.html +++ b/jsapi/LuCI.ui.menu.html @@ -4381,7 +4381,7 @@ internal root node if omitted.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.ui.tabs.html b/jsapi/LuCI.ui.tabs.html index c55582e477..c1a6a3e9c5 100644 --- a/jsapi/LuCI.ui.tabs.html +++ b/jsapi/LuCI.ui.tabs.html @@ -4081,7 +4081,7 @@ DOM node.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.view.html b/jsapi/LuCI.view.html index e69c73a74e..3b59010402 100644 --- a/jsapi/LuCI.view.html +++ b/jsapi/LuCI.view.html @@ -4685,7 +4685,7 @@ to a Node value.
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/LuCI.xhr.html b/jsapi/LuCI.xhr.html index 0032ce0df3..ea8dadec18 100644 --- a/jsapi/LuCI.xhr.html +++ b/jsapi/LuCI.xhr.html @@ -4649,7 +4649,7 @@ when invoked.

- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:25 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:28 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/form.js.html b/jsapi/form.js.html index b0f9d248c6..37658f7693 100644 --- a/jsapi/form.js.html +++ b/jsapi/form.js.html @@ -3898,7 +3898,7 @@ const CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement }, /** - * Parse this elements form input. + * Parse this element's form input. * * The `parse()` function recursively walks the form element tree and * triggers input value reading and validation for each encountered element. @@ -3908,7 +3908,7 @@ const CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement * @returns {Promise<void>} * Returns a promise resolving once this element's value and the values of * all child elements have been parsed. The returned promise is rejected - * if any parsed values are not meeting the validation constraints of their + * if any parsed values do not meet the validation constraints of their * respective elements. */ parse() { @@ -4038,19 +4038,19 @@ const CBIAbstractElement = baseclass.extend(/** @lends LuCI.form.AbstractElement * configuration file and is divided into multiple sections containing multiple * fields each. * - * It serves as main entry point into the `LuCI.form` for typical view code. + * It serves as the main entry point into the `LuCI.form` for typical view code. * * @param {string} config - * The UCI configuration to map. It is automatically loaded along when the + * The UCI configuration to map. It is automatically loaded along with the * resulting map instance. * * @param {string} [title] - * The title caption of the form. A form title is usually rendered as separate + * The title caption of the form. A form title is usually rendered as a separate * headline element before the actual form contents. If omitted, the * 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. */ @@ -4078,7 +4078,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { */ /** - * Find all DOM nodes within this Map which match the given search + * Return all DOM nodes within this Map which match the given search * parameters. This function is essentially a convenience wrapper around * `querySelectorAll()`. * @@ -4121,7 +4121,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { }, /** - * Find the first DOM node within this Map which matches the given search + * Return the first DOM node within this Map which matches the given search * parameters. This function is essentially a convenience wrapper around * `findElements()` which only returns the first found node. * @@ -4166,7 +4166,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @param {string} config * The additional UCI configuration file to tie to the map. If the given - * config already is in the list of required files, it will be ignored. + * config is in the list of required files already, it will be ignored. */ chain(config) { if (this.parsechain.indexOf(config) == -1) @@ -4176,8 +4176,8 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { /** * Add a configuration section to the map. * - * LuCI forms follow the structure of the underlying UCI configurations, - * means that a map, which represents a single UCI configuration, is + * LuCI forms follow the structure of the underlying UCI configurations. + * This means that a map, which represents a single UCI configuration, is * divided into multiple sections which in turn contain an arbitrary * number of options. * @@ -4219,7 +4219,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 rejected with * an error. */ load() { @@ -4249,8 +4249,8 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @returns {Promise<void>} * Returns a promise resolving once the entire form completed parsing all - * input values. The returned promise is rejected if any parsed values are - * not meeting the validation constraints of their respective elements. + * input values. The returned promise is rejected if any parsed values do + * not meet the validation constraints of their respective elements. */ parse() { const tasks = []; @@ -4275,7 +4275,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @param {boolean} [silent=false] * If set to `true`, trigger an alert message to the user in case saving - * the form data failures. Otherwise fail silently. + * the form data fails. Otherwise fail silently. * * @returns {Promise<void>} * Returns a promise resolving once the entire save operation is complete. @@ -4309,7 +4309,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * unsaved user inputs to their initial form state. * * @returns {Promise<Node>} - * Returns a promise resolving to the toplevel form DOM node once the + * Returns a promise resolving to the top-level form DOM node once the * re-rendering is complete. */ reset() { @@ -4320,7 +4320,7 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * Render the form markup. * * @returns {Promise<Node>} - * Returns a promise resolving to the toplevel form DOM node once the + * Returns a promise resolving to the top-level form DOM node once the * rendering is complete. */ render() { @@ -4476,12 +4476,12 @@ const CBIMap = CBIAbstractElement.extend(/** @lends LuCI.form.Map.prototype */ { * * @param {Object<string, Object<string, *>|Array<Object<string, *>>>} data * The JavaScript object to use as data source. Internally, the object is - * converted into an UCI-like format. Its toplevel keys are treated like UCI + * 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. * * @param {string} [title] - * The title caption of the form. A form title is usually rendered as separate + * The title caption of the form. A form title is usually rendered as a separate * headline element before the actual form contents. If omitted, the * corresponding headline element will not be rendered. * @@ -4507,10 +4507,10 @@ const CBIJSONMap = CBIMap.extend(/** @lends LuCI.form.JSONMap.prototype */ { * @hideconstructor * @classdesc * - * The `AbstractSection` class serves as abstract base for the different form + * The `AbstractSection` class serves as an abstract base for the different form * section styles implemented by `LuCI.form`. It provides the common logic for * enumerating underlying configuration section instances, for registering - * form options and for handling tabs to segment child options. + * form options and for handling tabs in order to segment child options. * * This class is private and not directly accessible by user code. */ @@ -4563,7 +4563,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * the form section element. * * The default implementation always returns `true`. User code or - * classes extending `AbstractSection` may overwrite this function with + * classes extending `AbstractSection` may override this function with * custom implementations. * * @abstract @@ -4587,7 +4587,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * @returns {Promise<void>} * Returns a promise resolving once the values of all child elements have * been loaded. The promise may reject with an error if any of the child - * elements load functions rejected with an error. + * elements' load functions rejected with an error. */ load() { const section_ids = this.cfgsections(); @@ -4615,8 +4615,8 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * @returns {Promise<void>} * Returns a promise resolving once the values of all child elements have - * been parsed. The returned promise is rejected if any parsed values are - * not meeting the validation constraints of their respective elements. + * been parsed. The returned promise is rejected if any parsed values do + * not meet the validation constraints of their respective elements. */ parse() { const section_ids = this.cfgsections(); @@ -4755,7 +4755,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * This function is sensitive to the amount of arguments passed to it; * if only one argument is specified, the configuration values of all - * options within this section are returned as dictionary. + * options within this section are returned as a dictionary. * * If both the section ID and an option name are supplied, this function * returns the configuration value of the specified option only. @@ -4788,7 +4788,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * 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 dictionary. + * options within this section are returned as a dictionary. * * If both the section ID and an option name are supplied, this function * returns the widget input value of the specified option only. @@ -4824,7 +4824,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * This function is sensitive to the amount of arguments passed to it; * if only one argument is specified, the LuCI.ui widget instances of all - * options within this section are returned as dictionary. + * options within this section are returned as a dictionary. * * If both the section ID and an option name are supplied, this function * returns the LuCI.ui widget instance value of the specified option only. @@ -4857,7 +4857,7 @@ const CBIAbstractSection = CBIAbstractElement.extend(/** @lends LuCI.form.Abstra * * This function is sensitive to the amount of arguments passed to it; * if no option name is specified, all options within this section are - * returned as dictionary. + * returned as a dictionary. * * If an option name is supplied, this function returns the matching * LuCI.form.AbstractValue instance only. @@ -5117,7 +5117,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * By default, the configuration name is inherited from the parent Map. * By setting this property, a deviating configuration may be specified. * - * The default is null, means inheriting from the parent form. + * The default of null means inherit from the parent form. * * @name LuCI.form.AbstractValue.prototype#uciconfig * @type string @@ -5130,7 +5130,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * By default, the section ID is inherited from the parent section element. * By setting this property, a deviating section may be specified. * - * The default is null, means inheriting from the parent section. + * The default of null means inherit from the parent section. * * @name LuCI.form.AbstractValue.prototype#ucisection * @type string @@ -5144,7 +5144,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * the constructor, is used as UCI option name. By setting this property, * a deviating UCI option may be specified. * - * The default is null, means using the option element name. + * The default of null means use the option element name. * * @name LuCI.form.AbstractValue.prototype#ucioption * @type string @@ -5157,7 +5157,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * 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 - * is rendered as full input widget within its cell instead of a text only + * is rendered as a full input widget within its cell instead of a text only * preview. * * This property has no effect on options that are not children of grid @@ -5190,8 +5190,8 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * This property defaults to the readonly state of the parent form element. * When set to `true`, the underlying widget is rendered in disabled state, - * means its contents cannot be changed and the widget cannot be interacted - * with. + * meaning its contents cannot be changed and the widget cannot be + * interacted with. * * @name LuCI.form.AbstractValue.prototype#readonly * @type boolean @@ -5217,8 +5217,8 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract /** * Register a custom value change handler. * - * If this property is set to a function value, the function is invoked - * whenever the value of the underlying UI input element is changing. + * If this property is set to a function, it is invoked + * whenever the value of the underlying UI input element changes. * * The invoked handler function will receive the DOM click element as * first and the underlying configuration section ID as well as the input @@ -5235,13 +5235,13 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * Dependency constraints allow making the presence of option elements * dependent on the current values of certain other options within the * same form. An option element with unsatisfied dependencies will be - * hidden from the view and its current value is omitted when saving. + * 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 - * possible to depend on multiple options simultaneously, allowing to form + * possible to depend on multiple options simultaneously, forming * a logical "and" expression. * * Option names may be given in "dot notation" which allows to reference @@ -5453,8 +5453,8 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * The default implementation of this method reads and returns the * underlying UCI option value (or the related JavaScript property for - * `JSONMap` instances). It may be overwritten by user code to load data - * from nonstandard sources. + * `JSONMap` instances). It may be overridden by user code to load data + * from non-standard sources. * * @param {string} section_id * The configuration section ID @@ -5501,7 +5501,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * The default implementation of this method returns the cached return * value of [load()]{@link LuCI.form.AbstractValue#load}. It may be - * overwritten by user code to obtain the configuration value in a + * overridden by user code to obtain the configuration value in a * different way. * * @param {string} section_id @@ -5530,7 +5530,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * The default implementation of this method returns the current input * value of the underlying [LuCI.ui]{@link LuCI.ui.AbstractElement} widget. - * It may be overwritten by user code to handle input values differently. + * It may be overridden by user code to handle input values differently. * * @param {string} section_id * The configuration section ID @@ -5549,10 +5549,10 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract /** * Obtain a textual input representation. * - * The default implementation of this method returns the HTML escaped + * The default implementation of this method returns the HTML-escaped * current input value of the underlying * [LuCI.ui]{@link LuCI.ui.AbstractElement} widget. User code or specific - * option element implementations may overwrite this function to apply a + * option element implementations may override this function to apply a * different logic, e.g. to return `Yes` or `No` depending on the checked * state of checkbox elements. * @@ -5584,7 +5584,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * the user input, e.g. on keyup or blur events. * * The default implementation of this method does nothing and always - * returns `true`. User code may overwrite this method to provide + * returns `true`. User code may override this method to provide * additional validation logic which is not covered by data type * constraints. * @@ -5734,7 +5734,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * The default implementation simply sets the given input value in the * UCI configuration (or the associated JavaScript object property in - * case of `JSONMap` forms). It may be overwritten by user code to + * case of `JSONMap` forms). It may be overridden by user code to * implement alternative save logic, e.g. to transform the input value * before it is written. * @@ -5761,7 +5761,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * * The default implementation simply removes the associated option from the * UCI configuration (or the associated JavaScript object property in - * case of `JSONMap` forms). It may be overwritten by user code to + * case of `JSONMap` forms). It may be overridden by user code to * implement alternative removal logic, e.g. to retain the original value. * * @param {string} section_id @@ -5804,7 +5804,7 @@ const CBIAbstractValue = CBIAbstractElement.extend(/** @lends LuCI.form.Abstract * @hideconstructor * @classdesc * - * The `TypedSection` class maps all or - if `filter()` is overwritten - a + * The `TypedSection` class maps all or - if `filter()` is overridden - a * subset of the underlying UCI configuration sections of a given type. * * Layout wise, the configuration section instances mapped by the section @@ -5831,7 +5831,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect /** * If set to `true`, the user may add or remove instances from the form - * section widget, otherwise only preexisting sections may be edited. + * section widget, otherwise only pre-existing sections may be edited. * The default is `false`. * * @name LuCI.form.TypedSection.prototype#addremove @@ -5863,8 +5863,8 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect /** * Override the caption used for the section add button at the bottom of - * the section form element. If set to a string, it will be used as-is, - * if set to a function, the function will be invoked and its return value + * 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 not set, the default is `Add`. * @@ -5877,7 +5877,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect * Override the UCI configuration name to read the section IDs from. By * default, the configuration name is inherited from the parent `Map`. * By setting this property, a deviating configuration may be specified. - * The default is `null`, means inheriting from the parent form. + * The default of `null` means inherit from the parent form. * * @name LuCI.form.TypedSection.prototype#uciconfig * @type string @@ -6043,7 +6043,7 @@ const CBITypedSection = CBIAbstractSection.extend(/** @lends LuCI.form.TypedSect * @hideconstructor * @classdesc * - * The `TableSection` class maps all or - if `filter()` is overwritten - a + * The `TableSection` class maps all or - if `filter()` is overridden - a * subset of the underlying UCI configuration sections of a given type. * * Layout wise, the configuration section instances mapped by the section @@ -6070,11 +6070,11 @@ 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. If set to a - * string, it will be used as `String.format()` pattern with the name of - * the underlying UCI section as first argument, if set to a function, the + * 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 is used as caption, after converting it to a string. + * its return value used as caption, after converting it to a string. * If this property is not set, the default is the name of the underlying * UCI configuration section. * @@ -6085,9 +6085,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`. If set - * to a string, it will be used as `String.format()` pattern with the name - * of the underlying UCI section as first argument, if set to a function, + * 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. * If this property is not set, the default is the name of the underlying @@ -6113,7 +6113,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection */ /** - * If set to `true`, alternating `cbi-rowstyle-1` and `cbi-rowstyle-2` CSS + * Set to `true`, alternating `cbi-rowstyle-1` and `cbi-rowstyle-2` CSS * classes are added to the table row elements. Not all LuCI themes * implement these row style classes. The default is `false`. * @@ -6134,9 +6134,9 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection /** * Enables a per-section instance row `Edit` button which triggers a certain - * action when clicked. If set to a string, the string value is used - * as `String.format()` pattern with the name of the underlying UCI section - * as first format argument. The result is then interpreted as URL which + * 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 * LuCI will navigate to when the user clicks the edit button. * * If set to a function, this function will be registered as click event @@ -6149,7 +6149,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection */ /** - * If set to `true`, a sort button is added to the last column, allowing + * Set to `true`, a sort button is added to the last column, allowing * the user to reorder the section instances mapped by the section form * element. * @@ -6159,7 +6159,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection */ /** - * If set to `true`, the header row with the options descriptions will + * Set to `true`, the header row with the options descriptions will * not be displayed. By default, descriptions row is automatically displayed * when at least one option has a description. * @@ -6802,7 +6802,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection /** * Add further options to the per-section instanced modal popup. * - * This function may be overwritten by user code to perform additional + * This function may be overridden by user code to perform additional * setup steps before displaying the more options modal which is useful to * e.g. query additional data or to inject further option elements. * @@ -6982,7 +6982,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * @hideconstructor * @classdesc * - * The `GridSection` class maps all or - if `filter()` is overwritten - a + * The `GridSection` class maps all or - if `filter()` is overridden - a * subset of the underlying UCI configuration sections of a given type. * * A grid section functions similar to a {@link LuCI.form.TableSection} but @@ -6993,7 +6993,7 @@ const CBITableSection = CBITypedSection.extend(/** @lends LuCI.form.TableSection * * Another important difference is that the table cells show a readonly text * preview of the corresponding option elements by default, unless the child - * option element is explicitly made writable by setting the `editable` + * option element is explicitly made writeable by setting the `editable` * property to `true`. * * Additionally, the grid section honours a `modalonly` property of child @@ -7025,7 +7025,7 @@ const CBIGridSection = CBITableSection.extend(/** @lends LuCI.form.GridSection.p * Before options can be moved into a tab pane, the corresponding tab * has to be defined first, which is done by calling this function. * - * Note that tabs are only effective in modal popups, options added with + * Note that tabs are only effective in modal popups. Options added with * `option()` will not be assigned to a specific tab and are rendered in * the table view only. * @@ -7188,9 +7188,9 @@ const CBINamedSection = CBIAbstractSection.extend(/** @lends LuCI.form.NamedSect }, /** - * If set to `true`, the user may remove or recreate the sole mapped + * Set to `true`, the user may remove or recreate the sole mapped * configuration instance from the form section widget, otherwise only a - * preexisting section may be edited. The default is `false`. + * pre-existing section may be edited. The default is `false`. * * @name LuCI.form.NamedSection.prototype#addremove * @type boolean @@ -7201,7 +7201,7 @@ const CBINamedSection = CBIAbstractSection.extend(/** @lends LuCI.form.NamedSect * Override the UCI configuration name to read the section IDs from. By * default, the configuration name is inherited from the parent `Map`. * By setting this property, a deviating configuration may be specified. - * The default is `null`, means inheriting from the parent form. + * The default of `null` means inherit from the parent form. * * @name LuCI.form.NamedSection.prototype#uciconfig * @type string @@ -7209,7 +7209,7 @@ const CBINamedSection = CBIAbstractSection.extend(/** @lends LuCI.form.NamedSect */ /** - * The `NamedSection` class overwrites the generic `cfgsections()` + * 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. * @@ -7338,8 +7338,8 @@ const CBIValue = CBIAbstractValue.extend(/** @lends LuCI.form.Value.prototype */ __name__: 'CBI.Value', /** - * If set to `true`, the field is rendered as password input, otherwise - * as plain text input. + * If set to `true`, the field is rendered as a password input, otherwise + * as a plain text input. * * @name LuCI.form.Value.prototype#password * @type boolean @@ -7522,7 +7522,7 @@ const CBIValue = CBIAbstractValue.extend(/** @lends LuCI.form.Value.prototype */ * @hideconstructor * @classdesc * - * The `DynamicList` class represents a multi value widget allowing the user + * The `DynamicList` class represents a multi-value widget allowing the user * to enter multiple unique values, optionally selected from a set of * predefined choices. It builds upon the {@link LuCI.ui.DynamicList} widget. * @@ -7864,9 +7864,9 @@ const CBIFlagValue = CBIValue.extend(/** @lends LuCI.form.FlagValue.prototype */ /** * Set a tooltip for the flag option. * - * If set to a string, it will be used as-is as a tooltip. + * Set to a string, it will be used as-is as a tooltip. * - * If set to a function, the function will be invoked and the return + * Set to a function, the function will be invoked and the return * value will be shown as a tooltip. If the return value of the function * is `null` no tooltip will be set. * @@ -8011,7 +8011,7 @@ const CBIMultiValue = CBIDynamicList.extend(/** @lends LuCI.form.MultiValue.prot /** * Allows to specify 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 unspecified as well. + * the `size` property is used or `3` when `size` is also unspecified. * * @name LuCI.form.MultiValue.prototype#display_size * @type number @@ -8021,7 +8021,7 @@ const CBIMultiValue = CBIDynamicList.extend(/** @lends LuCI.form.MultiValue.prot /** * Allows to specify 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 unspecified as well. + * the `size` property is used or `-1` when `size` is also unspecified. * * @name LuCI.form.MultiValue.prototype#dropdown_size * @type number @@ -8150,7 +8150,7 @@ const CBITextValue = CBIValue.extend(/** @lends LuCI.form.TextValue.prototype */ * @hideconstructor * @classdesc * - * The `DummyValue` element wraps an {@link LuCI.ui.Hiddenfield} widget and + * The `DummyValue` element wraps a {@link LuCI.ui.Hiddenfield} widget and * renders the underlying UCI option or default value as readonly text. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form @@ -8201,9 +8201,10 @@ const CBIDummyValue = CBIValue.extend(/** @lends LuCI.form.DummyValue.prototype */ /** - * Render the UCI option value as hidden using the HTML display: none style property. + * Render the UCI option value as hidden using the HTML 'display: none' + * style property. * - * By default, the value is displayed + * By default, the value is displayed. * * @name LuCI.form.DummyValue.prototype#hidden * @type boolean @@ -8214,7 +8215,8 @@ const CBIDummyValue = CBIValue.extend(/** @lends LuCI.form.DummyValue.prototype renderWidget(section_id, option_index, cfgvalue) { const value = (cfgvalue != null) ? cfgvalue : this.default; const hiddenEl = new ui.Hiddenfield(value, { id: this.cbid(section_id) }); - const outputEl = E('div', { 'style': this.hidden ? 'display:none' : null }); + const outputEl = E('output', { 'style': this.hidden ? 'display:none' : null, + 'for': this.cbid(section_id)}); if (this.href && !((this.readonly != null) ? this.readonly : this.map.readonly)) outputEl.appendChild(E('a', { 'href': this.href })); @@ -8242,7 +8244,7 @@ const CBIDummyValue = CBIValue.extend(/** @lends LuCI.form.DummyValue.prototype * @hideconstructor * @classdesc * - * The `DummyValue` element wraps an {@link LuCI.ui.Hiddenfield} widget and + * The `ButtonValue` element wraps a {@link LuCI.ui.Hiddenfield} widget and * renders the underlying UCI option or default value as readonly text. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form @@ -8274,13 +8276,13 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp * * By default, the option title - which is passed as fourth argument to the * constructor - is used as caption for the button element. When setting - * this property to a string, it is used as `String.format()` pattern with + * 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 * and the resulting return value is converted to a string before being * used as button caption. * - * The default is `null`, means the option title is used as caption. + * The default of `null` means the option title is used as caption. * * @name LuCI.form.ButtonValue.prototype#inputtitle * @type string|function @@ -8296,7 +8298,7 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp * Suitable values which are implemented by most themes are `positive`, * `negative` and `primary`. * - * The default is `null`, means a neutral button styling is used. + * The default of `null` means a neutral button styling is used. * * @name LuCI.form.ButtonValue.prototype#inputstyle * @type string @@ -8324,7 +8326,7 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp renderWidget(section_id, option_index, cfgvalue) { const value = (cfgvalue != null) ? cfgvalue : this.default; const hiddenEl = new ui.Hiddenfield(value, { id: this.cbid(section_id) }); - const outputEl = E('div'); + const outputEl = E('output', {'for': this.cbid(section_id)}); const btn_title = this.titleFn('inputtitle', section_id) ?? this.titleFn('title', section_id); if (value !== false) @@ -8358,7 +8360,7 @@ const CBIButtonValue = CBIValue.extend(/** @lends LuCI.form.ButtonValue.prototyp * @hideconstructor * @classdesc * - * The `HiddenValue` element wraps an {@link LuCI.ui.Hiddenfield} widget. + * The `HiddenValue` element wraps a {@link LuCI.ui.Hiddenfield} widget. * * Hidden value widgets used to be necessary in legacy code which actually * submitted the underlying HTML form the server. With client side handling of @@ -8409,7 +8411,7 @@ const CBIHiddenValue = CBIValue.extend(/** @lends LuCI.form.HiddenValue.prototyp * @hideconstructor * @classdesc * - * The `FileUpload` element wraps an {@link LuCI.ui.FileUpload} widget and + * The `FileUpload` element wraps a {@link LuCI.ui.FileUpload} widget and * offers the ability to browse, upload and select remote files. * * @param {LuCI.form.Map|LuCI.form.JSONMap} form @@ -8460,10 +8462,10 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype * Toggle display of hidden files. * * Display hidden files when rendering the remote directory listing. - * Note that this is merely a cosmetic feature, hidden files are always + * Note that this is merely a cosmetic feature: hidden files are always * included in received remote file listings. * - * The default is `false`, means hidden files are not displayed. + * The default of `false` means hidden files are not displayed. * * @name LuCI.form.FileUpload.prototype#show_hidden * @type boolean @@ -8475,10 +8477,10 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype * * When set to `true`, the underlying widget provides a button which lets * the user select and upload local files to the remote system. - * Note that this is merely a cosmetic feature, remote upload access is + * Note that this is merely a cosmetic feature: remote upload access is * controlled by the session ACL rules. * - * The default is `true`, means file upload functionality is displayed. + * The default of `true` means file upload functionality is displayed. * * @name LuCI.form.FileUpload.prototype#enable_upload * @type boolean @@ -8490,7 +8492,7 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype * * When set to `true`, the underlying widget provides a 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 + * a cosmetic feature: remote delete permissions are controlled by the * session ACL rules. * * The default is `true`, means file removal buttons are displayed. @@ -8512,8 +8514,8 @@ const CBIFileUpload = CBIValue.extend(/** @lends LuCI.form.FileUpload.prototype * Specify the root directory for file browsing. * * This property defines the topmost directory the file browser widget may - * navigate to, the UI will not allow browsing directories outside this - * prefix. Note that this is merely a cosmetic feature, remote file access + * navigate to. The UI will not allow browsing directories outside this + * prefix. Note that this is merely a cosmetic feature: remote file access * and directory listing permissions are controlled by the session ACL * rules. * @@ -8745,7 +8747,7 @@ return baseclass.extend(/** @lends LuCI.form.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/fs.js.html b/jsapi/fs.js.html index e758215438..1d3d4eaa10 100644 --- a/jsapi/fs.js.html +++ b/jsapi/fs.js.html @@ -4123,7 +4123,7 @@ return FileSystem;
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/index.html b/jsapi/index.html index f9978fff40..667a435dc9 100644 --- a/jsapi/index.html +++ b/jsapi/index.html @@ -3710,7 +3710,7 @@ is the central JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time) diff --git a/jsapi/luci.js.html b/jsapi/luci.js.html index c02fd0ddd6..db003ae5e3 100644 --- a/jsapi/luci.js.html +++ b/jsapi/luci.js.html @@ -7119,7 +7119,7 @@
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/network.js.html b/jsapi/network.js.html index f4a40f6eb2..4b4589e841 100644 --- a/jsapi/network.js.html +++ b/jsapi/network.js.html @@ -8232,7 +8232,7 @@ return Network;
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/rpc.js.html b/jsapi/rpc.js.html index d7981583b2..5bd2b43061 100644 --- a/jsapi/rpc.js.html +++ b/jsapi/rpc.js.html @@ -4179,7 +4179,7 @@ return baseclass.extend(/** @lends LuCI.rpc.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/uci.js.html b/jsapi/uci.js.html index d5e2745cf0..c9984a203a 100644 --- a/jsapi/uci.js.html +++ b/jsapi/uci.js.html @@ -4753,7 +4753,7 @@ return baseclass.extend(/** @lends LuCI.uci.prototype */ {
- Documentation generated by JSDoc 3.6.11 on Mon Jun 02 2025 19:03:24 GMT+0000 (Coordinated Universal Time) + Documentation generated by JSDoc 3.6.11 on Mon Jun 09 2025 22:45:27 GMT+0000 (Coordinated Universal Time)
diff --git a/jsapi/ui.js.html b/jsapi/ui.js.html index f188305bfa..2d1a1c0f85 100644 --- a/jsapi/ui.js.html +++ b/jsapi/ui.js.html @@ -8877,7 +8877,7 @@ return UI;