event.preventDefault vs return false
preventDefault() and return false are the different ways to prevent the default event from happening.
For example, when user clicks on an external link, we should display a confirmation modal that asks user for redirecting to the external website or not:
hyperlink.addEventListener('click', function (e) {
// Don't redirect user to the link
e.preventDefault();
});Or we don't want to submit the form when clicking its submit button. Instead, we want to validate the form first:
submitButton.addEventListener('click', function (e) {
// Don't submit the form when clicking a submit
e.preventDefault();
});Differences
return falsedoesn't have any effect on the default behavior if you use theaddEventListenermethod to handle an event. It only works when the event handler is declared as an element's attribute:hyperlink.addEventListener('click', function (e) {
// Does NOT work
return false;
});
// Work
hyperlink.onclick = function (e) {
return false;
};According to the HTML 5 specifications,
return falsewill cancel the event except themouseoverevent.
Good practices
It's recommended to use the
preventDefaultmethod instead ofreturn falseinside an event handler. Because the latter only works with using theonclickattribute which will remove other handlers for the same event.If you're using jQuery to manage the events, then you're able to use
return falsewithin the event handler:$(element).on('click', function (e) {
return false;
});Before returning the value of
false, the handler would do something else. The problem is that if there's any runtime error occurring in the handler, we will not reach thereturn falsestatement at the end.In that case, the default behavior will be taken:
$(element).on('click', function (e) {
// Do something here, but if there's error at runtime
// ...
return false;
});We can avoid this situation by using the
preventDefaultmethod before performing any custom handler:$(element).on('click', function (e) {
e.preventDefault();
// Do something here
// The default behavior is prevented regardless errors at runtime
// ...
});
Good to know
If you're using jQuery to manage the event, then return false will behave same as the preventDefault() and stopPropagation() methods:
$(element).on('click', function (e) {
// Prevent the deault event from happenning and
// prevent the event from bubbling up to the parent element
return false;
});