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

Constructor

new Textfield(valueopt, optionsopt)

Instantiate a text input widget.

Parameters:
NameTypeAttributesDefaultDescription
valuestring<optional>
null

The initial input value.

optionsLuCI.ui.Textfield.InitOptions<optional>

Object describing the widget specific options to initialize the input.

Source

Extends

Methods

getValidationError() → {string}

Returns the current validation error

Inherited From
Source
Returns:

The validation error at this time

Type: 
string

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

Read the current value of the input widget.

Overrides
Source
Returns:

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.

Type: 
string | Array.<string> | null

isChanged() → {boolean}

Check whether the input value was altered by the user.

Inherited From
Source
Returns:

Returns true if the input value has been altered by the user or false if it is unchanged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed.

Type: 
boolean

isValid() → {boolean}

Check whether the current input value is valid.

Inherited From
Source
Returns:

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

Type: 
boolean

registerEvents(targetNode, synevent, events)

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.

Parameters:
NameTypeDescription
targetNodeNode

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

syneventstring

The name of the custom event to dispatch to the widget root DOM node.

eventsArray.<string>

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

Inherited From
Source

render() → {Node}

Render the widget, set up event listeners and return resulting markup.

Overrides
Source
Returns:

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

Type: 
Node

setChangeEvents(targetNode, …events)

Set up 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.

Parameters:
NameTypeAttributesDescription
targetNodeNode

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

eventsstring<repeatable>

The DOM events for which event handlers should be registered.

Inherited From
Source

setPlaceholder(value)

Set the current placeholder value of the input widget.

Parameters:
NameTypeDescription
valuestring | Array.<string> | null

The placeholder to set for the input element. Only applicable to text inputs, not to radio buttons, selects or similar.

Inherited From
Source

setUpdateEvents(targetNode, …events)

Set up 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.

Parameters:
NameTypeAttributesDescription
targetNodeNode

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

eventsstring<repeatable>

The DOM events for which event handlers should be registered.

Inherited From
Source

setValue(value)

Set the current value of the input widget.

Parameters:
NameTypeDescription
valuestring | 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.

Overrides
Source

triggerValidation() → {boolean}

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.

Inherited From
Source
Returns:
Type: 
boolean

Type Definitions

InitOptions

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

Type:
Properties
NameTypeAttributesDefaultDescription
passwordboolean<optional>
false

Specifies whether the input should be rendered as concealed password field.

readonlyboolean<optional>
false

Specifies whether the input widget should be rendered readonly.

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

placeholderstring<optional>

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

Source