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) {
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) {
e.preventDefault();
});
Differences
-
return false
doesn't have any effect on the default behavior if you use the addEventListener
method to handle an event.
It only works when the event handler is declared as an element's attribute:
hyperlink.addEventListener('click', function (e) {
return false;
});
hyperlink.onclick = function (e) {
return false;
};
-
Good practices
-
It's recommended to use the preventDefault
method instead of return false
inside an event handler.
Because the later only works with using the onclick
attribute 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 false
within 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 the return false
statement at the end.
In that case, the default behavior will be taken:
$(element).on('click', function (e) {
return false;
});
We can avoid this situation by using the preventDefault
method before performing any custom handler:
$(element).on('click', function (e) {
e.preventDefault();
});
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) {
return false;
});
See also