version 1.0.0
module: version 0.0.3
size-min gzipped: 25.49 kb (incl. dependencies: kb)
dependencies: all ITSA-modules, hammerjs (npm), ypromise (npm), xmldom (npm), querystring (npm)
maintanance: Marco Asbreuk

all modules

Root of the standard distribution

The module provides the main root `ITSA` namespace and aggregates all the modules that make for the standard distribution of ITSA

Getting Started

With nodejs:

Create your project using this package.json. After downloaded, run npm install and start writing your application:

var ITSA = require('itsa');

In the browser:

For browser-usage, ITSA has a predefined loaderfiles. Once included, a global ITSA object with default features is available. For customized loaderfiles, read: Customized build.

<script src="/itsabuild-min.js"></script>
    // `ITSA` is available as a global variable

The Basics

To provide a convenient starting point for the usage of ITSA, we have created a standard distribution that collects the main resources of ITSA into one package and makes their methods accessible under the ITSA global namespace.

Though many applications can benefit from using the standard distribution, ITSA is not a monolithic framework. Its separate modules can be combined in multiple ways. All of the modules are self-contained and take care of their own dependencies and make no reference to the global ITSA namespaced provided by this aggregator.

The standard distribution is packed into a bundle (itsabuild-min.js) using Browserify and can be loaded in a single script-tag.

Some of the modules-export are functions which expect a window argument to be passed. Being designed to work both in the client and the server, these modules expect to receive the window by argument.

The standard distribution contains a minimal window emulator when used in a non-browser environment like nodejs.

The aggregator is wrapped in this function:

(function (window) {

    // window available for those modules who need it

})(global.window || require('node-win')());

Browserify creates global.window as reference to the browser's window. None of these are mandatory, the developer is free to use other Common-JS module bundler or DOM emulator to pass through the modules themselve.

Note that our window-emulator is not a full featured one. ITSA makes use of a very small number of window and DOM methods: node-win provides only those that are needed by ITSA-modules. Browsers will use their native window-object instead of node-win.

API Docs

Table of Contents