Dynamically Loading JS Libraries And Detecting When They're Loaded:
Sometimes it makes sense to dynamically load JavaScript library code only at the point at which it's required. If functionality which uses that library is used rarely then it makes little sense incur the overhead of an additional HTTP request or data transfer on page load.
We can dynamically load any JavaScript and add it to the document with the following function.
Making a dynamic request
function loadScript(sScriptSrc) {
var oHead = document.getElementById('head')[0];
var oScript = document.createElement('script');
oScript.type = 'text/javascript';
oScript.src = sScriptSrc;
oHead.appendChild(oScript);
}
This approach isn't without problems though. The request will load asynchronously which means that any JavaScript which depends on code returned by the request may continue to run before the request completes resulting in errors.
Callback event handlers
As described in far greater detail in JavaScript Madness: Dynamic Script Loading browsers provide the ability to specify a callback function to run once the script load completes. In most it's as simple as assigning a callback function to the script.onload event handler.
oScript.onload = callback;
Internet Explorer, as in so many cases, does things differently. It supports a onreadystatechange event handler to which we can assign a callback function. It's slightly more complicated than that used by other browsers as one has to check a return status before running the callback.
oScript.onreadystatechange = function() {
if (this.readyState == 'complete') {
callback();
}
}
Combining the parts gives us:
function loadScript(sScriptSrc, oCallback) {
var oHead = document.getElementById('head')[0];
var oScript = document.createElement('script');
oScript.type = 'text/javascript';
oScript.src = sScriptSrc;
// most browsers
oScript.onload = oCallback;
// IE 6 & 7
oScript.onreadystatechange = function() {
if (this.readyState == 'complete') {
oCallback();
}
}
oHead.appendChild(oScript);
}
Detecting script load with timeouts
Reading a number of sources however it seems that there is a lack of trust in the cross browser robustness of these event handlers. One could instead use timeouts to poll for the existence of required functions returned by the script request and run our callback once detected.
I wrote the following function to achieve just this recently. The function takes two main parameters, a string representing the function to poll for and a reference to the callback function to run once it's found.
function onFunctionAvailable(sMethod, oCallback, oObject, bScope) {
if (typeof(eval(sMethod)) === 'function') {
bScope ? oCallback.call(oObject) : oCallback(oObject);
} else {
setTimeout(function () {
onFunctionAvailable(sMethod, oCallback, oObject, bScope);
}), 50
}
}
Two additional parameters allow one to define the scope of "this" within the callback function.
The hardest part of this function was working out how to detect the existence of a function from a string.