Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / HTML

onsubmit — gérer une tentative de soumission de formulaire

L’attribut onsubmit définit le code JavaScript qui gère l’événement submit. Il permet de réagir à une tentative de soumission d’un formulaire et d’annuler la soumission par défaut ; il ne confirme pas que les données sont parvenues au serveur.

Version : WHATWG HTML Living Standard; index snapshot date recorded separately

Syntaxe

onsubmit="JavaScript statements"
form.onsubmit = function (event) { /* handler */ };

onsubmit est un attribut de gestion de l’événement submit. Il se place normalement sur l’élément form, et non sur le bouton de soumission. Bien qu’il soit disponible sur tous les éléments HTML, le formulaire est la cible de cet événement, qui se propage vers ses ancêtres. La valeur de l’attribut est du code JavaScript, et non l’adresse de destination du formulaire.

L’événement se produit avant la soumission par défaut, par exemple après l’activation d’un bouton de soumission ou l’appel de form.requestSubmit(). Si le navigateur effectue la validation des contraintes et que le formulaire échoue à cette validation, l’événement submit ne se produit pas. La méthode form.submit() ignore à la fois cette validation et l’événement submit.

Le code de l’attribut reçoit le paramètre event. Appeler event.preventDefault() ou exécuter return false annule la soumission par défaut. Cela n’arrête pas la propagation de l’événement. Appeler simplement une fonction qui renvoie false, sans transmettre son résultat avec return, n’annule pas la soumission.

JavaScript permet aussi d’affecter une fonction à form.onsubmit ; une nouvelle affectation remplace la fonction précédente de cette propriété. L’exemple utilise l’attribut, annule la soumission et modifie le texte d’état. JavaScript doit être activé et la politique de sécurité doit autoriser les gestionnaires d’événements intégrés au HTML.

Exemples

<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>onsubmit demo</title>
<form onsubmit="event.preventDefault(); document.getElementById('result').textContent = 'Submission canceled';">
  <button type="submit">Submit</button>
</form>
<p id="result" role="status">Ready</p>
</html>

Résultat

Submission canceled

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources