Angular2のフォームで非同期のバリデート、入力値の変更検知

Angular2のカスタムフォームで、非同期のバリデーションチェック、入力値の変更をリアルタイムに検知するサンプルを作成しました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。(デモはv4.4.3、v2.0.0で動作確認

 
※目次をクリックすると目次の下部にコンテンツが表示されます。

非同期のバリデーションチェック
ここでは、Promiseを使ってサンプルコードを作成しました。
 
①カスタムフォームでカスタムバリデートを定義
 
以下のように、各フォームコントロール定義の3番目の引数に非同期のバリデートを指定します。
 
this.myForm = fb.group({
 ”zip”: [‘1234567’,, zipValidator],
・・・・
});
 
②バリデーター関数を作成
 
ここでは、Promiseを使って3秒間待機させて、非同期の動作確認をしています。

function zipValidator(zip: FormControl) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      var valid = /^\d{7}$/.test(zip.value);
      if(zip.value == "" || valid) {
        resolve(null);
      } else {
        resolve({"invalidZip":true});
      };
    }, 3000);
  });
}

 
③テンプレートでエラーメッセージ表示
 
pending属性を使って、データ取得中のメッセージも表示しています。

<input type="text" class="form-control"
  formControlName="zip" ngModel />
<span [hidden]="!myForm.controls.zip.pending">
  チェック中です。</span>
<div *ngIf="myForm.controls.zip.dirty &&
            !myForm.controls.zip.pending &&
            myForm.controls.zip.errors">
  <span class="text-danger"
    [hidden]="!myForm.controls.zip.errors.invalidZip">
    フォーマットエラー</span>
</div>

FormControlオブジェクトの入力値の変更を検知
サンプルでは、Selectボックスの変更を検知し、選択した値を表示しています。
 
FormControlオブジェクトのvalueChangesを使って入力値の変更を検知し、変更値を取得して表示しています。
 
valueChangesはObservableなので、subscribeを使っています。

(テンプレート)
<select class="form-control" formControlName="pref" ngModel >
 <option value="">都道府県を選択してください</option>
 <option *ngFor="let item of prefs" [value]="item.id">{{item.name}}</option>
</select>
選択した都道府県のコード:{{select}}
 
(コンポーネントクラス)
public myForm: FormGroup;
public f_pref: AbstractControl;
public select: string;
constructor(fb: FormBuilder) {
  this.myForm = fb.group({
    "pref": ['', Validators.required]
  });
  this.f_pref = this.myForm.controls['pref'];
  this.f_pref.valueChanges.subscribe(
    (value: string) => {
      this.select = value;
    }
  );

デモ

Angular : 4.4.3(2.0.0でも動作確認済み)
Bootstrap : 3.x

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://unpkg.com/zone.js@0.7.4?main=browser"></script>
    <script src="https://npmcdn.com/systemjs@0.19.39/dist/system.src.js"></script>
    <script src="./js/systemjs.config.js"></script>
    <script>
      System.import('./ts/app.ts').catch(function(err){ console.error(err);  });    </script>
    <link rel="stylesheet" href="./css/bootstrap.min.css">
    <link rel="stylesheet" href="./css/styles.css">
  </head>
  <body>
    <div class="container">
      <my-app>Loading...</my-app>
    </div>
  </body>
</html>

(systemjs.config.js)
(function (global) {
  var ngVer = '@4.4.3';
  System.config({
    transpiler: 'ts',
    typescriptOptions: {
      "target": "es5",
      "module": "commonjs",
      "moduleResolution": "node",
      "sourceMap": true,
      "emitDecoratorMetadata": true,
      "experimentalDecorators": true,
      "lib": ["es2015", "dom"],
      "noImplicitAny": true,
      "suppressImplicitAnyIndexErrors": true,
      "strict": true
    },
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    paths: {
      'npm:': 'https://unpkg.com/'
    },
    map: {
      'app': 'app',
      '@angular/animations': 'npm:@angular/animations' + ngVer + '/bundles/animations.umd.js',
      '@angular/animations/browser': 'npm:@angular/animations' + ngVer + '/bundles/animations-browser.umd.js',
      '@angular/core': 'npm:@angular/core' + ngVer + '/bundles/core.umd.js',
      '@angular/common': 'npm:@angular/common' + ngVer + '/bundles/common.umd.js',
      '@angular/common/http': 'npm:@angular/common' + ngVer + '/bundles/common-http.umd.js',
      '@angular/compiler': 'npm:@angular/compiler' + ngVer + '/bundles/compiler.umd.js',
      '@angular/platform-browser': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser.umd.js',
      '@angular/platform-browser/animations': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser-animations.umd.js',
      '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic' + ngVer + '/bundles/platform-browser-dynamic.umd.js',
      '@angular/http': 'npm:@angular/http' + ngVer + '/bundles/http.umd.js',
      '@angular/router': 'npm:@angular/router' + ngVer + '/bundles/router.umd.js',
      '@angular/router/upgrade': 'npm:@angular/router' + ngVer + '/bundles/router-upgrade.umd.js',
      '@angular/forms': 'npm:@angular/forms' + ngVer + '/bundles/forms.umd.js',
      '@angular/upgrade': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade.umd.js',
      '@angular/upgrade/static': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade-static.umd.js',

      // other libraries
      'rxjs':                      'npm:rxjs@5.0.1',
      'tslib':                     'npm:tslib/tslib.js',
      'angular-in-memory-web-api': 'npm:angular-in-memory-web-api/bundles/in-memory-web-api.umd.js',
      'ts':                        'npm:plugin-typescript@5.2.7/lib/plugin.js',
      'typescript':                'npm:typescript@2.3.2/lib/typescript.js',

    },
    // packages tells the System loader how to load when no filename and/or no extension
    packages: {
      app: {
        main: './main.ts',
        defaultExtension: 'ts',
        meta: {
          './*.ts': {
            loader: 'systemjs-angular-loader.js'
          }
        }
      },
      rxjs: {
        defaultExtension: 'js'
      }
    }
  });

})(this);

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { NgModule } from '@angular/core';
import { BrowserModule }  from '@angular/platform-browser';
import { Component } from '@angular/core';
import { FormsModule, ReactiveFormsModule, FormBuilder, Validators} from '@angular/forms';

interface Pref {
  id: string;
  name: string;
}

function zipValidator(zip: FormControl) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      var valid = /^\d{7}$/.test(zip.value);
      if(zip.value == "" || valid) {
        resolve(null);
      } else {
        resolve({"invalidZip":true});
      };
    }, 3000);
  });
}

