RequireJS plugin for reliably loading and waiting for css files.
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
libs
src
test
.gitattributes
.gitignore
CSSLoader.json
LICENSE-GPL
LICENSE-MIT
README.md
grunt.js
package.json

README.md

CssLoader (css!) - RequireJs plugin

RequireJs plugin for reliably loading and waiting for css files.

Inspiration

There is a need for a well tested and reliable plugin for loading css resources using RequireJs.

The main issue with loading and waiting for css files, is actually not “loading” (I found only IE 31 stylesheet limit problematic,described below) but “waiting” for when the stylesheet is downloaded and available in the DOM. This is further described here and here.

Approach

After looking at existing plugins and approaches I came to conclusion that in order to address “waiting” issue the following things needed to be addressed first: 1. Reliably understand if browser support “load” event on “link” element. 2. Reliably understand if style sheet is applied on DOM when native “load” event doesn't provided by browser.

The plugin logic also contains the workaround for IE 31 stylesheet limit.

Because there are a lot of caveats in different browsers each approach used in plugin is tested thoroughly. There are Qunit unit tests available which can be found here.

Getting Started

Download the production version or the development version.

Usage (example)

You can specify a .css file resource as a requirejs dependency by using below css! syntax. Note that it works completely similar to require.js's 'standard' text! loader plugin. Here is an example:

require.config({
    // baseUrl: 'Scripts',  <-- baseUrl had to be commented out because the .css file is located at 'Content/bootstrap.css' (and not 'Scripts/Content/bootstrap.css').
    paths: {
        "jquery": "Scripts/jquery-1.11.1.min",
        "bootstrap": "Scripts/bootstrap.min",
        "bootbox": "Scripts/bootbox.min",
        ...
        "css": "Scripts/css.min"   // <- Step 1: Add the 'css.min.js' (or css.js) to your requirejs config.
    },
    shim: {
        "bootstrap": { "deps": ['jquery'] }
    }
});

require(['jquery', 'bootstrap', 'bootbox', 'css!Content/bootstrap.css'],  // <- Step 2: add the .css URL as a dependency with the 'css!' loader plugin before it.
    function($,bootstrap,bootbox) {
        bootbox.confirm(..  // The confirm is shown with the correct layout!
        ...
});

Compatability

Tested on : IE7,IE8,IE9, Firebox: 10.0.2, Chrome:21.0, Opera:12.02, Safari:5.17

Credits

Understanding if an event is supported on an element.

  • Worth to add that I first came to that approach when walking through the jQuery code.

Get identification when css is applied to DOM.

TODO:

Check that stylesheet not only applied to DOM but also that rules are applied on stylesheets loaded from another domain.

Handle the css files with @import directives.

Support for Requirejs optimizer.

License

Licensed under the MIT, GPL licenses.

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Important notes

Please don't edit files in the dist subdirectory as they are generated via grunt. You'll find source code in the src subdirectory!

While grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the test/*.html unit test file(s) in actual browsers.

Installing grunt

This assumes you have node.js and npm installed already.

  1. Test that grunt is installed globally by running grunt --version at the command-line.
  2. If grunt isn't installed globally, run npm install -g grunt to install the latest version. You may need to run sudo npm install -g grunt.
  3. From the root directory of this project, run npm install to install the project's dependencies.

Installing PhantomJS

In order for the qunit task to work properly, PhantomJS must be installed and in the system PATH (if you can run "phantomjs" at the command line, this task should work).

Unfortunately, PhantomJS cannot be installed automatically via npm or grunt, so you need to install it yourself. There are a number of ways to install PhantomJS.

Note that the phantomjs executable needs to be in the system PATH for grunt to see it.