@yoolabs/ngx-dynamic-form-builder
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.5 • Public • Published

    Greenkeeper badge Build Status npm version

    FormBuilder + class-transformer + class-validator = dynamic form group builder for Angular9+

    Installation

    npm i --save ngx-dynamic-form-builder

    Links

    Demo - Demo application with ngx-dynamic-form-builder.

    Stackblitz - Simply sample of usage on https://stackblitz.com

    Usage

    app.module.ts

    import { FormsModule, ReactiveFormsModule } from '@angular/forms';
    import { CompanyPanelComponent } from './company-panel.component';
     
    @NgModule({
      imports: [
        ...
        FormsModule,
        ReactiveFormsModule,
        ...
      ],
      declarations: [
        ...
        CompanyPanelComponent,
        ...
      ],
      ...
    })
    export class AppModule {}

    company.ts

    import { Validate, IsNotEmpty } from 'class-validator';
    import { plainToClassFromExist } from 'class-transformer';
    import { TextLengthMore15 } from '../utils/custom-validators';
     
    export class Company {
        id: number = undefined;
        @Validate(TextLengthMore15, {
            message: 'The company name must be longer than 15'
        })
        @IsNotEmpty()
        name: string = undefined;
     
        constructor(data?: any) {
            plainToClassFromExist(this, data);
        }
    }

    company-panel.component.html

    <form [formGroup]="form" *ngIf="form?.formErrors as errors" novalidate>
        <input formControlName="name" placeholder="Name">
        <p *ngIf="errors.name?.length">
          Error: {{errors.name[0]}}
        </p>
        <p>Form status: {{ form.status | json }}</p>
        <p>
          Form class-validator errors: {{errors|json}}
        </p>
        <p>
          Form native errors: {{form?.nativeValidateErrors|async|json}}
        </p>
        <p *ngIf="savedItem">
          Saved item: {{savedItem|json}}
        </p>
        <button (click)="onLoadClick()">Load</button>
        <button (click)="onClearClick()">Clear</button>
        <button (click)="onSaveClick()" [disabled]="!form.valid">Save</button>
    </form>

    company-panel.component.ts

    import { DynamicFormGroup, DynamicFormBuilder } from 'ngx-dynamic-form-builder';
    import { Company } from './../../shared/models/company';
    import { Input, Component } from '@angular/core';
    import { Validators } from '@angular/forms';
     
    @Component({
      selector: 'company-panel',
      templateUrl: './company-panel.component.html'
    })
    export class CompanyPanelComponent {
      
      form: DynamicFormGroup<Company>;
     
      @Input()
      item = new Company({
        'id': 11,
        'name': '123456789012345'
      });
     
      fb = new DynamicFormBuilder();
     
      savedItem: Company;
     
      constructor() {
        this.form = this.fb.group(Company, {
          name: ''
        });
      }
      onLoadClick(): void {
        this.savedItem = undefined;
        this.form.object = this.item;
        this.form.validateAllFormFields();
      }
      onClearClick(): void {
        this.savedItem = undefined;
        this.form.object = new Company();
        this.form.validateAllFormFields();
      }
      onSaveClick(): void {
        this.form.validateAllFormFields();
        if (this.form.valid) {
          this.savedItem = this.form.object;
        }
      }
    }

    custom-validators.ts

    import {
        ValidatorConstraintInterface, ValidatorConstraint
    } from 'class-validator';
     
    @ValidatorConstraint()
    export class TextLengthMore15 implements ValidatorConstraintInterface {
        validate(text: string) {
            return text ? text.length > 15 : false;
        }
    }

    Observable Errors

    the customValidateErrors property can be subscribed for cases in which your code should act on changes in errors

    company-panel.component.html

    <form [formGroup]="form" *ngIf="form?.customValidateErrors | async as errors" novalidate>
        <input formControlName="name" placeholder="Name">
        <p *ngIf="errors.name?.length">
          Error: {{errors.name[0]}}
        </p>
        <p>Form status: {{ form.status | json }}</p>
        <p>
          Observable validation errors: {{errors|json}}
        </p>
        <p *ngIf="savedItem">
          Saved item: {{savedItem|json}}
        </p>
        <button (click)="onLoadClick()">Load</button>
        <button (click)="onClearClick()">Clear</button>
        <button (click)="onSaveClick()" [disabled]="!form.valid">Save</button>
    </form>

    company-panel.component.ts

    import { DynamicFormGroup, DynamicFormBuilder } from 'ngx-dynamic-form-builder';
    import { Company } from './../../shared/models/company';
    import { Input, Component } from '@angular/core';
    import { Validators } from '@angular/forms';
    import { Subscription } from 'rxjs';
     
    @Component({
      selector: 'company-panel',
      templateUrl: './company-panel.component.html'
    })
    export class CompanyPanelComponent implements onDestroy {
     
      form: DynamicFormGroup<Company>;
     
      @Input()
      item = new Company({
        'id': 11,
        'name': '123456789012345'
      });
     
      @Input()
      strings = Company.strings;
     
      fb = new DynamicFormBuilder();
     
      savedItem: Company;
     
      errorChangeSubscription: Subscription;
     
      constructor() {
        this.form = this.fb.group(Company, {
          name: ''
        });
     
        this.errorChangeSubscription = this.form.customValidateErrors.subscribe((allErrors) => {
           console.log(`Errors changed: ${allErrors}`);
        })
      }
      ngOnDestroy() {
        if(this.errorChangeSubscription != null && this.errorChangeSubscription.closed === false) {
          this.errorChangeSubscription.unsubscribe();
        }
      }
      onLoadClick(): void {
        this.savedItem = undefined;
        this.form.object = this.item;
        this.form.validateAllFormFields();
      }
      onClearClick(): void {
        this.savedItem = undefined;
        this.form.object = new Company();
        this.form.validateAllFormFields();
      }
      onSaveClick(): void {
        this.form.validateAllFormFields();
        if (this.form.valid) {
          this.savedItem = this.form.object;
        }
      }
    }

    License

    MIT

    Install

    npm i @yoolabs/ngx-dynamic-form-builder

    DownloadsWeekly Downloads

    18

    Version

    1.3.5

    License

    MIT

    Unpacked Size

    990 kB

    Total Files

    58

    Last publish

    Collaborators

    • yooser