10 var callSessionAccess
= rpc
.declare({
13 params
: [ 'scope', 'object', 'function' ],
14 expect
: { 'access': false }
17 var CBIJSONConfig
= baseclass
.extend({
18 __init__: function(data
) {
19 data
= Object
.assign({}, data
);
26 for (var sectiontype
in data
) {
27 if (!data
.hasOwnProperty(sectiontype
))
30 if (Array
.isArray(data
[sectiontype
])) {
31 for (var i
= 0, index
= 0; i
< data
[sectiontype
].length
; i
++) {
32 var item
= data
[sectiontype
][i
],
35 if (!L
.isObject(item
))
38 if (typeof(item
['.name']) == 'string') {
43 name
= sectiontype
+ num_sections
;
47 if (!this.data
.hasOwnProperty(name
))
48 section_ids
.push(name
);
50 this.data
[name
] = Object
.assign(item
, {
51 '.index': num_sections
++,
52 '.anonymous': anonymous
,
58 else if (L
.isObject(data
[sectiontype
])) {
59 this.data
[sectiontype
] = Object
.assign(data
[sectiontype
], {
65 section_ids
.push(sectiontype
);
70 section_ids
.sort(L
.bind(function(a
, b
) {
71 var indexA
= (this.data
[a
]['.index'] != null) ? +this.data
[a
]['.index'] : 9999,
72 indexB
= (this.data
[b
]['.index'] != null) ? +this.data
[b
]['.index'] : 9999;
75 return (indexA
- indexB
);
80 for (var i
= 0; i
< section_ids
.length
; i
++)
81 this.data
[section_ids
[i
]]['.index'] = i
;
85 return Promise
.resolve(this.data
);
89 return Promise
.resolve();
92 get: function(config
, section
, option
) {
97 return this.data
[section
];
99 if (!this.data
.hasOwnProperty(section
))
102 var value
= this.data
[section
][option
];
104 if (Array
.isArray(value
))
108 return String(value
);
113 set: function(config
, section
, option
, value
) {
114 if (section
== null || option
== null || option
.charAt(0) == '.')
117 if (!this.data
.hasOwnProperty(section
))
121 delete this.data
[section
][option
];
122 else if (Array
.isArray(value
))
123 this.data
[section
][option
] = value
;
125 this.data
[section
][option
] = String(value
);
128 unset: function(config
, section
, option
) {
129 return this.set(config
, section
, option
, null);
132 sections: function(config
, sectiontype
, callback
) {
135 for (var section_id
in this.data
)
136 if (sectiontype
== null || this.data
[section_id
]['.type'] == sectiontype
)
137 rv
.push(this.data
[section_id
]);
139 rv
.sort(function(a
, b
) { return a
['.index'] - b
['.index'] });
141 if (typeof(callback
) == 'function')
142 for (var i
= 0; i
< rv
.length
; i
++)
143 callback
.call(this, rv
[i
], rv
[i
]['.name']);
148 add: function(config
, sectiontype
, sectionname
) {
149 var num_sections_type
= 0, next_index
= 0;
151 for (var name
in this.data
) {
152 num_sections_type
+= (this.data
[name
]['.type'] == sectiontype
);
153 next_index
= Math
.max(next_index
, this.data
[name
]['.index']);
156 var section_id
= sectionname
|| sectiontype
+ num_sections_type
;
158 if (!this.data
.hasOwnProperty(section_id
)) {
159 this.data
[section_id
] = {
161 '.type': sectiontype
,
162 '.anonymous': (sectionname
== null),
163 '.index': next_index
+ 1
170 remove: function(config
, section
) {
171 if (this.data
.hasOwnProperty(section
))
172 delete this.data
[section
];
175 resolveSID: function(config
, section_id
) {
179 move: function(config
, section_id1
, section_id2
, after
) {
180 return uci
.move.apply(this, [config
, section_id1
, section_id2
, after
]);
185 * @class AbstractElement
186 * @memberof LuCI.form
190 * The `AbstractElement` class serves as abstract base for the different form
191 * elements implemented by `LuCI.form`. It provides the common logic for
192 * loading and rendering values, for nesting elements and for defining common
195 * This class is private and not directly accessible by user code.
197 var CBIAbstractElement
= baseclass
.extend(/** @lends LuCI.form.AbstractElement.prototype */ {
198 __init__: function(title
, description
) {
199 this.title
= title
|| '';
200 this.description
= description
|| '';
205 * Add another form element as children to this element.
207 * @param {AbstractElement} element
208 * The form element to add.
210 append: function(obj
) {
211 this.children
.push(obj
);
215 * Parse this elements form input.
217 * The `parse()` function recursively walks the form element tree and
218 * triggers input value reading and validation for each encountered element.
220 * Elements which are hidden due to unsatisified dependencies are skipped.
222 * @returns {Promise<void>}
223 * Returns a promise resolving once this element's value and the values of
224 * all child elements have been parsed. The returned promise is rejected
225 * if any parsed values are not meeting the validation constraints of their
226 * respective elements.
229 var args
= arguments
;
230 this.children
.forEach(function(child
) {
231 child
.parse
.apply(child
, args
);
236 * Render the form element.
238 * The `render()` function recursively walks the form element tree and
239 * renders the markup for each element, returning the assembled DOM tree.
242 * @returns {Node|Promise<Node>}
243 * May return a DOM Node or a promise resolving to a DOM node containing
244 * the form element's markup, including the markup of any child elements.
247 L
.error('InternalError', 'Not implemented');
251 loadChildren: function(/* ... */) {
254 if (Array
.isArray(this.children
))
255 for (var i
= 0; i
< this.children
.length
; i
++)
256 if (!this.children
[i
].disable
)
257 tasks
.push(this.children
[i
].load
.apply(this.children
[i
], arguments
));
259 return Promise
.all(tasks
);
263 renderChildren: function(tab_name
/*, ... */) {
267 if (Array
.isArray(this.children
))
268 for (var i
= 0; i
< this.children
.length
; i
++)
269 if (tab_name
=== null || this.children
[i
].tab
=== tab_name
)
270 if (!this.children
[i
].disable
)
271 tasks
.push(this.children
[i
].render
.apply(
272 this.children
[i
], this.varargs(arguments
, 1, index
++)));
274 return Promise
.all(tasks
);
278 * Strip any HTML tags from the given input string.
280 * @param {string} input
281 * The input string to clean.
284 * The cleaned input string with HTML removes removed.
286 stripTags: function(s
) {
287 if (typeof(s
) == 'string' && !s
.match(/[<>]/))
290 var x
= E('div', {}, s
);
291 return x
.textContent
|| x
.innerText
|| '';
295 * Format the given named property as title string.
297 * This function looks up the given named property and formats its value
298 * suitable for use as element caption or description string. It also
299 * strips any HTML tags from the result.
301 * If the property value is a string, it is passed to `String.format()`
302 * along with any additional parameters passed to `titleFn()`.
304 * If the property value is a function, it is invoked with any additional
305 * `titleFn()` parameters as arguments and the obtained return value is
306 * converted to a string.
308 * In all other cases, `null` is returned.
310 * @param {string} property
311 * The name of the element property to use.
313 * @param {...*} fmt_args
314 * Extra values to format the title string with.
316 * @returns {string|null}
317 * The formatted title string or `null` if the property did not exist or
318 * was neither a string nor a function.
320 titleFn: function(attr
/*, ... */) {
323 if (typeof(this[attr
]) == 'function')
324 s
= this[attr
].apply(this, this.varargs(arguments
, 1));
325 else if (typeof(this[attr
]) == 'string')
326 s
= (arguments
.length
> 1) ? ''.format
.apply(this[attr
], this.varargs(arguments
, 1)) : this[attr
];
329 s
= this.stripTags(String(s
)).trim();
331 if (s
== null || s
== '')
340 * @memberof LuCI.form
341 * @augments LuCI.form.AbstractElement
345 * The `Map` class represents one complete form. A form usually maps one UCI
346 * configuraton file and is divided into multiple sections containing multiple
349 * It serves as main entry point into the `LuCI.form` for typical view code.
351 * @param {string} config
352 * The UCI configuration to map. It is automatically loaded along when the
353 * resulting map instance.
355 * @param {string} [title]
356 * The title caption of the form. A form title is usually rendered as separate
357 * headline element before the actual form contents. If omitted, the
358 * corresponding headline element will not be rendered.
360 * @param {string} [description]
361 * The description text of the form which is usually rendered as text
362 * paragraph below the form title and before the actual form conents.
363 * If omitted, the corresponding paragraph element will not be rendered.
365 var CBIMap
= CBIAbstractElement
.extend(/** @lends LuCI.form.Map.prototype */ {
366 __init__: function(config
/*, ... */) {
367 this.super('__init__', this.varargs(arguments
, 1));
369 this.config
= config
;
370 this.parsechain
= [ config
];
375 * Toggle readonly state of the form.
377 * If set to `true`, the Map instance is marked readonly and any form
378 * option elements added to it will inherit the readonly state.
380 * If left unset, the Map will test the access permission of the primary
381 * uci configuration upon loading and mark the form readonly if no write
382 * permissions are granted.
384 * @name LuCI.form.Map.prototype#readonly
389 * Find all DOM nodes within this Map which match the given search
390 * parameters. This function is essentially a convenience wrapper around
391 * `querySelectorAll()`.
393 * This function is sensitive to the amount of arguments passed to it;
394 * if only one argument is specified, it is used as selector-expression
395 * as-is. When two arguments are passed, the first argument is treated
396 * as attribute name, the second one as attribute value to match.
398 * As an example, `map.findElements('input')` would find all `<input>`
399 * nodes while `map.findElements('type', 'text')` would find any DOM node
400 * with a `type="text"` attribute.
402 * @param {string} selector_or_attrname
403 * If invoked with only one parameter, this argument is a
404 * `querySelectorAll()` compatible selector expression. If invoked with
405 * two parameters, this argument is the attribute name to filter for.
407 * @param {string} [attrvalue]
408 * In case the function is invoked with two parameters, this argument
409 * specifies the attribute value to match.
411 * @throws {InternalError}
412 * Throws an `InternalError` if more than two function parameters are
415 * @returns {NodeList}
416 * Returns a (possibly empty) DOM `NodeList` containing the found DOM nodes.
418 findElements: function(/* ... */) {
421 if (arguments
.length
== 1)
423 else if (arguments
.length
== 2)
424 q
= '[%s="%s"]'.format(arguments
[0], arguments
[1]);
426 L
.error('InternalError', 'Expecting one or two arguments to findElements()');
428 return this.root
.querySelectorAll(q
);
432 * Find the first DOM node within this Map which matches the given search
433 * parameters. This function is essentially a convenience wrapper around
434 * `findElements()` which only returns the first found node.
436 * This function is sensitive to the amount of arguments passed to it;
437 * if only one argument is specified, it is used as selector-expression
438 * as-is. When two arguments are passed, the first argument is treated
439 * as attribute name, the second one as attribute value to match.
441 * As an example, `map.findElement('input')` would find the first `<input>`
442 * node while `map.findElement('type', 'text')` would find the first DOM
443 * node with a `type="text"` attribute.
445 * @param {string} selector_or_attrname
446 * If invoked with only one parameter, this argument is a `querySelector()`
447 * compatible selector expression. If invoked with two parameters, this
448 * argument is the attribute name to filter for.
450 * @param {string} [attrvalue]
451 * In case the function is invoked with two parameters, this argument
452 * specifies the attribute value to match.
454 * @throws {InternalError}
455 * Throws an `InternalError` if more than two function parameters are
458 * @returns {Node|null}
459 * Returns the first found DOM node or `null` if no element matched.
461 findElement: function(/* ... */) {
462 var res
= this.findElements
.apply(this, arguments
);
463 return res
.length
? res
[0] : null;
467 * Tie another UCI configuration to the map.
469 * By default, a map instance will only load the UCI configuration file
470 * specified in the constructor but sometimes access to values from
471 * further configuration files is required. This function allows for such
472 * use cases by registering further UCI configuration files which are
475 * @param {string} config
476 * The additional UCI configuration file to tie to the map. If the given
477 * config already is in the list of required files, it will be ignored.
479 chain: function(config
) {
480 if (this.parsechain
.indexOf(config
) == -1)
481 this.parsechain
.push(config
);
485 * Add a configuration section to the map.
487 * LuCI forms follow the structure of the underlying UCI configurations,
488 * means that a map, which represents a single UCI configuration, is
489 * divided into multiple sections which in turn contain an arbitrary
492 * While UCI itself only knows two kinds of sections - named and anonymous
493 * ones - the form class offers various flavors of form section elements
494 * to present configuration sections in different ways. Refer to the
495 * documentation of the different section classes for details.
497 * @param {LuCI.form.AbstractSection} sectionclass
498 * The section class to use for rendering the configuration section.
499 * Note that this value must be the class itself, not a class instance
500 * obtained from calling `new`. It must also be a class dervied from
501 * `LuCI.form.AbstractSection`.
503 * @param {...string} classargs
504 * Additional arguments which are passed as-is to the contructor of the
505 * given section class. Refer to the class specific constructor
506 * documentation for details.
508 * @returns {LuCI.form.AbstractSection}
509 * Returns the instantiated section class instance.
511 section: function(cbiClass
/*, ... */) {
512 if (!CBIAbstractSection
.isSubclass(cbiClass
))
513 L
.error('TypeError', 'Class must be a descendent of CBIAbstractSection');
515 var obj
= cbiClass
.instantiate(this.varargs(arguments
, 1, this));
521 * Load the configuration covered by this map.
523 * The `load()` function first loads all referenced UCI configurations,
524 * then it recursively walks the form element tree and invokes the
525 * load function of each child element.
527 * @returns {Promise<void>}
528 * Returns a promise resolving once the entire form completed loading all
529 * data. The promise may reject with an error if any configuration failed
530 * to load or if any of the child elements load functions rejected with
534 var doCheckACL
= (!(this instanceof CBIJSONMap
) && this.readonly
== null),
535 loadTasks
= [ doCheckACL
? callSessionAccess('uci', this.config
, 'write') : true ],
536 configs
= this.parsechain
|| [ this.config
];
538 loadTasks
.push
.apply(loadTasks
, configs
.map(L
.bind(function(config
, i
) {
539 return i
? L
.resolveDefault(this.data
.load(config
)) : this.data
.load(config
);
542 return Promise
.all(loadTasks
).then(L
.bind(function(res
) {
543 if (res
[0] === false)
544 this.readonly
= true;
546 return this.loadChildren();
551 * Parse the form input values.
553 * The `parse()` function recursively walks the form element tree and
554 * triggers input value reading and validation for each child element.
556 * Elements which are hidden due to unsatisified dependencies are skipped.
558 * @returns {Promise<void>}
559 * Returns a promise resolving once the entire form completed parsing all
560 * input values. The returned promise is rejected if any parsed values are
561 * not meeting the validation constraints of their respective elements.
566 if (Array
.isArray(this.children
))
567 for (var i
= 0; i
< this.children
.length
; i
++)
568 tasks
.push(this.children
[i
].parse());
570 return Promise
.all(tasks
);
574 * Save the form input values.
576 * This function parses the current form, saves the resulting UCI changes,
577 * reloads the UCI configuration data and redraws the form elements.
579 * @param {function} [cb]
580 * An optional callback function that is invoked after the form is parsed
581 * but before the changed UCI data is saved. This is useful to perform
582 * additional data manipulation steps before saving the changes.
584 * @param {boolean} [silent=false]
585 * If set to `true`, trigger an alert message to the user in case saving
586 * the form data failes. Otherwise fail silently.
588 * @returns {Promise<void>}
589 * Returns a promise resolving once the entire save operation is complete.
590 * The returned promise is rejected if any step of the save operation
593 save: function(cb
, silent
) {
598 .then(this.data
.save
.bind(this.data
))
599 .then(this.load
.bind(this))
602 ui
.showModal(_('Save error'), [
603 E('p', {}, [ _('An error occurred while saving the form:') ]),
604 E('p', {}, [ E('em', { 'style': 'white-space:pre' }, [ e
.message
]) ]),
605 E('div', { 'class': 'right' }, [
606 E('button', { 'class': 'btn', 'click': ui
.hideModal
}, [ _('Dismiss') ])
611 return Promise
.reject(e
);
612 }).then(this.renderContents
.bind(this));
616 * Reset the form by re-rendering its contents. This will revert all
617 * unsaved user inputs to their initial form state.
619 * @returns {Promise<Node>}
620 * Returns a promise resolving to the toplevel form DOM node once the
621 * re-rendering is complete.
624 return this.renderContents();
628 * Render the form markup.
630 * @returns {Promise<Node>}
631 * Returns a promise resolving to the toplevel form DOM node once the
632 * rendering is complete.
635 return this.load().then(this.renderContents
.bind(this));
639 renderContents: function() {
640 var mapEl
= this.root
|| (this.root
= E('div', {
641 'id': 'cbi-%s'.format(this.config
),
643 'cbi-dependency-check': L
.bind(this.checkDepends
, this)
646 dom
.bindClassInstance(mapEl
, this);
648 return this.renderChildren(null).then(L
.bind(function(nodes
) {
649 var initialRender
= !mapEl
.firstChild
;
651 dom
.content(mapEl
, null);
653 if (this.title
!= null && this.title
!= '')
654 mapEl
.appendChild(E('h2', { 'name': 'content' }, this.title
));
656 if (this.description
!= null && this.description
!= '')
657 mapEl
.appendChild(E('div', { 'class': 'cbi-map-descr' }, this.description
));
660 dom
.append(mapEl
, E('div', { 'class': 'cbi-map-tabbed' }, nodes
));
662 dom
.append(mapEl
, nodes
);
664 if (!initialRender
) {
665 mapEl
.classList
.remove('flash');
667 window
.setTimeout(function() {
668 mapEl
.classList
.add('flash');
674 var tabGroups
= mapEl
.querySelectorAll('.cbi-map-tabbed, .cbi-section-node-tabbed');
676 for (var i
= 0; i
< tabGroups
.length
; i
++)
677 ui
.tabs
.initTabGroup(tabGroups
[i
].childNodes
);
684 * Find a form option element instance.
686 * @param {string} name_or_id
687 * The name or the full ID of the option element to look up.
689 * @param {string} [section_id]
690 * The ID of the UCI section containing the option to look up. May be
691 * omitted if a full ID is passed as first argument.
693 * @param {string} [config]
694 * The name of the UCI configuration the option instance is belonging to.
695 * Defaults to the main UCI configuration of the map if omitted.
697 * @returns {Array<LuCI.form.AbstractValue,string>|null}
698 * Returns a two-element array containing the form option instance as
699 * first item and the corresponding UCI section ID as second item.
700 * Returns `null` if the option could not be found.
702 lookupOption: function(name
, section_id
, config_name
) {
703 var id
, elem
, sid
, inst
;
705 if (name
.indexOf('.') > -1)
706 id
= 'cbid.%s'.format(name
);
708 id
= 'cbid.%s.%s.%s'.format(config_name
|| this.config
, section_id
, name
);
710 elem
= this.findElement('data-field', id
);
711 sid
= elem
? id
.split(/\./)[2] : null;
712 inst
= elem
? dom
.findClassInstance(elem
) : null;
714 return (inst
instanceof CBIAbstractValue
) ? [ inst
, sid
] : null;
718 checkDepends: function(ev
, n
) {
721 for (var i
= 0, s
= this.children
[0]; (s
= this.children
[i
]) != null; i
++)
722 if (s
.checkDepends(ev
, n
))
725 if (changed
&& (n
|| 0) < 10)
726 this.checkDepends(ev
, (n
|| 10) + 1);
728 ui
.tabs
.updateTabs(ev
, this.root
);
732 isDependencySatisfied: function(depends
, config_name
, section_id
) {
735 if (!Array
.isArray(depends
) || !depends
.length
)
738 for (var i
= 0; i
< depends
.length
; i
++) {
740 reverse
= depends
[i
]['!reverse'],
741 contains
= depends
[i
]['!contains'];
743 for (var dep
in depends
[i
]) {
744 if (dep
== '!reverse' || dep
== '!contains') {
747 else if (dep
== '!default') {
752 var res
= this.lookupOption(dep
, section_id
, config_name
),
753 val
= (res
&& res
[0].isActive(res
[1])) ? res
[0].formvalue(res
[1]) : null;
756 ? isContained(val
, depends
[i
][dep
])
757 : isEqual(val
, depends
[i
][dep
]);
759 istat
= (istat
&& equal
);
772 * @constructor JSONMap
773 * @memberof LuCI.form
774 * @augments LuCI.form.Map
778 * A `JSONMap` class functions similar to [LuCI.form.Map]{@link LuCI.form.Map}
779 * but uses a multidimensional JavaScript object instead of UCI configuration
782 * @param {Object<string, Object<string, *>|Array<Object<string, *>>>} data
783 * The JavaScript object to use as data source. Internally, the object is
784 * converted into an UCI-like format. Its toplevel keys are treated like UCI
785 * section types while the object or array-of-object values are treated as
788 * @param {string} [title]
789 * The title caption of the form. A form title is usually rendered as separate
790 * headline element before the actual form contents. If omitted, the
791 * corresponding headline element will not be rendered.
793 * @param {string} [description]
794 * The description text of the form which is usually rendered as text
795 * paragraph below the form title and before the actual form conents.
796 * If omitted, the corresponding paragraph element will not be rendered.
798 var CBIJSONMap
= CBIMap
.extend(/** @lends LuCI.form.JSONMap.prototype */ {
799 __init__: function(data
/*, ... */) {
800 this.super('__init__', this.varargs(arguments
, 1, 'json'));
802 this.config
= 'json';
803 this.parsechain
= [ 'json' ];
804 this.data
= new CBIJSONConfig(data
);
809 * @class AbstractSection
810 * @memberof LuCI.form
811 * @augments LuCI.form.AbstractElement
815 * The `AbstractSection` class serves as abstract base for the different form
816 * section styles implemented by `LuCI.form`. It provides the common logic for
817 * enumerating underlying configuration section instances, for registering
818 * form options and for handling tabs to segment child options.
820 * This class is private and not directly accessible by user code.
822 var CBIAbstractSection
= CBIAbstractElement
.extend(/** @lends LuCI.form.AbstractSection.prototype */ {
823 __init__: function(map
, sectionType
/*, ... */) {
824 this.super('__init__', this.varargs(arguments
, 2));
826 this.sectiontype
= sectionType
;
828 this.config
= map
.config
;
830 this.optional
= true;
831 this.addremove
= false;
832 this.dynamic
= false;
836 * Access the parent option container instance.
838 * In case this section is nested within an option element container,
839 * this property will hold a reference to the parent option instance.
841 * If this section is not nested, the property is `null`.
843 * @name LuCI.form.AbstractSection.prototype#parentoption
844 * @type LuCI.form.AbstractValue
849 * Enumerate the UCI section IDs covered by this form section element.
852 * @throws {InternalError}
853 * Throws an `InternalError` exception if the function is not implemented.
855 * @returns {string[]}
856 * Returns an array of UCI section IDs covered by this form element.
857 * The sections will be rendered in the same order as the returned array.
859 cfgsections: function() {
860 L
.error('InternalError', 'Not implemented');
864 * Filter UCI section IDs to render.
866 * The filter function is invoked for each UCI section ID of a given type
867 * and controls whether the given UCI section is rendered or ignored by
868 * the form section element.
870 * The default implementation always returns `true`. User code or
871 * classes extending `AbstractSection` may overwrite this function with
872 * custom implementations.
875 * @param {string} section_id
876 * The UCI section ID to test.
879 * Returns `true` when the given UCI section ID should be handled and
880 * `false` when it should be ignored.
882 filter: function(section_id
) {
887 * Load the configuration covered by this section.
889 * The `load()` function recursively walks the section element tree and
890 * invokes the load function of each child option element.
892 * @returns {Promise<void>}
893 * Returns a promise resolving once the values of all child elements have
894 * been loaded. The promise may reject with an error if any of the child
895 * elements load functions rejected with an error.
898 var section_ids
= this.cfgsections(),
901 if (Array
.isArray(this.children
))
902 for (var i
= 0; i
< section_ids
.length
; i
++)
903 tasks
.push(this.loadChildren(section_ids
[i
])
904 .then(Function
.prototype.bind
.call(function(section_id
, set_values
) {
905 for (var i
= 0; i
< set_values
.length
; i
++)
906 this.children
[i
].cfgvalue(section_id
, set_values
[i
]);
907 }, this, section_ids
[i
])));
909 return Promise
.all(tasks
);
913 * Parse this sections form input.
915 * The `parse()` function recursively walks the section element tree and
916 * triggers input value reading and validation for each encountered child
919 * Options which are hidden due to unsatisified dependencies are skipped.
921 * @returns {Promise<void>}
922 * Returns a promise resolving once the values of all child elements have
923 * been parsed. The returned promise is rejected if any parsed values are
924 * not meeting the validation constraints of their respective elements.
927 var section_ids
= this.cfgsections(),
930 if (Array
.isArray(this.children
))
931 for (var i
= 0; i
< section_ids
.length
; i
++)
932 for (var j
= 0; j
< this.children
.length
; j
++)
933 tasks
.push(this.children
[j
].parse(section_ids
[i
]));
935 return Promise
.all(tasks
);
939 * Add an option tab to the section.
941 * The child option elements of a section may be divided into multiple
942 * tabs to provide a better overview to the user.
944 * Before options can be moved into a tab pane, the corresponding tab
945 * has to be defined first, which is done by calling this function.
947 * Note that once tabs are defined, user code must use the `taboption()`
948 * method to add options to specific tabs. Option elements added by
949 * `option()` will not be assigned to any tab and not be rendered in this
952 * @param {string} name
953 * The name of the tab to register. It may be freely chosen and just serves
954 * as an identifier to differentiate tabs.
956 * @param {string} title
957 * The human readable caption of the tab.
959 * @param {string} [description]
960 * An additional description text for the corresponding tab pane. It is
961 * displayed as text paragraph below the tab but before the tab pane
962 * contents. If omitted, no description will be rendered.
965 * Throws an exeption if a tab with the same `name` already exists.
967 tab: function(name
, title
, description
) {
968 if (this.tabs
&& this.tabs
[name
])
969 throw 'Tab already declared';
974 description
: description
,
978 this.tabs
= this.tabs
|| [];
979 this.tabs
.push(entry
);
980 this.tabs
[name
] = entry
;
982 this.tab_names
= this.tab_names
|| [];
983 this.tab_names
.push(name
);
987 * Add a configuration option widget to the section.
989 * Note that [taboption()]{@link LuCI.form.AbstractSection#taboption}
990 * should be used instead if this form section element uses tabs.
992 * @param {LuCI.form.AbstractValue} optionclass
993 * The option class to use for rendering the configuration option. Note
994 * that this value must be the class itself, not a class instance obtained
995 * from calling `new`. It must also be a class dervied from
996 * [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}.
998 * @param {...*} classargs
999 * Additional arguments which are passed as-is to the contructor of the
1000 * given option class. Refer to the class specific constructor
1001 * documentation for details.
1003 * @throws {TypeError}
1004 * Throws a `TypeError` exception in case the passed class value is not a
1005 * descendent of `AbstractValue`.
1007 * @returns {LuCI.form.AbstractValue}
1008 * Returns the instantiated option class instance.
1010 option: function(cbiClass
/*, ... */) {
1011 if (!CBIAbstractValue
.isSubclass(cbiClass
))
1012 throw L
.error('TypeError', 'Class must be a descendent of CBIAbstractValue');
1014 var obj
= cbiClass
.instantiate(this.varargs(arguments
, 1, this.map
, this));
1020 * Add a configuration option widget to a tab of the section.
1022 * @param {string} tabname
1023 * The name of the section tab to add the option element to.
1025 * @param {LuCI.form.AbstractValue} optionclass
1026 * The option class to use for rendering the configuration option. Note
1027 * that this value must be the class itself, not a class instance obtained
1028 * from calling `new`. It must also be a class dervied from
1029 * [LuCI.form.AbstractSection]{@link LuCI.form.AbstractSection}.
1031 * @param {...*} classargs
1032 * Additional arguments which are passed as-is to the contructor of the
1033 * given option class. Refer to the class specific constructor
1034 * documentation for details.
1036 * @throws {ReferenceError}
1037 * Throws a `ReferenceError` exception when the given tab name does not
1040 * @throws {TypeError}
1041 * Throws a `TypeError` exception in case the passed class value is not a
1042 * descendent of `AbstractValue`.
1044 * @returns {LuCI.form.AbstractValue}
1045 * Returns the instantiated option class instance.
1047 taboption: function(tabName
/*, ... */) {
1048 if (!this.tabs
|| !this.tabs
[tabName
])
1049 throw L
.error('ReferenceError', 'Associated tab not declared');
1051 var obj
= this.option
.apply(this, this.varargs(arguments
, 1));
1053 this.tabs
[tabName
].children
.push(obj
);
1058 * Query underlying option configuration values.
1060 * This function is sensitive to the amount of arguments passed to it;
1061 * if only one argument is specified, the configuration values of all
1062 * options within this section are returned as dictionary.
1064 * If both the section ID and an option name are supplied, this function
1065 * returns the configuration value of the specified option only.
1067 * @param {string} section_id
1068 * The configuration section ID
1070 * @param {string} [option]
1071 * The name of the option to query
1073 * @returns {null|string|string[]|Object<string, null|string|string[]>}
1074 * Returns either a dictionary of option names and their corresponding
1075 * configuration values or just a single configuration value, depending
1076 * on the amount of passed arguments.
1078 cfgvalue: function(section_id
, option
) {
1079 var rv
= (arguments
.length
== 1) ? {} : null;
1081 for (var i
= 0, o
; (o
= this.children
[i
]) != null; i
++)
1083 rv
[o
.option
] = o
.cfgvalue(section_id
);
1084 else if (o
.option
== option
)
1085 return o
.cfgvalue(section_id
);
1091 * Query underlying option widget input values.
1093 * This function is sensitive to the amount of arguments passed to it;
1094 * if only one argument is specified, the widget input values of all
1095 * options within this section are returned as dictionary.
1097 * If both the section ID and an option name are supplied, this function
1098 * returns the widget input value of the specified option only.
1100 * @param {string} section_id
1101 * The configuration section ID
1103 * @param {string} [option]
1104 * The name of the option to query
1106 * @returns {null|string|string[]|Object<string, null|string|string[]>}
1107 * Returns either a dictionary of option names and their corresponding
1108 * widget input values or just a single widget input value, depending
1109 * on the amount of passed arguments.
1111 formvalue: function(section_id
, option
) {
1112 var rv
= (arguments
.length
== 1) ? {} : null;
1114 for (var i
= 0, o
; (o
= this.children
[i
]) != null; i
++) {
1115 var func
= this.map
.root
? this.children
[i
].formvalue
: this.children
[i
].cfgvalue
;
1118 rv
[o
.option
] = func
.call(o
, section_id
);
1119 else if (o
.option
== option
)
1120 return func
.call(o
, section_id
);
1127 * Obtain underlying option LuCI.ui widget instances.
1129 * This function is sensitive to the amount of arguments passed to it;
1130 * if only one argument is specified, the LuCI.ui widget instances of all
1131 * options within this section are returned as dictionary.
1133 * If both the section ID and an option name are supplied, this function
1134 * returns the LuCI.ui widget instance value of the specified option only.
1136 * @param {string} section_id
1137 * The configuration section ID
1139 * @param {string} [option]
1140 * The name of the option to query
1142 * @returns {null|LuCI.ui.AbstractElement|Object<string, null|LuCI.ui.AbstractElement>}
1143 * Returns either a dictionary of option names and their corresponding
1144 * widget input values or just a single widget input value, depending
1145 * on the amount of passed arguments.
1147 getUIElement: function(section_id
, option
) {
1148 var rv
= (arguments
.length
== 1) ? {} : null;
1150 for (var i
= 0, o
; (o
= this.children
[i
]) != null; i
++)
1152 rv
[o
.option
] = o
.getUIElement(section_id
);
1153 else if (o
.option
== option
)
1154 return o
.getUIElement(section_id
);
1160 * Obtain underlying option objects.
1162 * This function is sensitive to the amount of arguments passed to it;
1163 * if no option name is specified, all options within this section are
1164 * returned as dictionary.
1166 * If an option name is supplied, this function returns the matching
1167 * LuCI.form.AbstractValue instance only.
1169 * @param {string} [option]
1170 * The name of the option object to obtain
1172 * @returns {null|LuCI.form.AbstractValue|Object<string, LuCI.form.AbstractValue>}
1173 * Returns either a dictionary of option names and their corresponding
1174 * option instance objects or just a single object instance value,
1175 * depending on the amount of passed arguments.
1177 getOption: function(option
) {
1178 var rv
= (arguments
.length
== 0) ? {} : null;
1180 for (var i
= 0, o
; (o
= this.children
[i
]) != null; i
++)
1183 else if (o
.option
== option
)
1190 renderUCISection: function(section_id
) {
1191 var renderTasks
= [];
1194 return this.renderOptions(null, section_id
);
1196 for (var i
= 0; i
< this.tab_names
.length
; i
++)
1197 renderTasks
.push(this.renderOptions(this.tab_names
[i
], section_id
));
1199 return Promise
.all(renderTasks
)
1200 .then(this.renderTabContainers
.bind(this, section_id
));
1204 renderTabContainers: function(section_id
, nodes
) {
1205 var config_name
= this.uciconfig
|| this.map
.config
,
1206 containerEls
= E([]);
1208 for (var i
= 0; i
< nodes
.length
; i
++) {
1209 var tab_name
= this.tab_names
[i
],
1210 tab_data
= this.tabs
[tab_name
],
1211 containerEl
= E('div', {
1212 'id': 'container.%s.%s.%s'.format(config_name
, section_id
, tab_name
),
1213 'data-tab': tab_name
,
1214 'data-tab-title': tab_data
.title
,
1215 'data-tab-active': tab_name
=== this.selected_tab
1218 if (tab_data
.description
!= null && tab_data
.description
!= '')
1219 containerEl
.appendChild(
1220 E('div', { 'class': 'cbi-tab-descr' }, tab_data
.description
));
1222 containerEl
.appendChild(nodes
[i
]);
1223 containerEls
.appendChild(containerEl
);
1226 return containerEls
;
1230 renderOptions: function(tab_name
, section_id
) {
1231 var in_table
= (this instanceof CBITableSection
);
1232 return this.renderChildren(tab_name
, section_id
, in_table
).then(function(nodes
) {
1233 var optionEls
= E([]);
1234 for (var i
= 0; i
< nodes
.length
; i
++)
1235 optionEls
.appendChild(nodes
[i
]);
1241 checkDepends: function(ev
, n
) {
1242 var changed
= false,
1243 sids
= this.cfgsections();
1245 for (var i
= 0, sid
= sids
[0]; (sid
= sids
[i
]) != null; i
++) {
1246 for (var j
= 0, o
= this.children
[0]; (o
= this.children
[j
]) != null; j
++) {
1247 var isActive
= o
.isActive(sid
),
1248 isSatisified
= o
.checkDepends(sid
);
1250 if (isActive
!= isSatisified
) {
1251 o
.setActive(sid
, !isActive
);
1252 isActive
= !isActive
;
1257 o
.triggerValidation(sid
);
1266 var isEqual = function(x
, y
) {
1267 if (typeof(y
) == 'object' && y
instanceof RegExp
)
1268 return (x
== null) ? false : y
.test(x
);
1270 if (x
!= null && y
!= null && typeof(x
) != typeof(y
))
1273 if ((x
== null && y
!= null) || (x
!= null && y
== null))
1276 if (Array
.isArray(x
)) {
1277 if (x
.length
!= y
.length
)
1280 for (var i
= 0; i
< x
.length
; i
++)
1281 if (!isEqual(x
[i
], y
[i
]))
1284 else if (typeof(x
) == 'object') {
1286 if (x
.hasOwnProperty(k
) && !y
.hasOwnProperty(k
))
1289 if (!isEqual(x
[k
], y
[k
]))
1294 if (y
.hasOwnProperty(k
) && !x
.hasOwnProperty(k
))
1304 var isContained = function(x
, y
) {
1305 if (Array
.isArray(x
)) {
1306 for (var i
= 0; i
< x
.length
; i
++)
1310 else if (L
.isObject(x
)) {
1311 if (x
.hasOwnProperty(y
) && x
[y
] != null)
1314 else if (typeof(x
) == 'string') {
1315 return (x
.indexOf(y
) > -1);
1322 * @class AbstractValue
1323 * @memberof LuCI.form
1324 * @augments LuCI.form.AbstractElement
1328 * The `AbstractValue` class serves as abstract base for the different form
1329 * option styles implemented by `LuCI.form`. It provides the common logic for
1330 * handling option input values, for dependencies among options and for
1331 * validation constraints that should be applied to entered values.
1333 * This class is private and not directly accessible by user code.
1335 var CBIAbstractValue
= CBIAbstractElement
.extend(/** @lends LuCI.form.AbstractValue.prototype */ {
1336 __init__: function(map
, section
, option
/*, ... */) {
1337 this.super('__init__', this.varargs(arguments
, 3));
1339 this.section
= section
;
1340 this.option
= option
;
1342 this.config
= map
.config
;
1346 this.rmempty
= true;
1347 this.default = null;
1349 this.optional
= false;
1353 * If set to `false`, the underlying option value is retained upon saving
1354 * the form when the option element is disabled due to unsatisfied
1355 * dependency constraints.
1357 * @name LuCI.form.AbstractValue.prototype#rmempty
1363 * If set to `true`, the underlying ui input widget is allowed to be empty,
1364 * otherwise the option element is marked invalid when no value is entered
1365 * or selected by the user.
1367 * @name LuCI.form.AbstractValue.prototype#optional
1373 * Sets a default value to use when the underlying UCI option is not set.
1375 * @name LuCI.form.AbstractValue.prototype#default
1381 * Specifies a datatype constraint expression to validate input values
1382 * against. Refer to {@link LuCI.validation} for details on the format.
1384 * If the user entered input does not match the datatype validation, the
1385 * option element is marked as invalid.
1387 * @name LuCI.form.AbstractValue.prototype#datatype
1393 * Specifies a custom validation function to test the user input for
1394 * validity. The validation function must return `true` to accept the
1395 * value. Any other return value type is converted to a string and
1396 * displayed to the user as validation error message.
1398 * If the user entered input does not pass the validation function, the
1399 * option element is marked as invalid.
1401 * @name LuCI.form.AbstractValue.prototype#validate
1407 * Override the UCI configuration name to read the option value from.
1409 * By default, the configuration name is inherited from the parent Map.
1410 * By setting this property, a deviating configuration may be specified.
1412 * The default is null, means inheriting from the parent form.
1414 * @name LuCI.form.AbstractValue.prototype#uciconfig
1420 * Override the UCI section name to read the option value from.
1422 * By default, the section ID is inherited from the parent section element.
1423 * By setting this property, a deviating section may be specified.
1425 * The default is null, means inheriting from the parent section.
1427 * @name LuCI.form.AbstractValue.prototype#ucisection
1433 * Override the UCI option name to read the value from.
1435 * By default, the elements name, which is passed as third argument to
1436 * the constructor, is used as UCI option name. By setting this property,
1437 * a deviating UCI option may be specified.
1439 * The default is null, means using the option element name.
1441 * @name LuCI.form.AbstractValue.prototype#ucioption
1447 * Mark grid section option element as editable.
1449 * Options which are displayed in the table portion of a `GridSection`
1450 * instance are rendered as readonly text by default. By setting the
1451 * `editable` property of a child option element to `true`, that element
1452 * is rendered as full input widget within its cell instead of a text only
1455 * This property has no effect on options that are not children of grid
1458 * @name LuCI.form.AbstractValue.prototype#editable
1464 * Move grid section option element into the table, the modal popup or both.
1466 * If this property is `null` (the default), the option element is
1467 * displayed in both the table preview area and the per-section instance
1468 * modal popup of a grid section. When it is set to `false` the option
1469 * is only shown in the table but not the modal popup. When set to `true`,
1470 * the option is only visible in the modal popup but not the table.
1472 * This property has no effect on options that are not children of grid
1475 * @name LuCI.form.AbstractValue.prototype#modalonly
1481 * Make option element readonly.
1483 * This property defaults to the readonly state of the parent form element.
1484 * When set to `true`, the underlying widget is rendered in disabled state,
1485 * means its contents cannot be changed and the widget cannot be interacted
1488 * @name LuCI.form.AbstractValue.prototype#readonly
1494 * Override the cell width of a table or grid section child option.
1496 * If the property is set to a numeric value, it is treated as pixel width
1497 * which is set on the containing cell element of the option, essentially
1498 * forcing a certain column width. When the property is set to a string
1499 * value, it is applied as-is to the CSS `width` property.
1501 * This property has no effect on options that are not children of grid or
1502 * table section elements.
1504 * @name LuCI.form.AbstractValue.prototype#width
1505 * @type number|string
1510 * Register a custom value change handler.
1512 * If this property is set to a function value, the function is invoked
1513 * whenever the value of the underlying UI input element is changing.
1515 * The invoked handler function will receive the DOM click element as
1516 * first and the underlying configuration section ID as well as the input
1517 * value as second and third argument respectively.
1519 * @name LuCI.form.AbstractValue.prototype#onchange
1525 * Add a dependency contraint to the option.
1527 * Dependency constraints allow making the presence of option elements
1528 * dependant on the current values of certain other options within the
1529 * same form. An option element with unsatisfied dependencies will be
1530 * hidden from the view and its current value is omitted when saving.
1532 * Multiple constraints (that is, multiple calls to `depends()`) are
1533 * treated as alternatives, forming a logical "or" expression.
1535 * By passing an object of name => value pairs as first argument, it is
1536 * possible to depend on multiple options simultaneously, allowing to form
1537 * a logical "and" expression.
1539 * Option names may be given in "dot notation" which allows to reference
1540 * option elements outside of the current form section. If a name without
1541 * dot is specified, it refers to an option within the same configuration
1542 * section. If specified as <code>configname.sectionid.optionname</code>,
1543 * options anywhere within the same form may be specified.
1545 * The object notation also allows for a number of special keys which are
1546 * not treated as option names but as modifiers to influence the dependency
1547 * constraint evaluation. The associated value of these special "tag" keys
1548 * is ignored. The recognized tags are:
1552 * <code>!reverse</code><br>
1553 * Invert the dependency, instead of requiring another option to be
1554 * equal to the dependency value, that option should <em>not</em> be
1558 * <code>!contains</code><br>
1559 * Instead of requiring an exact match, the dependency is considered
1560 * satisfied when the dependency value is contained within the option
1564 * <code>!default</code><br>
1565 * The dependency is always satisfied
1573 * <code>opt.depends("foo", "test")</code><br>
1574 * Require the value of `foo` to be `test`.
1577 * <code>opt.depends({ foo: "test" })</code><br>
1578 * Equivalent to the previous example.
1581 * <code>opt.depends({ foo: /test/ })</code><br>
1582 * Require the value of `foo` to match the regular expression `/test/`.
1585 * <code>opt.depends({ foo: "test", bar: "qrx" })</code><br>
1586 * Require the value of `foo` to be `test` and the value of `bar` to be
1590 * <code>opt.depends({ foo: "test" })<br>
1591 * opt.depends({ bar: "qrx" })</code><br>
1592 * Require either <code>foo</code> to be set to <code>test</code>,
1593 * <em>or</em> the <code>bar</code> option to be <code>qrx</code>.
1596 * <code>opt.depends("test.section1.foo", "bar")</code><br>
1597 * Require the "foo" form option within the "section1" section to be
1601 * <code>opt.depends({ foo: "test", "!contains": true })</code><br>
1602 * Require the "foo" option value to contain the substring "test".
1606 * @param {string|Object<string, string|RegExp>} optionname_or_depends
1607 * The name of the option to depend on or an object describing multiple
1608 * dependencies which must be satified (a logical "and" expression).
1610 * @param {string} optionvalue|RegExp
1611 * When invoked with a plain option name as first argument, this parameter
1612 * specifies the expected value. In case an object is passed as first
1613 * argument, this parameter is ignored.
1615 depends: function(field
, value
) {
1618 if (typeof(field
) === 'string')
1619 deps
= {}, deps
[field
] = value
;
1623 this.deps
.push(deps
);
1627 transformDepList: function(section_id
, deplist
) {
1628 var list
= deplist
|| this.deps
,
1631 if (Array
.isArray(list
)) {
1632 for (var i
= 0; i
< list
.length
; i
++) {
1635 for (var k
in list
[i
]) {
1636 if (list
[i
].hasOwnProperty(k
)) {
1637 if (k
.charAt(0) === '!')
1638 dep
[k
] = list
[i
][k
];
1639 else if (k
.indexOf('.') !== -1)
1640 dep
['cbid.%s'.format(k
)] = list
[i
][k
];
1642 dep
['cbid.%s.%s.%s'.format(
1643 this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
1644 this.ucisection
|| section_id
,
1650 for (var k
in dep
) {
1651 if (dep
.hasOwnProperty(k
)) {
1663 transformChoices: function() {
1664 if (!Array
.isArray(this.keylist
) || this.keylist
.length
== 0)
1669 for (var i
= 0; i
< this.keylist
.length
; i
++)
1670 choices
[this.keylist
[i
]] = this.vallist
[i
];
1676 checkDepends: function(section_id
) {
1677 var config_name
= this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
1678 active
= this.map
.isDependencySatisfied(this.deps
, config_name
, section_id
);
1681 this.updateDefaultValue(section_id
);
1687 updateDefaultValue: function(section_id
) {
1688 if (!L
.isObject(this.defaults
))
1691 var config_name
= this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
1692 cfgvalue
= L
.toArray(this.cfgvalue(section_id
))[0],
1693 default_defval
= null, satisified_defval
= null;
1695 for (var value
in this.defaults
) {
1696 if (!this.defaults
[value
] || this.defaults
[value
].length
== 0) {
1697 default_defval
= value
;
1700 else if (this.map
.isDependencySatisfied(this.defaults
[value
], config_name
, section_id
)) {
1701 satisified_defval
= value
;
1706 if (satisified_defval
== null)
1707 satisified_defval
= default_defval
;
1709 var node
= this.map
.findElement('id', this.cbid(section_id
));
1710 if (node
&& node
.getAttribute('data-changed') != 'true' && satisified_defval
!= null && cfgvalue
== null)
1711 dom
.callClassMethod(node
, 'setValue', satisified_defval
);
1713 this.default = satisified_defval
;
1717 * Obtain the internal ID ("cbid") of the element instance.
1719 * Since each form section element may map multiple underlying
1720 * configuration sections, the configuration section ID is required to
1721 * form a fully qualified ID pointing to the specific element instance
1722 * within the given specific section.
1724 * @param {string} section_id
1725 * The configuration section ID
1727 * @throws {TypeError}
1728 * Throws a `TypeError` exception when no `section_id` was specified.
1731 * Returns the element ID.
1733 cbid: function(section_id
) {
1734 if (section_id
== null)
1735 L
.error('TypeError', 'Section ID required');
1737 return 'cbid.%s.%s.%s'.format(
1738 this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
1739 section_id
, this.option
);
1743 * Load the underlying configuration value.
1745 * The default implementation of this method reads and returns the
1746 * underlying UCI option value (or the related JavaScript property for
1747 * `JSONMap` instances). It may be overwritten by user code to load data
1748 * from nonstandard sources.
1750 * @param {string} section_id
1751 * The configuration section ID
1753 * @throws {TypeError}
1754 * Throws a `TypeError` exception when no `section_id` was specified.
1756 * @returns {*|Promise<*>}
1757 * Returns the configuration value to initialize the option element with.
1758 * The return value of this function is filtered through `Promise.resolve()`
1759 * so it may return promises if overridden by user code.
1761 load: function(section_id
) {
1762 if (section_id
== null)
1763 L
.error('TypeError', 'Section ID required');
1765 return this.map
.data
.get(
1766 this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
1767 this.ucisection
|| section_id
,
1768 this.ucioption
|| this.option
);
1772 * Obtain the underlying `LuCI.ui` element instance.
1774 * @param {string} section_id
1775 * The configuration section ID
1777 * @throws {TypeError}
1778 * Throws a `TypeError` exception when no `section_id` was specified.
1780 * @return {LuCI.ui.AbstractElement|null}
1781 * Returns the `LuCI.ui` element instance or `null` in case the form
1782 * option implementation does not use `LuCI.ui` widgets.
1784 getUIElement: function(section_id
) {
1785 var node
= this.map
.findElement('id', this.cbid(section_id
)),
1786 inst
= node
? dom
.findClassInstance(node
) : null;
1787 return (inst
instanceof ui
.AbstractElement
) ? inst
: null;
1791 * Query the underlying configuration value.
1793 * The default implementation of this method returns the cached return
1794 * value of [load()]{@link LuCI.form.AbstractValue#load}. It may be
1795 * overwritten by user code to obtain the configuration value in a
1798 * @param {string} section_id
1799 * The configuration section ID
1801 * @throws {TypeError}
1802 * Throws a `TypeError` exception when no `section_id` was specified.
1805 * Returns the configuration value.
1807 cfgvalue: function(section_id
, set_value
) {
1808 if (section_id
== null)
1809 L
.error('TypeError', 'Section ID required');
1811 if (arguments
.length
== 2) {
1812 this.data
= this.data
|| {};
1813 this.data
[section_id
] = set_value
;
1816 return this.data
? this.data
[section_id
] : null;
1820 * Query the current form input value.
1822 * The default implementation of this method returns the current input
1823 * value of the underlying [LuCI.ui]{@link LuCI.ui.AbstractElement} widget.
1824 * It may be overwritten by user code to handle input values differently.
1826 * @param {string} section_id
1827 * The configuration section ID
1829 * @throws {TypeError}
1830 * Throws a `TypeError` exception when no `section_id` was specified.
1833 * Returns the current input value.
1835 formvalue: function(section_id
) {
1836 var elem
= this.getUIElement(section_id
);
1837 return elem
? elem
.getValue() : null;
1841 * Obtain a textual input representation.
1843 * The default implementation of this method returns the HTML escaped
1844 * current input value of the underlying
1845 * [LuCI.ui]{@link LuCI.ui.AbstractElement} widget. User code or specific
1846 * option element implementations may overwrite this function to apply a
1847 * different logic, e.g. to return `Yes` or `No` depending on the checked
1848 * state of checkbox elements.
1850 * @param {string} section_id
1851 * The configuration section ID
1853 * @throws {TypeError}
1854 * Throws a `TypeError` exception when no `section_id` was specified.
1857 * Returns the text representation of the current input value.
1859 textvalue: function(section_id
) {
1860 var cval
= this.cfgvalue(section_id
);
1863 cval
= this.default;
1865 return (cval
!= null) ? '%h'.format(cval
) : null;
1869 * Apply custom validation logic.
1871 * This method is invoked whenever incremental validation is performed on
1872 * the user input, e.g. on keyup or blur events.
1874 * The default implementation of this method does nothing and always
1875 * returns `true`. User code may overwrite this method to provide
1876 * additional validation logic which is not covered by data type
1880 * @param {string} section_id
1881 * The configuration section ID
1884 * The value to validate
1887 * The method shall return `true` to accept the given value. Any other
1888 * return value is treated as failure, converted to a string and displayed
1889 * as error message to the user.
1891 validate: function(section_id
, value
) {
1896 * Test whether the input value is currently valid.
1898 * @param {string} section_id
1899 * The configuration section ID
1901 * @returns {boolean}
1902 * Returns `true` if the input value currently is valid, otherwise it
1905 isValid: function(section_id
) {
1906 var elem
= this.getUIElement(section_id
);
1907 return elem
? elem
.isValid() : true;
1911 * Test whether the option element is currently active.
1913 * An element is active when it is not hidden due to unsatisfied dependency
1916 * @param {string} section_id
1917 * The configuration section ID
1919 * @returns {boolean}
1920 * Returns `true` if the option element currently is active, otherwise it
1923 isActive: function(section_id
) {
1924 var field
= this.map
.findElement('data-field', this.cbid(section_id
));
1925 return (field
!= null && !field
.classList
.contains('hidden'));
1929 setActive: function(section_id
, active
) {
1930 var field
= this.map
.findElement('data-field', this.cbid(section_id
));
1932 if (field
&& field
.classList
.contains('hidden') == active
) {
1933 field
.classList
[active
? 'remove' : 'add']('hidden');
1935 if (dom
.matches(field
.parentNode
, '.td.cbi-value-field'))
1936 field
.parentNode
.classList
[active
? 'remove' : 'add']('inactive');
1945 triggerValidation: function(section_id
) {
1946 var elem
= this.getUIElement(section_id
);
1947 return elem
? elem
.triggerValidation() : true;
1951 * Parse the option element input.
1953 * The function is invoked when the `parse()` method has been invoked on
1954 * the parent form and triggers input value reading and validation.
1956 * @param {string} section_id
1957 * The configuration section ID
1959 * @returns {Promise<void>}
1960 * Returns a promise resolving once the input value has been read and
1961 * validated or rejecting in case the input value does not meet the
1962 * validation constraints.
1964 parse: function(section_id
) {
1965 var active
= this.isActive(section_id
),
1966 cval
= this.cfgvalue(section_id
),
1967 fval
= active
? this.formvalue(section_id
) : null;
1969 if (active
&& !this.isValid(section_id
)) {
1970 var title
= this.stripTags(this.title
).trim();
1971 return Promise
.reject(new TypeError(_('Option "%s" contains an invalid input value.').format(title
|| this.option
)));
1974 if (fval
!= '' && fval
!= null) {
1975 if (this.forcewrite
|| !isEqual(cval
, fval
))
1976 return Promise
.resolve(this.write(section_id
, fval
));
1979 if (!active
|| this.rmempty
|| this.optional
) {
1980 return Promise
.resolve(this.remove(section_id
));
1982 else if (!isEqual(cval
, fval
)) {
1983 var title
= this.stripTags(this.title
).trim();
1984 return Promise
.reject(new TypeError(_('Option "%s" must not be empty.').format(title
|| this.option
)));
1988 return Promise
.resolve();
1992 * Write the current input value into the configuration.
1994 * This function is invoked upon saving the parent form when the option
1995 * element is valid and when its input value has been changed compared to
1996 * the initial value returned by
1997 * [cfgvalue()]{@link LuCI.form.AbstractValue#cfgvalue}.
1999 * The default implementation simply sets the given input value in the
2000 * UCI configuration (or the associated JavaScript object property in
2001 * case of `JSONMap` forms). It may be overwritten by user code to
2002 * implement alternative save logic, e.g. to transform the input value
2003 * before it is written.
2005 * @param {string} section_id
2006 * The configuration section ID
2008 * @param {string|string[]} formvalue
2009 * The input value to write.
2011 write: function(section_id
, formvalue
) {
2012 return this.map
.data
.set(
2013 this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
2014 this.ucisection
|| section_id
,
2015 this.ucioption
|| this.option
,
2020 * Remove the corresponding value from the configuration.
2022 * This function is invoked upon saving the parent form when the option
2023 * element has been hidden due to unsatisfied dependencies or when the
2024 * user cleared the input value and the option is marked optional.
2026 * The default implementation simply removes the associated option from the
2027 * UCI configuration (or the associated JavaScript object property in
2028 * case of `JSONMap` forms). It may be overwritten by user code to
2029 * implement alternative removal logic, e.g. to retain the original value.
2031 * @param {string} section_id
2032 * The configuration section ID
2034 remove: function(section_id
) {
2035 return this.map
.data
.unset(
2036 this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
2037 this.ucisection
|| section_id
,
2038 this.ucioption
|| this.option
);
2043 * @class TypedSection
2044 * @memberof LuCI.form
2045 * @augments LuCI.form.AbstractSection
2049 * The `TypedSection` class maps all or - if `filter()` is overwritten - a
2050 * subset of the underlying UCI configuration sections of a given type.
2052 * Layout wise, the configuration section instances mapped by the section
2053 * element (sometimes referred to as "section nodes") are stacked beneath
2054 * each other in a single column, with an optional section remove button next
2055 * to each section node and a section add button at the end, depending on the
2056 * value of the `addremove` property.
2058 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
2059 * The configuration form this section is added to. It is automatically passed
2060 * by [section()]{@link LuCI.form.Map#section}.
2062 * @param {string} section_type
2063 * The type of the UCI section to map.
2065 * @param {string} [title]
2066 * The title caption of the form section element.
2068 * @param {string} [description]
2069 * The description text of the form section element.
2071 var CBITypedSection
= CBIAbstractSection
.extend(/** @lends LuCI.form.TypedSection.prototype */ {
2072 __name__
: 'CBI.TypedSection',
2075 * If set to `true`, the user may add or remove instances from the form
2076 * section widget, otherwise only preexisting sections may be edited.
2077 * The default is `false`.
2079 * @name LuCI.form.TypedSection.prototype#addremove
2085 * If set to `true`, mapped section instances are treated as anonymous
2086 * UCI sections, which means that section instance elements will be
2087 * rendered without title element and that no name is required when adding
2088 * new sections. The default is `false`.
2090 * @name LuCI.form.TypedSection.prototype#anonymous
2096 * When set to `true`, instead of rendering section instances one below
2097 * another, treat each instance as separate tab pane and render a tab menu
2098 * at the top of the form section element, allowing the user to switch
2099 * among instances. The default is `false`.
2101 * @name LuCI.form.TypedSection.prototype#tabbed
2107 * Override the caption used for the section add button at the bottom of
2108 * the section form element. If set to a string, it will be used as-is,
2109 * if set to a function, the function will be invoked and its return value
2110 * is used as caption, after converting it to a string. If this property
2111 * is not set, the default is `Add`.
2113 * @name LuCI.form.TypedSection.prototype#addbtntitle
2114 * @type string|function
2119 * Override the UCI configuration name to read the section IDs from. By
2120 * default, the configuration name is inherited from the parent `Map`.
2121 * By setting this property, a deviating configuration may be specified.
2122 * The default is `null`, means inheriting from the parent form.
2124 * @name LuCI.form.TypedSection.prototype#uciconfig
2130 cfgsections: function() {
2131 return this.map
.data
.sections(this.uciconfig
|| this.map
.config
, this.sectiontype
)
2132 .map(function(s
) { return s
['.name'] })
2133 .filter(L
.bind(this.filter
, this));
2137 handleAdd: function(ev
, name
) {
2138 var config_name
= this.uciconfig
|| this.map
.config
;
2140 this.map
.data
.add(config_name
, this.sectiontype
, name
);
2141 return this.map
.save(null, true);
2145 handleRemove: function(section_id
, ev
) {
2146 var config_name
= this.uciconfig
|| this.map
.config
;
2148 this.map
.data
.remove(config_name
, section_id
);
2149 return this.map
.save(null, true);
2153 renderSectionAdd: function(extra_class
) {
2154 if (!this.addremove
)
2157 var createEl
= E('div', { 'class': 'cbi-section-create' }),
2158 config_name
= this.uciconfig
|| this.map
.config
,
2159 btn_title
= this.titleFn('addbtntitle');
2161 if (extra_class
!= null)
2162 createEl
.classList
.add(extra_class
);
2164 if (this.anonymous
) {
2165 createEl
.appendChild(E('button', {
2166 'class': 'cbi-button cbi-button-add',
2167 'title': btn_title
|| _('Add'),
2168 'click': ui
.createHandlerFn(this, 'handleAdd'),
2169 'disabled': this.map
.readonly
|| null
2170 }, [ btn_title
|| _('Add') ]));
2173 var nameEl
= E('input', {
2175 'class': 'cbi-section-create-name',
2176 'disabled': this.map
.readonly
|| null
2179 dom
.append(createEl
, [
2180 E('div', {}, nameEl
),
2182 'class': 'cbi-button cbi-button-add',
2184 'value': btn_title
|| _('Add'),
2185 'title': btn_title
|| _('Add'),
2186 'click': ui
.createHandlerFn(this, function(ev
) {
2187 if (nameEl
.classList
.contains('cbi-input-invalid'))
2190 return this.handleAdd(ev
, nameEl
.value
);
2192 'disabled': this.map
.readonly
|| null
2196 ui
.addValidator(nameEl
, 'uciname', true, 'blur', 'keyup');
2203 renderSectionPlaceholder: function() {
2205 E('em', _('This section contains no values yet')),
2211 renderContents: function(cfgsections
, nodes
) {
2212 var section_id
= null,
2213 config_name
= this.uciconfig
|| this.map
.config
,
2214 sectionEl
= E('div', {
2215 'id': 'cbi-%s-%s'.format(config_name
, this.sectiontype
),
2216 'class': 'cbi-section',
2217 'data-tab': (this.map
.tabbed
&& !this.parentoption
) ? this.sectiontype
: null,
2218 'data-tab-title': (this.map
.tabbed
&& !this.parentoption
) ? this.title
|| this.sectiontype
: null
2221 if (this.title
!= null && this.title
!= '')
2222 sectionEl
.appendChild(E('h3', {}, this.title
));
2224 if (this.description
!= null && this.description
!= '')
2225 sectionEl
.appendChild(E('div', { 'class': 'cbi-section-descr' }, this.description
));
2227 for (var i
= 0; i
< nodes
.length
; i
++) {
2228 if (this.addremove
) {
2229 sectionEl
.appendChild(
2230 E('div', { 'class': 'cbi-section-remove right' },
2232 'class': 'cbi-button',
2233 'name': 'cbi.rts.%s.%s'.format(config_name
, cfgsections
[i
]),
2234 'data-section-id': cfgsections
[i
],
2235 'click': ui
.createHandlerFn(this, 'handleRemove', cfgsections
[i
]),
2236 'disabled': this.map
.readonly
|| null
2237 }, [ _('Delete') ])));
2240 if (!this.anonymous
)
2241 sectionEl
.appendChild(E('h3', cfgsections
[i
].toUpperCase()));
2243 sectionEl
.appendChild(E('div', {
2244 'id': 'cbi-%s-%s'.format(config_name
, cfgsections
[i
]),
2246 ? 'cbi-section-node cbi-section-node-tabbed' : 'cbi-section-node',
2247 'data-section-id': cfgsections
[i
]
2251 if (nodes
.length
== 0)
2252 sectionEl
.appendChild(this.renderSectionPlaceholder());
2254 sectionEl
.appendChild(this.renderSectionAdd());
2256 dom
.bindClassInstance(sectionEl
, this);
2262 render: function() {
2263 var cfgsections
= this.cfgsections(),
2266 for (var i
= 0; i
< cfgsections
.length
; i
++)
2267 renderTasks
.push(this.renderUCISection(cfgsections
[i
]));
2269 return Promise
.all(renderTasks
).then(this.renderContents
.bind(this, cfgsections
));
2274 * @class TableSection
2275 * @memberof LuCI.form
2276 * @augments LuCI.form.TypedSection
2280 * The `TableSection` class maps all or - if `filter()` is overwritten - a
2281 * subset of the underlying UCI configuration sections of a given type.
2283 * Layout wise, the configuration section instances mapped by the section
2284 * element (sometimes referred to as "section nodes") are rendered as rows
2285 * within an HTML table element, with an optional section remove button in the
2286 * last column and a section add button below the table, depending on the
2287 * value of the `addremove` property.
2289 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
2290 * The configuration form this section is added to. It is automatically passed
2291 * by [section()]{@link LuCI.form.Map#section}.
2293 * @param {string} section_type
2294 * The type of the UCI section to map.
2296 * @param {string} [title]
2297 * The title caption of the form section element.
2299 * @param {string} [description]
2300 * The description text of the form section element.
2302 var CBITableSection
= CBITypedSection
.extend(/** @lends LuCI.form.TableSection.prototype */ {
2303 __name__
: 'CBI.TableSection',
2306 * If set to `true`, the user may add or remove instances from the form
2307 * section widget, otherwise only preexisting sections may be edited.
2308 * The default is `false`.
2310 * @name LuCI.form.TableSection.prototype#addremove
2316 * If set to `true`, mapped section instances are treated as anonymous
2317 * UCI sections, which means that section instance elements will be
2318 * rendered without title element and that no name is required when adding
2319 * new sections. The default is `false`.
2321 * @name LuCI.form.TableSection.prototype#anonymous
2327 * Override the caption used for the section add button at the bottom of
2328 * the section form element. If set to a string, it will be used as-is,
2329 * if set to a function, the function will be invoked and its return value
2330 * is used as caption, after converting it to a string. If this property
2331 * is not set, the default is `Add`.
2333 * @name LuCI.form.TableSection.prototype#addbtntitle
2334 * @type string|function
2339 * Override the per-section instance title caption shown in the first
2340 * column of the table unless `anonymous` is set to true. If set to a
2341 * string, it will be used as `String.format()` pattern with the name of
2342 * the underlying UCI section as first argument, if set to a function, the
2343 * function will be invoked with the section name as first argument and
2344 * its return value is used as caption, after converting it to a string.
2345 * If this property is not set, the default is the name of the underlying
2346 * UCI configuration section.
2348 * @name LuCI.form.TableSection.prototype#sectiontitle
2349 * @type string|function
2354 * Override the per-section instance modal popup title caption shown when
2355 * clicking the `More…` button in a section specifying `max_cols`. If set
2356 * to a string, it will be used as `String.format()` pattern with the name
2357 * of the underlying UCI section as first argument, if set to a function,
2358 * the function will be invoked with the section name as first argument and
2359 * its return value is used as caption, after converting it to a string.
2360 * If this property is not set, the default is the name of the underlying
2361 * UCI configuration section.
2363 * @name LuCI.form.TableSection.prototype#modaltitle
2364 * @type string|function
2369 * Override the UCI configuration name to read the section IDs from. By
2370 * default, the configuration name is inherited from the parent `Map`.
2371 * By setting this property, a deviating configuration may be specified.
2372 * The default is `null`, means inheriting from the parent form.
2374 * @name LuCI.form.TableSection.prototype#uciconfig
2380 * Specify a maximum amount of columns to display. By default, one table
2381 * column is rendered for each child option of the form section element.
2382 * When this option is set to a positive number, then no more columns than
2383 * the given amount are rendered. When the number of child options exceeds
2384 * the specified amount, a `More…` button is rendered in the last column,
2385 * opening a modal dialog presenting all options elements in `NamedSection`
2386 * style when clicked.
2388 * @name LuCI.form.TableSection.prototype#max_cols
2394 * If set to `true`, alternating `cbi-rowstyle-1` and `cbi-rowstyle-2` CSS
2395 * classes are added to the table row elements. Not all LuCI themes
2396 * implement these row style classes. The default is `false`.
2398 * @name LuCI.form.TableSection.prototype#rowcolors
2404 * Enables a per-section instance row `Edit` button which triggers a certain
2405 * action when clicked. If set to a string, the string value is used
2406 * as `String.format()` pattern with the name of the underlying UCI section
2407 * as first format argument. The result is then interpreted as URL which
2408 * LuCI will navigate to when the user clicks the edit button.
2410 * If set to a function, this function will be registered as click event
2411 * handler on the rendered edit button, receiving the section instance
2412 * name as first and the DOM click event as second argument.
2414 * @name LuCI.form.TableSection.prototype#extedit
2415 * @type string|function
2420 * If set to `true`, a sort button is added to the last column, allowing
2421 * the user to reorder the section instances mapped by the section form
2424 * @name LuCI.form.TableSection.prototype#sortable
2430 * If set to `true`, the header row with the options descriptions will
2431 * not be displayed. By default, descriptions row is automatically displayed
2432 * when at least one option has a description.
2434 * @name LuCI.form.TableSection.prototype#nodescriptions
2440 * The `TableSection` implementation does not support option tabbing, so
2441 * its implementation of `tab()` will always throw an exception when
2445 * @throws Throws an exception when invoked.
2448 throw 'Tabs are not supported by TableSection';
2452 renderContents: function(cfgsections
, nodes
) {
2453 var section_id
= null,
2454 config_name
= this.uciconfig
|| this.map
.config
,
2455 max_cols
= isNaN(this.max_cols
) ? this.children
.length
: this.max_cols
,
2456 has_more
= max_cols
< this.children
.length
,
2457 sectionEl
= E('div', {
2458 'id': 'cbi-%s-%s'.format(config_name
, this.sectiontype
),
2459 'class': 'cbi-section cbi-tblsection',
2460 'data-tab': (this.map
.tabbed
&& !this.parentoption
) ? this.sectiontype
: null,
2461 'data-tab-title': (this.map
.tabbed
&& !this.parentoption
) ? this.title
|| this.sectiontype
: null
2463 tableEl
= E('table', {
2464 'class': 'table cbi-section-table'
2467 if (this.title
!= null && this.title
!= '')
2468 sectionEl
.appendChild(E('h3', {}, this.title
));
2470 if (this.description
!= null && this.description
!= '')
2471 sectionEl
.appendChild(E('div', { 'class': 'cbi-section-descr' }, this.description
));
2473 tableEl
.appendChild(this.renderHeaderRows(max_cols
));
2475 for (var i
= 0; i
< nodes
.length
; i
++) {
2476 var sectionname
= this.titleFn('sectiontitle', cfgsections
[i
]);
2478 if (sectionname
== null)
2479 sectionname
= cfgsections
[i
];
2481 var trEl
= E('tr', {
2482 'id': 'cbi-%s-%s'.format(config_name
, cfgsections
[i
]),
2483 'class': 'tr cbi-section-table-row',
2484 'data-sid': cfgsections
[i
],
2485 'draggable': this.sortable
? true : null,
2486 'mousedown': this.sortable
? L
.bind(this.handleDragInit
, this) : null,
2487 'dragstart': this.sortable
? L
.bind(this.handleDragStart
, this) : null,
2488 'dragover': this.sortable
? L
.bind(this.handleDragOver
, this) : null,
2489 'dragenter': this.sortable
? L
.bind(this.handleDragEnter
, this) : null,
2490 'dragleave': this.sortable
? L
.bind(this.handleDragLeave
, this) : null,
2491 'dragend': this.sortable
? L
.bind(this.handleDragEnd
, this) : null,
2492 'drop': this.sortable
? L
.bind(this.handleDrop
, this) : null,
2493 'data-title': (sectionname
&& (!this.anonymous
|| this.sectiontitle
)) ? sectionname
: null,
2494 'data-section-id': cfgsections
[i
]
2497 if (this.extedit
|| this.rowcolors
)
2498 trEl
.classList
.add(!(tableEl
.childNodes
.length
% 2)
2499 ? 'cbi-rowstyle-1' : 'cbi-rowstyle-2');
2501 for (var j
= 0; j
< max_cols
&& nodes
[i
].firstChild
; j
++)
2502 trEl
.appendChild(nodes
[i
].firstChild
);
2504 trEl
.appendChild(this.renderRowActions(cfgsections
[i
], has_more
? _('More…') : null));
2505 tableEl
.appendChild(trEl
);
2508 if (nodes
.length
== 0)
2509 tableEl
.appendChild(E('tr', { 'class': 'tr cbi-section-table-row placeholder' },
2510 E('td', { 'class': 'td' },
2511 E('em', {}, _('This section contains no values yet')))));
2513 sectionEl
.appendChild(tableEl
);
2515 sectionEl
.appendChild(this.renderSectionAdd('cbi-tblsection-create'));
2517 dom
.bindClassInstance(sectionEl
, this);
2523 renderHeaderRows: function(max_cols
, has_action
) {
2524 var has_titles
= false,
2525 has_descriptions
= false,
2526 max_cols
= isNaN(this.max_cols
) ? this.children
.length
: this.max_cols
,
2527 has_more
= max_cols
< this.children
.length
,
2528 anon_class
= (!this.anonymous
|| this.sectiontitle
) ? 'named' : 'anonymous',
2531 for (var i
= 0, opt
; i
< max_cols
&& (opt
= this.children
[i
]) != null; i
++) {
2535 has_titles
= has_titles
|| !!opt
.title
;
2536 has_descriptions
= has_descriptions
|| !!opt
.description
;
2540 var trEl
= E('tr', {
2541 'class': 'tr cbi-section-table-titles ' + anon_class
,
2542 'data-title': (!this.anonymous
|| this.sectiontitle
) ? _('Name') : null
2545 for (var i
= 0, opt
; i
< max_cols
&& (opt
= this.children
[i
]) != null; i
++) {
2549 trEl
.appendChild(E('th', {
2550 'class': 'th cbi-section-table-cell',
2551 'data-widget': opt
.__name__
2554 if (opt
.width
!= null)
2555 trEl
.lastElementChild
.style
.width
=
2556 (typeof(opt
.width
) == 'number') ? opt
.width
+'px' : opt
.width
;
2559 trEl
.lastElementChild
.appendChild(E('a', {
2560 'href': opt
.titleref
,
2561 'class': 'cbi-title-ref',
2562 'title': this.titledesc
|| _('Go to relevant configuration page')
2565 dom
.content(trEl
.lastElementChild
, opt
.title
);
2568 if (this.sortable
|| this.extedit
|| this.addremove
|| has_more
|| has_action
)
2569 trEl
.appendChild(E('th', {
2570 'class': 'th cbi-section-table-cell cbi-section-actions'
2573 trEls
.appendChild(trEl
);
2576 if (has_descriptions
&& !this.nodescriptions
) {
2577 var trEl
= E('tr', {
2578 'class': 'tr cbi-section-table-descr ' + anon_class
2581 for (var i
= 0, opt
; i
< max_cols
&& (opt
= this.children
[i
]) != null; i
++) {
2585 trEl
.appendChild(E('th', {
2586 'class': 'th cbi-section-table-cell',
2587 'data-widget': opt
.__name__
2588 }, opt
.description
));
2590 if (opt
.width
!= null)
2591 trEl
.lastElementChild
.style
.width
=
2592 (typeof(opt
.width
) == 'number') ? opt
.width
+'px' : opt
.width
;
2595 if (this.sortable
|| this.extedit
|| this.addremove
|| has_more
|| has_action
)
2596 trEl
.appendChild(E('th', {
2597 'class': 'th cbi-section-table-cell cbi-section-actions'
2600 trEls
.appendChild(trEl
);
2607 renderRowActions: function(section_id
, more_label
) {
2608 var config_name
= this.uciconfig
|| this.map
.config
;
2610 if (!this.sortable
&& !this.extedit
&& !this.addremove
&& !more_label
)
2613 var tdEl
= E('td', {
2614 'class': 'td cbi-section-table-cell nowrap cbi-section-actions'
2617 if (this.sortable
) {
2618 dom
.append(tdEl
.lastElementChild
, [
2620 'title': _('Drag to reorder'),
2621 'class': 'btn cbi-button drag-handle center',
2622 'style': 'cursor:move',
2623 'disabled': this.map
.readonly
|| null
2631 if (typeof(this.extedit
) == 'function')
2632 evFn
= L
.bind(this.extedit
, this);
2633 else if (typeof(this.extedit
) == 'string')
2634 evFn
= L
.bind(function(sid
, ev
) {
2635 location
.href
= this.extedit
.format(sid
);
2636 }, this, section_id
);
2638 dom
.append(tdEl
.lastElementChild
,
2641 'class': 'cbi-button cbi-button-edit',
2648 dom
.append(tdEl
.lastElementChild
,
2650 'title': more_label
,
2651 'class': 'cbi-button cbi-button-edit',
2652 'click': ui
.createHandlerFn(this, 'renderMoreOptionsModal', section_id
)
2657 if (this.addremove
) {
2658 var btn_title
= this.titleFn('removebtntitle', section_id
);
2660 dom
.append(tdEl
.lastElementChild
,
2662 'title': btn_title
|| _('Delete'),
2663 'class': 'cbi-button cbi-button-remove',
2664 'click': ui
.createHandlerFn(this, 'handleRemove', section_id
),
2665 'disabled': this.map
.readonly
|| null
2666 }, [ btn_title
|| _('Delete') ])
2674 handleDragInit: function(ev
) {
2675 scope
.dragState
= { node
: ev
.target
};
2679 handleDragStart: function(ev
) {
2680 if (!scope
.dragState
|| !scope
.dragState
.node
.classList
.contains('drag-handle')) {
2681 scope
.dragState
= null;
2682 ev
.preventDefault();
2686 scope
.dragState
.node
= dom
.parent(scope
.dragState
.node
, '.tr');
2687 ev
.dataTransfer
.setData('text', 'drag');
2688 ev
.target
.style
.opacity
= 0.4;
2692 handleDragOver: function(ev
) {
2693 var n
= scope
.dragState
.targetNode
,
2694 r
= scope
.dragState
.rect
,
2695 t
= r
.top
+ r
.height
/ 2;
2697 if (ev
.clientY
<= t
) {
2698 n
.classList
.remove('drag-over-below');
2699 n
.classList
.add('drag-over-above');
2702 n
.classList
.remove('drag-over-above');
2703 n
.classList
.add('drag-over-below');
2706 ev
.dataTransfer
.dropEffect
= 'move';
2707 ev
.preventDefault();
2712 handleDragEnter: function(ev
) {
2713 scope
.dragState
.rect
= ev
.currentTarget
.getBoundingClientRect();
2714 scope
.dragState
.targetNode
= ev
.currentTarget
;
2718 handleDragLeave: function(ev
) {
2719 ev
.currentTarget
.classList
.remove('drag-over-above');
2720 ev
.currentTarget
.classList
.remove('drag-over-below');
2724 handleDragEnd: function(ev
) {
2727 n
.style
.opacity
= '';
2728 n
.classList
.add('flash');
2729 n
.parentNode
.querySelectorAll('.drag-over-above, .drag-over-below')
2730 .forEach(function(tr
) {
2731 tr
.classList
.remove('drag-over-above');
2732 tr
.classList
.remove('drag-over-below');
2737 handleDrop: function(ev
) {
2738 var s
= scope
.dragState
;
2740 if (s
.node
&& s
.targetNode
) {
2741 var config_name
= this.uciconfig
|| this.map
.config
,
2742 ref_node
= s
.targetNode
,
2745 if (ref_node
.classList
.contains('drag-over-below')) {
2746 ref_node
= ref_node
.nextElementSibling
;
2750 var sid1
= s
.node
.getAttribute('data-sid'),
2751 sid2
= s
.targetNode
.getAttribute('data-sid');
2753 s
.node
.parentNode
.insertBefore(s
.node
, ref_node
);
2754 this.map
.data
.move(config_name
, sid1
, sid2
, after
);
2757 scope
.dragState
= null;
2758 ev
.target
.style
.opacity
= '';
2759 ev
.stopPropagation();
2760 ev
.preventDefault();
2765 handleModalCancel: function(modalMap
, ev
) {
2766 return Promise
.resolve(ui
.hideModal());
2770 handleModalSave: function(modalMap
, ev
) {
2771 return modalMap
.save(null, true)
2772 .then(L
.bind(this.map
.load
, this.map
))
2773 .then(L
.bind(this.map
.reset
, this.map
))
2775 .catch(function() {});
2779 * Add further options to the per-section instanced modal popup.
2781 * This function may be overwritten by user code to perform additional
2782 * setup steps before displaying the more options modal which is useful to
2783 * e.g. query additional data or to inject further option elements.
2785 * The default implementation of this function does nothing.
2788 * @param {LuCI.form.NamedSection} modalSection
2789 * The `NamedSection` instance about to be rendered in the modal popup.
2791 * @param {string} section_id
2792 * The ID of the underlying UCI section the modal popup belongs to.
2795 * The DOM event emitted by clicking the `More…` button.
2797 * @returns {*|Promise<*>}
2798 * Return values of this function are ignored but if a promise is returned,
2799 * it is run to completion before the rendering is continued, allowing
2800 * custom logic to perform asynchroneous work before the modal dialog
2803 addModalOptions: function(modalSection
, section_id
, ev
) {
2808 renderMoreOptionsModal: function(section_id
, ev
) {
2809 var parent
= this.map
,
2810 title
= parent
.title
,
2812 m
= new CBIMap(this.map
.config
, null, null),
2813 s
= m
.section(CBINamedSection
, section_id
, this.sectiontype
);
2816 m
.readonly
= parent
.readonly
;
2819 s
.tab_names
= this.tab_names
;
2821 if ((name
= this.titleFn('modaltitle', section_id
)) != null)
2823 else if ((name
= this.titleFn('sectiontitle', section_id
)) != null)
2824 title
= '%s - %s'.format(parent
.title
, name
);
2825 else if (!this.anonymous
)
2826 title
= '%s - %s'.format(parent
.title
, section_id
);
2828 for (var i
= 0; i
< this.children
.length
; i
++) {
2829 var o1
= this.children
[i
];
2831 if (o1
.modalonly
=== false)
2834 var o2
= s
.option(o1
.constructor, o1
.option
, o1
.title
, o1
.description
);
2837 if (!o1
.hasOwnProperty(k
))
2854 return Promise
.resolve(this.addModalOptions(s
, section_id
, ev
)).then(L
.bind(m
.render
, m
)).then(L
.bind(function(nodes
) {
2855 ui
.showModal(title
, [
2857 E('div', { 'class': 'right' }, [
2860 'click': ui
.createHandlerFn(this, 'handleModalCancel', m
)
2861 }, [ _('Dismiss') ]), ' ',
2863 'class': 'cbi-button cbi-button-positive important',
2864 'click': ui
.createHandlerFn(this, 'handleModalSave', m
),
2865 'disabled': m
.readonly
|| null
2869 }, this)).catch(L
.error
);
2874 * @class GridSection
2875 * @memberof LuCI.form
2876 * @augments LuCI.form.TableSection
2880 * The `GridSection` class maps all or - if `filter()` is overwritten - a
2881 * subset of the underlying UCI configuration sections of a given type.
2883 * A grid section functions similar to a {@link LuCI.form.TableSection} but
2884 * supports tabbing in the modal overlay. Option elements added with
2885 * [option()]{@link LuCI.form.GridSection#option} are shown in the table while
2886 * elements added with [taboption()]{@link LuCI.form.GridSection#taboption}
2887 * are displayed in the modal popup.
2889 * Another important difference is that the table cells show a readonly text
2890 * preview of the corresponding option elements by default, unless the child
2891 * option element is explicitely made writable by setting the `editable`
2892 * property to `true`.
2894 * Additionally, the grid section honours a `modalonly` property of child
2895 * option elements. Refer to the [AbstractValue]{@link LuCI.form.AbstractValue}
2896 * documentation for details.
2898 * Layout wise, a grid section looks mostly identical to table sections.
2900 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
2901 * The configuration form this section is added to. It is automatically passed
2902 * by [section()]{@link LuCI.form.Map#section}.
2904 * @param {string} section_type
2905 * The type of the UCI section to map.
2907 * @param {string} [title]
2908 * The title caption of the form section element.
2910 * @param {string} [description]
2911 * The description text of the form section element.
2913 var CBIGridSection
= CBITableSection
.extend(/** @lends LuCI.form.GridSection.prototype */ {
2915 * Add an option tab to the section.
2917 * The modal option elements of a grid section may be divided into multiple
2918 * tabs to provide a better overview to the user.
2920 * Before options can be moved into a tab pane, the corresponding tab
2921 * has to be defined first, which is done by calling this function.
2923 * Note that tabs are only effective in modal popups, options added with
2924 * `option()` will not be assigned to a specific tab and are rendered in
2925 * the table view only.
2927 * @param {string} name
2928 * The name of the tab to register. It may be freely chosen and just serves
2929 * as an identifier to differentiate tabs.
2931 * @param {string} title
2932 * The human readable caption of the tab.
2934 * @param {string} [description]
2935 * An additional description text for the corresponding tab pane. It is
2936 * displayed as text paragraph below the tab but before the tab pane
2937 * contents. If omitted, no description will be rendered.
2940 * Throws an exeption if a tab with the same `name` already exists.
2942 tab: function(name
, title
, description
) {
2943 CBIAbstractSection
.prototype.tab
.call(this, name
, title
, description
);
2947 handleAdd: function(ev
, name
) {
2948 var config_name
= this.uciconfig
|| this.map
.config
,
2949 section_id
= this.map
.data
.add(config_name
, this.sectiontype
, name
);
2951 this.addedSection
= section_id
;
2952 return this.renderMoreOptionsModal(section_id
);
2956 handleModalSave: function(/* ... */) {
2957 return this.super('handleModalSave', arguments
)
2958 .then(L
.bind(function() { this.addedSection
= null }, this));
2962 handleModalCancel: function(/* ... */) {
2963 var config_name
= this.uciconfig
|| this.map
.config
;
2965 if (this.addedSection
!= null) {
2966 this.map
.data
.remove(config_name
, this.addedSection
);
2967 this.addedSection
= null;
2970 return this.super('handleModalCancel', arguments
);
2974 renderUCISection: function(section_id
) {
2975 return this.renderOptions(null, section_id
);
2979 renderChildren: function(tab_name
, section_id
, in_table
) {
2980 var tasks
= [], index
= 0;
2982 for (var i
= 0, opt
; (opt
= this.children
[i
]) != null; i
++) {
2983 if (opt
.disable
|| opt
.modalonly
)
2987 tasks
.push(opt
.render(index
++, section_id
, in_table
));
2989 tasks
.push(this.renderTextValue(section_id
, opt
));
2992 return Promise
.all(tasks
);
2996 renderTextValue: function(section_id
, opt
) {
2997 var title
= this.stripTags(opt
.title
).trim(),
2998 descr
= this.stripTags(opt
.description
).trim(),
2999 value
= opt
.textvalue(section_id
);
3002 'class': 'td cbi-value-field',
3003 'data-title': (title
!= '') ? title
: null,
3004 'data-description': (descr
!= '') ? descr
: null,
3005 'data-name': opt
.option
,
3006 'data-widget': opt
.typename
|| opt
.__name__
3007 }, (value
!= null) ? value
: E('em', _('none')));
3011 renderHeaderRows: function(section_id
) {
3012 return this.super('renderHeaderRows', [ NaN
, true ]);
3016 renderRowActions: function(section_id
) {
3017 return this.super('renderRowActions', [ section_id
, _('Edit') ]);
3022 var section_ids
= this.cfgsections(),
3025 if (Array
.isArray(this.children
)) {
3026 for (var i
= 0; i
< section_ids
.length
; i
++) {
3027 for (var j
= 0; j
< this.children
.length
; j
++) {
3028 if (!this.children
[j
].editable
|| this.children
[j
].modalonly
)
3031 tasks
.push(this.children
[j
].parse(section_ids
[i
]));
3036 return Promise
.all(tasks
);
3041 * @class NamedSection
3042 * @memberof LuCI.form
3043 * @augments LuCI.form.AbstractSection
3047 * The `NamedSection` class maps exactly one UCI section instance which is
3048 * specified when constructing the class instance.
3050 * Layout and functionality wise, a named section is essentially a
3051 * `TypedSection` which allows exactly one section node.
3053 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3054 * The configuration form this section is added to. It is automatically passed
3055 * by [section()]{@link LuCI.form.Map#section}.
3057 * @param {string} section_id
3058 * The name (ID) of the UCI section to map.
3060 * @param {string} section_type
3061 * The type of the UCI section to map.
3063 * @param {string} [title]
3064 * The title caption of the form section element.
3066 * @param {string} [description]
3067 * The description text of the form section element.
3069 var CBINamedSection
= CBIAbstractSection
.extend(/** @lends LuCI.form.NamedSection.prototype */ {
3070 __name__
: 'CBI.NamedSection',
3071 __init__: function(map
, section_id
/*, ... */) {
3072 this.super('__init__', this.varargs(arguments
, 2, map
));
3074 this.section
= section_id
;
3078 * If set to `true`, the user may remove or recreate the sole mapped
3079 * configuration instance from the form section widget, otherwise only a
3080 * preexisting section may be edited. The default is `false`.
3082 * @name LuCI.form.NamedSection.prototype#addremove
3088 * Override the UCI configuration name to read the section IDs from. By
3089 * default, the configuration name is inherited from the parent `Map`.
3090 * By setting this property, a deviating configuration may be specified.
3091 * The default is `null`, means inheriting from the parent form.
3093 * @name LuCI.form.NamedSection.prototype#uciconfig
3099 * The `NamedSection` class overwrites the generic `cfgsections()`
3100 * implementation to return a one-element array containing the mapped
3101 * section ID as sole element. User code should not normally change this.
3103 * @returns {string[]}
3104 * Returns a one-element array containing the mapped section ID.
3106 cfgsections: function() {
3107 return [ this.section
];
3111 handleAdd: function(ev
) {
3112 var section_id
= this.section
,
3113 config_name
= this.uciconfig
|| this.map
.config
;
3115 this.map
.data
.add(config_name
, this.sectiontype
, section_id
);
3116 return this.map
.save(null, true);
3120 handleRemove: function(ev
) {
3121 var section_id
= this.section
,
3122 config_name
= this.uciconfig
|| this.map
.config
;
3124 this.map
.data
.remove(config_name
, section_id
);
3125 return this.map
.save(null, true);
3129 renderContents: function(data
) {
3130 var ucidata
= data
[0], nodes
= data
[1],
3131 section_id
= this.section
,
3132 config_name
= this.uciconfig
|| this.map
.config
,
3133 sectionEl
= E('div', {
3134 'id': ucidata
? null : 'cbi-%s-%s'.format(config_name
, section_id
),
3135 'class': 'cbi-section',
3136 'data-tab': (this.map
.tabbed
&& !this.parentoption
) ? this.sectiontype
: null,
3137 'data-tab-title': (this.map
.tabbed
&& !this.parentoption
) ? this.title
|| this.sectiontype
: null
3140 if (typeof(this.title
) === 'string' && this.title
!== '')
3141 sectionEl
.appendChild(E('h3', {}, this.title
));
3143 if (typeof(this.description
) === 'string' && this.description
!== '')
3144 sectionEl
.appendChild(E('div', { 'class': 'cbi-section-descr' }, this.description
));
3147 if (this.addremove
) {
3148 sectionEl
.appendChild(
3149 E('div', { 'class': 'cbi-section-remove right' },
3151 'class': 'cbi-button',
3152 'click': ui
.createHandlerFn(this, 'handleRemove'),
3153 'disabled': this.map
.readonly
|| null
3154 }, [ _('Delete') ])));
3157 sectionEl
.appendChild(E('div', {
3158 'id': 'cbi-%s-%s'.format(config_name
, section_id
),
3160 ? 'cbi-section-node cbi-section-node-tabbed' : 'cbi-section-node',
3161 'data-section-id': section_id
3164 else if (this.addremove
) {
3165 sectionEl
.appendChild(
3167 'class': 'cbi-button cbi-button-add',
3168 'click': ui
.createHandlerFn(this, 'handleAdd'),
3169 'disabled': this.map
.readonly
|| null
3173 dom
.bindClassInstance(sectionEl
, this);
3179 render: function() {
3180 var config_name
= this.uciconfig
|| this.map
.config
,
3181 section_id
= this.section
;
3183 return Promise
.all([
3184 this.map
.data
.get(config_name
, section_id
),
3185 this.renderUCISection(section_id
)
3186 ]).then(this.renderContents
.bind(this));
3192 * @memberof LuCI.form
3193 * @augments LuCI.form.AbstractValue
3197 * The `Value` class represents a simple one-line form input using the
3198 * {@link LuCI.ui.Textfield} or - in case choices are added - the
3199 * {@link LuCI.ui.Combobox} class as underlying widget.
3201 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3202 * The configuration form this section is added to. It is automatically passed
3203 * by [option()]{@link LuCI.form.AbstractSection#option} or
3204 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3205 * option to the section.
3207 * @param {LuCI.form.AbstractSection} section
3208 * The configuration section this option is added to. It is automatically passed
3209 * by [option()]{@link LuCI.form.AbstractSection#option} or
3210 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3211 * option to the section.
3213 * @param {string} option
3214 * The name of the UCI option to map.
3216 * @param {string} [title]
3217 * The title caption of the option element.
3219 * @param {string} [description]
3220 * The description text of the option element.
3222 var CBIValue
= CBIAbstractValue
.extend(/** @lends LuCI.form.Value.prototype */ {
3223 __name__
: 'CBI.Value',
3226 * If set to `true`, the field is rendered as password input, otherwise
3227 * as plain text input.
3229 * @name LuCI.form.Value.prototype#password
3235 * Set a placeholder string to use when the input field is empty.
3237 * @name LuCI.form.Value.prototype#placeholder
3243 * Add a predefined choice to the form option. By adding one or more
3244 * choices, the plain text input field is turned into a combobox widget
3245 * which prompts the user to select a predefined choice, or to enter a
3248 * @param {string} key
3249 * The choice value to add.
3251 * @param {Node|string} value
3252 * The caption for the choice value. May be a DOM node, a document fragment
3253 * or a plain text string. If omitted, the `key` value is used as caption.
3255 value: function(key
, val
) {
3256 this.keylist
= this.keylist
|| [];
3257 this.keylist
.push(String(key
));
3259 this.vallist
= this.vallist
|| [];
3260 this.vallist
.push(dom
.elem(val
) ? val
: String(val
!= null ? val
: key
));
3264 render: function(option_index
, section_id
, in_table
) {
3265 return Promise
.resolve(this.cfgvalue(section_id
))
3266 .then(this.renderWidget
.bind(this, section_id
, option_index
))
3267 .then(this.renderFrame
.bind(this, section_id
, in_table
, option_index
));
3271 handleValueChange: function(section_id
, state
, ev
) {
3272 if (typeof(this.onchange
) != 'function')
3275 var value
= this.formvalue(section_id
);
3277 if (isEqual(value
, state
.previousValue
))
3280 state
.previousValue
= value
;
3281 this.onchange
.call(this, ev
, section_id
, value
);
3285 renderFrame: function(section_id
, in_table
, option_index
, nodes
) {
3286 var config_name
= this.uciconfig
|| this.section
.uciconfig
|| this.map
.config
,
3287 depend_list
= this.transformDepList(section_id
),
3291 var title
= this.stripTags(this.title
).trim();
3292 optionEl
= E('td', {
3293 'class': 'td cbi-value-field',
3294 'data-title': (title
!= '') ? title
: null,
3295 'data-description': this.stripTags(this.description
).trim(),
3296 'data-name': this.option
,
3297 'data-widget': this.typename
|| (this.template
? this.template
.replace(/^.+\//, '') : null) || this.__name__
3299 'id': 'cbi-%s-%s-%s'.format(config_name
, section_id
, this.option
),
3300 'data-index': option_index
,
3301 'data-depends': depend_list
,
3302 'data-field': this.cbid(section_id
)
3306 optionEl
= E('div', {
3307 'class': 'cbi-value',
3308 'id': 'cbi-%s-%s-%s'.format(config_name
, section_id
, this.option
),
3309 'data-index': option_index
,
3310 'data-depends': depend_list
,
3311 'data-field': this.cbid(section_id
),
3312 'data-name': this.option
,
3313 'data-widget': this.typename
|| (this.template
? this.template
.replace(/^.+\//, '') : null) || this.__name__
3316 if (this.last_child
)
3317 optionEl
.classList
.add('cbi-value-last');
3319 if (typeof(this.title
) === 'string' && this.title
!== '') {
3320 optionEl
.appendChild(E('label', {
3321 'class': 'cbi-value-title',
3322 'for': 'widget.cbid.%s.%s.%s'.format(config_name
, section_id
, this.option
),
3323 'click': function(ev
) {
3324 var node
= ev
.currentTarget
,
3325 elem
= node
.nextElementSibling
.querySelector('#' + node
.getAttribute('for')) || node
.nextElementSibling
.querySelector('[data-widget-id="' + node
.getAttribute('for') + '"]');
3333 this.titleref
? E('a', {
3334 'class': 'cbi-title-ref',
3335 'href': this.titleref
,
3336 'title': this.titledesc
|| _('Go to relevant configuration page')
3337 }, this.title
) : this.title
));
3339 optionEl
.appendChild(E('div', { 'class': 'cbi-value-field' }));
3344 (optionEl
.lastChild
|| optionEl
).appendChild(nodes
);
3346 if (!in_table
&& typeof(this.description
) === 'string' && this.description
!== '')
3347 dom
.append(optionEl
.lastChild
|| optionEl
,
3348 E('div', { 'class': 'cbi-value-description' }, this.description
));
3350 if (depend_list
&& depend_list
.length
)
3351 optionEl
.classList
.add('hidden');
3353 optionEl
.addEventListener('widget-change',
3354 L
.bind(this.map
.checkDepends
, this.map
));
3356 optionEl
.addEventListener('widget-change',
3357 L
.bind(this.handleValueChange
, this, section_id
, {}));
3359 dom
.bindClassInstance(optionEl
, this);
3365 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3366 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default,
3367 choices
= this.transformChoices(),
3371 var placeholder
= (this.optional
|| this.rmempty
)
3372 ? E('em', _('unspecified')) : _('-- Please choose --');
3374 widget
= new ui
.Combobox(Array
.isArray(value
) ? value
.join(' ') : value
, choices
, {
3375 id
: this.cbid(section_id
),
3377 optional
: this.optional
|| this.rmempty
,
3378 datatype
: this.datatype
,
3379 select_placeholder
: this.placeholder
|| placeholder
,
3380 validate
: L
.bind(this.validate
, this, section_id
),
3381 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3385 widget
= new ui
.Textfield(Array
.isArray(value
) ? value
.join(' ') : value
, {
3386 id
: this.cbid(section_id
),
3387 password
: this.password
,
3388 optional
: this.optional
|| this.rmempty
,
3389 datatype
: this.datatype
,
3390 placeholder
: this.placeholder
,
3391 validate
: L
.bind(this.validate
, this, section_id
),
3392 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3396 return widget
.render();
3401 * @class DynamicList
3402 * @memberof LuCI.form
3403 * @augments LuCI.form.Value
3407 * The `DynamicList` class represents a multi value widget allowing the user
3408 * to enter multiple unique values, optionally selected from a set of
3409 * predefined choices. It builds upon the {@link LuCI.ui.DynamicList} widget.
3411 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3412 * The configuration form this section is added to. It is automatically passed
3413 * by [option()]{@link LuCI.form.AbstractSection#option} or
3414 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3415 * option to the section.
3417 * @param {LuCI.form.AbstractSection} section
3418 * The configuration section this option is added to. It is automatically passed
3419 * by [option()]{@link LuCI.form.AbstractSection#option} or
3420 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3421 * option to the section.
3423 * @param {string} option
3424 * The name of the UCI option to map.
3426 * @param {string} [title]
3427 * The title caption of the option element.
3429 * @param {string} [description]
3430 * The description text of the option element.
3432 var CBIDynamicList
= CBIValue
.extend(/** @lends LuCI.form.DynamicList.prototype */ {
3433 __name__
: 'CBI.DynamicList',
3436 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3437 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default,
3438 choices
= this.transformChoices(),
3439 items
= L
.toArray(value
);
3441 var widget
= new ui
.DynamicList(items
, choices
, {
3442 id
: this.cbid(section_id
),
3444 optional
: this.optional
|| this.rmempty
,
3445 datatype
: this.datatype
,
3446 placeholder
: this.placeholder
,
3447 validate
: L
.bind(this.validate
, this, section_id
),
3448 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3451 return widget
.render();
3457 * @memberof LuCI.form
3458 * @augments LuCI.form.Value
3462 * The `ListValue` class implements a simple static HTML select element
3463 * allowing the user to chose a single value from a set of predefined choices.
3464 * It builds upon the {@link LuCI.ui.Select} widget.
3466 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3467 * The configuration form this section is added to. It is automatically passed
3468 * by [option()]{@link LuCI.form.AbstractSection#option} or
3469 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3470 * option to the section.
3472 * @param {LuCI.form.AbstractSection} section
3473 * The configuration section this option is added to. It is automatically passed
3474 * by [option()]{@link LuCI.form.AbstractSection#option} or
3475 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3476 * option to the section.
3478 * @param {string} option
3479 * The name of the UCI option to map.
3481 * @param {string} [title]
3482 * The title caption of the option element.
3484 * @param {string} [description]
3485 * The description text of the option element.
3487 var CBIListValue
= CBIValue
.extend(/** @lends LuCI.form.ListValue.prototype */ {
3488 __name__
: 'CBI.ListValue',
3490 __init__: function() {
3491 this.super('__init__', arguments
);
3492 this.widget
= 'select';
3493 this.orientation
= 'horizontal';
3498 * Set the size attribute of the underlying HTML select element.
3500 * @name LuCI.form.ListValue.prototype#size
3506 * Set the type of the underlying form controls.
3508 * May be one of `select` or `radio`. If set to `select`, an HTML
3509 * select element is rendered, otherwise a collection of `radio`
3512 * @name LuCI.form.ListValue.prototype#widget
3518 * Set the orientation of the underlying radio or checkbox elements.
3520 * May be one of `horizontal` or `vertical`. Only applies to non-select
3523 * @name LuCI.form.ListValue.prototype#orientation
3525 * @default horizontal
3529 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3530 var choices
= this.transformChoices();
3531 var widget
= new ui
.Select((cfgvalue
!= null) ? cfgvalue
: this.default, choices
, {
3532 id
: this.cbid(section_id
),
3535 widget
: this.widget
,
3536 optional
: this.optional
,
3537 orientation
: this.orientation
,
3538 placeholder
: this.placeholder
,
3539 validate
: L
.bind(this.validate
, this, section_id
),
3540 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3543 return widget
.render();
3549 * @memberof LuCI.form
3550 * @augments LuCI.form.Value
3554 * The `FlagValue` element builds upon the {@link LuCI.ui.Checkbox} widget to
3555 * implement a simple checkbox element.
3557 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3558 * The configuration form this section is added to. It is automatically passed
3559 * by [option()]{@link LuCI.form.AbstractSection#option} or
3560 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3561 * option to the section.
3563 * @param {LuCI.form.AbstractSection} section
3564 * The configuration section this option is added to. It is automatically passed
3565 * by [option()]{@link LuCI.form.AbstractSection#option} or
3566 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3567 * option to the section.
3569 * @param {string} option
3570 * The name of the UCI option to map.
3572 * @param {string} [title]
3573 * The title caption of the option element.
3575 * @param {string} [description]
3576 * The description text of the option element.
3578 var CBIFlagValue
= CBIValue
.extend(/** @lends LuCI.form.FlagValue.prototype */ {
3579 __name__
: 'CBI.FlagValue',
3581 __init__: function() {
3582 this.super('__init__', arguments
);
3585 this.disabled
= '0';
3586 this.default = this.disabled
;
3590 * Sets the input value to use for the checkbox checked state.
3592 * @name LuCI.form.FlagValue.prototype#enabled
3598 * Sets the input value to use for the checkbox unchecked state.
3600 * @name LuCI.form.FlagValue.prototype#disabled
3606 * Set a tooltip for the flag option.
3608 * If set to a string, it will be used as-is as a tooltip.
3610 * If set to a function, the function will be invoked and the return
3611 * value will be shown as a tooltip. If the return value of the function
3612 * is `null` no tooltip will be set.
3614 * @name LuCI.form.TypedSection.prototype#tooltip
3615 * @type string|function
3620 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3623 if (typeof(this.tooltip
) == 'function')
3624 tooltip
= this.tooltip
.apply(this, [section_id
]);
3625 else if (typeof(this.tooltip
) == 'string')
3626 tooltip
= (arguments
.length
> 1) ? ''.format
.apply(this.tooltip
, this.varargs(arguments
, 1)) : this.tooltip
;
3628 var widget
= new ui
.Checkbox((cfgvalue
!= null) ? cfgvalue
: this.default, {
3629 id
: this.cbid(section_id
),
3630 value_enabled
: this.enabled
,
3631 value_disabled
: this.disabled
,
3632 validate
: L
.bind(this.validate
, this, section_id
),
3634 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3637 return widget
.render();
3641 * Query the checked state of the underlying checkbox widget and return
3642 * either the `enabled` or the `disabled` property value, depending on
3643 * the checked state.
3647 formvalue: function(section_id
) {
3648 var elem
= this.getUIElement(section_id
),
3649 checked
= elem
? elem
.isChecked() : false;
3650 return checked
? this.enabled
: this.disabled
;
3654 * Query the checked state of the underlying checkbox widget and return
3655 * either a localized `Yes` or `No` string, depending on the checked state.
3659 textvalue: function(section_id
) {
3660 var cval
= this.cfgvalue(section_id
);
3663 cval
= this.default;
3665 return (cval
== this.enabled
) ? _('Yes') : _('No');
3669 parse: function(section_id
) {
3670 if (this.isActive(section_id
)) {
3671 var fval
= this.formvalue(section_id
);
3673 if (!this.isValid(section_id
)) {
3674 var title
= this.stripTags(this.title
).trim();
3675 return Promise
.reject(new TypeError(_('Option "%s" contains an invalid input value.').format(title
|| this.option
)));
3678 if (fval
== this.default && (this.optional
|| this.rmempty
))
3679 return Promise
.resolve(this.remove(section_id
));
3681 return Promise
.resolve(this.write(section_id
, fval
));
3684 return Promise
.resolve(this.remove(section_id
));
3691 * @memberof LuCI.form
3692 * @augments LuCI.form.DynamicList
3696 * The `MultiValue` class is a modified variant of the `DynamicList` element
3697 * which leverages the {@link LuCI.ui.Dropdown} widget to implement a multi
3698 * select dropdown element.
3700 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3701 * The configuration form this section is added to. It is automatically passed
3702 * by [option()]{@link LuCI.form.AbstractSection#option} or
3703 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3704 * option to the section.
3706 * @param {LuCI.form.AbstractSection} section
3707 * The configuration section this option is added to. It is automatically passed
3708 * by [option()]{@link LuCI.form.AbstractSection#option} or
3709 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3710 * option to the section.
3712 * @param {string} option
3713 * The name of the UCI option to map.
3715 * @param {string} [title]
3716 * The title caption of the option element.
3718 * @param {string} [description]
3719 * The description text of the option element.
3721 var CBIMultiValue
= CBIDynamicList
.extend(/** @lends LuCI.form.MultiValue.prototype */ {
3722 __name__
: 'CBI.MultiValue',
3724 __init__: function() {
3725 this.super('__init__', arguments
);
3726 this.placeholder
= _('-- Please choose --');
3730 * Allows to specify the [display_items]{@link LuCI.ui.Dropdown.InitOptions}
3731 * property of the underlying dropdown widget. If omitted, the value of
3732 * the `size` property is used or `3` when `size` is unspecified as well.
3734 * @name LuCI.form.MultiValue.prototype#display_size
3740 * Allows to specify the [dropdown_items]{@link LuCI.ui.Dropdown.InitOptions}
3741 * property of the underlying dropdown widget. If omitted, the value of
3742 * the `size` property is used or `-1` when `size` is unspecified as well.
3744 * @name LuCI.form.MultiValue.prototype#dropdown_size
3750 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3751 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default,
3752 choices
= this.transformChoices();
3754 var widget
= new ui
.Dropdown(L
.toArray(value
), choices
, {
3755 id
: this.cbid(section_id
),
3758 optional
: this.optional
|| this.rmempty
,
3759 select_placeholder
: this.placeholder
,
3760 display_items
: this.display_size
|| this.size
|| 3,
3761 dropdown_items
: this.dropdown_size
|| this.size
|| -1,
3762 validate
: L
.bind(this.validate
, this, section_id
),
3763 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3766 return widget
.render();
3772 * @memberof LuCI.form
3773 * @augments LuCI.form.Value
3777 * The `TextValue` class implements a multi-line textarea input using
3778 * {@link LuCI.ui.Textarea}.
3780 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3781 * The configuration form this section is added to. It is automatically passed
3782 * by [option()]{@link LuCI.form.AbstractSection#option} or
3783 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3784 * option to the section.
3786 * @param {LuCI.form.AbstractSection} section
3787 * The configuration section this option is added to. It is automatically passed
3788 * by [option()]{@link LuCI.form.AbstractSection#option} or
3789 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3790 * option to the section.
3792 * @param {string} option
3793 * The name of the UCI option to map.
3795 * @param {string} [title]
3796 * The title caption of the option element.
3798 * @param {string} [description]
3799 * The description text of the option element.
3801 var CBITextValue
= CBIValue
.extend(/** @lends LuCI.form.TextValue.prototype */ {
3802 __name__
: 'CBI.TextValue',
3808 * Enforces the use of a monospace font for the textarea contents when set
3811 * @name LuCI.form.TextValue.prototype#monospace
3817 * Allows to specify the [cols]{@link LuCI.ui.Textarea.InitOptions}
3818 * property of the underlying textarea widget.
3820 * @name LuCI.form.TextValue.prototype#cols
3826 * Allows to specify the [rows]{@link LuCI.ui.Textarea.InitOptions}
3827 * property of the underlying textarea widget.
3829 * @name LuCI.form.TextValue.prototype#rows
3835 * Allows to specify the [wrap]{@link LuCI.ui.Textarea.InitOptions}
3836 * property of the underlying textarea widget.
3838 * @name LuCI.form.TextValue.prototype#wrap
3844 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3845 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default;
3847 var widget
= new ui
.Textarea(value
, {
3848 id
: this.cbid(section_id
),
3849 optional
: this.optional
|| this.rmempty
,
3850 placeholder
: this.placeholder
,
3851 monospace
: this.monospace
,
3855 validate
: L
.bind(this.validate
, this, section_id
),
3856 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
3859 return widget
.render();
3865 * @memberof LuCI.form
3866 * @augments LuCI.form.Value
3870 * The `DummyValue` element wraps an {@link LuCI.ui.Hiddenfield} widget and
3871 * renders the underlying UCI option or default value as readonly text.
3873 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3874 * The configuration form this section is added to. It is automatically passed
3875 * by [option()]{@link LuCI.form.AbstractSection#option} or
3876 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3877 * option to the section.
3879 * @param {LuCI.form.AbstractSection} section
3880 * The configuration section this option is added to. It is automatically passed
3881 * by [option()]{@link LuCI.form.AbstractSection#option} or
3882 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3883 * option to the section.
3885 * @param {string} option
3886 * The name of the UCI option to map.
3888 * @param {string} [title]
3889 * The title caption of the option element.
3891 * @param {string} [description]
3892 * The description text of the option element.
3894 var CBIDummyValue
= CBIValue
.extend(/** @lends LuCI.form.DummyValue.prototype */ {
3895 __name__
: 'CBI.DummyValue',
3898 * Set an URL which is opened when clicking on the dummy value text.
3900 * By setting this property, the dummy value text is wrapped in an `<a>`
3901 * element with the property value used as `href` attribute.
3903 * @name LuCI.form.DummyValue.prototype#href
3909 * Treat the UCI option value (or the `default` property value) as HTML.
3911 * By default, the value text is HTML escaped before being rendered as
3912 * text. In some cases it may be needed to actually interpret and render
3913 * HTML contents as-is. When set to `true`, HTML escaping is disabled.
3915 * @name LuCI.form.DummyValue.prototype#rawhtml
3921 renderWidget: function(section_id
, option_index
, cfgvalue
) {
3922 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default,
3923 hiddenEl
= new ui
.Hiddenfield(value
, { id
: this.cbid(section_id
) }),
3924 outputEl
= E('div');
3926 if (this.href
&& !((this.readonly
!= null) ? this.readonly
: this.map
.readonly
))
3927 outputEl
.appendChild(E('a', { 'href': this.href
}));
3929 dom
.append(outputEl
.lastChild
|| outputEl
,
3930 this.rawhtml
? value
: [ value
]);
3939 remove: function() {},
3942 write: function() {}
3946 * @class ButtonValue
3947 * @memberof LuCI.form
3948 * @augments LuCI.form.Value
3952 * The `DummyValue` element wraps an {@link LuCI.ui.Hiddenfield} widget and
3953 * renders the underlying UCI option or default value as readonly text.
3955 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
3956 * The configuration form this section is added to. It is automatically passed
3957 * by [option()]{@link LuCI.form.AbstractSection#option} or
3958 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3959 * option to the section.
3961 * @param {LuCI.form.AbstractSection} section
3962 * The configuration section this option is added to. It is automatically passed
3963 * by [option()]{@link LuCI.form.AbstractSection#option} or
3964 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
3965 * option to the section.
3967 * @param {string} option
3968 * The name of the UCI option to map.
3970 * @param {string} [title]
3971 * The title caption of the option element.
3973 * @param {string} [description]
3974 * The description text of the option element.
3976 var CBIButtonValue
= CBIValue
.extend(/** @lends LuCI.form.ButtonValue.prototype */ {
3977 __name__
: 'CBI.ButtonValue',
3980 * Override the rendered button caption.
3982 * By default, the option title - which is passed as fourth argument to the
3983 * constructor - is used as caption for the button element. When setting
3984 * this property to a string, it is used as `String.format()` pattern with
3985 * the underlying UCI section name passed as first format argument. When
3986 * set to a function, it is invoked passing the section ID as sole argument
3987 * and the resulting return value is converted to a string before being
3988 * used as button caption.
3990 * The default is `null`, means the option title is used as caption.
3992 * @name LuCI.form.ButtonValue.prototype#inputtitle
3993 * @type string|function
3998 * Override the button style class.
4000 * By setting this property, a specific `cbi-button-*` CSS class can be
4001 * selected to influence the style of the resulting button.
4003 * Suitable values which are implemented by most themes are `positive`,
4004 * `negative` and `primary`.
4006 * The default is `null`, means a neutral button styling is used.
4008 * @name LuCI.form.ButtonValue.prototype#inputstyle
4014 * Override the button click action.
4016 * By default, the underlying UCI option (or default property) value is
4017 * copied into a hidden field tied to the button element and the save
4018 * action is triggered on the parent form element.
4020 * When this property is set to a function, it is invoked instead of
4021 * performing the default actions. The handler function will receive the
4022 * DOM click element as first and the underlying configuration section ID
4023 * as second argument.
4025 * @name LuCI.form.ButtonValue.prototype#onclick
4031 renderWidget: function(section_id
, option_index
, cfgvalue
) {
4032 var value
= (cfgvalue
!= null) ? cfgvalue
: this.default,
4033 hiddenEl
= new ui
.Hiddenfield(value
, { id
: this.cbid(section_id
) }),
4034 outputEl
= E('div'),
4035 btn_title
= this.titleFn('inputtitle', section_id
) || this.titleFn('title', section_id
);
4037 if (value
!== false)
4038 dom
.content(outputEl
, [
4040 'class': 'cbi-button cbi-button-%s'.format(this.inputstyle
|| 'button'),
4041 'click': ui
.createHandlerFn(this, function(section_id
, ev
) {
4043 return this.onclick(ev
, section_id
);
4045 ev
.currentTarget
.parentNode
.nextElementSibling
.value
= value
;
4046 return this.map
.save();
4048 'disabled': ((this.readonly
!= null) ? this.readonly
: this.map
.readonly
) || null
4052 dom
.content(outputEl
, ' - ');
4062 * @class HiddenValue
4063 * @memberof LuCI.form
4064 * @augments LuCI.form.Value
4068 * The `HiddenValue` element wraps an {@link LuCI.ui.Hiddenfield} widget.
4070 * Hidden value widgets used to be necessary in legacy code which actually
4071 * submitted the underlying HTML form the server. With client side handling of
4072 * forms, there are more efficient ways to store hidden state data.
4074 * Since this widget has no visible content, the title and description values
4075 * of this form element should be set to `null` as well to avoid a broken or
4076 * distorted form layout when rendering the option element.
4078 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
4079 * The configuration form this section is added to. It is automatically passed
4080 * by [option()]{@link LuCI.form.AbstractSection#option} or
4081 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4082 * option to the section.
4084 * @param {LuCI.form.AbstractSection} section
4085 * The configuration section this option is added to. It is automatically passed
4086 * by [option()]{@link LuCI.form.AbstractSection#option} or
4087 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4088 * option to the section.
4090 * @param {string} option
4091 * The name of the UCI option to map.
4093 * @param {string} [title]
4094 * The title caption of the option element.
4096 * @param {string} [description]
4097 * The description text of the option element.
4099 var CBIHiddenValue
= CBIValue
.extend(/** @lends LuCI.form.HiddenValue.prototype */ {
4100 __name__
: 'CBI.HiddenValue',
4103 renderWidget: function(section_id
, option_index
, cfgvalue
) {
4104 var widget
= new ui
.Hiddenfield((cfgvalue
!= null) ? cfgvalue
: this.default, {
4105 id
: this.cbid(section_id
)
4108 return widget
.render();
4114 * @memberof LuCI.form
4115 * @augments LuCI.form.Value
4119 * The `FileUpload` element wraps an {@link LuCI.ui.FileUpload} widget and
4120 * offers the ability to browse, upload and select remote files.
4122 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
4123 * The configuration form this section is added to. It is automatically passed
4124 * by [option()]{@link LuCI.form.AbstractSection#option} or
4125 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4126 * option to the section.
4128 * @param {LuCI.form.AbstractSection} section
4129 * The configuration section this option is added to. It is automatically passed
4130 * by [option()]{@link LuCI.form.AbstractSection#option} or
4131 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4132 * option to the section.
4134 * @param {string} option
4135 * The name of the UCI option to map.
4137 * @param {string} [title]
4138 * The title caption of the option element.
4140 * @param {string} [description]
4141 * The description text of the option element.
4143 var CBIFileUpload
= CBIValue
.extend(/** @lends LuCI.form.FileUpload.prototype */ {
4144 __name__
: 'CBI.FileSelect',
4146 __init__: function(/* ... */) {
4147 this.super('__init__', arguments
);
4149 this.show_hidden
= false;
4150 this.enable_upload
= true;
4151 this.enable_remove
= true;
4152 this.root_directory
= '/etc/luci-uploads';
4156 * Toggle display of hidden files.
4158 * Display hidden files when rendering the remote directory listing.
4159 * Note that this is merely a cosmetic feature, hidden files are always
4160 * included in received remote file listings.
4162 * The default is `false`, means hidden files are not displayed.
4164 * @name LuCI.form.FileUpload.prototype#show_hidden
4170 * Toggle file upload functionality.
4172 * When set to `true`, the underlying widget provides a button which lets
4173 * the user select and upload local files to the remote system.
4174 * Note that this is merely a cosmetic feature, remote upload access is
4175 * controlled by the session ACL rules.
4177 * The default is `true`, means file upload functionality is displayed.
4179 * @name LuCI.form.FileUpload.prototype#enable_upload
4185 * Toggle remote file delete functionality.
4187 * When set to `true`, the underlying widget provides a buttons which let
4188 * the user delete files from remote directories. Note that this is merely
4189 * a cosmetic feature, remote delete permissions are controlled by the
4190 * session ACL rules.
4192 * The default is `true`, means file removal buttons are displayed.
4194 * @name LuCI.form.FileUpload.prototype#enable_remove
4200 * Specify the root directory for file browsing.
4202 * This property defines the topmost directory the file browser widget may
4203 * navigate to, the UI will not allow browsing directories outside this
4204 * prefix. Note that this is merely a cosmetic feature, remote file access
4205 * and directory listing permissions are controlled by the session ACL
4208 * The default is `/etc/luci-uploads`.
4210 * @name LuCI.form.FileUpload.prototype#root_directory
4212 * @default /etc/luci-uploads
4216 renderWidget: function(section_id
, option_index
, cfgvalue
) {
4217 var browserEl
= new ui
.FileUpload((cfgvalue
!= null) ? cfgvalue
: this.default, {
4218 id
: this.cbid(section_id
),
4219 name
: this.cbid(section_id
),
4220 show_hidden
: this.show_hidden
,
4221 enable_upload
: this.enable_upload
,
4222 enable_remove
: this.enable_remove
,
4223 root_directory
: this.root_directory
,
4224 disabled
: (this.readonly
!= null) ? this.readonly
: this.map
.readonly
4227 return browserEl
.render();
4232 * @class SectionValue
4233 * @memberof LuCI.form
4234 * @augments LuCI.form.Value
4238 * The `SectionValue` widget embeds a form section element within an option
4239 * element container, allowing to nest form sections into other sections.
4241 * @param {LuCI.form.Map|LuCI.form.JSONMap} form
4242 * The configuration form this section is added to. It is automatically passed
4243 * by [option()]{@link LuCI.form.AbstractSection#option} or
4244 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4245 * option to the section.
4247 * @param {LuCI.form.AbstractSection} section
4248 * The configuration section this option is added to. It is automatically passed
4249 * by [option()]{@link LuCI.form.AbstractSection#option} or
4250 * [taboption()]{@link LuCI.form.AbstractSection#taboption} when adding the
4251 * option to the section.
4253 * @param {string} option
4254 * The internal name of the option element holding the section. Since a section
4255 * container element does not read or write any configuration itself, the name
4256 * is only used internally and does not need to relate to any underlying UCI
4259 * @param {LuCI.form.AbstractSection} subsection_class
4260 * The class to use for instantiating the nested section element. Note that
4261 * the class value itself is expected here, not a class instance obtained by
4262 * calling `new`. The given class argument must be a subclass of the
4263 * `AbstractSection` class.
4265 * @param {...*} [class_args]
4266 * All further arguments are passed as-is to the subclass constructor. Refer
4267 * to the corresponding class constructor documentations for details.
4269 var CBISectionValue
= CBIValue
.extend(/** @lends LuCI.form.SectionValue.prototype */ {
4270 __name__
: 'CBI.ContainerValue',
4271 __init__: function(map
, section
, option
, cbiClass
/*, ... */) {
4272 this.super('__init__', [map
, section
, option
]);
4274 if (!CBIAbstractSection
.isSubclass(cbiClass
))
4275 throw 'Sub section must be a descendent of CBIAbstractSection';
4277 this.subsection
= cbiClass
.instantiate(this.varargs(arguments
, 4, this.map
));
4278 this.subsection
.parentoption
= this;
4282 * Access the embedded section instance.
4284 * This property holds a reference to the instantiated nested section.
4286 * @name LuCI.form.SectionValue.prototype#subsection
4287 * @type LuCI.form.AbstractSection
4292 load: function(section_id
) {
4293 return this.subsection
.load(section_id
);
4297 parse: function(section_id
) {
4298 return this.subsection
.parse(section_id
);
4302 renderWidget: function(section_id
, option_index
, cfgvalue
) {
4303 return this.subsection
.render(section_id
);
4307 checkDepends: function(section_id
) {
4308 this.subsection
.checkDepends(section_id
);
4309 return CBIValue
.prototype.checkDepends
.apply(this, [ section_id
]);
4313 * Since the section container is not rendering an own widget,
4314 * its `value()` implementation is a no-op.
4318 value: function() {},
4321 * Since the section container is not tied to any UCI configuration,
4322 * its `write()` implementation is a no-op.
4326 write: function() {},
4329 * Since the section container is not tied to any UCI configuration,
4330 * its `remove()` implementation is a no-op.
4334 remove: function() {},
4337 * Since the section container is not tied to any UCI configuration,
4338 * its `cfgvalue()` implementation will always return `null`.
4343 cfgvalue: function() { return null },
4346 * Since the section container is not tied to any UCI configuration,
4347 * its `formvalue()` implementation will always return `null`.
4352 formvalue: function() { return null }
4361 * The LuCI form class provides high level abstractions for creating creating
4362 * UCI- or JSON backed configurations forms.
4364 * To import the class in views, use `'require form'`, to import it in
4365 * external JavaScript, use `L.require("form").then(...)`.
4367 * A typical form is created by first constructing a
4368 * {@link LuCI.form.Map} or {@link LuCI.form.JSONMap} instance using `new` and
4369 * by subsequently adding sections and options to it. Finally
4370 * [render()]{@link LuCI.form.Map#render} is invoked on the instance to
4371 * assemble the HTML markup and insert it into the DOM.
4381 * m = new form.Map('example', 'Example form',
4382 * 'This is an example form mapping the contents of /etc/config/example');
4384 * s = m.section(form.NamedSection, 'first_section', 'example', 'The first section',
4385 * 'This sections maps "config example first_section" of /etc/config/example');
4387 * o = s.option(form.Flag, 'some_bool', 'A checkbox option');
4389 * o = s.option(form.ListValue, 'some_choice', 'A select element');
4390 * o.value('choice1', 'The first choice');
4391 * o.value('choice2', 'The second choice');
4393 * m.render().then(function(node) {
4394 * document.body.appendChild(node);
4398 return baseclass
.extend(/** @lends LuCI.form.prototype */ {
4400 JSONMap
: CBIJSONMap
,
4401 AbstractSection
: CBIAbstractSection
,
4402 AbstractValue
: CBIAbstractValue
,
4404 TypedSection
: CBITypedSection
,
4405 TableSection
: CBITableSection
,
4406 GridSection
: CBIGridSection
,
4407 NamedSection
: CBINamedSection
,
4410 DynamicList
: CBIDynamicList
,
4411 ListValue
: CBIListValue
,
4413 MultiValue
: CBIMultiValue
,
4414 TextValue
: CBITextValue
,
4415 DummyValue
: CBIDummyValue
,
4416 Button
: CBIButtonValue
,
4417 HiddenValue
: CBIHiddenValue
,
4418 FileUpload
: CBIFileUpload
,
4419 SectionValue
: CBISectionValue