EventTarget: addEventListener() method - Web APIs | MDN (2024)

type

A case-sensitive string representing the event type to listen for.

listener

The object that receives a notification (an object that implements the Event interface) when an event of the specified type occurs. This must be null, an object with a handleEvent() method, or a JavaScript function. See The event listener callback for details on the callback itself.

options Optional

An object that specifies characteristics about the event listener. The available options are:

capture Optional

A boolean value indicating that events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree. If not specified, defaults to false.

once Optional

A boolean value indicating that the listener should be invoked at most once after being added. If true, the listener would be automatically removed when invoked. If not specified, defaults to false.

passive Optional

A boolean value that, if true, indicates that the function specified by listener will never call preventDefault(). If a passive listener does call preventDefault(), the user agent will do nothing other than generate a console warning.

If this option is not specified it defaults to false – except that in browsers other than Safari, it defaults to true for wheel, mousewheel, touchstart and touchmove events. See Using passive listeners to learn more.

signal Optional

An AbortSignal. The listener will be removed when the given AbortSignal object's abort() method is called. If not specified, no AbortSignal is associated with the listener.

useCapture Optional

A boolean value indicating whether events of this type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree. Events that are bubbling upward through the tree will not trigger a listener designated to use capture. Event bubbling and capturing are two ways of propagating events that occur in an element that is nested within another element, when both elements have registered a handle for that event. The event propagation mode determines the order in which elements receive the event. See DOM Level 3 Events and JavaScript Event order for a detailed explanation. If not specified, useCapture defaults to false.

Note: For event listeners attached to the event target, the event is in the target phase, rather than the capturing and bubbling phases. Event listeners in the capturing phase are called before event listeners in any non-capturing phases.

wantsUntrusted Optional Non-standard

A Firefox (Gecko)-specific parameter. If true, the listener receives synthetic events dispatched by web content (the default is false for browser chrome and true for regular web pages). This parameter is useful for code found in add-ons, as well as the browser itself.

None (undefined).

The event listener can be specified as either a callback function or an object whose handleEvent() method serves as the callback function.

The callback function itself has the same parameters and return value as the handleEvent() method; that is, the callback accepts a single parameter: an object based on Event describing the event that has occurred, and it returns nothing.

For example, an event handler callback that can be used to handle both fullscreenchange and fullscreenerror might look like this:

function handleEvent(event) { if (event.type === "fullscreenchange") { /* handle a full screen toggle */ } else { /* handle a full screen toggle error */ }}

In older versions of the DOM specification, the third parameter of addEventListener() was a Boolean value indicating whether or not to use capture. Over time, it became clear that more options were needed. Rather than adding more parameters to the function (complicating things enormously when dealing with optional values), the third parameter was changed to an object that can contain various properties defining the values of options to configure the process of removing the event listener.

Because older browsers (as well as some not-too-old browsers) still assume the third parameter is a Boolean, you need to build your code to handle this scenario intelligently. You can do this by using feature detection for each of the options you're interested in.

For example, if you want to check for the passive option:

