https://github.com/fabiosantoscode/ink.js
Ink JavaScript core library
https://github.com/fabiosantoscode/ink.js
Last synced: over 1 year ago
JSON representation
Ink JavaScript core library
- Host: GitHub
- URL: https://github.com/fabiosantoscode/ink.js
- Owner: fabiosantoscode
- Created: 2013-07-30T16:59:01.000Z (almost 13 years ago)
- Default Branch: develop
- Last Pushed: 2013-09-16T18:41:21.000Z (almost 13 years ago)
- Last Synced: 2025-01-17T22:44:52.433Z (over 1 year ago)
- Language: JavaScript
- Size: 3.15 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# IMPORTANT NOTICE
__The Ink.js repository was merged into [https://github.com/sapo/Ink/](sapo/Ink), and placed in a subfolder. We will no longer be accepting pull requests or responding to issues on this repo.__
--------
The old README.md follows:
# Ink.js
[Ink](http://ink.sapo.pt/) comes with a collection of [UI components](http://ink.sapo.pt/js/ui/) out of the box.
These components depend on [Ink's JavaScript core](http://ink.sapo.pt/js/core/), which provides a set of methods and modules that give developers the ability to extend the features of the framework.
Documentation for Ink's JavaScript core comes in two flavours, a simpler version to get you up and running as quickly as possible, and a more technical in depth version for when you want to go beyond our examples, these can be found at http://ink.sapo.pt/js/core/ and http://js.ink.sapo.pt/docs/ respectively.
This repo provides you with information on how Ink's JavaScript core is organised.
It all starts with __Ink__, from there you will find our main module, __the core__, and all of the relevant namespaces.
## Organization
* Ink/ - It's where you can find all the source code
## Ink Namespaces
* Dom - provides modules to work with DOM and Events
* Net - provides communication modules to make AJAX requests or JsonP
* Util - provides utility modules
* UI - Where all [UI modules](http://ink.sapo.pt/js/ui) are made
A global variable named __Ink__ provides the methods to create and load all of the modules.
Namespaces and modules mirror the structure of the filesystem keeping everything coordinated and where you'd expect it to be.
The __lib.js__ file is in a numbered directory to prevent collisions, this way different versions of the same module in the same page will not break any existing code, the following sections show how to avoid collisions altogether.
Ex:
* /Ink/1/ exposes `window.Ink`
* /Ink/Dom/Element/1/ exposes `Ink.Dom.Element` and `Ink.Dom.Element_1` with methods to manipulate DOM
* /Ink/Dom/Event/1/ exposes `Ink.Dom.Event` and `Ink.Dom.Event_1` with methods to manipulate Events
* /Ink/Net/Ajax/1/ exposes `Ink.Net.Ajax` and `Ink.Net.Ajax_1` to make AJAX requests
## Using modules
There may be times when you need to use an older version of a component in the same instance that a newer one has been loaded. Ink provides a couple of methods that mitigate problems involving namespace collisions when loading modules, namely:
`Ink.requireModule()` - request a module if it's not loaded yet
`Ink.getModule()` - return a module that has already been loaded
Ex:
```javascript
Ink.requireModules(['Ink.Namespace.ModuleName_version'], function(ModuleName) {
ModuleName.moduleMethod('arg1', 'arg2');
});
```
or
```javascript
var ModuleName = Ink.getModule('Ink.Namespace.ModuleName', version);
ModuleName.moduleMethod('arg1', 'arg2');
```
## Creating modules
Take a look at our samples on __/Ink/Namespace/ClassModule/__ and __/Ink/Namespace/StaticModule/__
In a simple explanation its:
```javascript
Ink.createModule(
'Ink.Namespace.ModuleName',
'version',
['Ink_Namespace_Dependency1_version', 'Ink_Namespace_Dependency2_version'],
function(Dependency1, Dependency2) {
var ModuleName = {
// __...your code here...__
};
return ModuleName;
}
);
```
## Other important files on the repo:
* Makefile - Running "make all" will minify all modules, create bundles (in builds directory) and documentation files (in docs directory)
* builds - It's the place where bundles are created (ink-v.v.v.js, ink-all.v.v.v.js and ink-ui.v.v.v.js)
* serverUtils - The place with node.js scripts and config files to run make
# Install Ink.js on your machine - How To
## Requirements
* makefile
* node.js http://nodejs.org/
* java (jenkins ci)
## Install
[sudo] npm -g install yuidocjs
[sudo] npm -g install plato
npm install uglify-js
npm install async