Builder-Defined Events
Page Load
The page load event happens after the bundle page load event as defined in the Ready Options (see below). Use this when you want to do something before the user interacts with the page.
Variables available to custom code by default:
element
- The page objectevent
- Empty for page load eventsaction
- Contains no actions for page load eventsresource
- Result of the bridged resource AJAX call if one was made
Page Submit
The page submit event happens before the page is submitted to the server.
Variables available to custom code by default:
element
- The page objectevent
- Empty for page submit eventsaction
- Contains stop/continue methods that control timing of the form submission when event contains asynchronous functions, see example belowresource
- Result of the bridged resource AJAX call if one was made
Stop/Continue in submit events
In the example below we demonstrate how to use the stop and continue methods defined on the action object. Note that if you are using a bridged resource in a page submit event, these make asynchronous calls but we automatically stop and continue submission.
// signals that the submission process should stop/wait, forgetting this call
// will result in the form being submitted before the response is received
action.stop();
// make the ajax call
$.ajax({
url: '...',
type: 'GET',
success: function(data, textStatus, jqXHR) {
console.log(data);
// signals that the submission process should resume, forgetting this
// call will result in never submitting the form
action.continue();
}
});
Field Change
The field change events fire on changes to their data, not necessarily just changes to the input element by the user. If a field change event changes another field’s value, that field will also fire a change event if one is defined.
Variables available to custom code by default:
element
The field objectevent
The event object contains the members listed belownewValue
The new value of the field when the change event was triggeredconstraints
The field constraint messages after constraints are evaluated using the new value
action
Contains no actions for field change eventsresource
Result of the bridged resource AJAX call if one was made
Button Click
The button click events can be defined on custom button elements and fire when the button is clicked.
Variables available to custom code by default:
element
The button objectevent
The event object contains the members listed belowdomEvent
The original DOM event that resulted from the button click
action
Contains no actions for button click eventsresource
Result of the bridged resource AJAX call if one was made
Updated 8 months ago