What is k(InK)

k(ink) is under heavy development. If you want a stable prof-of-concept check the master branch

k(Ink) is a kinky way to interact with the ink.js library (currently used on all SAPO.pt projects and some OS as well) easing the pain of designers and developers alike when using the awesome Ink css framework.

k(Ink) takes some of the functionality of the full fledged ink.js and creates a set of chainable methods and aliases, allowing for easy usage, fast implementation and code readability. This fan made library comes in a small <10kb minified file that works with the most recent Ink (v2) package.

How does it work

Lets say you want to create a dinamically generated menu. you prepare a script in JS that reads all the div.content elements and uses the content of the first H2 as a title and then insejcts the .sidebar with links to the content. simple hum?

Lets see how to do this using Ink.js

Ink.Dom.Loaded.run(function(){

   var contentH2 = Ink.Dom.Selector.select('.content h2');
   var sidebar   = Ink.Dom.Selector.select('.sidebar ul')[0];

   Ink.Util.Array.each(contentH2,function(elem){
        var name  = Ink.Dom.Element.textContent(elem);
        var perma = name.replace(/\s/g,"-");

        elem.setAttribute('id',perma);

        Ink.Dom.Element.appendHTML(sidebar,"<li><a href='#"+perma+"'>"+name+"</a></li>");
   });

});

Ok... not that hard... how would someone who isn`t a full time javascript developer or has bad memory for namespaces do this kind of script?

Enter k(Ink), a small wrapper for the Ink.js framework. k(Ink) does not add or remove any of Ink.js functionality, it`s a simple wrapper for the many methods and classes present on Ink allowing for chained calls with a simple human API.

Check out the exact same functionality, but now using k(Ink)

//find every h2 under the class .content
kk('.content').find('h2').each(function(elem){
    //get name and permalink
    var name  = kk(elem).html();
    var perma = name.replace(/\s/g,"-");
    //assign the new ID
    kk(elem).id(perma);
    //inject the menu on the .sidebar
    kk('.sidebar ul').appendHTML("<li><a href='#"+perma+"'>"+name+"</a></li>");
});

Looks Familiar... ?

Installation

k(Ink) is built as a Ink.js module, So the requirements are the Ink.js core. after this you just need to include it on your script and it will load the dependencies. Its recommended that you use Ink-all.js so your page doesn`t clutter with dependency requests, bur for now k(Ink) does not offer any wrapper for the Ink-UI modules.

<script type="text/javascript" src="http://cdn.ink.sapo.pt/2.0.0/js/ink.min.js"></script>
<script type="text/javascript" src="/your/site/js/kink.js"></script>

The kink (kk) Object

The kink object, by default assigned to kk, is the main selector and wrapper. It allways returns a kinkResult Object that can then be manipulated using the API. Full API documentation is under construction.

Kink accepts many inputs, depending on your needs

kink(selector[,context])

###Example###

//string
kk('div')

kk('div#mastodon')

kk('ul li a.active')

//array
kk([1,2,3])

//kinkResult object
var parent = kk('div')
kk(parent)

//dom element
kk(document.body)

//function
kk(function(){
    return "a.selected";
})

kk(function(context){
    return [1,2,3];
},context)

Development

Clone this repo and use npm to compile k(Ink). All code and modules are located at lib/*.js

$ git clone https://github.com/entomb/k-ink-interface.git kink
$ cd kink
$ npm install

this will compile all lib/*.js files and run unit tests

$ grunt tests

or if you want to skip unit testing

$ grunt

Plugins

Kink suports an .extend() syntax. To add features to the kink core or kinkResult use the following syntax:

 kink.extend({
    someFunction: function(param){
      console.log(param);

      //`this` relates to kink
      return this;
    }
 });

 kink.result.extend({
    anotherFunction: function(){
      //`this` relates to the current KinkResult
      this.each(function(element){
        kink.someFunction(element);
      });
    },
    foo: function(){
      //foo
      return this;
    },
    bar: function(){
      //bar
      return this;
    }
 });

This will add the following methods to the API:

  kk.someFunction();
  kk('#content').anotherFunction();
  kk('#content').foo().bar();

Licence

k(Ink) is under the MIT licence, so feel free to use, modify and contribute to its code

DEMO

http://inktest.eu01.aws.af.cm/