Element: auxclick event


 

The auxclick event fires when a non-primary pointing device button (e.g., any mouse button other than the left button) has been pressed and released on an element.

auxclick fires after the mousedown and mouseup events, in that order.

Bubbles Yes
Cancelable Yes
Interface MouseEvent
Event handler property onauxclick

Preventing default actions

For the vast majority of browsers that map middle click to opening a link in a new tab, including Firefox, it is possible to cancel this behaviour by calling preventDefault() from within an auxclick event handler.

When listening for auxclick events originating on elements that do not support input or navigation, you will often want to explicitly prevent other default actions mapped to the down action of the middle mouse button. On Windows this is usually autoscroll, and on macOS and Linux this is usually clipboard paste. This can be done by preventing the default behaviour of the mousedown or pointerdown event.

Additionally, you may need to avoid opening a system context menu after a right click. Due to timing differences between operating systems, this too is not a preventable default behaviour of auxclick. Instead, this can be done by preventing the default behaviour of the contextmenu event.

Examples

In this example we define functions for two event handlers — onclick and onauxclick. The former changes the color of the button background, while the latter changes the button foreground (text) color. You can see the two functions in action by trying the demo out with a multi-button mouse (see it live on GitHub; also see the source code).

var button = document.querySelector('button');
var html = document.querySelector('html');

function random(number) {
  return Math.floor(Math.random() * number);
}

button.onclick = function() {
  var rndCol = 'rgb(' + random(255) + ',' + random(255) + ',' + random(255) + ')';
  button.style.backgroundColor = rndCol;
};

button.onauxclick = function() {
  var rndCol = 'rgb(' + random(255) + ',' + random(255) + ',' + random(255) + ')';
  button.style.color = rndCol;
}

Note: If you are using a three-button mouse, you'll notice that the onauxclick handler is run when either of the non-left mouse buttons are clicked.

Specification

Specification Status Comment
Unknown
The definition of 'auxclick' in that specification.
Working Draft Initial definition

Browser compatibility

No compatibility data found. Please contribute data for "api.Element.auxclick" (depth: 1) to the MDN compatibility data repository.

See also

Document Tags and Contributors

Last updated by: irenesmith,