In JavaScript, when I want to run a script once when the page has loaded, should I use window.onload or just write the script?
For example, if I want to have a pop-up, should I write (directly inside the <script> tag):
alert("hello!");
Or:
window.onload = function() {
alert("hello!");
}
Both appear to run just after the page is loaded. What is the the difference?
window.onload just runs when the browser gets to it.
window.addEventListener waits for the window to be loaded before running it.
In general you should do the second, but you should attach an event listener to it instead of defining the function. For example:
window.addEventListener('load',
function() {
alert('hello!');
}, false);
The other answers all seem out of date
First off, putting scripts at the top and using window.onload is an anti-pattern. It's left over from IE days at best or mis-understandings of JavaScript and the browser at worst.
You can just move your scripts the the bottom of your html
<html>
<head>
<title>My Page</title>
</head>
<body>
content
<script src="some-external.js"></script>
<script>
some in page code
</script>
</body>
</html>
The only reason people used window.onload is because they mistakenly believed scripts needed to go in the head section. Because things are executed in order if your script was in the head section then the body and your content didn't yet exist by definition of execute in order.
The hacky workaround was to use window.onload to wait for the rest of the page to load. Moving your script to the bottom also solved that issue and now there's no need to use window.onload since your body and content will have already been loaded.
The more modern solution is to use the defer tag on your scripts but to use that your scripts need to all be external.
<head>
<script src="some-external.js" defer></script>
<script src="some-other-external.js" defer></script>
</head>
This has the advantage that the browser will start downloading the scripts immediately and it will execute them in the order specified but it will wait to execute them until after the page has loaded, no need for window.onload or the better but still unneeded window.addEventListener('load', ...
window.onload and now everything looks wrong if it doesn't follow that pattern. I have the opposite bias. When I see code that uses window.onload I think "programmer stuck with old outdated patterns from 20 years ago. You'd be hard pressed to find a modern JavaScript tutorial that uses onload. Pick any modern JavaScript library (react, vue, svelte, three.js, angular, etc) and you won't find them using onload or the load event. Of course do whatever you want. There's no "right" answer. –
Convalesce DOMContentLoaded). Example: Dark mode toggles. A script in the head usually sets an attribute on the root ASAP, but you have to wait for the page to load so you can grab a ref to your theme toggle and start registering event listeners. If you want to keep these two scripts in sync (e.g., shared variables), addEventListener('DOMContentLoaded', ...) in the head is your best bet. Otherwise, the body script has to access those shared variables under window.x. –
Wahkuna window.onload since it doesn't have to wait for all content to load. So it's functionally equivalent to putting a script tag at the end of the body or using a deferred script or module script). –
Wahkuna :root { color-scheme: light dark; ... } and/or @media (prefers-color-scheme: dark) { ... }. For example: code, example which you can toggle from the devtools to see the user's preference video. Of course there might be other reasons you want something to run early. –
Convalesce window.onload just runs when the browser gets to it.
window.addEventListener waits for the window to be loaded before running it.
In general you should do the second, but you should attach an event listener to it instead of defining the function. For example:
window.addEventListener('load',
function() {
alert('hello!');
}, false);
Here's the documentation on MDN.
According to it:
The load event fires at the end of the document loading process. At this point, all of the objects in the document are in the DOM, and all the images and sub-frames have finished loading.
Your first snippet of code will run as soon as browser hit this spot in HTML.
The second snippet will trigger popup when the DOM and all images are fully loaded (see the specs).
Considering the alert() function, it doesn't really matter at which point it will run (it doesn't depend on anything besides window object). But if you want to manipulate the DOM - you should definitely wait for it to properly load.
You have three alternatives:
Directly inside the script tag runs it as soon as it is parsed.
Inside document.addEventListener( "DOMContentLoaded", function(){}); will run it once the DOM is ready.
Inside window.onload function(){}) will run as soon as all page resources are loaded.
That depends on if you want it to run when the script element is encountered or if you want it to run when the load event fires (which is after the entire document (including such things as images) has loaded).
Neither is always right.
In general, however, I'd avoid assigning functions directly to onload in favour of using addEventListener (with compatibility libraries if I needed to support older browsers).
The reason for waiting for the DOM to be loaded is so that you can target any elements that load after your script. If you're just creating an alert, it doesn't matter. Let's say, however, you were targeting a div that was in your markup after your script, you would get an error if you don't wait until that piece of the DOM tree to load.
document.ready is a great alternative to window.onload if you're using jQuery.
See here: window.onload vs $(document).ready()
One more interesting difference is that window.onload will only be called once, and it will override the previously attached onload event. But if you use window.addEventListener you can add as many functions as you want, and multiple window.addEventListener won't override each other.
© 2022 - 2024 — McMap. All rights reserved.