LuCI

https://openwrt.github.io/luci/
Admin
LuCI is OpenWrt's web-based administration interface providing a customizable web UI for managing...
Tokens:215,622
Snippets:1,597
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install C/C++ binaries in Makefile

Source: https://openwrt.github.io/luci/jsapi/tutorial-Modules.html

Example command for the install target in a module Makefile to deploy compiled binaries.

```makefile
| mkdir -p $(DESTDIR)/usr/bin; cp myexecutable $(DESTDIR)/usr/bin/myexecutable  
---|---  

```

--------------------------------

### DeclareOptions params examples

Source: https://openwrt.github.io/luci/jsapi/LuCI.rpc.html

Examples showing how params map arguments to remote ubus method calls.

```javascript
params: [ "foo", "bar" ]
```

```javascript
params: [ "test" ], filter: function(reply, args, extra) { ... }
```

--------------------------------

### DeclareOptions expect examples

Source: https://openwrt.github.io/luci/jsapi/LuCI.rpc.html

Examples demonstrating how to define expected return data structures for ubus replies.

```javascript
expect: { '': { error: 'Invalid response' } }
```

```javascript
expect: { results: [] }
```

```javascript
expect: { success: false }
```

--------------------------------

### start()

Source: https://openwrt.github.io/luci/jsapi/LuCI.poll.html

Starts or restarts the polling loop.

```APIDOC
## start()

### Description
(Re)start the polling loop. Dispatches a custom 'poll-start' event to the document object upon successful start.

### Returns
- **boolean** - Returns true if polling has been started (or if no functions were registered) or false when the polling loop already runs.
```

--------------------------------

### Define LuCI package installation target

Source: https://openwrt.github.io/luci/jsapi/tutorial-Modules.html

Installation target definition for a LuCI application using the standard template.

```makefile
define Package/luci-app-YOURMODULE/install
  $(call Package/luci/install/template,$(1),applications/YOURMODULE)
endef

```

--------------------------------

### Initialize LuCI components

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Example of initializing LuCI components by requiring modules and overriding the default cbi_init.

```javascript
this.require('form'),
				this.probeRPCBaseURL()
			]).then(this.setupDOM.bind(this)).catch(this.error);

			originalCBIInit = window.cbi_init;
			window.cbi_init = () => {};
```

--------------------------------

### Post-Installation Script

Source: https://openwrt.github.io/luci/jsapi/tutorial-ThemesHowTo.html

Use an ipkg postinst script to execute the uci-defaults configuration upon package installation.

```shell
#!/bin/sh  
[ -n "${IPKG_INSTROOT}" ] || {  
	( . /etc/uci-defaults/luci-theme-mytheme ) && rm -f /etc/uci-defaults/luci-theme-mytheme  
}
```

--------------------------------

### LuCI.request.poll.start()

Source: https://openwrt.github.io/luci/jsapi/LuCI.request.poll.html

Starts the polling mechanism.

```APIDOC
## LuCI.request.poll.start()

### Description
Alias for LuCI.poll.start().

### Returns
- **boolean** - Returns true if the polling was successfully started.
```

--------------------------------

### LuCI.run()

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Deprecated wrapper to start the polling loop.

```APIDOC
## LuCI.run()

### Returns
- **boolean** - Returns true if the loop was started, false if it was already running.
```

--------------------------------

### Get Protocol Instance

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Instantiates a specific network protocol back-end by name.

```javascript
getProtocol(protoname, netname) {  
		const v = _protocols[protoname];  
		if (v != null)  
			return new v(netname || '__dummy__');  
   
		return null;  
	},
```

--------------------------------

### LuCI.form Usage

Source: https://openwrt.github.io/luci/jsapi/LuCI.form.html

Example of creating a configuration form using LuCI.form.Map, adding a section, and defining options.

```APIDOC
## LuCI.form Usage

### Description
This example demonstrates how to initialize a form map, add a named section, and define various input options like checkboxes and select lists.

### Code Example
```javascript
'use strict';
'require form';

let m, s, o;

// Create a map for /etc/config/example
m = new form.Map('example', _('Example form'),
	_('This is an example form mapping the contents of /etc/config/example'));

// Add a named section
s = m.section(form.NamedSection, 'first_section', 'example', _('The first section'),
	_('This sections maps "config example first_section" of /etc/config/example'));

// Add a checkbox option
o = s.option(form.Flag, 'some_bool', _('A checkbox option'));

// Add a select element
o = s.option(form.ListValue, 'some_choice', _('A select element'));
o.value('choice1', _('The first choice'));
o.value('choice2', _('The second choice'));

// Render the form and append to DOM
m.render().then((node) => {
	document.body.appendChild(node);
});
```
```

--------------------------------

### Get All Logical Interfaces

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Returns an array of LuCI.network.Protocol instances assigned to the device.

```javascript
getNetworks() {
		if (this.networks == null) {
			this.networks = [];

			const networks = enumerateNetworks.apply(L.network);

			for (let n of networks)
				if (n.containsDevice(this.device) || n.getIfname() == this.device)
					this.networks.push(n);

			this.networks.sort(networkSort);
		}

		return this.networks;
	},
```

--------------------------------

### LuCI.request.get(url, options)

Source: https://openwrt.github.io/luci/jsapi/LuCI.request.html

Initiates an HTTP GET request to the specified target.

```APIDOC
## LuCI.request.get(url, options)

### Description
Initiate an HTTP GET request to the given target.

### Parameters
- **url** (string) - Required - The URL to request.
- **options** (LuCI.request.RequestOptions) - Optional - Additional options to configure the request.

### Returns
- **(Promise.<LuCI.response>)** - The resulting HTTP response.
```

