The Operations Builder Events Reference contains a non-exhaustive list of events that can fire operations using the Operations Builder tool. In Unqork applications, events occur that cause operations to execute. Events can occur from actions in the runtime, in the DOM, or by the end-user. For example, when an end-user clicks an element on the page, the element emits the onClick
event. Using the Operations Builder in a Vega-compatible component, Creatorscan assign one or more operations to execute after an event occurs.
To learn more about events and the Operations Builder tool, view our Introduction to the Operations Builder article.
Operations Builder Events
This non-exhaustive list of events details the event name, type, runtime compatibility, and a description of what it does. Events that have an HTML Event counterpart also display external documentation for reference.
New events are added regularly to ensure a better building experience. Return to this page often to see an updated list of events.
Event Name | Description | Additional Documentation |
---|---|---|
On Blur | Occurs when an input component has lost focus. | |
On Change | Occurs when an input component's value changes. Fires when the end-user commits a value change.
| |
On Click | Occurs on click of any input component that is not disabled.
| |
On Edit Submission | Occurs when the page loads with a submission ID. Similar to the Initializer component's Edit Submission trigger function. | |
On Execute | Occurs when executing a component using the Operations Builder Execute operation. Also occurs when using the | |
On Focus | Occurs when an input component has received focus. | |
On Initialize | Occurs when a component loads from a page load or Dynamic Refresh. This includes components that have been hidden. | |
On Mouse Enter | Occurs when the mouse cursor hovers over a UI component and can be used in place of onMouseOver.
| |
On Mouse Leave | Occurs when the mouse cursor moves off a UI component.
| |
On New Submission | Occurs when the page or called module loads without an existing submission ID. Similar to the Initializer component's New Submission function. | |
On Table Cell Change | Occurs when a change happens to a component in a Vega Table cell. For input components such as Text Field and Number, it fires when end-users finish editing a cell. For Checkboxes and Dropdown components, it fires when a selection change occurs. | |
On Table Cell Double Click | Occurs when double-clicking a Vega Table cell. Use this event to toggle a cell's edit mode to | |
On Table Cell Focus | Occurs when a Vega Table cell has received focus. Can fire from mouse clicks, or keyboard tab navigation from a different cell. | |
On Table Cell Key Down | Occurs when pressing a key on an active cell in the Vega Table. | |
On Toggle Column Filter List | Occurs when toggling column filters in a Vega Table. | |
On Toggle Column Visibility Menu | Occurs when toggling the Column Visibility menu on a Vega Table. | |
On Toggle Full Screen | Occurs when toggling the full-screen mode on a Vega Table. | |
On Toggle Global Filter | Occurs when toggling a Vega Table toolbar. | |
On Toggle Row Density | Occurs when there is a change to a Vega Table's row density. |
Event Compatability
Operations Builder events are only compatible with components that can use them. For example, you cannot use an onClick event on a Hidden component because the component does not have a UI element in Express View.
Understanding the Events Compatibility Table
While most events are compatible with Unqork components, some might be limited or unsupported. In the table below, components that are compatible with events display an empty cell.
If an event is not compatible, it is marked with an icon from the list below:
Empty Cell: This event is compatible with the component.
Limited: This event might be available at a later time.
Unsupported: This event is not compatible with the component.
The current list of compatible components and events include:
Components | On Blur | On Change | On Click | On Edit Submission | On Execute | On Focus | On Initialize | On Mouse Enter | On Mouse Leave | On New Submission |
---|---|---|---|---|---|---|---|---|---|---|
Text Field | ||||||||||
Text Area | ||||||||||
Checkboxes | ||||||||||
Radio Buttons | ||||||||||
Dropdown | ||||||||||
Multi-Select Dropdown |
| |||||||||
Number | ||||||||||
Date Input | ||||||||||
Single Checkbox | ||||||||||
Menu |
| |||||||||
Simple Select | ||||||||||
Search Select | ||||||||||
Button | ||||||||||
Phone Number | ||||||||||
Intl Phone Number | ||||||||||
Hidden |
| |||||||||
HTML Element | ||||||||||
Columns | ||||||||||
Panel | ||||||||||
Image | ||||||||||
Iframe | ||||||||||
Field Group |
|
| ||||||||
Vega Table |
|
|
|
| ||||||
Plug-In |
|
|
| |||||||
Data Table |
|
| ||||||||
Timer |
|
|
|
|
|
|
|