jQuery
document.ready() function: syntax and features
JavaScript provides us with
load() function in order to perform
specific action whenever the DOM gets loaded (i.e. a page gets rendered). One
issue with this function is that it is not triggered until all the elements
within the page (including the images) get displayed. With $(document).ready() function, all the event driven codes in JavaScript
are guaranteed to be run once the DOM is ready.
The syntax for .ready() is
illustrated by the following example:
$(document).ready(function(){
alert('This code is
triggered once the DOM is ready');
// perform other necessary
actions if any
});
A short way to
write the same function is as follows:
$(function(){
alert('This code is
triggered once the DOM is ready');
// perform other necessary
actions if any
});
A simple reason that we can
shorten our code is that any function which is passed as an argument to the
jQuery constructor is bound to the document ready event.
Another very important
feature of $(document).ready() is that it can be used or referenced more than
once within a document. So the following piece of code would be possible
(within a single file):
$(document).ready(function(){
// some piece of code
});
$(document).ready(function(){
// other piece of code
});
One scenario
where more .ready() could be used more than once is when we have a common JavaScript
which is referenced across a given project. And, there is another JavaScript
which is referenced in a particular file. We would then be using the following
references in that particular file:
<script src="/js/common-file.js"
type="text/javascript"></script>
<script src="/js/specific-file.js"
type="text/javascript"></script>
References:
- http://think2loud.com/653-jquery-document-ready-howto/
- http://api.jquery.com/ready/
- http://docs.jquery.com/Tutorials:Multiple_$%28document%29.ready%28%29