Is it ok to use google.setOnLoadCallback multiple times?

Joseph picture Joseph · Sep 4, 2009 · Viewed 19.6k times · Source

I'm building a site using ASP.NET MVC, and I have partial views that use jQuery to do various things. I was thinking of switching to Google's AJAX API and using their loader to load jQuery. However, I noticed that I would no longer be able to use $(document).ready() anymore because Google's loader specifies a callback google.setOnLoadCallback().

This is a little bit of a problem for me because I have $(document).ready() in various partial views because they do different things specific to themselves that I don't want the parent view to be aware of.

Can I specify multiple callbacks and just swap out the $(document).ready()'s with google.setOnLoadCallback(someUniqueCallbackFunction)?

Would that be the ideal way to handle this situation or is there something else that is preferred?

Answer

Ryan Wheale picture Ryan Wheale · Oct 27, 2009

Yes, you may use setOnLoadCallback in lieu of $(document).ready. There is an undocumented SECOND PARAMETER (or at least, I can't find it) that specifies when to call the callback function; possible values are "false" (default) - on the window load, or "true" - on DOM load (DOMContentLoaded). The DOM event fires once all the markup has loaded (much earlier than window.load). The window load event fires after all the images and scripts and such have finished loading.

// Very similar to $(document).ready()
google.setOnLoadCallback( OnLoad, true );

// Very similar to $(window).load()
// Same as google.setOnLoadCallback( OnLoad, false );
google.setOnLoadCallback( OnLoad );

Yes, you may use setOnLoadCallback multiple times on a single page. This is a very important undocumented feature of the AJAX API (undocumented as of this posting). Every time you call setOnLoadCallback, it stacks up all the functions to be called once the DOM or window loads.