ngx-hoc v0.0.4

ngx-hoc

This is a WIP. Use at your own risk.

Demo

https://phillipcurl.github.io/ngx-hoc/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

Higher-order components for Angular apps

Installation

Install through npm:

npm install --save ngx-hoc

Then include in your apps module:

import { Component, NgModule } from '@angular/core';
import { HocModule } from 'ngx-hoc';

@NgModule({
  imports: [
    HocModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}

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

Usage without a module bundler

<script src="node_modules/ngx-hoc/bundles/ngx-hoc.umd.js"></script>
<script>
    // everything is exported ngxHoc namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://phillipcurl.github.io/ngx-hoc/docs/

Development

Prepare your environment

• Install Node.js and <% if (isYarnAvailable) { %>yarn<% } else { %>NPM<% } %>
• Install local dev dependencies: <% if (isYarnAvailable) { %>yarn<% } else { %>npm install<% } %> while current directory is this repo

Development server

Run <% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> start to start a development server on port 8000 with auto reload + tests.

Testing

Run <% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> test to run tests once or <% if (isYarnAvailable) { %>yarn<% } else { %>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)

<% if (isYarnAvailable) { %>yarn<% } else { %>npm<% } %> run release

License

MIT