--------------------------------

### Get All Protocols

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Retrieves instances of all registered network protocol back-ends.

```javascript
getProtocols() {  
		const rv = [];  
   
		for (let protoname in _protocols)  
			rv.push(new _protocols[protoname]('__dummy__'));  
   
		return rv;  
	},
```

--------------------------------

### DOM and RPC Setup

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Configures the RPC base URL and adds an interceptor to handle session expiry errors.

```javascript
setupDOM([domEv, uiClass, rpcClass, formClass, rpcBaseURL]) {

			rpcClass.setBaseURL(rpcBaseURL);

			rpcClass.addInterceptor((msg, req) => {
				if (!LuCI.prototype.isObject(msg) ||
					!LuCI.prototype.isObject(msg.error) ||
					msg.error.code != -32002)
					return;

				if (!LuCI.prototype.isObject(req) ||
					(req.object == 'session' && req.method == 'access'))
					return;

				return rpcClass.declare({
					'object': 'session',
					'method': 'access',
					'params': [ 'scope', 'object', 'function' ],
					'expect': { access: true }
				})('uci', 'luci', 'read').catch(LuCI.prototype.notifySessionExpiry);
			});
		},
```

--------------------------------

### Initialize LuCI framework

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Sets up the LuCI environment, detects base URLs from script tags, and initializes core promises.

```javascript
__init__(setenv) {  
   
			document.querySelectorAll('script[src*="/luci.js"]').forEach(s => {  
				if (setenv.base_url == null || setenv.base_url == '') {  
					const m = (s.getAttribute('src') ?? '').match(/^(.*)\/luci\.js(?:\?v=([^?]+))?$/);  
					if (m) {  
						setenv.base_url = m[1];  
						setenv.resource_version = m[2];  
					}  
				}  
			});  
   
			if (setenv.base_url == null)  
				this.error('InternalError', 'Cannot find url of luci.js');  
   
			setenv.cgi_base = setenv.scriptname.replace(/\/[^/]+$/, '');  
   
			Object.assign(env, setenv);  
   
			const domReady = new Promise((resolveFn, rejectFn) => {  
				document.addEventListener('DOMContentLoaded', resolveFn);  
			});  
   
			Promise.all([  
				domReady,  
				this.require('ui'),  
				this.require('rpc'),
```

--------------------------------

### Perform HTTP GET request

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Issues a GET request to the specified URL. This method is deprecated.

```javascript
get(url, args, cb) {
			return this.poll(null, url, args, cb, false);
		}
```

--------------------------------

### Tuple Validator Usage Examples

Source: https://openwrt.github.io/luci/jsapi/validation.js.html

Examples of how to use the tuple validator with different types and separators.

```javascript
tuple(ipaddr,port) // "192.0.2.1 88"

tuple(host,port,sep(',')) // "taurus,8000"

tuple(port,port,port,sep('-')) // "33-45-78"
```

--------------------------------

### Get Switch Topologies

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Retrieves the topologies of all swconfig switches found on the system as a promise.

```javascript
getSwitchTopologies() {
		return initNetworkState().then(function() {
			return _state.switches;
		});
	}
```

--------------------------------

### Add Modal Options

Source: https://openwrt.github.io/luci/jsapi/form.js.html

Abstract method to perform setup before displaying a modal popup. Override this to inject custom elements or query data.

```javascript
addModalOptions(modalSection, section_id, ev) {

	},
```

--------------------------------

### get(url, args, cb)

Source: https://openwrt.github.io/luci/jsapi/LuCI.html

Issues a GET request to the given URL and invokes the specified callback function.

```APIDOC
## get(url, args, cb)

### Description
Issues a GET request to the given url and invokes the specified callback function. This function is deprecated.

### Parameters
- **url** (string) - Required - The URL to request.
- **args** (Object) - Optional - Additional query string arguments to append to the URL.
- **cb** (LuCI.requestCallbackFn) - Required - The callback function to invoke when the request finishes.

### Returns
- **Promise.<null>** - Returns a promise resolving to `null` when concluded.
```

--------------------------------

### Initialize translation files

Source: https://openwrt.github.io/luci/jsapi/tutorial-i18n.html

Generate skeleton .po files for available languages using the i18n-add-language script.

```bash
../../build/i18n-add-language.sh
```

```bash
./build/i18n-add-language.sh
```

--------------------------------

### Range validation examples

Source: https://openwrt.github.io/luci/jsapi/LuCI.validation.ValidatorFactory.types.html

Shows static range validation and dynamic range calculation for VLAN IDs.

```text
| range(-253, 253) // assert a value between -253 and +253  
---|---  
|    
| 'range(%u,%u)'.format(min_vid, feat.vid_option ? 4094 : num_vlans - 1);  
| // assert values calculated at runtime for VLAN IDs.
```

--------------------------------

### Initialize LuCI Application

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Handles system feature probing, class preloading, and DOM initialization.

```javascript
return Promise.all([  
				this.probeSystemFeatures(),  
				this.probePreloadClasses()  
			]).finally(LuCI.prototype.bind(function() {  
				const tasks = [];  
   
				if (Array.isArray(preloadClasses))  
					for (let i = 0; i < preloadClasses.length; i++)  
						tasks.push(this.require(preloadClasses[i]));  
   
				return Promise.all(tasks);  
			}, this)).finally(this.initDOM);  
		},  
   
		/* private */  
		initDOM() {  
			originalCBIInit();  
			Poll.start();  
			L.loaded = true;  
			document.dispatchEvent(new CustomEvent('luci-loaded'));  
		},
```

