Events

forms.willSubmit

Detailed viewer event reference for forms.willSubmit.

Summary

  • Category: Forms
  • Event: forms.willSubmit
  • Trigger: Fires before a form submit lifecycle starts.

Payload

[{ formFieldValues: FormFieldValueMap }];

Payload fields

Payload is not an object literal. Use the declaration above and runtime guards when handling this event.

Subscription example

function onEvent(payload) {
  console.log('forms.willSubmit', payload);
}

instance.addEventListener('forms.willSubmit', onEvent);
instance.removeEventListener('forms.willSubmit', onEvent);