jblocks v1.2.2

jBlocks

• Codepen DEMO
• Full API Doc created from source

jBlocks helps to create interface components in a functional programming flavour.

It's build on the following simple rules:

• declare your components
• set special data-attributes in HTML to bind an instance of the component (will be created in the future) to the node
• interact with components using API, events and other components

Give me an example

Let we have a simple component.

Counter with 2 buttons to increase and decrease its value. It could be a lot of independent counters on a page with different initials values.

At first we need to declare a component in JavaScript and then mark some nodes in HTML using special data-attributes.

Declare a component in JavaScript

Declare a component:

jBlocks.define('counter', {
    events: {
        'click .js-inc': 'inc',
        'click .js-dec': 'dec'
    },

    methods: {
        oninit: function() {
            this._currentValue = Number(this.props.initialValue);
        },
        ondestroy: function() {
            this._currentValue = null;
        },
        /**
         * Increases the counter, emits changed event
         */
        inc: function() {
            this._currentValue++;
            this.emit('changed', {
                value: this._currentValue
            });
        },
        /**
         * Decreases the counter, emits changed event
         */
        dec: function() {
            this._currentValue--;
            this.emit('changed', {
                value: this._currentValue
            });
        },
        /**
         * Returns the current value
         * @return {Number}
         */
        getCurrentValue: function() {
            return this._currentValue;
        }
    }
})

Declare a component in HTML

To make some node as a root node of the component we should set special data attributes:

• data-component — name of the given component (counter in this case)
• data-props — initial properties ({ "initialValue": 2 } in this case)

<div class="js-counter" data-component="counter" data-props='{ "initialValue": 2 }'>
    <button class="js-inc">+</button>
    <button class="js-dec">-</button>
</div>

Create instances and interact with them

After describing all components in declarative way it's time to create an instance and interact with it using API:

// somewhere in my program...

var counter = jBlocks.get(document.querySelector('.js-counter'));

// use event to react on what happens during lifecycle
counter.on('changed', function() {
    console.log('hello, world!');
});

// ... when user clicks on inc button
// log => 'hello, world!'

// log => 3, cause the counter has been increased
counter.getCurrentValue();

// ... then I decided to decrease it using API
counter.dec();

// log => 2
counter.getCurrentValue();

// If I remove nodes from DOM instance should be destroyed
counter.destroy();

Usage

CDN

Include the library:

<script type="text/javascript" src="https://unpkg.com/jblocks@latest/jblocks.js"></script>

:warning: You may use any available version instead of latest in the URL above.

jBlocks namespace is now in global scope.

Commonjs

First of all, get the package using npm:

npm install jblocks

After the package ends up in you node_modules:

var jblocks = require('jblocks');

You can use the full API Doc generated from source.

Also, feel free to drop me a line — viktor.s.karpov@gmail.com