principlejavascriptCritical
addEventListener vs onclick
Viewed 0 times
addeventlisteneronclickstackoverflow
Problem
What's the difference between
The code above resides together in a separate
addEventListener and onclick?var h = document.getElementById("a");
h.onclick = dothing1;
h.addEventListener("click", dothing2);The code above resides together in a separate
.js file, and they both work perfectly.Solution
Both are correct, but none of them are "best" per se, and there may be a reason the developer chose to use both approaches.
Event Listeners (
Earlier versions of Internet Explorer implement JavaScript differently from pretty much every other browser. With versions less than 9, you use the
In most other browsers (including IE 9 and above), you use
Using this approach (DOM Level 2 events), you can attach a theoretically unlimited number of events to any single element. The only practical limitation is client-side memory and other performance concerns, which are different for each browser.
The examples above represent using an anonymous function[doc]. You can also add an event listener using a function reference[doc] or a closure[doc]:
Another important feature of
Inline events (HTML
In all browsers that support JavaScript, you can put an event listener inline, meaning right in the HTML code. You've probably seen this:
Most experienced developers avoid this method, but it does get the job done; it is simple and direct. You may not use closures or anonymous functions here (though the handler itself is an anonymous function of sorts), and your control of scope is limited.
The other method you mention:
... is the equivalent of inline JavaScript except that you have more control of the scope (since you're writing a script rather than HTML) and can use anonymous functions, function references, and/or closures.
The significant drawback with inline events is that unlike event listeners described above, you may only have one inline event assigned. Inline events are stored as an attribute/property of the element[doc], meaning that it can be overwritten.
Using the example `
element.onclick = function () { alert('did stuff #1'); };
element.onclick = function () { alert('did stuff #2'); };
function addEvent(element, evnt, funct){
if (element.attachEve
Event Listeners (
addEventListener and IE's attachEvent)Earlier versions of Internet Explorer implement JavaScript differently from pretty much every other browser. With versions less than 9, you use the
attachEvent[doc] method, like this:element.attachEvent('onclick', function() { / do stuff here/ });
In most other browsers (including IE 9 and above), you use
addEventListener[doc], like this:element.addEventListener('click', function() { / do stuff here/ }, false);
Using this approach (DOM Level 2 events), you can attach a theoretically unlimited number of events to any single element. The only practical limitation is client-side memory and other performance concerns, which are different for each browser.
The examples above represent using an anonymous function[doc]. You can also add an event listener using a function reference[doc] or a closure[doc]:
const myFunctionReference = function() { / do stuff here/ }
element.attachEvent('onclick', myFunctionReference);
element.addEventListener('click', myFunctionReference , false);
Another important feature of
addEventListener is the final parameter, which controls how the listener reacts to bubbling events[doc]. I've been passing false in the examples, which is standard for probably 95% of use cases. There is no equivalent argument for attachEvent, or when using inline events.Inline events (HTML
onclick="" property and element.onclick)In all browsers that support JavaScript, you can put an event listener inline, meaning right in the HTML code. You've probably seen this:
Click me
Most experienced developers avoid this method, but it does get the job done; it is simple and direct. You may not use closures or anonymous functions here (though the handler itself is an anonymous function of sorts), and your control of scope is limited.
The other method you mention:
element.onclick = function () { /do stuff here / };
... is the equivalent of inline JavaScript except that you have more control of the scope (since you're writing a script rather than HTML) and can use anonymous functions, function references, and/or closures.
The significant drawback with inline events is that unlike event listeners described above, you may only have one inline event assigned. Inline events are stored as an attribute/property of the element[doc], meaning that it can be overwritten.
Using the example `
from the HTML above:
const element = document.getElementById('testing');element.onclick = function () { alert('did stuff #1'); };
element.onclick = function () { alert('did stuff #2'); };
... when you clicked the element, you'd only see "Did stuff #2" - you overwrote the first assigned of the onclick property with the second value, and you overwrote the original inline HTML onclick property too. Check it out here: http://jsfiddle.net/jpgah/.
Broadly speaking, do not use inline events. There may be specific use cases for it, but if you are not 100% sure you have that use case, then you do not and should not use inline events.
Modern JavaScript (Angular and the like)
Since this answer was originally posted, JavaScript frameworks like Angular have become far more popular. You will see code like this in an Angular template:
Do Something
This looks like an inline event, but it isn't. This type of template will be transpiled into more complex code which uses event listeners behind the scenes. Everything I've written about events here still applies, but you are removed from the nitty gritty by at least one layer. You should understand the nuts and bolts, but if your modern JavaScript framework best practices involve writing this kind of code in a template, don't feel like you're using an inline event – you aren't.
Which is Best?
The question is a matter of browser compatibility and necessity. Do you need to attach more than one event to an element? Will you in the future? Odds are, you will. attachEvent and addEventListener are necessary. If not, an inline event may seem like they'd do the trick, but you're much better served preparing for a future that, though it may seem unlikely, is predictable at least. There is a chance you'll have to move to JavaScript-based event listeners, so you may as well just start there. Don't use inline events.
jQuery and other JavaScript frameworks encapsulate the different browser implementations of DOM level 2 events in generic models so you can write cross-browser compliant code without having to worry about IE's history as a rebel. Same code with jQuery, all cross-browser and ready to rock:
$(element).on('click', function () { /* do stuff */ });
Don't run out and get a framework just for this one thing, though. You can easily roll your own little utility to take care of the older browsers:
``function addEvent(element, evnt, funct){
if (element.attachEve
Code Snippets
$(element).on('click', function () { /* do stuff */ });function addEvent(element, evnt, funct){
if (element.attachEvent)
return element.attachEvent('on'+evnt, funct);
else
return element.addEventListener(evnt, funct, false);
}
// example
addEvent(
document.getElementById('myElement'),
'click',
function () { alert('hi!'); }
);Context
Stack Overflow Q#6348494, score: 1270
Revisions (0)
No revisions yet.