Flicker is a component to build user interface, an instance of Component module.
npm install spa-component-flicker
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);
}
});
Name | Type | Default value | Description |
---|---|---|---|
render | Function | default render | Custom render function |
interval | Number | 1000 | Interval for flicking |
value | String | "" | Value to set in flickering container |
Start flickering:
flicker.start();
Stop flickering:
flicker.stop();
There is a global var
DEVELOP
which activates additional consistency checks and protection logic not available in release mode.
If you have any problem or suggestion please open an issue here. Pull requests are welcomed with respect to the JavaScript Code Style.
spa-component-flicker
is released under the MIT License.