Icontem

File: README.md

Recommend this page to a friend!
  Classes of Thomas Björk  >  JS and CSS Resource Loader  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: JS and CSS Resource Loader
Load cached JavaScript and CSS from localStorage
Author: By
Last change: Added a readme for jQuery called JQUERY.md
Date: 4 years ago
Size: 6,733 bytes
 

Contents

Class file image Download

JResourceLoader

A simple resource loader in javascript with the ability to store the scripts, stylesheets and images in localStorage or sessionStorage.

ResourceLoader has a built in feature to avoid reloading itself. If a newer version if ResourceLoader is loaded then it will replace the older version.

Distribution and development

There are two different files that can be used.

resourceloader.js

is intended for development and testing.

resourceloader.min.js

is intended for production usage.

The minification is done by Googles Closure compiler in simple mode.

ResourceLoader.load(src, options)

Arguments

src

The argument src identifies which source file should be loaded. The url can be prefixed with either js! or css! to force the loading as a script or a style. The prefix is useful when files are loaded from repositories where the files extension isn't always .js or .css.

If the url is prefixed with png!, gif!, jpeg!, jpe! or jpg! then the file is handled as an image.

options

In the options argument there are several arguments collected in a common object that is passed to the load function.

options.cache

If options.cache is set to true then ResourceLoader will attempt to load the resource from localStorage or sessionStorage.

options.cacheTimeout

If the options.cache is set to true then options.cacheTimeout will define how old the data in the cache may be. This is given in seconds and will default to 3600 (1 hour).

options.complete

When the script is loaded the callback defined in options.complete will be called. (If this is omitted then it won't be called.) The callback has one argument and that is the options object used by the load function. In the options object passed to the callback there is a property called options.loadedFrom that is set to how the resource was loaded. This is explained in more details further down in this file under the heading Response

options.test

If the property options.test is set then this is evaluated before the script is loaded. It can be an anonymous function or a simple property. If the function returns true or the property is set to true then the resource will not be loaded.

options.waitFor

options.waitfor is also allowed for backward compatibility.

If the property options.waitFor is assigned a function then this is evaluated before the script is loaded. If the assigned function returns true then the load proceeds as normal. But if the assigned function returns false then the load is interrupted and retried after 10 ms. This makes it possible to make sure that a feature is loaded before the load function executes.

Response

The ResourceLoader.load returns itself which allows chaining (i.e. ResourceLoader.load().load().load(); )

options

Upon return (and in the options.complete callback) the options object has the following options set.

options.loadedFrom

The options.loadedFrom can have the following values * web/jquery This means that the resource has been loaded with the help of jQuery.ajax * web/xhr The resource has been loaded by using XMLHttpRequest * web/direct The resource has been loaded directly without the use of the resource loader. This is used by images for browser that is not compatible with the loading requirements used by the loader. * cache The resource was taken from the cache (i.e. localStorage or sessionStorage) * notloaded/test The resource has not been loaded since the test returned true

options.mediaType

This attribute is set by the system to identify which type of image that has been loaded.

ResourceLoader.getVersion()

Returns a string with the current version of ResourceLoader

ResourceLoader.loadImage(src, options)

Arguments

src

The argument src identifies which source file should be loaded. The url can be prefixed with either png!, gif!, jpeg!, jpe! or jpg! to force the loading as an image. The prefix is useful when files are loaded from repositories where the files extension isn't always available.

options

In the options argument there are several arguments collected in a common object that is passed to the load function.

For a specification of the available options please see the function load

ResourceLoader.loadImages(options)

This function loops through all image elements on the page and looks for the images which the ResourceLoader can handle i.e. has the attribute data-resource-src set.

When a image has been loaded the ResourceLoader sets the attribute data-resource-src-action to the value done.

When starting the loop for the first time an interval is started every 50 ms. So when all elements has been processed it starts over and over. This makes it possible to append a new image element dynamically that can be processed with ResourceLoader.

Arguments

src

The argument src identifies which source file should be loaded. The url can be prefixed with either js! or css! to force the loading as a script or a style. The prefix i useful when files are loaded from repositories where the files extension isn't always .js or .css.

options

In the options argument there are several arguments collected in a common object that is passed to the load function.

For a specification of the generic options please see the function load

options.attributeName

The attributeName defaults to 'resource'.

This is used to locate images that should use the resource loader to load the content.

To activate image loading set the attribute 'data-resource-src' to the url that is to be used by the image. The 'resource' part of this attributes name can be changed by this property. If options.attributeName is set to 'zxcv' then the loader will look for an attribute called 'data-zxcv-src'.

ResourceLoader.stopImageLoading()

Stops the interval started by loadImages.

Usage

examples/demo2.html

<!DOCTYPE html>
<html lang="en">
 <head>
  <title>Simple demo</title>
  <script src="../resourceloader.js"></script>
  <script>
    var options = {
      cache: true,
      cacheTimeout: 7200,
      complete: function(options) {
        alert("Loaded "+options.src+" from "+options.loadedFrom);
      },
      test: function(options) {
        if(typeof(dummyObject) != "undefined") {
          return true;
        }
        return false;
      }
    }
    window.resourceLoader.load("dummies/script1.js", options);
    window.resourceLoader.load("dummies/script1.js", options);
  </script>
 </head>
 <body>
 </body>
</html>

Version history

1.0.0

Initial release

1.1.0

Added an image loader capability.

1.2.0

Added a jQuery plugin for resourceLoader