--------------------------------

### isInstalled()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Checks whether the protocol functionality is installed. Note: This method is deprecated and always returns true.

```APIDOC
## isInstalled()

### Description
Checks whether the protocol functionality is installed. This function exists for compatibility with old code, it always returns true.

### Returns
- **boolean** - Returns true if the protocol support is installed, else false.
```

--------------------------------

### LuCI.poll.start()

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

(Re)starts the polling loop.

```APIDOC
## LuCI.poll.start()

### Description
Starts the polling loop. Dispatches a custom 'poll-start' event to the document object upon successful start.

### Returns
- **boolean** - Returns true if polling has been started (or if no functions were registered) or false when the polling loop already runs.
```

--------------------------------

### Initiate HTTP requests

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Methods for performing GET and POST requests using the LuCI request infrastructure.

```javascript
get(url, options) {
			return this.request(url, Object.assign({ method: 'GET' }, options));
		},
```

```javascript
post(url, data, options) {
			return this.request(url, Object.assign({ method: 'POST', content: data }, options));
		},
```

--------------------------------

### Initialize UITable

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Constructs a new table instance, setting up headers and optional placeholders.

```javascript
const UITable = baseclass.extend(/** @lends LuCI.ui.table.prototype */ {  
	__init__(captions, options, placeholder) {  
		if (!Array.isArray(captions)) {  
			this.initFromMarkup(captions);  
   
			return;  
		}  
   
		const id = options.id ?? 'table%08x'.format(Math.random() * 0xffffffff);  
   
		const table = E('table', { 'id': id, 'class': 'table' }, [  
			E('tr', { 'class': 'tr table-titles', 'click': UI.prototype.createHandlerFn(this, 'handleSort') })  
		]);  
   
		this.id = id;  
		this.node = table  
		this.options = options;  
   
		const sorting = this.getActiveSortState();  
   
		for (let i = 0; i < captions.length; i++) {  
			if (captions[i] == null)  
				continue;  
   
			const th = E('th', { 'class': 'th' }, [ captions[i] ]);  
   
			if (typeof(options.captionClasses) == 'object')  
				DOMTokenList.prototype.add.apply(th.classList, L.toArray(options.captionClasses[i]));  
   
			if (options.sortable !== false && (typeof(options.sortable) != 'object' || options.sortable[i] !== false)) {  
				th.setAttribute('data-sortable-row', true);  
   
				if (sorting && sorting[0] == i)  
					th.setAttribute('data-sort-direction', sorting[1] ? 'desc' : 'asc');  
			}  
   
			table.firstElementChild.appendChild(th);  
		}  
   
		if (placeholder) {  
			const trow = table.appendChild(E('tr', { 'class': 'tr placeholder' }));  
			const td = trow.appendChild(E('td', { 'class': 'td' }, placeholder));  
   
			if (typeof(options.captionClasses) == 'object')  
				DOMTokenList.prototype.add.apply(td.classList, L.toArray(options.captionClasses[0]));  
		}  
   
		DOMTokenList.prototype.add.apply(table.classList, L.toArray(options.classes));  
	},
```

--------------------------------

### getUptime()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Gets the uptime of the logical interface.

```APIDOC
## getUptime()

### Description
Returns the uptime of the associated interface in seconds.

### Returns
- **number** - Uptime in seconds.
```

--------------------------------

### WifiDevice Class Implementation

Source: https://openwrt.github.io/luci/jsapi/network.js.html

The constructor initializes the device state using UCI configuration and ubus data.

```javascript
WifiDevice = baseclass.extend(/** @lends LuCI.network.WifiDevice.prototype */ {
	__init__(name, radiostate) {
		const uciWifiDevice = uci.get('wireless', name);

		if (uciWifiDevice != null &&
		    uciWifiDevice['.type'] == 'wifi-device' &&
		    uciWifiDevice['.name'] != null) {
			this.sid    = uciWifiDevice['.name'];
		}

		this.sid    = this.sid || name;
		this._ubusdata = {
			radio: name,
			dev:   radiostate
		};
	},
```

--------------------------------

### getType()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Gets the type of the underlying interface.

```APIDOC
## getType()

### Description
Returns the value of the 'type' option of the associated logical interface, often used to check if the interface is a bridge.

### Returns
- **null|string** - The interface type or null if not set.
```

--------------------------------

### Initialize a LuCI form Map

Source: https://openwrt.github.io/luci/jsapi/form.js.html

Demonstrates the basic setup for a new form map targeting a specific UCI configuration file.

```javascript
'use strict';
'require form';

let m, s, o;

m = new form.Map('example', _('Example form'),
	_('This is an example form mapping the contents of /etc/config/example'));
```

--------------------------------

### Render File Listing

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Initializes the rendering of a file system listing, including sorting logic.

```javascript
renderListing(container, path, list) {
		const breadcrumb = E('p');
		const rows = E('ul');

		list.sort((a, b) => {
			return (b.type == 'directory') - (a.type == 'directory') || L.naturalCompare(a.name, b.name);
		});

		for (let i = 0; i < list.length; i++) {
```

--------------------------------

### getBSSID()

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Get the configured BSSID of the wireless network.

```APIDOC
## getBSSID()

### Description
Get the configured BSSID of the wireless network.

### Returns
- **string|null** - The BSSID value or null if none has been specified.
```

