zr validation message

Demo

https://ZhongruiGroup.github.io/zr-validation-message/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

A form validation information feedback component.

Installation

Install through npm:

npm install --save zr-validation-message

Then include in your apps module:

import { NgModule } from '@angular/core';
import { ZrValidationMessageModule } from 'zr-validation-message';

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

Finally use in one of your apps components:

import { Component } from '@angular/core';
import { FormBuilder, FormGroup, Validators } from '@angular/forms';

@Component({
  template: '<component-zr-validation-message [control]="form.controls['category']" label="类别"></component-zr-validation-message>'
})

export class MyComponent {
  form: FormGroup;

  constructor(
        private formBuilder: FormBuilder
    ) {
        this.form = this.formBuilder.group({
            category: [null, [Validators.required]]
        });
    };

}

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

Usage without a module bundler

<script src="node_modules/zr-validation-message/bundles/zr-validation-message.umd.js"></script>
<script>
    // everything is exported zrValidationMessage namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://ZhongruiGroup.github.io/zr-validation-message/docs/

Development

Prepare your environment

• Install Node.js and NPM
• 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