Module: cbi

CBI (Configuration Bindings Interface) helper utilities and DOM helpers.

Provides initialization for CBI UI elements, dependency handling, validation wiring and miscellaneous helpers used by LuCI forms. Functions defined here are registered as global window.* symbols.

Source: cbi.js, line 14

Methods

(inner) E() → {HTMLElement}

Create DOM elements using L.dom.create helper (convenience wrapper).

Source: cbi.js, line 916

Returns:

Type:: HTMLElement

(inner) N_(n, s, p, copt) → {string}

Plural-aware translation lookup.

Parameters:

Name	Type	Attributes	Description
`n`	number		Quantity to evaluate plural form.
`s`	string		Singular string.
`p`	string		Plural string.
`c`	string	<optional>	Optional context.

Source: cbi.js, line 167

Returns:

Translated plural form or source string.

Type:: string

(inner) _(s, copt) → {string}

Lookup a translated string for the given message and optional context. Falls back to the source string when no translation found.

Parameters:

Name	Type	Attributes	Description
`s`	string		Source string.
`c`	string	<optional>	Optional translation context.

Source: cbi.js, line 154

Returns:

Translated string or original.

Type:: string

(inner) cbi_d_add(field, dep, index)

Parameters:

Name	Type	Description
`field`	HTMLElement \| string	Field element or its id.
`dep`	Object	Dependency specification object.
`index`	number	Order index of the dependent node.

Source: cbi.js, line 184

(inner) cbi_d_check(deps) → {boolean}

Evaluate a list of dependency descriptors and return whether any match.

Parameters:

Name	Type	Description
`deps`	Array.<Object>	Array of dependency objects to evaluate.

Source: cbi.js, line 232

Returns:

True when dependencies indicate the element should be shown.

Type:: boolean

(inner) cbi_d_checkvalue(target, ref) → {boolean}

Check whether an input/select identified by target matches the given reference value.

Parameters:

Name	Type	Description
`target`	string	Element id or name to query.
`ref`	string	Reference value to compare with.

Source: cbi.js, line 214

Returns:

True if the current value matches ref.

Type:: boolean

(inner) cbi_d_update()

Update DOM nodes based on registered dependencies, showing or hiding nodes and restoring their order when dependency state changes.

Source: cbi.js, line 260

(inner) cbi_dropdown_init(sb) → {L.ui.Dropdown|undefined}

Initialize a dropdown element into an L.ui.Dropdown instance and bind it. If already bound, this is a no-op.

Parameters:

Name	Type	Description
`sb`	HTMLElement	The select element to convert.

Source: cbi.js, line 924

Returns:

Dropdown instance or undefined when already bound.

Type:: L.ui.Dropdown | undefined

(inner) cbi_init()

Initialize CBI widgets and wire up dependency and validation handlers. Walks the DOM looking for CBI-specific data attributes and replaces placeholders with interactive widgets.

Source: cbi.js, line 306

(inner) cbi_row_swap(elem, up, store) → {boolean}

Move a table row up or down within a section and update the storage field.

Parameters:

Name	Type	Description
`elem`	HTMLElement	Element inside the row that triggers the swap.
`up`	boolean	If true, move the row up; otherwise move down.
`store`	string	ID of the hidden input used to store the order.

Source: cbi.js, line 533

Returns:

Always returns false to cancel default action.

Type:: boolean

(inner) cbi_submit(elem, nameopt, valueopt, actionopt) → {boolean}

Submit a form, optionally adding a hidden input to pass a name/value pair.

Parameters:

Name	Type	Attributes	Description
`elem`	HTMLElement		Element inside the form or an element with a form.
`name`	string	<optional>	Name of hidden input to include, if any.
`value`	string	<optional>	Value for the hidden input (defaults to '1').
`action`	string	<optional>	Optional form action URL override.

Source: cbi.js, line 614

Returns:

True on successful submit, false when no form found.

Type:: boolean

(inner) cbi_tag_last(container)

