CKTIS / JavaScript
MouseEvent : boutons de souris et touches de modification
Identifiez le bouton concerné et l’état de Ctrl, Meta, Maj et Alt au moment de l’événement. Ne confondez pas le code `button` avec le masque de bits `buttons`.
Version : ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
event.button
event.ctrlKey
event.metaKey
event.shiftKey
event.altKeybutton, ctrlKey, metaKey, shiftKey et altKey sont des propriétés d’instance de MouseEvent en lecture seule. Lisez-les sur l’objet événement, par exemple avec event.button. Elles relèvent de l’API Web, et non d’ECMAScript 2024 : leur disponibilité dépend de l’environnement d’exécution.
Pour un événement de pression ou de relâchement comme mousedown ou mouseup, button donne le code d’un seul bouton : 0 principal (souvent à gauche), 1 auxiliaire (souvent au milieu), 2 secondaire (souvent à droite), 3 quatrième (généralement Précédent), 4 cinquième (généralement Suivant). Ces codes désignent des rôles, pas des positions physiques. Sur mousemove, button n’indique pas de manière fiable qu’un bouton est maintenu enfoncé. buttons est le masque de bits des boutons enfoncés : 0 signifie aucun, et 1, 2, 4, 8, 16 désignent respectivement les boutons principal, secondaire, auxiliaire, quatrième et cinquième. (event.buttons & 1) !== 0 teste le bit du bouton principal.
ctrlKey correspond à Ctrl, metaKey à Meta (Commande sur macOS, touche Windows sous Windows), shiftKey à Maj et altKey à Alt (Option sur macOS). Chaque valeur est true si l’événement signale que la touche est enfoncée, et false sinon. C’est l’état enregistré dans l’événement, pas une lecture du clavier en temps réel. Le système peut intercepter un geste : sur macOS, Ctrl-clic peut ouvrir un menu contextuel au lieu de produire un click ordinaire. Un click ne prouve pas l’usage d’une souris : il peut aussi provenir du clavier ou d’une interaction tactile.
Dans new MouseEvent(type, options), les options button et buttons omises valent 0 par défaut, et les options de modification omises valent false. Un événement synthétique a isTrusted === false et ne fournit pas l’activation utilisateur exigée par certaines API.
Exemples
// Use native MouseEvent in browsers. In Node.js, model only the fields read below.
const DemoMouseEvent = globalThis.MouseEvent ?? class extends Event {
constructor(type, {
button = 0, buttons = 0,
ctrlKey = false, metaKey = false, shiftKey = false, altKey = false,
} = {}) {
super(type);
const fields = { button, buttons, ctrlKey, metaKey, shiftKey, altKey };
for (const [key, value] of Object.entries(fields)) {
Object.defineProperty(this, key, { value });
}
}
};
for (const event of [
new DemoMouseEvent("mousedown", { button: 1, buttons: 6, ctrlKey: true, shiftKey: true }),
new DemoMouseEvent("mousemove", { buttons: 2, metaKey: true, altKey: true }),
]) {
const { type, button, buttons, ctrlKey, metaKey, shiftKey, altKey } = event;
console.log(JSON.stringify({ type, button, buttons, ctrlKey, metaKey, shiftKey, altKey }));
}Résultat
{"type":"mousedown","button":1,"buttons":6,"ctrlKey":true,"metaKey":false,"shiftKey":true,"altKey":false}
{"type":"mousemove","button":0,"buttons":2,"ctrlKey":false,"metaKey":true,"shiftKey":false,"altKey":true}Exécutez le code dans la console du navigateur. Sur la première ligne, `button: 1` désigne le bouton auxiliaire et `buttons: 6` combine les bits secondaire (`2`) et auxiliaire (`4`). Sur la seconde, `button: 0` est la valeur par défaut, tandis que le masque ne signale que le bouton secondaire. Aucun des deux événements n’est distribué.
Leçons associées
- JavaScript · Leçon 37 · Avancé · Version : 4
- JavaScript · Leçon 38 · Avancé · Version : 4
- JavaScript · Leçon 36 · Intermédiaire · Version : 3
- JavaScript · Leçon 37 · Intermédiaire · Version : 3
Sources
- MouseEvent: button property
- MouseEvent: ctrlKey property
- MouseEvent: metaKey property
- MouseEvent: shiftKey property
- MouseEvent: altKey property
- MouseEvent: buttons property
- MouseEvent: MouseEvent() constructor
- Element: click event
- Event: isTrusted property
- HTML Standard: Tracking user activation
- ECMAScript 2024 Language Specification: Hosts and Implementations