--------------------------------

### UI Class Initialization

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Initializes modal and tooltip containers and sets up global event listeners.

```javascript
__init__() {
		modalDiv = document.body.appendChild(
			dom.create('div', {
				id: 'modal_overlay',
				tabindex: -1,
				keydown: this.cancelModal
			}, [
				dom.create('div', {
					class: 'modal',
					role: 'dialog',
					'aria-modal': true
				})
			]));

		tooltipDiv = document.body.appendChild(
			dom.create('div', { class: 'cbi-tooltip' }));

		/* set up old aliases */
		L.showModal = this.showModal;
		L.hideModal = this.hideModal;
		L.showTooltip = this.showTooltip;
		L.hideTooltip = this.hideTooltip;
		L.itemlist = this.itemlist;

		document.addEventListener('mouseover', this.showTooltip.bind(this), true);
		document.addEventListener('mouseout', this.hideTooltip.bind(this), true);
		document.addEventListener('focus', this.showTooltip.bind(this), true);
		document.addEventListener('blur', this.hideTooltip.bind(this), true);

		document.addEventListener('luci-loaded', this.tabs.init.bind(this.tabs));
		document.addEventListener('luci-loaded', this.changes.init.bind(this.changes));
		document.addEventListener('uci-loaded', this.changes.init.bind(this.changes));
	},
```

--------------------------------

### getNetworks()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.html

Gets an array containing all known networks.

```APIDOC
## getNetworks()

### Description
Gets an array containing all known networks.

### Returns
- **Promise.<Array.<LuCI.network.Protocol>>** - A promise resolving to a name-sorted array of Protocol subclass instances.
```

--------------------------------

### Retrieve Host Hints

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Fetches aggregated host information from system sources and returns a Hosts instance.

```javascript
getHostHints() {
		return initNetworkState().then(function() {
			return new Hosts(_state.hosts);
		});
	}
```

--------------------------------

### Instantiate Device

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Internal method to create a new network device instance.

```javascript
instantiateDevice(name, network, extend) {
		if (extend != null)
			return new (Device.extend(extend))(name, network);

		return new Device(name, network);
	}
```

--------------------------------

### getProtocol()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Gets the name of the network protocol class.

```APIDOC
## getProtocol()

### Description
Returns the name of the network protocol implementation, such as 'static' or 'dhcp'.

### Returns
- **string** - The protocol name.
```

--------------------------------

### cbi_init()

Source: https://openwrt.github.io/luci/jsapi/LuCI.module_cbi.html

Initialize CBI widgets.

```APIDOC
## cbi_init()

### Description
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.
```

--------------------------------

### getWifiDevice()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the corresponding WiFi radio device.

```APIDOC
### getWifiDevice() -> {null|LuCI.network.WifiDevice}

Get the corresponding WiFi radio device.

**Returns:**
Returns a Network.WifiDevice instance representing the corresponding WiFi radio device or null if the related radio device could not be found.
```

--------------------------------

### getSSID()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the configured SSID of the wireless network.

```APIDOC
## getSSID()

### Description
Get the configured SSID of the wireless network.

### Returns
- **(null|string)** - The SSID or null if in mesh mode.
```

--------------------------------

### LuCI.ui.Textarea.InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.Textarea.html

Configuration options for initializing a Textarea component, extending AbstractElement.InitOptions.

```APIDOC
## InitOptions

### Description
Configuration properties for the LuCI.ui.Textarea component.

### Properties
- **readonly** (boolean) - Optional - Default: false. Specifies whether the input widget should be rendered readonly.
- **placeholder** (string) - Optional - Specifies the HTML placeholder attribute.
- **monospace** (boolean) - Optional - Default: false. Specifies whether a monospace font should be forced for the textarea contents.
- **cols** (number) - Optional - Specifies the HTML cols attribute.
- **rows** (number) - Optional - Specifies the HTML rows attribute.
- **wrap** (boolean) - Optional - Default: false. Specifies whether the HTML wrap attribute should be set.
```

--------------------------------

### List all configured wireless devices

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Returns a promise resolving to an array of all configured WifiDevice instances.

```javascript
getWifiDevices() {
		return initNetworkState().then(L.bind(function() {
			const uciWifiDevices = uci.sections('wireless', 'wifi-device');
			const rv = [];

			for (let wfd of uciWifiDevices) {
				const devname = wfd['.name'];
				rv.push(this.instantiateWifiDevice(devname, _state.radios[devname] || {}));
			}

			return rv;
		}, this));
	},
```

--------------------------------

### getNetworks()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the logical interfaces this network is attached to.

```APIDOC
## getNetworks()

### Description
Get the logical interfaces this network is attached to.

### Returns
- **(Array.<LuCI.network.Protocol>)** - An array of logical interface instances.
```

--------------------------------

### getName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the configuration ID of this wireless network.

```APIDOC
## getName()

### Description
Get the UCI section ID of the network.

### Returns
- **(string)** - The configuration ID.
```

--------------------------------

### InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.FileUpload.html

Configuration options for initializing the LuCI.ui.FileUpload component.

