- Inject on the web: http://www.injectjs.com
- InjectJS Mailing List: https://groups.google.com/forum/#!forum/injectjs
Inject (Apache Software License 2.0) is a revolutionary way to manage your dependencies in a Library Agnostic way. Some of its major features include:
- CommonJS Compliance in the Browser (exports.*)
- View the full CommonJS Support Matrix
- Cross domain retrieval of files (via easyXDM)
- localStorage (load a module once)
- Frustratingly Simple
This page is designed to get you up and running with the latest version of Inject. For greater detail, there is an Advanced Usage section, and a guide to the API.
The latest version of inject is always available via the source repository at http://www.injectjs.com/download/. The most recent version is usually at the top, and inside is the required JS and optional HTML files. Copy them to your own server.
As of 0.4.2, you can also get Inject as a Bower package via bower install inject. Our Bower repository can be found here.
This walkthrough is assuming you're using a directory called js which contains all of your javascript, possibly even this file. It also assumes inside of the js directory is a modules directory which will contain all of your modules. Your directory layout might look like the following:
|-index.html
|-relay.html (optional)
|-js
|-inject.js
|-modules
|-math.js
|-increment.js
|-program.js
The location of the modules directory does not need to be under the inject.js file, but it's common practice to group files of similar types together such as JavaScript.
To use inject, place the following script tags into the <head> of your document
<script type="text/javascript" src="inject.js"></script>
<script type="text/javascript">
Inject.setModuleRoot("/js/modules");
require.run("program");
</script>- Inject.setModuleRoot is the location of ALL your JS modules. Based on the directory structure above, they are located in the
js/modulesdirectory. - require.run executes your main entry point, whatever it may be. Given the above directory structure, it will run the
program.jsfile in your module root (from require.setModuleRoot). The.jsis added automatically.
Here's some common configuration options you're going to want for Inject
// Set the "root" where all your modules can be found
// you can use an http:// path or just /path/to/modules like above
Inject.setModuleRoot("path");
// Specify how long files should be in localStorage (in minutes)
// or 0 for never, which is great for development
Inject.setExpires(integerValue);
// configure "cross domain" support. You need to put "relay.swf" and "relay.html"
// on your remote server for this to work
Inject.setModuleRoot("http://example-cdn.com/modules");
Inject.setCrossDomain({
relayHtml: "http://example-cdn.com/relay.html",
});When you're ready to write your own modules, have a look at the CommonJS Module Examples to get started.
We have a whole section on building from source. Building From Source has all the juicy details.
From here, you can...
- learn advanced syntax such as Inject.addRule() for custom module routing
addRule and Routing - make asynchronous includes using require.ensure() or go cross-domain
Advanced Usage API Guide - use AMD-compliant modules with define()
Advanced Usage API Guide - use existing libraries that you never thought had CommonJS Support
Recipies for Inject and Your Favorite Library - learn how to protect your code from JS minifiers
Common Minification Problems
Inject couldn't be as great as it is without these other rockstar libraries:
- easyXDM: Cross Domain Communication
- lscache: LocalStorage Cache Provider
- link.js: dependency extraction (from their src/Library/link.js)
- GoWithTheFlow.js: simple flow control
- (and a whole lot of npm related things for development)