Class: Textfield

LuCI.ui. Textfield

The Textfield class implements a standard single line text input field.

UI widget instances are usually not supposed to be created by view code directly, instead they're implicitely created by LuCI.form when instantiating CBI forms.

This class is automatically instantiated as part of LuCI.ui. To use it in views, use 'require ui' and refer to ui.Textfield. To import it in external JavaScript, use L.require("ui").then(...) and access the Textfield property of the class instance value.

new LuCI.ui.Textfield(value, options)

ui.js, line 252

Instantiate a text input widget.

Name Type Default Description
value string null optional

The initial input value.
options LuCI.ui.Textfield.InitOptions optional

Object describing the widget specific options to initialize the input.

Extends

Methods

inherited getValue(){string|Array.<string>|null}

ui.js, line 367

Read the current value of the input widget.

Returns:
Type Description
string | Array.<string> | null The current value of the input element. For simple inputs like text fields or selects, the return value type will be a - possibly empty - string. Complex widgets such as DynamicList instances may result in an array of strings or null for unset values.

inherited isValid(){boolean}

ui.js, line 113

Check whether the current input value is valid.

Returns:
Type Description
boolean Returns true if the current input value is valid or false if it does not meet the validation constraints.

inherited registerEvents(targetNode, synevent, events)

ui.js, line 162

Dispatch a custom (synthetic) event in response to received events.

Sets up event handlers on the given target DOM node for the given event names that dispatch a custom event of the given type to the widget root DOM node.

The primary purpose of this function is to set up a series of custom uniform standard events such as widget-update, validation-success, validation-failure etc. which are triggered by various different widget specific native DOM events.

Name Type Description
targetNode Node

Specifies the DOM node on which the native event listeners should be registered.
synevent string

The name of the custom event to dispatch to the widget root DOM node.
events Array.<string>

The native DOM events for which event handlers should be registered.

inherited render(){Node}

ui.js, line 311

Render the widget, setup event listeners and return resulting markup.

Returns:
Type Description
Node Returns a DOM Node or DocumentFragment containing the rendered widget markup.

inherited setChangeEvents(targetNode, events)

ui.js, line 230

Setup listeners for native DOM events that may change the widget value.

Sets up event handlers on the given target DOM node for the given event names which may cause the input value to change completely, such as change events in a select menu. In contrast to update events, such change events will not trigger input value validation but they may cause field dependencies to get re-evaluated and will mark the input widget as dirty.

Name Type Description
targetNode Node

Specifies the DOM node on which the event listeners should be registered.
events string repeatable

The DOM events for which event handlers should be registered.

inherited setUpdateEvents(targetNode, events)

ui.js, line 187

Setup listeners for native DOM events that may update the widget value.

Sets up event handlers on the given target DOM node for the given event names which may cause the input value to update, such as keyup or onclick events. In contrast to change events, such update events will trigger input value validation.

Name Type Description
targetNode Node

Specifies the DOM node on which the event listeners should be registered.
events string repeatable

The DOM events for which event handlers should be registered.

inherited setValue(value)

ui.js, line 373

Set the current value of the input widget.

Name Type Description
value string | Array.<string> | null

The value to set the input element to. For simple inputs like text fields or selects, the value should be a - possibly empty - string. Complex widgets such as DynamicList instances may accept string array or null values.

inherited triggerValidation()

ui.js, line 127

Force validation of the current input value.

Usually input validation is automatically triggered by various DOM events bound to the input widget. In some cases it is required though to manually trigger validation runs, e.g. when programmatically altering values.

Type Definitions

LuCI.ui.Textfield.InitOptionsLuCI.ui.AbstractElement.InitOptions

In addition to the AbstractElement.InitOptions the following properties are recognized:

Properties:
Name Type Argument Default Description
password boolean <optional>
 false

Specifies whether the input should be rendered as concealed password field.
readonly boolean <optional>
 false

Specifies whether the input widget should be rendered readonly.
maxlength number <optional>

Specifies the HTML maxlength attribute to set on the corresponding <input> element. Note that this a legacy property that exists for compatibility reasons. It is usually better to maxlength(N) validation expression.
placeholder string <optional>

Specifies the HTML placeholder attribute which is displayed when the corresponding <input> element is empty.