```APIDOC
## InitOptions

### Description
Configuration properties for the LuCI.ui.FileUpload widget, extending AbstractElement.InitOptions.

### Properties
- **browser** (boolean) - Optional - Default: false - Use a file browser mode.
- **show_hidden** (boolean) - Optional - Default: false - Specifies whether hidden files should be displayed when browsing remote files.
- **enable_upload** (boolean) - Optional - Default: true - Specifies whether the widget allows the user to upload files.
- **enable_remove** (boolean) - Optional - Default: true - Specifies whether the widget allows the user to delete files.
- **directory_create** (boolean) - Optional - Default: false - Specifies whether the widget allows the user to create directories.
- **directory_select** (boolean) - Optional - Default: false - Specifies whether the widget shall select directories only instead of files.
- **enable_download** (boolean) - Optional - Default: false - Specifies whether the widget allows the user to download files.
- **root_directory** (string) - Optional - Default: /etc/luci-uploads - Specifies the remote directory the upload and file browsing actions take place in.
```

--------------------------------

### Handle Directory Creation

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Displays a modal dialog to create a new directory and executes the mkdir command via the filesystem API.

```javascript
handleCreateDirectory(path, ev) {  
		const container = E('div', { 'class': 'uci-dialog' });  
   
		const input = E('input', {  
			'type': 'text',  
			'placeholder': _('Directory name'),  
			'style': 'margin-right: 0.5em'  
		});  
   
		const okBtn = E('button', {  
			'type': 'button',  
			'class': 'btn cbi-button',  
			'click': async () => {  
				var directoryName = input.value.trim();  
				if (!directoryName) {  
					alert(_('Directory name cannot be empty.'));  
					return;  
				}  
   
				try {  
					// Assume current upload path (you may need to retrieve or set this yourself)  
					var basePath = path || '/tmp';  
					var fullPath = basePath + '/' + directoryName;  
   
					await fs.exec('mkdir', ['-p', fullPath]).then(L.bind((path, ev) => {  
						return this.handleSelect(path, null, ev);  
					}, this, path, ev));  
				} catch (err) {  
					UI.prototype.addTimeLimitedNotification(_('Error'), E('p', _('Failed to create directory: %s').format(err.message)), 5000, 'error');  
				} finally {  
					UI.prototype.hideModal();  
				}  
			}  
		}, _('OK'));  
   
		var cancelBtn = E('button', {  
			'type': 'button',  
			'class': 'btn cbi-button',  
			'click': () => UI.prototype.hideModal(),  
		}, _('Cancel'));  
   
        container.appendChild(input);  
        container.appendChild(okBtn);  
        container.appendChild(cancelBtn);
```

--------------------------------

### getIfname()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the Linux network device name.

```APIDOC
## getIfname()

### Description
Get the Linux network device name as resolved from ubus runtime information.

### Returns
- **(null|string)** - The device name or null if not associated.
```

--------------------------------

### getI18n()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get a description string for this wireless network.

```APIDOC
## getI18n()

### Description
Get a description string for this wireless network, consisting of the term 'Wireless Network', followed by the active operation mode, the SSID, BSSID or internal network ID and the Linux network device name.

### Returns
- **(string)** - A descriptive string for the network.
```

--------------------------------

### LuCI.ui.Select.InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.Select.html

Configuration options for initializing a LuCI.ui.Select component, extending AbstractElement.InitOptions.

```APIDOC
## LuCI.ui.Select.InitOptions

### Description
Configuration properties for the Select widget. Inherits from LuCI.ui.AbstractElement.InitOptions.

### Properties
- **multiple** (boolean) - Optional - Default: false. Specifies whether multiple choice values may be selected.
- **widget** ("select" | "individual") - Optional - Default: "select". Specifies the kind of widget to render. "select" uses an HTML <select> element, while "individual" creates a group of checkboxes or radio buttons.
- **orientation** (string) - Optional - Default: "horizontal". Specifies if checkbox/radio groups are rendered "horizontal" or "vertical". Only applies to "individual" widget type.
- **sort** (boolean | Array.<string>) - Optional - Default: false. Defines sorting behavior. If true, sorts alphabetically. If an array, defines the specific sort order.
- **size** (number) - Optional - Sets the HTML size attribute for the <select> element. Only applies to "select" widget type.
- **placeholder** (string) - Optional - Default: "-- Please choose --". Placeholder text displayed when no choice is selected. Only applies to "select" widget type.
```

--------------------------------

### getName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiDevice.html

Get the configuration name of this wireless radio.

```APIDOC
## getName()

### Description
Get the configuration name of this wireless radio.

### Returns
- **string** - The UCI section name (e.g., radio0).
```

--------------------------------

### __init__(value, choices, options)

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Initializes the Dropdown widget with a set of values, available choices, and configuration options.

```APIDOC
## __init__(value, choices, options)

### Description
Initializes a new instance of the Dropdown widget. It sets the initial values, defines the available choices, and merges user-provided options with defaults.

### Parameters
- **value** (any) - The initial value or array of values to be selected.
- **choices** (object) - A key-value map of available choices.
- **options** (object) - Configuration object for the widget.

### Configuration Options
- **sort** (boolean|string[]) - Specifies if and how to sort choice values. Default: true.
- **select_placeholder** (string) - Placeholder text when no choice is selected. Default: '-- Please choose --'.
- **custom_placeholder** (string) - Placeholder text for custom input field. Default: '-- custom --'.
- **create** (boolean) - Whether custom choices may be entered. Default: false.
- **create_query** (string) - CSS selector for the custom input element. Default: '.create-item-input'.
- **create_template** (string) - CSS selector for the custom choice template. Default: 'script[type="item-template"]'.
- **display_items** (number) - Max labels shown in collapsed state. Default: 3.
- **dropdown_items** (number) - Max items shown when dropdown is open. Default: -1.
- **placeholder** (string) - Shortcut to set both select and custom placeholders.
- **readonly** (boolean) - Whether the custom input is readonly. Default: false.
- **maxlength** (number) - HTML maxlength attribute for custom input.
```

