Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Universal dynamic module loader
JavaScript HTML Makefile CoffeeScript TypeScript CSS

README.md

SystemJS

Build Status Gitter

For upgrading to SystemJS 0.17 / 0.18, see the SystemJS 0.17 release upgrade notes for more information, or read the updated SystemJS Overview guide.

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

Built on top of the ES6 Module Loader polyfill.

~14KB minified and gzipped, runs in IE8+ and NodeJS.

For discussion, see the Google Group.

For a list of guides and tools, see the Third-Party Resources Wiki.

Documentation

Basic Use

Browser

<script src="system.js"></script>
<script>
  // set our baseURL reference path
  System.config({
    baseURL: '/app'
  });

  // loads /app/main.js
  System.import('main.js');
</script>

To load ES6, locate a transpiler (traceur.js, 'browser.js' from Babel, or 'typescript.js' from TypeScript) in the baseURL path, then set the transpiler:

<script>
  System.config({
    // or 'traceur' or 'typescript'
    transpiler: 'babel',
    // or traceurOptions or typescriptOptions
    babelOptions: {

    }
  });
</script>

Alternatively a custom path to Babel or Traceur can also be set through paths:

System.config({
  map: {
    traceur: 'path/to/traceur.js'
  }
});

Polyfills

SystemJS relies on Promise and URL being present in the environment. When these are not available it will send a request out to the system-polyfills.js file located in the dist folder which will polyfill window.Promise and window.URLPolyfill.

This is typically necessary in IE, so ensure to keep this file in the same folder as SystemJS.

Alternatively the polyfills can be loaded manually or via other polyfill implementations as well.

NodeJS

To load modules in NodeJS, install SystemJS with:

  npm install systemjs

If transpiling ES6, also install the transpiler:

  npm install traceur babel typescript 

We can then load modules equivalently to in the browser:

var System = require('systemjs');

System.transpiler = 'traceur';

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

If using TypeScript, set global.ts = require('typescript') before importing to ensure it is loaded correctly.

Plugins

Supported loader plugins:

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

Additional Plugins:

  • CoffeeScript System.import('./test.coffee')
  • Jade
  • Jade VirtualDOM
  • 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')
  • Handlebars System.import('template.hbs!')
  • Ember Handlebars System.import('template.hbs!')
  • raw System.import('file.bin!raw').then(function(data) {})
  • jst Underscore templates

Read about using plugins here 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.