let passiveSupported = false;try { const options = { get passive() { // This function will be called when the browser // attempts to access the passive property. passiveSupported = true; return false; }, }; window.addEventListener("test", null, options); window.removeEventListener("test", null, options);} catch (err) { passiveSupported = false;}

This creates an options object with a getter function for the passive property; the getter sets a flag, passiveSupported, to true if it gets called. That means that if the browser checks the value of the passive property on the options object, passiveSupported will be set to true; otherwise, it will remain false. We then call addEventListener() to set up a fake event handler, specifying those options, so that the options will be checked if the browser recognizes an object as the third parameter. Then, we call removeEventListener() to clean up after ourselves. (Note that handleEvent() is ignored on event listeners that aren't called.)

You can check whether any option is supported this way. Just add a getter for that option using code similar to what is shown above.

Then, when you want to create an actual event listener that uses the options in question, you can do something like this:

someElement.addEventListener( "mouseup", handleMouseUp, passiveSupported ? { passive: true } : false,);

Here we're adding a listener for the mouseup event on the element someElement. For the third parameter, if passiveSupported is true, we're specifying an options object with passive set to true; otherwise, we know that we need to pass a Boolean, and we pass false as the value of the useCapture parameter.

You can learn more in the Implementing feature detection documentation and the explainer about EventListenerOptions from the Web Incubator Community Group.

It is often desirable to reference the element on which the event handler was fired, such as when using a generic handler for a set of similar elements.

When attaching a handler function to an element using addEventListener(), the value of this inside the handler will be a reference to the element. It will be the same as the value of the currentTarget property of the event argument that is passed to the handler.

my_element.addEventListener("click", function (e) { console.log(this.className); // logs the className of my_element console.log(e.currentTarget === this); // logs `true`});

As a reminder, arrow functions do not have their own this context.

my_element.addEventListener("click", (e) => { console.log(this.className); // WARNING: `this` is not `my_element` console.log(e.currentTarget === this); // logs `false`});

If an event handler (for example, onclick) is specified on an element in the HTML source, the JavaScript code in the attribute value is effectively wrapped in a handler function that binds the value of this in a manner consistent with the addEventListener(); an occurrence of this within the code represents a reference to the element.

<table id="my_table" onclick="console.log(this.id);"> <!-- `this` refers to the table; logs 'my_table' --> …</table>

Note that the value of this inside a function, called by the code in the attribute value, behaves as per standard rules. This is shown in the following example:

<script> function logID() { console.log(this.id); }</script><table id="my_table" onclick="logID();"> <!-- when called, `this` will refer to the global object --> …</table>

The value of this within logID() is a reference to the global object Window (or undefined in the case of strict mode.

Specifying "this" using bind()

The Function.prototype.bind() method lets you establish a fixed this context for all subsequent calls — bypassing problems where it's unclear what this will be, depending on the context from which your function was called. Note, however, that you'll need to keep a reference to the listener around so you can remove it later.

This is an example with and without bind():

class Something { name = "Something Good"; constructor(element) { // bind causes a fixed `this` context to be assigned to `onclick2` this.onclick2 = this.onclick2.bind(this); element.addEventListener("click", this.onclick1, false); element.addEventListener("click", this.onclick2, false); // Trick } onclick1(event) { console.log(this.name); // undefined, as `this` is the element } onclick2(event) { console.log(this.name); // 'Something Good', as `this` is bound to the Something instance }}const s = new Something(document.body);

Another solution is using a special function called handleEvent() to catch any events:

class Something { name = "Something Good"; constructor(element) { // Note that the listeners in this case are `this`, not this.handleEvent element.addEventListener("click", this, false); element.addEventListener("dblclick", this, false); } handleEvent(event) { console.log(this.name); // 'Something Good', as this is bound to newly created object switch (event.type) { case "click": // some code here… break; case "dblclick": // some code here… break; } }}const s = new Something(document.body);

Another way of handling the reference to this is to use an arrow function, which doesn't create a separate this context.

class SomeClass { name = "Something Good"; register() { window.addEventListener("keydown", (e) => { this.someMethod(e); }); } someMethod(e) { console.log(this.name); switch (e.code) { case "ArrowUp": // some code here… break; case "ArrowDown": // some code here… break; } }}const myObject = new SomeClass();myObject.register();

Event listeners only take one argument, an Event or a subclass of Event, which is automatically passed to the listener, and the return value is ignored. Therefore, to get data into and out of an event listener, instead of passing the data through parameters and return values, you need to create closures instead.

The functions passed as event listeners have access to all variables declared in the outer scopes that contain the function.

const myButton = document.getElementById("my-button-id");let someString = "Data";myButton.addEventListener("click", () => { console.log(someString); // 'Data' on first click, // 'Data Again' on second click someString = "Data Again";});console.log(someString); // Expected Value: 'Data' (will never output 'Data Again')

Read the function guide for more information about function scopes.

const elts = document.getElementsByTagName("*");// Case 1for (const elt of elts) { elt.addEventListener( "click", (e) => { // Do something }, false, );}// Case 2function processEvent(e) { // Do something}for (const elt of elts) { elt.addEventListener("click", processEvent, false);}

In the first case above, a new (anonymous) handler function is created with each iteration of the loop. In the second case, the same previously declared function is used as an event handler, which results in smaller memory consumption because there is only one handler function created. Moreover, in the first case, it is not possible to call removeEventListener() because no reference to the anonymous function is kept (or here, not kept to any of the multiple anonymous functions the loop might create.) In the second case, it's possible to do myElement.removeEventListener("click", processEvent, false) because processEvent is the function reference.

Actually, regarding memory consumption, the lack of keeping a function reference is not the real issue; rather it is the lack of keeping a static function reference.

If an event has a default action — for example, a wheel event that scrolls the container by default — the browser is in general unable to start the default action until the event listener has finished, because it doesn't know in advance whether the event listener might cancel the default action by calling Event.preventDefault(). If the event listener takes too long to execute, this can cause a noticeable delay, also known as jank, before the default action can be executed.

By setting the passive option to true, an event listener declares that it will not cancel the default action, so the browser can start the default action immediately, without waiting for the listener to finish. If the listener does then call Event.preventDefault(), this will have no effect.

The specification for addEventListener() defines the default value for the passive option as always being false. However, to realize the scroll performance benefits of passive listeners in legacy code, modern browsers have changed the default value of the passive option to true for the wheel, mousewheel, touchstart and touchmove events on the document-level nodes Window, Document, and Document.body. That prevents the event listener from canceling the event, so it can't block page rendering while the user is scrolling.

Because of that, when you want to override that behavior and ensure the passive option is false, you must explicitly set the option to false (rather than relying on the default).

You don't need to worry about the value of passive for the basic scroll event. Since it can't be canceled, event listeners can't block page rendering anyway.

See Improving scroll performance using passive listeners for an example showing the effect of passive listeners.

This example demonstrates how to use addEventListener() to watch for mouse clicks on an element.

HTML

<table id="outside"> <tr> <td id="t1">one</td> </tr> <tr> <td id="t2">two</td> </tr></table>

JavaScript

// Function to change the content of t2function modifyText() { const t2 = document.getElementById("t2"); const isNodeThree = t2.firstChild.nodeValue === "three"; t2.firstChild.nodeValue = isNodeThree ? "two" : "three";}// Add event listener to tableconst el = document.getElementById("outside");el.addEventListener("click", modifyText, false);

In this code, modifyText() is a listener for click events registered using addEventListener(). A click anywhere in the table bubbles up to the handler and runs modifyText().

Result

This example demonstrates how to add an addEventListener() that can be aborted with an AbortSignal.

HTML

<table id="outside"> <tr> <td id="t1">one</td> </tr> <tr> <td id="t2">two</td> </tr></table>

JavaScript

// Add an abortable event listener to tableconst controller = new AbortController();const el = document.getElementById("outside");el.addEventListener("click", modifyText, { signal: controller.signal });// Function to change the content of t2function modifyText() { const t2 = document.getElementById("t2"); if (t2.firstChild.nodeValue === "three") { t2.firstChild.nodeValue = "two"; } else { t2.firstChild.nodeValue = "three"; controller.abort(); // remove listener after value reaches "three" }}

In the example above, we modify the code in the previous example such that after the second row's content changes to "three", we call abort() from the AbortController we passed to the addEventListener() call. That results in the value remaining as "three" forever because we no longer have any code listening for a click event.

Result

Here, we'll take a look at how to use an anonymous function to pass parameters into the event listener.

HTML

<table id="outside"> <tr> <td id="t1">one</td> </tr> <tr> <td id="t2">two</td> </tr></table>

JavaScript

// Function to change the content of t2function modifyText(new_text) { const t2 = document.getElementById("t2"); t2.firstChild.nodeValue = new_text;}// Function to add event listener to tableconst el = document.getElementById("outside");el.addEventListener( "click", function () { modifyText("four"); }, false,);

Notice that the listener is an anonymous function that encapsulates code that is then, in turn, able to send parameters to the modifyText() function, which is responsible for actually responding to the event.

Result

This example demonstrates a simple event listener implemented using arrow function notation.

HTML

<table id="outside"> <tr> <td id="t1">one</td> </tr> <tr> <td id="t2">two</td> </tr></table>

JavaScript

// Function to change the content of t2function modifyText(new_text) { const t2 = document.getElementById("t2"); t2.firstChild.nodeValue = new_text;}// Add event listener to table with an arrow functionconst el = document.getElementById("outside");el.addEventListener( "click", () => { modifyText("four"); }, false,);

Result

Please note that while anonymous and arrow functions are similar, they have different this bindings. While anonymous (and all traditional JavaScript functions) create their own this bindings, arrow functions inherit the this binding of the containing function.

That means that the variables and constants available to the containing function are also available to the event handler when using an arrow function.

HTML

<div class="outer"> outer, once & none-once <div class="middle" target="_blank"> middle, capture & none-capture <a class="inner1" href="https://www.mozilla.org" target="_blank"> inner1, passive & preventDefault(which is not allowed) </a> <a class="inner2" href="https://developer.mozilla.org/" target="_blank"> inner2, none-passive & preventDefault(not open new page) </a> </div></div><hr /><button class="clear-button">Clear logs</button><section class="demo-logs"></section>

CSS

.outer,.middle,.inner1,.inner2 { display: block; width: 520px; padding: 15px; margin: 15px; text-decoration: none;}.outer { border: 1px solid red; color: red;}.middle { border: 1px solid green; color: green; width: 460px;}.inner1,.inner2 { border: 1px solid purple; color: purple; width: 400px;}

.demo-logs { width: 530px; height: 16rem; background-color: #ddd; overflow-x: auto; padding: 1rem;}

JavaScript

const clearBtn = document.querySelector(".clear-button");const demoLogs = document.querySelector(".demo-logs");function log(msg) { demoLogs.innerText += `${msg}\n`;}clearBtn.addEventListener("click", () => { demoLogs.innerText = "";});

const outer = document.querySelector(".outer");const middle = document.querySelector(".middle");const inner1 = document.querySelector(".inner1");const inner2 = document.querySelector(".inner2");const capture = { capture: true,};const noneCapture = { capture: false,};const once = { once: true,};const noneOnce = { once: false,};const passive = { passive: true,};const nonePassive = { passive: false,};outer.addEventListener("click", onceHandler, once);outer.addEventListener("click", noneOnceHandler, noneOnce);middle.addEventListener("click", captureHandler, capture);middle.addEventListener("click", noneCaptureHandler, noneCapture);inner1.addEventListener("click", passiveHandler, passive);inner2.addEventListener("click", nonePassiveHandler, nonePassive);function onceHandler(event) { log("outer, once");}function noneOnceHandler(event) { log("outer, none-once, default\n");}function captureHandler(event) { //event.stopImmediatePropagation(); log("middle, capture");}function noneCaptureHandler(event) { log("middle, none-capture, default");}function passiveHandler(event) { // Unable to preventDefault inside passive event listener invocation. event.preventDefault(); log("inner1, passive, open new page");}function nonePassiveHandler(event) { event.preventDefault(); //event.stopPropagation(); log("inner2, none-passive, default, not open new page");}

Result

Click the outer, middle, inner containers respectively to see how the options work.

Before using a particular value in the options object, it's a good idea to ensure that the user's browser supports it, since these are an addition that not all browsers have supported historically. See Safely detecting option support for details.

You can set more than one of the options in the options parameter. In the following example we are setting two options:

• passive, to assert that the handler will not call preventDefault()
• once, to ensure that the event handler will only be called once.

HTML

<button id="example-button">You have not clicked this button.</button><button id="reset-button">Click this button to reset the first button.</button>

JavaScript

const buttonToBeClicked = document.getElementById("example-button");const resetButton = document.getElementById("reset-button");// the text that the button is initialized withconst initialText = buttonToBeClicked.textContent;// the text that the button contains after being clickedconst clickedText = "You have clicked this button.";// we hoist the event listener callback function// to prevent having duplicate listeners attachedfunction eventListener() { buttonToBeClicked.textContent = clickedText;}function addListener() { buttonToBeClicked.addEventListener("click", eventListener, { passive: true, once: true, });}// when the reset button is clicked, the example button is reset,// and allowed to have its state updated againresetButton.addEventListener("click", () => { buttonToBeClicked.textContent = initialText; addListener();});addListener();

Result

The following example shows the effect of setting passive. It includes a <div> that contains some text, and a check box.

HTML

<div id="container"> <p> But down there it would be dark now, and not the lovely lighted aquarium she imagined it to be during the daylight hours, eddying with schools of tiny, delicate animals floating and dancing slowly to their own serene currents and creating the look of a living painting. That was wrong, in any case. The ocean was different from an aquarium, which was an artificial environment. The ocean was a world. And a world is not art. Dorothy thought about the living things that moved in that world: large, ruthless and hungry. Like us up here. </p></div><div> <input type="checkbox" id="passive" name="passive" checked /> <label for="passive">passive</label></div>

#container { width: 150px; height: 200px; overflow: scroll; margin: 2rem 0; padding: 0.4rem; border: 1px solid black;}

JavaScript

The code adds a listener to the container's wheel event, which by default scrolls the container. The listener runs a long-running operation. Initially the listener is added with the passive option, and whenever the checkbox is toggled, the code toggles the passive option.

const passive = document.querySelector("#passive");passive.addEventListener("change", (event) => { container.removeEventListener("wheel", wheelHandler); container.addEventListener("wheel", wheelHandler, { passive: passive.checked, once: true, });});const container = document.querySelector("#container");container.addEventListener("wheel", wheelHandler, { passive: true, once: true,});function wheelHandler() { function isPrime(n) { for (let c = 2; c <= Math.sqrt(n); ++c) { if (n % c === 0) { return false; } } return true; } const quota = 1000000; const primes = []; const maximum = 1000000; while (primes.length < quota) { const candidate = Math.floor(Math.random() * (maximum + 1)); if (isPrime(candidate)) { primes.push(candidate); } } console.log(primes);}

Result

The effect is that:

• Initially, the listener is passive, so trying to scroll the container with the wheel is immediate.
• If you uncheck "passive" and try to scroll the container using the wheel, then there is a noticeable delay before the container scrolls, because the browser has to wait for the long-running listener to finish.

• EventTarget.removeEventListener()
• Creating and triggering custom events
• More details on the use of this in event handlers