web api event
HTMLFormElement: submit event
The submit event fires when a <form> is submitted.
Note that the submit event fires on the <form> element itself, and not on any <button> or [<<input type=“submit”>>](/firefox/mdn/html/reference/elements/input/submit/) inside it. However, the SubmitEvent which is sent to indicate the form’s submit action has been triggered includes a submitter property, which is the button that was invoked to trigger the submit request.
The submit event fires when:
- the user clicks a submit button,
- the user presses Enter while editing a field (e.g.,
<<input type="text">>) in a form, - a script calls the
form.requestSubmit()method
However, the event is not sent to the form when a script calls the form.submit() method directly.
[!NOTE] Trying to submit a form that does not pass validation triggers an
invalidevent. In this case, the validation prevents form submission, and thus there is nosubmitevent.
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener("submit", (event) => { })
onsubmit = (event) => { }
Event type
A SubmitEvent. Inherits from Event.
Examples
This example uses addEventListener() to listen for form submit, and logs the current timeStamp whenever that occurs, then prevents the default action of submitting the form.
HTML
<form id="form">
<label>Test field: <input type="text" /></label>
<br /><br />
<button type="submit">Submit form</button>
</form>
<p id="log"></p>
JavaScript
const form = document.getElementById("form");
const log = document.getElementById("log");
function logSubmit(event) {
log.textContent = `Form Submitted! Timestamp: ${event.timeStamp}`;
event.preventDefault();
}
form.addEventListener("submit", logSubmit);