--------------------------------

### getPackageName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Gets the name of the package providing the protocol functionality.

```APIDOC
## getPackageName()

### Description
Returns the name of the package required for the protocol to function (e.g., 'odhcp6c'). This is used when a config refers to a protocol handler that is not yet installed.

### Returns
- **string** - The package name.
```

--------------------------------

### getWifiDeviceName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the name of the corresponding WiFi radio device.

```APIDOC
### getWifiDeviceName() -> {null|string}

Get the name of the corresponding WiFi radio device.

**Returns:**
Returns the name of the radio device this network is configured on or null if it cannot be determined.
```

--------------------------------

### instantiate(args)

Source: https://openwrt.github.io/luci/jsapi/LuCI.baseclass.html

Creates a new instance of the class using an array of arguments.

```APIDOC
## instantiate(args)

### Description
Calls the class constructor using `new` with the given argument array passed as variadic parameters.

### Parameters
- **args** (Array.<*>) - Required - An array of values to be passed as arguments to the constructor.

### Returns
- **result** (LuCI.baseclass) - A new instance of the class.
```

--------------------------------

### Initialize LuCI.ui.Select

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

The constructor handles input values, choice mapping, and configuration options for the widget.

```javascript
__init__(value, choices, options) {  
		if (!L.isObject(choices))  
			choices = {};  
   
		if (!Array.isArray(value))  
			value = (value != null && value != '') ? [ value ] : [];  
   
		if (!options.multiple && value.length > 1)  
			value.length = 1;  
   
		this.values = value;  
		this.choices = choices;  
		this.options = Object.assign({  
			multiple: false,  
			widget: 'select',  
			orientation: 'horizontal'  
		}, options);  
   
		if (this.choices.hasOwnProperty(''))  
			this.options.optional = true;  
	}
```

--------------------------------

### getVlanIfnames()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the Linux VLAN network device names.

```APIDOC
### getVlanIfnames() -> {Array.<string>}

Get the Linux VLAN network device names.

**Returns:**
Returns the current Linux VLAN network device name as resolved from ubus runtime information or empty array if this network has no associated VLAN network devices.
```

--------------------------------

### InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.AbstractElement.html

Configuration object used to initialize UI elements in LuCI.

```APIDOC
## InitOptions

### Description
Configuration object used to define properties for UI elements, including HTML attributes and validation logic.

### Properties
- **id** (string) - Optional - Specifies the widget ID to use as the HTML `id` attribute.
- **name** (string) - Optional - Specifies the widget name to use as the HTML `name` attribute.
- **optional** (boolean) - Optional - Default: true. Specifies whether the input field allows empty values.
- **datatype** (string) - Optional - Default: 'string'. Expression describing input data validation constraints.
- **validator** (function|Array.<function()>) - Optional - Custom validator functions invoked after standard validation.
- **disabled** (boolean) - Optional - Default: false. Specifies whether the widget is rendered in a disabled state.
```

--------------------------------

### getShortName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get a short description string for this wireless network.

```APIDOC
## getShortName()

### Description
Get a short description string for this wireless network, consisting of the active operation mode, followed by either the SSID, BSSID or internal network ID.

### Returns
- **(string)** - A short descriptive string.
```

--------------------------------

### getExpiry()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Get the logical interface expiry time in seconds.

```APIDOC
## getExpiry()

### Description
Get the logical interface expiry time in seconds. Returns the remaining time for leases (e.g., DHCP).

### Returns
- **number** - The number of seconds until the lease expires, or -1 if not applicable.
```

--------------------------------

### Instantiate WiFi Device

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Internal method to create a new WiFi device instance.

```javascript
instantiateWifiDevice(radioname, radiostate) {
		return new WifiDevice(radioname, radiostate);
	}
```

--------------------------------

### getNetwork()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the primary logical interface this network is attached to.

```APIDOC
## getNetwork()

### Description
Get the primary logical interface this network is attached to.

### Returns
- **(null|LuCI.network.Protocol)** - The logical interface or null.
```

--------------------------------

### get(opt)

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Reads a UCI option value for the network.

```APIDOC
## get(opt)

### Description
Read the given UCI option value of this network.

### Parameters
- **opt** (string) - Required - The UCI option name to read.

### Returns
- **null | string | Array.<string>** - Returns the UCI option value or null if the requested option is not found.
```

--------------------------------

### Define Theme Makefile

Source: https://openwrt.github.io/luci/jsapi/tutorial-ThemesHowTo.html

Create a Makefile in the theme directory to define the package title and include the LuCI build rules.

```makefile
include $(TOPDIR)/rules.mk

LUCI_TITLE:=Title of mytheme

include ../../luci.mk
# call BuildPackage - OpenWrt buildroot signature
```

--------------------------------

### Construct URL paths with resource() and media()

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

These methods construct URL paths relative to the LuCI resource or media directories.

```javascript
resource() {
			return this.path(env.resource, arguments);
		}
```

```javascript
media() {
			return this.path(env.media, arguments);
		}
```

--------------------------------

### getMode()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the configured operation mode of the wireless network.

```APIDOC
## getMode()

### Description
Get the configured operation mode (ap, sta, adhoc, mesh, monitor).

### Returns
- **(string)** - The operation mode.
```

--------------------------------

### getMeshID()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the configured Mesh ID of the wireless network.

