Constructor
new ComboButton(valueopt, choices, optionsopt)
Instantiate a combo button widget offering multiple action choices.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
value | string | | <optional> | null | The initial input value(s). |
choices | Object.<string, *> | Object containing the selectable choices of the widget. The object keys serve as values for the different choices while the values are used as choice labels. | ||
options | LuCI. | <optional> | Object describing the widget specific options to initialize the button. |
Extends
Methods
addChoices(values, labels)
Add new choices to the dropdown menu.
This function adds further choices to an existing dropdown menu, ignoring choice values which are already present.
| Name | Type | Description |
|---|---|---|
values | Array.<string> | The choice values to add to the dropdown widget. |
labels | Object.<string, *> | The choice label values to use when adding dropdown choices. If no label is found for a particular choice value, the value itself is used as label text. Choice labels may be any valid value accepted by |
- Inherited From
clearChoices(reset_valueopt)
Remove all existing choices from the dropdown menu.
This function removes all preexisting dropdown choices from the widget, keeping only choices currently being selected unless reset_values is given, in which case all choices and deselected and removed.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
reset_value | boolean | <optional> | false | If set to |
- Inherited From
closeAllDropdowns()
Close all open dropdown widgets in the current document.
- Inherited From
getValidationError() → {string}
Returns the current validation error
- Inherited From
The validation error at this time
- Type:
- string
isChanged() → {boolean}
Check whether the input value was altered by the user.
- Inherited From
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
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.
| 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 From
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.
| Name | Type | Attributes | 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 From
setPlaceholder(value)
Set the current placeholder value of the input widget.
| Name | Type | Description |
|---|---|---|
value | string | | The placeholder to set for the input element. Only applicable to text inputs, not to radio buttons, selects or similar. |
- Inherited From
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.
| Name | Type | Attributes | 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 From
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
- Type:
- boolean
Type Definitions
InitOptions
ComboButtons support the same properties as Dropdown.InitOptions but enforce specific values for some properties and add additional button specific properties.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
multiple | boolean | <optional> | false | Since ComboButtons never allow selecting multiple actions, this property is forcibly set to |
create | boolean | <optional> | false | Since ComboButtons never allow creating custom choices, this property is forcibly set to |
optional | boolean | <optional> | false | Since ComboButtons must always select one action, this property is forcibly set to |
classes | Object.<string, string> | <optional> | Specifies a mapping of choice values to CSS class names. If an action choice is selected by the user and if a corresponding entry exists in the This is useful to apply different button styles, such as colors, to the combined button depending on the selected action. | |
click | function | <optional> | Specifies a handler function to invoke when the user clicks the button. This function will be called with the button DOM node as |