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

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

(1)非同期のバリデーションチェック


 
ここでは、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>

 

(2)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;
    }
  );

 

(3)デモ


 
Angular : 2.0.0
Bootstrap : 3.2.0

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://npmcdn.com/zone.js@0.6.23?main=browser"></script>
    <script src="https://npmcdn.com/reflect-metadata@0.1.3"></script>
    <script src="https://npmcdn.com/systemjs@0.19.27/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 = '@2.0.0';
  var routerVer = '@3.0.0';
  var formsVer = '@2.0.0';
  var routerDeprecatedVer = '@2.0.0-rc.2';
  var map = {
    'app':                        'app',
    '@angular':                   'https://npmcdn.com/@angular',
    '@angular/router':            'https://npmcdn.com/@angular/router' + routerVer,
    '@angular/forms':             'https://npmcdn.com/@angular/forms' + formsVer,
    '@angular/router-deprecated': 'https://npmcdn.com/@angular/router-deprecated' + routerDeprecatedVer,
    'angular2-in-memory-web-api': 'https://npmcdn.com/angular2-in-memory-web-api',
    'rxjs':                       'https://npmcdn.com/rxjs@5.0.0-beta.12',
    'ts':                         'https://npmcdn.com/plugin-typescript@4.0.10/lib/plugin.js',
    'typescript':                 'https://npmcdn.com/typescript@1.9.0-dev.20160409/lib/typescript.js',
 };
  var packages = {
    'app':                        { main: 'main.ts',  defaultExtension: 'ts' },
    'rxjs':                       { defaultExtension: 'js' },
    'angular2-in-memory-web-api': { main: 'index.js', defaultExtension: 'js' },
  };

  var ngPackageNames = [
    'common',
    'compiler',
    'core',
    'http',
    'platform-browser',
    'platform-browser-dynamic',
    'upgrade',
  ];
  ngPackageNames.forEach(function(pkgName) {
    map['@angular/'+pkgName] = 'https://npmcdn.com/@angular/' + pkgName + ngVer;
  });
  ngPackageNames.concat(['forms', 'router', 'router-deprecated']).forEach(function(pkgName) {
    packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' };
  });

  var config = {
    transpiler: 'ts',
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    map: map,
    packages: packages
  };

  System.config(config);

})(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: "神奈川県"}
];

 
●サンプルコード(β版)

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://code.angularjs.org/2.0.0-beta.17/angular2-polyfills.js"></script>
    <script src="https://code.angularjs.org/tools/system.js"></script>
    <script src="https://code.angularjs.org/tools/typescript.js"></script>
    <script src="https://code.angularjs.org/2.0.0-beta.17/Rx.js"></script>
    <script src="https://code.angularjs.org/2.0.0-beta.17/angular2.dev.js"></script>
    <script>
      System.config({
        transpiler: 'typescript',
        typescriptOptions: { emitDecoratorMetadata: true }
      });
      System.import('./ts/app.ts').then(null, console.error.bind(console));
    </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>

import {bootstrap} from 'angular2/platform/browser'
import {Component} from 'angular2/core';
import {FormBuilder, Validators, ControlGroup} from 'angular2/common';

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

function zipValidator(zip: Control) {
  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)" [ngFormModel]="myForm" novalidate>
<div class="well">
  <div class="form-group">
    <label>郵便番号("-"なしの7桁の数値)</label>
    <input type="text" class="form-control" ngControl="zip" />
    <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" ngControl="pref">
      <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 MyApp {
  public prefs = PREFS;
  public master;
  public myForm: ControlGroup;
  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;
  }
}

bootstrap(MyApp);

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

関連記事の目次

コメントを残す

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