```APIDOC
## getMeshID()

### Description
Get the configured Mesh ID of the wireless network.

### Returns
- **(null|string)** - The mesh ID or null if not in mesh mode.
```

--------------------------------

### LuCI.ui.Dropdown.InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.Dropdown.html

Configuration properties for initializing a Dropdown widget.

```APIDOC
## LuCI.ui.Dropdown.InitOptions

### Description
Configuration object used to initialize a LuCI.ui.Dropdown widget. Inherits from LuCI.ui.AbstractElement.InitOptions.

### Properties
- **optional** (boolean) - Optional - Specifies whether the dropdown selection is optional. If false, the user cannot deselect all choices.
- **multiple** (boolean) - Optional - Specifies whether multiple choice values may be selected.
- **sort** (boolean|Array<string>) - Optional - Specifies if and how to sort choice values. Defaults to false.
- **select_placeholder** (string) - Optional - Placeholder text displayed when no choice is selected.
- **custom_placeholder** (string) - Optional - Placeholder text for the custom choice input field.
- **create** (boolean) - Optional - Specifies whether custom choices may be entered.
- **create_query** (string) - Optional - CSS selector for the custom choice input element.
- **create_template** (string) - Optional - CSS selector for the HTML template used for new custom choices.
- **create_markup** (string) - Optional - Direct markup string for custom choices.
- **display_items** (number) - Optional - Max number of labels shown in collapsed state when multiple is true.
- **dropdown_items** (number) - Optional - Max number of choices shown when the dropdown is open.
- **placeholder** (string) - Optional - Shortcut to set both select_placeholder and custom_placeholder.
- **readonly** (boolean) - Optional - Specifies if the custom choice input is readonly.
- **maxlength** (number) - Optional - Sets the HTML maxlength attribute on the custom choice input.
```

--------------------------------

### getID()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the internal network ID of this wireless network.

```APIDOC
## getID()

### Description
Get the internal network ID of this wireless network in the form 'radio#.network#'.

### Returns
- **(string)** - The LuCI specific network ID.
```

--------------------------------

### LuCI.ui.Textfield.InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.Textfield.html

Configuration properties for initializing a Textfield component.

```APIDOC
## LuCI.ui.Textfield.InitOptions

### Description
Defines the configuration properties available when initializing a Textfield component. Inherits from `LuCI.ui.AbstractElement.InitOptions`.

### Properties
- **password** (boolean) - Optional - Default: false. Specifies whether the input should be rendered as a concealed password field.
- **readonly** (boolean) - Optional - Default: false. Specifies whether the input widget should be rendered as readonly.
- **maxlength** (number) - Optional - Specifies the HTML `maxlength` attribute for the input element.
- **placeholder** (string) - Optional - Specifies the HTML `placeholder` attribute displayed when the input is empty.
```

--------------------------------

### getI18n()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiDevice.html

Get a string describing the wireless radio hardware.

```APIDOC
## getI18n()

### Description
Get a string describing the wireless radio hardware.

### Returns
- **string** - The description string.
```

--------------------------------

### Initialize Hosts Class

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Constructor for the Hosts class which stores the provided host data.

```javascript
__init__(hosts) {
		this.hosts = hosts;
	}
```

--------------------------------

### getHWModes()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiDevice.html

Gets a list of supported hwmodes for the wireless phy.

```APIDOC
## getHWModes()

### Description
Gets a list of supported hwmodes (frequency band and wireless standard versions) supported by the wireless phy.

### Returns
- **Array.<string>** - An array of valid hwmode values (e.g., a, b, g, n, ac, ax, be).
```

--------------------------------

### LuCI.network.WifiVlan Methods

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Methods for interacting with a WiFi VLAN instance.

```APIDOC
## getName()
- **Returns** (string) - The name of the wifi vlan.

## getVlanId()
- **Returns** (number) - The vlan id of the wifi vlan.

## getNetwork()
- **Returns** (string) - The network associated with the wifi vlan.
```

--------------------------------

### getHTModes()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiDevice.html

Gets a list of supported htmodes for the wireless phy.

```APIDOC
## getHTModes()

### Description
Gets a list of supported htmodes (wide-frequency options) supported by the wireless phy.

### Returns
- **Array.<string>** - An array of valid htmode values (e.g., HT20, VHT80, HE160, EHT320).
```

--------------------------------

### Initialize LuCI view

Source: https://openwrt.github.io/luci/jsapi/luci.js.html

Handles the initialization lifecycle of a view, including loading and rendering.

```javascript
__init__() {
			const vp = document.getElementById('view');

			DOM.content(vp, E('div', { 'class': 'spinning' }, _('Loading view…')));

			const ready = L.loaded
				? Promise.resolve()
				: new Promise((resolve) => {
					document.addEventListener('luci-loaded', resolve, { once: true });
				});

			return ready
				.then(LuCI.prototype.bind(this.load, this))
				.then(LuCI.prototype.bind(this.render, this))
				.then(LuCI.prototype.bind(function(nodes) {
					const vp = document.getElementById('view');

					DOM.content(vp, nodes);
					DOM.append(vp, this.addFooter());
				}, this)).catch(LuCI.prototype.error);
		},

		load() {}
```

--------------------------------

### Value Management Methods

Source: https://openwrt.github.io/luci/jsapi/ui.js.html

Overrides for setting and getting widget values.

