Skip to content

jbmarchetti/angular-forms-utils

Repository files navigation

angular forms utils

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

Demo

https://jbmarchetti.github.io/angular-forms-utils/demo/

Table of contents

About

Angular2 Reactive forms utils

Installation

Install through npm:

npm install --save angular-forms-utils

Then include in your apps module:

import { Component, NgModule } from '@angular/core';
import { AngularFormsUtilsModule } from 'angular-forms-utils';

@NgModule({
  imports: [
    AngularFormsUtilsModule.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/angular-forms-utils/bundles/angular-forms-utils.umd.js"></script>
<script>
    // everything is exported angularFormsUtils namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://jbmarchetti.github.io/angular-forms-utils/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