spa-component-flicker

Flicker component

Flicker is a component to build user interface, an instance of Component module.

Installation

npm install spa-component-flicker

Usage

Add the constructor to the scope:

var Flicker = require('spa-component-flicker');

Create an instance with config:

var flicker = new Flicker({
    className: 'clock',
    interval: 1000,
    render: function ( $item, value ) {
        var time  = new Date(),
            hours = time.getHours(),
            mins  = time.getMinutes();

        $item.innerText = (hours > 9 ? hours : '0' + hours) + ':' + (mins > 9 ? mins : '0' + mins);
    }
});

Start flickering:

flicker.start();

Stop flickering:

flicker.stop();

Development mode

There is a global var DEVELOP which activates additional consistency checks and protection logic not available in release mode.

Contribution

If you have any problem or suggestion please open an issue here. Pull requests are welcomed with respect to the JavaScript Code Style.

License

spa-component-flicker is released under the MIT License.