You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Download Inject
The latest version of inject is always available via the source repository at https://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.
Adding Inject to Your Page
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:
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.
Starting Your JavaScript
To use inject, place the following script tags into the <head> of your document
Inject.setModuleRoot is the location of ALL your JS modules. Based on the directory structure above, they are located in the js/modules directory.
require.run executes your main entry point, whatever it may be. Given the above directory structure, it will run the program.js file in your module root (from require.setModuleRoot). The .js is added automatically.
Some Quick Configs
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 https:// path or just /path/to/modules like aboveInject.setModuleRoot("path");// Specify how long files should be in localStorage (in minutes)// or 0 for never, which is great for developmentInject.setExpires(integerValue);// configure "cross domain" support. You need to put "relay.swf" and "relay.html"// on your remote server for this to workInject.setModuleRoot("https://example-cdn.com/modules");Inject.setCrossDomain({relayHtml: "https://example-cdn.com/relay.html",});
Writing Some Modules
When you're ready to write your own modules, have a look at the CommonJS Module Examples to get started.
Building From Source
We have a whole section on building from source. Building From Source has all the juicy details.
Next Steps
From here, you can...
learn advanced syntax such as Inject.addRule() for custom module routing addRule and Routing