Mark the last visible value container child with class cbi-value-last.

Parameters:

Name	Type	Description
`container`	HTMLElement	Parent container element.

Source: cbi.js, line 590

(inner) cbi_update_table(table, …data, placeholderopt)

Update or initialize a table UI widget with new data.

Parameters:

Name	Type	Attributes	Description
`table`	HTMLElement \| string		Table element or selector.
`data`	Array.<Node>	<repeatable>	Data to update the table with.
`placeholder`	string	<optional>	Placeholder text when empty.

Source: cbi.js, line 938

(inner) cbi_validate_field(cbid, optional, type)

Attach a validator to a field and wire validation events.

Parameters:

Name	Type	Description
`cbid`	HTMLElement \| string	Element or element id to validate.
`optional`	boolean	Whether an empty value is allowed.
`type`	string	Validator type expression (passed to L.validation).

Source: cbi.js, line 492

(inner) cbi_validate_form(form, errmsgopt) → {boolean}

Run all validators associated with a form and optionally show an error.

Parameters:

Name	Type	Attributes	Description
`form`	HTMLFormElement		Form element containing validators.
`errmsg`	string	<optional>	Message to show when validation fails.

Source: cbi.js, line 441

Returns:

True when form is valid.

Type:: boolean

(inner) cbi_validate_named_section_add(input)

Enable/disable a named-section add button depending on input value.

Parameters:

Name	Type	Description
`input`	HTMLInputElement	Input that contains the new section name.

Source: cbi.js, line 466

(inner) cbi_validate_reset(form) → {boolean}

Trigger a delayed form validation (used to allow UI state to settle).

Parameters:

Name	Type	Description
`form`	HTMLFormElement	Form to validate after a short delay.

Source: cbi.js, line 477

Returns:

Always returns true.

Type:: boolean

(inner) findParent(node, selector) → {HTMLElement|null}

Find the parent matching selector from node upwards.

Parameters:

Name	Type	Description
`node`	Node	Starting node.
`selector`	string	CSS selector to match ancestor.

Source: cbi.js, line 910

Returns:

Type:: HTMLElement | null

(inner) isElem(e) → {HTMLElement|null}

Return the element for input which may be an element or an id.

Parameters:

Name	Type	Description
`e`	Element \| string	Element or id.

Source: cbi.js, line 894

Returns:

Type:: HTMLElement | null

(inner) matchesElem(node, selector) → {boolean}

Test whether node matches a CSS selector.

Parameters:

Name	Type	Description
`node`	Node	Node to test.
`selector`	string	CSS selector.

Source: cbi.js, line 902

Returns:

Type:: boolean

(inner) s8(bytes, off) → {number}

Read signed 8-bit integer from a byte array at the given offset.

Parameters:

Name	Type	Description
`bytes`	Array.<number>	Byte array.
`off`	number	Offset into the array.

Source: cbi.js, line 35

Returns:

Signed 8-bit value (returned as unsigned number).

Type:: number

(inner) sfh(s) → {string|null}

Compute a stable 32-bit-ish string hash used for translation keys. Encodes UTF-8 surrogate pairs and mixes bytes into a hex hash string.

Parameters:

Name	Type	Description
`s`	string \| null	Input string.

Source: cbi.js, line 56

Returns:

Hex hash string or null for empty input.

Type:: string | null

(inner) trimws(s) → {string}

Trim whitespace and normalise internal whitespace sequences to single spaces.

Parameters:

Name	Type	Description
`s`	*	Value to convert to string and trim.

Source: cbi.js, line 143

Returns:

Trimmed and normalised string.

Type:: string

(inner) u16(bytes, off) → {number}

Read unsigned 16-bit little-endian integer from a byte array at offset.

Parameters:

Name	Type	Description
`bytes`	Array.<number>	Byte array.
`off`	number	Offset into the array.

Source: cbi.js, line 46

Returns:

Unsigned 16-bit integer.

Type:: number