@pearson-components/features-list v2.2.0

features-list

Note: This is still in experimental stage.

How to Consume in an Application

Assumption: You have Node v4+ and npm 2+ installed.

> npm i --save @pearson-components/features-list

Script Include (Preferred)

The javascript bundle is available in /node_modules/@pearson-components/features-list/build/dist.features-list.js.

Add the following script include to your web page:

	<script src="path/to/dist.features-list.js"></script>

var features = new $featureComponent().init(options, data, element);

CommonJS

This method requires a web bundler, such as webpack or browserify.

var features = require('@pearson-components/features-list');

How to Develop

Toolchain

• Node.js v4+
• webpack

Recommendation: If you are using different node versions on your machine, use nvm to manage them.

Demo

The following npm script will build the component in memory, fire up a webpack dev server at localhost:8080/demo, and hot reload any saved changes to the source without having to refresh the browser.

npm run dev

Test

The following npm script will execute any unit tests.

npm test

Licence

Copyright 2015 Pearson Education. This software is published under the MIT licence.