```javascript
/** @override */  
	setValue(values) {  
		if (this.options.multiple) {  
			if (!Array.isArray(values))  
				values = (values != null && values != '') ? [ values ] : [];  
   
			const v = {};  
   
			for (let i = 0; i < values.length; i++)  
				v[values[i]] = true;  
   
			this.setValues(this.node, v);  
		}  
		else {  
			const v = {};  
   
			if (values != null) {  
				if (Array.isArray(values))  
					v[values[0]] = true;  
				else  
					v[values] = true;  
			}  
   
			this.setValues(this.node, v);  
		}  
	},  
   
	/** @override */  
	getValue() {  
		const div = this.node.lastElementChild;  
		const h = div.querySelectorAll('input[type="hidden"]');  
		const v = [];  
   
		for (let i = 0; i < h.length; i++)  
			v.push(h[i].value);  
   
		return this.options.multiple ? v : v[0];  
	}
```

--------------------------------

### Get All Networks

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Returns an array of all known network Protocol instances.

```javascript
getNetworks() {
		return initNetworkState().then(L.bind(enumerateNetworks, this));
	},
```

--------------------------------

### Create a basic LuCI form

Source: https://openwrt.github.io/luci/jsapi/LuCI.form.html

Constructs a form mapping to a UCI configuration file, adds sections and options, and renders the form to the document body.

```javascript
'use strict';
'require form';

let m, s, o;

m = new form.Map('example', _('Example form'),
	_('This is an example form mapping the contents of /etc/config/example'));

s = m.section(form.NamedSection, 'first_section', 'example', _('The first section'),
	_('This sections maps "config example first_section" of /etc/config/example'));

o = s.option(form.Flag, 'some_bool', _('A checkbox option'));

o = s.option(form.ListValue, 'some_choice', _('A select element'));
o.value('choice1', _('The first choice'));
o.value('choice2', _('The second choice'));

m.render().then((node) => {
	document.body.appendChild(node);
});
```

--------------------------------

### Protocol Class Initialization and Helpers

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Internal methods for initializing the Protocol class and interacting with UCI and UBUS data.

```javascript
__init__(name) {  
		this.sid = name;  
	},  
   
	_get(opt) {  
		const val = uci.get('network', this.sid, opt);  
   
		if (Array.isArray(val))  
			return val.join(' ');  
   
		return val || '';  
	},  
   
	_ubus(field) {  
		for (let sif of _state.ifaces) {  
			if (sif.interface != this.sid)  
				continue;  
   
			return (field != null ? sif[field] : sif);  
		}  
	}
```

--------------------------------

### getZoneName()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.Protocol.html

Gets the requested firewall zone name of the logical interface.

```APIDOC
## getZoneName()

### Description
Returns the requested firewall zone name as published in the ubus runtime information.

### Returns
- **null|string** - The zone name or null if not requested.
```

--------------------------------

### getNetworkNames()

Source: https://openwrt.github.io/luci/jsapi/LuCI.network.WifiNetwork.html

Get the names of the logical interfaces this wireless network is attached to.

```APIDOC
## getNetworkNames()

### Description
Get the names of the logical interfaces this wireless network is attached to.

### Returns
- **(Array.<string>)** - An array of logical interface names.
```

--------------------------------

### LuCI.ui.Combobox.InitOptions

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.Combobox.html

Configuration options for initializing a Combobox. It extends LuCI.ui.Dropdown.InitOptions with specific forced property values.

```APIDOC
## LuCI.ui.Combobox.InitOptions

### Description
Defines the initialization options for a Combobox. Comboboxes inherit from Dropdown but enforce specific behaviors for selection and input.

### Properties
- **multiple** (boolean) - Default: false - Forcibly set to false as Comboboxes do not support multiple selections.
- **create** (boolean) - Default: true - Forcibly set to true to allow custom choice values.
- **optional** (boolean) - Default: true - Forcibly set to true as Comboboxes are always optional.
```

--------------------------------

### Initialize Header Template

Source: https://openwrt.github.io/luci/jsapi/tutorial-ThemesHowTo.html

Ensure the header template sets the correct content type and imports necessary core modules.

```ucode
{%  
  import { getuid, getspnam } from 'luci.core';  
   
  const boardinfo = ubus.call('system', 'board');  
   
  http.prepare_content('text/html; charset=UTF-8');  
-%}
```

--------------------------------

### Get Network Description

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Retrieves a formatted string describing the wireless network.

```javascript
getShortName() {
		return '%s "%s"'.format(
			this.getActiveModeI18n(),
			this.getActiveSSID() || this.getActiveBSSID() || this.getID());
	}
```

--------------------------------

### new menu()

Source: https://openwrt.github.io/luci/jsapi/LuCI.ui.menu.html

Constructor for the menu handler.

```APIDOC
## new menu()

### Description
Initializes a new instance of the menu handler.

### Signature
`new LuCI.ui.menu()`
```

--------------------------------

### Get Interface Name

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Obtains the network device name of the given object.

```javascript
getIfnameOf(obj) {
		return ifnameOf(obj);
	}
```

--------------------------------

### Get Network Instance

Source: https://openwrt.github.io/luci/jsapi/network.js.html

Retrieves a Protocol instance for a specific network name.

```javascript
getNetwork(name) {
		return initNetworkState().then(L.bind(function() {
			const section = (name != null) ? uci.get('network', name) : null;

			if (section != null && section['.type'] == 'interface') {
				return this.instantiateNetwork(name);
			}
			else if (name != null) {
				for (let ifc of _state.ifaces)
					if (ifc.interface == name)
						return this.instantiateNetwork(name, ifc.proto);
			}

			return null;
		}, this));
	},
```
Tokens:
Raw