event.preventDefault vs return false
Written byPhuoc Nguyen
Created
24 Jun, 2020
Last updated
03 Dec, 2021
Category
DOM
`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:
js
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:
js
submitButton.addEventListener('click', function (e) {
// Don't submit the form when clicking a submit
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:jshyperlink.addEventListener('click', function (e) {// Does NOT workreturn false;});// Workhyperlink.onclick = function (e) {return false;}; -
According to the HTML 5 specifications,
`return false`
will cancel the event except the`mouseover`
event.
#Good practices
-
It's recommended to use the
`preventDefault`
method instead of`return false`
inside an event handler. Because the latter 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:js$(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:js$(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`preventDefault`
method before performing any custom handler:js$(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:js
$(element).on('click', function (e) {
// Prevent the deault event from happenning and
// prevent the event from bubbling up to the parent element
return false;
});
#See also
Questions? 🙋
Do you have any questions about front-end development? If so, feel free to create a new issue on GitHub using the button below. I'm happy to help with any topic you'd like to learn more about, even beyond what's covered in this post.
While I have a long list of upcoming topics, I'm always eager to prioritize your questions and ideas for future content. Let's learn and grow together! Sharing knowledge is the best way to elevate ourselves 🥷.
Recent posts ⚡
Newsletter 🔔
If you're into front-end technologies and you want to see more of the content I'm creating, then you might want to consider subscribing to my newsletter.
By subscribing, you'll be the first to know about new articles, products, and exclusive promotions.
Don't worry, I won't spam you. And if you ever change your mind, you can unsubscribe at any time.
Phước Nguyễn