Attribut global HTMLAttributs globaux

onclick

Exécute du code JavaScript au clic sur l’élément. La façon la plus simple, mais pas la meilleure, de gérer les événements.

S’applique à
Tous les éléments HTML
Sur cette page

Exemple

#
HTML
<button type="button" onclick="this.textContent = 'Inscrit à la formation'; this.disabled = true">
  S’inscrire à la formation HTML
</button>

<p>Formations dans le panier : <strong id="cart">0</strong></p>
<button type="button" onclick="
  const cart = document.getElementById('cart');
  cart.textContent = Number(cart.textContent) + 1;
">Ajouter une formation au panier</button>
Aperçu

Dans le premier bouton, this désigne le bouton lui-même, le code modifie donc son libellé et le désactive. Le second bouton retrouve le compteur par son id et l’augmente à chaque clic. Atteignez les boutons avec la touche Tab et appuyez sur Entrée : c’est aussi un clic.

Définition et utilisation

#

L’attribut onclick contient du code JavaScript que le navigateur exécute au clic sur l’élément. L’événement click ne se produit pas seulement après un clic de souris ou un toucher de l’écran : un bouton le déclenche aussi après un appui sur Entrée ou la barre d’espace, et un lien après un appui sur Entrée. Sur un élément <button>, un seul attribut gère donc la souris, le toucher et le clavier.

Le navigateur enveloppe le code de l’attribut dans une fonction avec un paramètre event. À l’intérieur, vous disposez donc de this, l’élément qui porte l’attribut, et de event, l’objet événement. event.target désigne l’élément sur lequel on a réellement cliqué. Ce peut être un enfant de l’élément portant l’attribut, car le clic remonte dans l’arbre (bubbling). Renvoyer false annule l’action par défaut, comme event.preventDefault().

Les attributs d’événements sont pratiques dans de courts exemples, mais dans de vrais projets il vaut mieux utiliser la méthode addEventListener dans un script. Le HTML reste alors propre, un élément peut avoir plusieurs gestionnaires, et la page fonctionne aussi avec une politique de sécurité du contenu (CSP) stricte, qui bloque le code écrit dans les attributs. L’attribut ne voit que les fonctions globales, vous ne pouvez donc pas y appeler une fonction déclarée dans un <script type="module">.

Méfiez-vous aussi d’une façon inhabituelle de chercher les noms. Dans le code de l’attribut, le navigateur vérifie d’abord les propriétés de l’élément lui-même, puis celles du formulaire auquel l’élément appartient, puis l’objet document, et seulement à la fin les variables globales. C’est pourquoi votre propre fonction open() ou clear() appelée depuis l’attribut ne s’exécutera pas. À sa place s’exécutera document.open(), qui efface toute la page, ou document.clear(), qui ne fait rien.

Syntaxe

#
Syntaxe
<element onclick="code JavaScript">…</element>

Disponible dans le code de l’attribut

#
  • this

    L’élément qui porte l’attribut. Par this, vous pouvez modifier son texte, ses classes ou ses attributs.
  • event

    L’objet événement. Pour un clic, il contient entre autres la position du curseur (clientX, clientY) et l’information indiquant si Maj ou Ctrl étaient enfoncées (shiftKey, ctrlKey).
  • event.target

    L’élément sur lequel on a réellement cliqué. Ce peut être un enfant de l’élément portant l’attribut.
  • event.preventDefault()

    Annule l’action par défaut, par exemple l’ouverture de l’adresse d’un lien ou le cochage d’une case.
  • return false

    Dans un attribut, fonctionne comme event.preventDefault(). Dans une fonction ajoutée par addEventListener, cela n’a pas cet effet.

Plus d’exemples

#
La différence entre this et event.target
HTML
<ul onclick="
  document.getElementById('log').textContent =
    'this: ' + this.tagName + ', event.target: ' + event.target.tagName;
">
  <li>Leçon 1 : <strong>les balises</strong></li>
  <li>Leçon 2 : <em>les attributs</em></li>
</ul>
<p id="log">Cliquez sur la liste, de préférence sur un mot en gras ou en italique.</p>
Aperçu

L’attribut se trouve sur la liste <ul>, this désigne donc toujours la liste. event.target est l’élément atteint par le curseur : LI, STRONG, EM, et parfois la liste elle-même. C’est sur cela que repose la délégation d’événements : un seul gestionnaire pour de nombreux éléments.

La même chose avec addEventListener
HTML
<button type="button" id="enroll">S’inscrire à la formation HTML</button>

<script>
  const button = document.getElementById('enroll');

  button.addEventListener('click', (event) => {
    event.currentTarget.textContent = 'Inscrit à la formation';
    event.currentTarget.disabled = true;
  });
</script>
Aperçu

C’est ainsi que l’on gère les événements dans de vrais projets. Dans une fonction fléchée, this ne désigne pas l’élément, on utilise donc event.currentTarget à la place.

Compatibilité des navigateurs

#

Largement disponible

Fonctionne dans tous les navigateurs modernes, y compris sur mobile. Vous pouvez l’utiliser sans crainte.

  • Chrome
  • Edge
  • Firefox
  • Safari

Bonnes pratiques

#
  • Ce qui est cliquable doit être un <button> ou un <a>, pas un <div> avec un attribut onclick. On n’atteint pas un <div> avec la touche Tab, et un lecteur d’écran ne dira pas qu’on peut cliquer dessus.
  • Dans React, la notation onClick={handleClick} ne fait que ressembler à un attribut HTML. Vous y transmettez une fonction, et non une chaîne contenant du code, et c’est React qui ajoute l’écoute de l’événement.
  • N’écrivez pas de code long dans l’attribut. Si vous avez besoin de plus d’une ou deux instructions, déplacez-le dans une fonction d’un script, et de préférence directement dans addEventListener.

Entrées associées

#

Pratiquer dans les leçons

#

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.