Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Universal dynamic module loader

README.md

SystemJS

Gitter

Universal dynamic module loader - loads ES6 modules, AMD, CommonJS and global scripts in the browser and NodeJS. Works with both Traceur and Babel.

Designed as a collection of extensions to the ES6 module loader which can also be applied individually.

Designed to work with the ES6 Module Loader polyfill (9KB) for a combined total footprint of 16KB minified and gzipped.

Runs in IE8+ and NodeJS.

For discussion, see the Google Group.

For a list of guides and tools, see the community project page.

Documentation

Getting Started

Browser Use

Download es6-module-loader.js into the same folder as system.js.

Load SystemJS with a single script tag:

<script src="system.js"></script>

It will load es6-module-loader.js itself.

To load ES6, locate traceur.js in the same folder and it will be loaded when needed.

For use with Babel set:

<script>
  System.transpiler = 'babel';
</script>

Alternatively a custom path to Babel can also be set:

<script src="system.js" data-babel-src="path/to/babel.js"></script>

NodeJS Use

To load modules in NodeJS, install SystemJS with:

  npm install systemjs

We can then load modules equivalently to in the browser:

var System = require('systemjs');

/* 
 * Include
 *   System.transpiler = 'babel';
 * to use Babel instead of Traceur
 */

// loads './app.js' from the current directory
System.import('./app').then(function(m) {
  console.log(m);
});

If configuring baseURL for use in Windows, prepend file: i.e.

System.config({
 baseURL: 'file:' + path.resolve('../path')
});

Plugins

Plugins handle alternative loading scenarios, including loading assets such as CSS or images, and providing custom transpilation scenarios.

Supported Plugins:

  • CSS System.import('my/file.css!')
  • Image System.import('some/image.png!image')
  • JSON System.import('some/data.json!').then(function(json){})
  • Text System.import('some/text.txt!text').then(function(text) {})

Additional Plugins:

  • CoffeeScript System.import('./test.coffee!')
  • Jade
  • JSX System.import('template.jsx!')
  • Markdown System.import('app/some/project/README.md!').then(function(html) {})
  • WebFont System.import('google Port Lligat Slab, Droid Sans !font')

Plugins are loaded from the module name of the extension. To set them up, you'll most likely want to add map configuration. For example:

System.map['css'] = 'path/to/css/plugin';

Loading through plugin is indicated with ! at the end of the name:

System.import('file.css!');      // will use the "css" plugin, assumed from the extension
System.import('file.css!text');  // will use the "text" plugin, instead of checking the extension

Read the guide here on creating plugins.

Running the tests

To install the dependencies correctly, run bower install from the root of the repo, then open test/test.html in a browser with a local server or file access flags enabled.

License

MIT

Something went wrong with that request. Please try again.