Instantiate a hidden input field widget.
| Name | Type | Default | Description |
|---|---|---|---|
value |
string | Array.<string> | null |
optional
The initial input value. |
options |
LuCI.ui.AbstractElement.InitOptions |
optional
Object describing the widget specific options to initialize the hidden input. |
Extends
Methods
-
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 DynamicListinstances may result in an array of strings ornullfor unset values. -
Check whether the input value was altered by the user.
Returns:
Type Description boolean Returns trueif the input value has been altered by the user orfalseif it is unchaged. Note that if the user modifies the initial value and changes it back to the original state, it is still reported as changed. -
Check whether the current input value is valid.
Returns:
Type Description boolean Returns trueif the current input value is valid orfalseif it does not meet the validation constraints. -
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-failureetc. which are triggered by various different widget specific native DOM events.Name Type Description 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.
-
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. -
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
changeevents 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 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.
-
Set the current placeholder value of the input widget.
Name Type Description valuestring | Array.<string> | null The placeholder to set for the input element. Only applicable to text inputs, not to radio buttons, selects or similar.
-
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
keyuporonclickevents. In contrast to change events, such update events will trigger input value validation.Name Type Description 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.
-
Set the current value of the input widget.
Name Type Description 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
DynamicListinstances may accept string array ornullvalues. -
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.