node package manager

weighted-screen

Build Status npm version [![devDepende

weighted screen

Build Status npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

https://grow-design.github.io/weighted-screen/demo/

Table of contents

About

Installation

Install through npm:

npm install --save weighted-screen

Then use it in your app like so:

import {Component} from '@angular/core';
import {WeightedScreen} from 'weighted-screen';
 
@Component({
  selector: 'demo-app',
  directives: [WeightedScreen],
  template: '<weighted-screen></weighted-screen>'
})
export class DemoApp {}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/dist/umd/weighted-screen/weighted-screen.js"></script>
<script>
    // everything is exported weightedScreen namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here: https://grow-design.github.io/weighted-screen/docs/

Development

Prepare your environment

  • Install Node.js and NPM (should come with)
  • Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release

License

MIT