storm-component-boilerplate

This is a boilerplate for developing UI components by StormId, used in production in conjunction with our project scaffold.

It includes an opinionated JS component boilerplate, build system, test integration, example, README (see below), and deployment, using nodeJS, npm, gulp, mocha, shouldjs, instanbul, babel, travis ci, and codecov.

Before use make sure to grep for “storm-component-boilerplate” and replace every occurrence as well as updating your tests, readme and example.

---

#Component Name

One line summary

##Usage HTML

<div class="js-boilerplate"></div>

JS

npm i -S storm-component-boilerplate

either using es6 import

import Boilerplate from 'storm-component-boilerplate';

Boilerplate.init('.js-selector');

aynchronous browser loading (use the .standalone version in the /dist folder)

import Load from 'storm-load';

Load('/content/js/async/storm-component-boilerplate.standalone.js')
    .then(() => {
        StormComponentBoilerplate.init('.js-component-boilerplate');
    });

or es5 commonjs (legacy, use the .standalone version in the /dist folder)

var Boilerplate = require('./libs/storm-component-boilerplate');

Boilerplate.init('.js-selector');

##Example https://mjbp.github.io/storm-component-boilerplate

##Options

    {
        delay: 200,
        callback: null
    }

e.g.

Boilerplate.init('.js-selector', {
    callback(){
        console.log(this);
    }
});

##API ####Boilerplate.init(selector, opts) Initialise the module with a DOM selector and options object

####Boilerplate.handleClick() Trigger click event handler

##Tests

npm run test

##Browser support This is module has both es6 and es5 distributions. The es6 version should be used in a workflow that transpiles.

The es5 version depends unpon Object.assign, element.classList, and Promises so all evergreen browsers are supported out of the box, ie9+ is supported with polyfills. ie8+ will work with even more polyfils for Array functions and eventListeners.

##Dependencies None

##License MIT