Class: NamedSection

LuCI.form. NamedSection

The NamedSection class maps exactly one UCI section instance which is specified when constructing the class instance.

Layout and functionality wise, a named section is essentially a TypedSection which allows exactly one section node.

new LuCI.form.NamedSection(form, section_id, section_type, title, description)

form.js, line 3469
Name Type Description
form LuCI.form.Map | LuCI.form.JSONMap

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

The name (ID) of the UCI section to map.
section_type string

The type of the UCI section to map.
title string optional

The title caption of the form section element.
description string optional

The description text of the form section element.

Extends

Members

addremoveboolean

If 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.

Default Value:
  • false

uciconfigstring

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.

Default Value:
  • null

readonlyparentoptionLuCI.form.AbstractValue

Access the parent option container instance.

In case this section is nested within an option element container, this property will hold a reference to the parent option instance.

If this section is not nested, the property is null.

Methods

inherited append(obj)

form.js, line 212

Add another form element as children to this element.

Name Type Description
obj AbstractElement

The form element to add.

cfgsections(){Array.<string>}

form.js, line 3535

The NamedSection class overwrites 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.

Returns:
Type Description
Array.<string> Returns a one-element array containing the mapped section ID.

inherited cfgvalue(section_id, option){null|string|Array.<string>|Object.<string, (null|string|Array.<string>)>}

form.js, line 1090

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.

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

Name Type Description
section_id string

The configuration section ID
option string optional

The name of the option to query
Returns:
Type Description
null | string | Array.<string> | Object.<string, (null|string|Array.<string>)> Returns either a dictionary of option names and their corresponding configuration values or just a single configuration value, depending on the amount of passed arguments.

inherited abstractfilter(section_id){boolean}

form.js, line 893

Filter UCI section IDs to render.

The filter function is invoked for each UCI section ID of a given type 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 custom implementations.

Name Type Description
section_id string

The UCI section ID to test.
Returns:
Type Description
boolean Returns true when the given UCI section ID should be handled and false when it should be ignored.

inherited formvalue(section_id, option){null|string|Array.<string>|Object.<string, (null|string|Array.<string>)>}

form.js, line 1123

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.

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

Name Type Description
section_id string

The configuration section ID
option string optional

The name of the option to query
Returns:
Type Description
null | string | Array.<string> | Object.<string, (null|string|Array.<string>)> Returns either a dictionary of option names and their corresponding widget input values or just a single widget input value, depending on the amount of passed arguments.

inherited getOption(option){null|LuCI.form.AbstractValue|Object.<string, LuCI.form.AbstractValue>}

form.js, line 1189

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.

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

Name Type Description
option string optional

The name of the option object to obtain
Returns:
Type Description
null | LuCI.form.AbstractValue | Object.<string, LuCI.form.AbstractValue> Returns either a dictionary of option names and their corresponding option instance objects or just a single object instance value, depending on the amount of passed arguments.

inherited getUIElement(section_id, option){null|LuCI.ui.AbstractElement|Object.<string, (null|LuCI.ui.AbstractElement)>}

form.js, line 1159

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.

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.

Name Type Description
section_id string

The configuration section ID
option string optional

The name of the option to query
Returns:
Type Description
null | LuCI.ui.AbstractElement | Object.<string, (null|LuCI.ui.AbstractElement)> Returns either a dictionary of option names and their corresponding widget input values or just a single widget input value, depending on the amount of passed arguments.

inherited load(){Promise.<void>}

form.js, line 908

Load the configuration covered by this section.

The load() function recursively walks the section element tree and invokes the load function of each child option element.

Returns:
Type Description
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.

inherited option(optionclass, classargs){LuCI.form.AbstractValue}

form.js, line 1021

Add a configuration option widget to the section.

Note that taboption() should be used instead if this form section element uses tabs.

Name Type Description
optionclass LuCI.form.AbstractValue

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained from calling new. It must also be a class derived from LuCI.form.AbstractSection.
classargs * repeatable

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.
Throws:

Throws a TypeError exception in case the passed class value is not a descendant of AbstractValue.

Type
TypeError
Returns:
Type Description
LuCI.form.AbstractValue Returns the instantiated option class instance.

inherited parse(){Promise.<void>}

form.js, line 937

Parse this sections form input.

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

Options which are hidden due to unsatisfied dependencies are skipped.

Returns:
Type Description
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.

inherited render(){Node|Promise.<Node>}

form.js, line 3610

Render the form element.

The render() function recursively walks the form element tree and renders the markup for each element, returning the assembled DOM tree.

Returns:
Type Description
Node | Promise.<Node> May return a DOM Node or a promise resolving to a DOM node containing the form element's markup, including the markup of any child elements.

inherited stripTags(s){string}

form.js, line 289

Strip any HTML tags from the given input string, and decode HTML entities.

Name Type Description
s string

The input string to clean.
Returns:
Type Description
string The cleaned input string with HTML tags removed, and HTML entities decoded.

inherited tab(name, title, description)

form.js, line 978

Add an option tab to the section.

The child option elements of a section may be divided into multiple 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 once tabs are defined, user code must use the taboption() method to add options to specific tabs. Option elements added by option() will not be assigned to any tab and not be rendered in this case.

Name Type Description
name string

The name of the tab to register. It may be freely chosen and just serves as an identifier to differentiate tabs.
title string

The human readable caption of the tab.
description string optional

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

Throws an exception if a tab with the same name already exists.

Type
Error

inherited taboption(tabName, optionclass, classargs){LuCI.form.AbstractValue}

form.js, line 1058

Add a configuration option widget to a tab of the section.

Name Type Description
tabName string

The name of the section tab to add the option element to.
optionclass LuCI.form.AbstractValue

The option class to use for rendering the configuration option. Note that this value must be the class itself, not a class instance obtained from calling new. It must also be a class derived from LuCI.form.AbstractSection.
classargs * repeatable

Additional arguments which are passed as-is to the constructor of the given option class. Refer to the class specific constructor documentation for details.
Throws:

  • Throws a ReferenceError exception when the given tab name does not exist.

    Type
    ReferenceError

  • Throws a TypeError exception in case the passed class value is not a descendant of AbstractValue.

    Type
    TypeError
Returns:
Type Description
LuCI.form.AbstractValue Returns the instantiated option class instance.

inherited titleFn(property, fmt_args){string|null}

form.js, line 328

Format the given named property as title string.

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

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

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

In all other cases, null is returned.

Name Type Description
property string

The name of the element property to use.
fmt_args * repeatable

Extra values to format the title string with.
Returns:
Type Description
string | null The formatted title string or null if the property did not exist or was neither a string nor a function.