@Component({
  selector: 'my-app',
  styles:[`
    .ng-valid {
      border-left: 5px solid lightgreen;
    }
    .ng-invalid {
      border-left: 5px solid lightpink;
    }
  `],
  template: `
<strong>Angular2のカスタムフォームで入力チェック、CSS設定</strong>
<form (ngSubmit)="onSubmit(myForm.value)" [formGroup]="myForm" novalidate>
<div class="well">
  <div class="form-group">
    <label>郵便番号("-"なしの7桁の数値)</label>
    <input type="text" class="form-control"
      formControlName="zip" ngModel />
    <span [hidden]="!myForm.controls.zip.pending">
      チェック中です。</span>
    <div *ngIf="myForm.controls.zip.dirty && 
                !myForm.controls.zip.pending &&
                myForm.controls.zip.errors">
      <span class="text-danger" 
        [hidden]="!myForm.controls.zip.errors.invalidZip">
        フォーマットエラー</span>
    </div>
  </div>
  <div class="form-group">
    <label>登録する都道府県</label>
    <select class="form-control" formControlName="pref" ngModel >
      <option value="">都道府県を選択してください</option>
      <option *ngFor="let item of prefs" [value]="item.id">{{item.name}}</option>
    </select>
  </div>
  選択した都道府県のコード:{{select}}
  <div class="text-center">
    <button type="submit" class="btn btn-primary"
        [disabled]="!myForm.valid">登録</button>
  </div>
</div>
</form>

<div class="well" ng-if="master">
  <strong>入力内容</strong><br />
  {{master | json}}
</div>
  `,
  providers: [FormBuilder]

})
export class AppComponent {
  public prefs = PREFS;
  public master;
  public myForm: FormGroup;
  public f_pref: AbstractControl;
  public select: string;
  constructor(fb: FormBuilder) {
    this.myForm = fb.group({
      "zip": ['1234567',, zipValidator],
      "pref": ['', Validators.required]
    });
    this.f_pref = this.myForm.controls['pref'];
    this.f_pref.valueChanges.subscribe(  
      (value: string) => {
        this.select = value;
      }
    );
  }

  onSubmit(data){
    this.master = data;
  }
}

@NgModule({
  imports: [
    BrowserModule,
    FormsModule,
    ReactiveFormsModule
  ],
  declarations: [
    AppComponent
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

platformBrowserDynamic().bootstrapModule(AppModule);

var PREFS: Pref[] = [
  { id: "01", name: "東京都"},
  { id: "02", name: "神奈川県"}
];

関連記事の目次

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です