Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 4.27 KB

module-types.md

File metadata and controls

117 lines (89 loc) · 4.27 KB
Raw

Module Types

SystemJS supports loading modules that are in the following formats:

Module Format s.js system.js File Extension
System.register ✔️ ✔️ *
JSON Modules Module Types extra ✔️ *.json
CSS Modules Module Types extra ✔️ *.css
Web Assembly Module Types extra ✔️ *.wasm
Global variable global extra ✔️ *
AMD AMD extra AMD extra *
UMD AMD extra AMD extra *

File Extension Limitations

When loading JSON modules, CSS modules and Web Assembly modules, the browser specifications require interpreting these modules based on checking their MIME type. Since SystemJS has to choose upfront whether to append a script element (for JS modules) or make a fetch request (for a JSON/CSS/Wasm module), it needs to know the module type upfront at resolution time.

Instead of reading the MIME type, the file extension is thus used specifically for the JSON, CSS and Web Assembly module cases.

JSON Modules

JSON modules support importing a JSON file as the default export.

Example

file.json

{
  "some": "json value"
}
System.import('file.json').then(function (module) {
  console.log(module.default); // The json as a js object.
});

CSS Modules

CSS Modules are supported when a Constructable Style Sheets polyfill is present for browsers other than Chromium.

Note that the term CSS Modules refers to two separate things: (1) the browser spec, or (2) the Webpack / PostCSS plugin. The CSS modules implemented by SystemJS are the browser spec.

Example

/* file.css */
.brown {
  color: brown;
}
System.import('file.css').then(function (module) {
  const styleSheet = module.default; // A CSSStyleSheet object
  document.adoptedStyleSheets = [...document.adoptedStyleSheets, styleSheet]; // now your css is available to be used.
});

Constructable Style Sheets Polyfill

CSS modules export a Constructable Stylesheet instance as their default export when imported.

Currently these are only available in new versions of Chromium based browsers (e.g., Chrome 73+), so usage in any other browsers will require a polyfill, such as the one at https://www.npmjs.com/package/construct-style-sheets-polyfill.

The polyfill can be conditionally loaded with an approach like:

<script defer src="https://unpkg.com/construct-style-sheets-polyfill@2.1.0/adoptedStyleSheets.min.js"></script>

Note that this polyfill does not currently work in IE11.

Web Assembly Modules

Web Assembly Modules support importing Web Assembly with Web Assembly in turn supporting other modules.

Example

<script type="systemjs-importmap">
{
  "imports": {
    "example": "./wasm-dependency.js"
  }
}
</script>
<script>
  System.import('/wasm-module.wasm').then(function (m) {
    // calls wasm-dependency square function through Wasm
    m.exampleExport(5); // 25
  });
</script>

wasm-dependency.js

// function called from Wasm
export function exampleImport (num) {
  return num * num;
}

where wasm-module.wasm is generated from:

wasm-module.wat

(module
  (func $exampleImport (import "example" "exampleImport") (param i32) (result i32))
  (func $exampleExport (export "exampleExport") (param $value i32) (result i32)
    get_local $value
    call $exampleImport
  )
)