The SubmitEvent
interface defines the object used to represent an HTML form's submit
event. This event is fired at the <form>
when the form's submit action is invoked.
The SubmitEvent
interface defines the object used to represent an HTML form's submit
event. This event is fired at the <form>
when the form's submit action is invoked.
SubmitEvent()
Creates and returns a new SubmitEvent
object whose type
and other options are configured as specified. Note that currently the only valid type
for a SubmitEvent
is submit
.
In addition to the properties listed below, this interface inherits the properties of its parent interface, Event
.
submitter
Read only
An HTMLElement
object which identifies the button or other element which was invoked to trigger the form being submitted.
While SubmitEvent
offers no methods of its own, it inherits any specified by its parent interface, Event
.
In this example, a shopping cart may have an assortment of different submit buttons depending on factors such as the user's settings, the shop's settings, and any minimum or maximum shopping card totals established by the payment processors. Each of the submit elements' id
is used to identify which payment processor the button corresponds to.
js
let form = document.querySelector("form"); form.addEventListener("submit", (event) => { let submitter = event.submitter; let handler = submitter.id; if (handler) { processOrder(form, handler); } else { showAlertMessage( "An unknown or unaccepted payment type was selected. Please try again.", "OK", ); } });
The handler ID is obtained by using the submit
event's submitter
property to get the submit button, from which we then get the ID. With that in hand, we can call a processOrder()
function to handle the order, passing along the form and the handler ID.
Specification |
---|
HTML Standard # the-submitevent-interface |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
SubmitEvent |
81 | 81 | 75 | No | 68 | 15 | 81 | 81 | 79 | 58 | 15 | 13.0 |
SubmitEvent |
81 | 81 | 75 | No | 68 | 15 | 81 | 81 | 79 | 58 | 15 | 13.0 |
submitter |
81 | 81 | 75 | No | 68 | 15.4 | 81 | 81 | 79 | 58 | 15.4 | 13.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/SubmitEvent