Angular2でカスタムバリデート、カスタムフォーム

Angular2でユーザー定義のバリデーションやユーザー定義のフォームを作成する方法をまとめました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。(デモはv4.4.3、v2.0.0で動作確認)

※ビルトインのフォーム作成方法はこちら
 
※目次をクリックすると目次の下部にコンテンツが表示されます。

FormControlオブジェクト、FormGroupオブジェクト
上記参照記事のビルトインのフォームの場合は、Angular2内部で暗黙的にFormControlオブジェクト、FormGroupオブジェクトが生成されていました。
 
カスタムバリデート、カスタムフォームを作成する場合は、コンポーネントクラス内で明示的にFormControlオブジェクト、FormGroupオブジェクトを定義し、生成する必要があります。
 
1)FormControlオブジェクト
 
○構文
ctrlName = new FormControl(‘初期値’, バリデーター);
 
①ビルトインのバリデーター
 
ビルトインのバリデータとしてrequired、minLength、maxLength、patternなどがある。
 
例)
name = new FormControl(‘Tom’, Validators.required);
 
複数のバリデーションを指定する場合は、composeメソッドを使用する。
name = new FormControl(‘Tom’, Validators.compose([Validators.required, Validators.maxLength(10)]));
 
②カスタムバリデーター
 
上記ビルトインのバリデーター以外に、ユーザー定義のバリデーターを作成する事ができます。
 
Validatorの関数は、FormControlをインプットの引数とし、<string, boolean>のStringMapをリターンします。
 
上記関数をcomposeメソッドで指定して定義します。
 
例)7桁の数字のみを許可するバリデーター

function zipValidator(zip: FormControl) {
  var valid = /^\d{7}$/.test(zip.value);
  if(zip.value == "" || valid) {
    return null;
  } else {
    return {"invalidZip":true};
  }
}
user_zip = new FormControl('1234567', Validators.compose([zipValidator]));

 
③テンプレート内のDOMとFormControlオブジェクトとのバインド
 
上記で定義したFormControlオブジェクトを該当のフォームコントロールにバインドするには、FormControlNameディレクティブを使用します。
 
例)
<input type=”number” formControlName=”user_zip” ngModel />
 
2)FormGroupオブジェクト
 
・複数の固定数のFormControlオブジェクトを含む事ができる。(可変数のFormControlオブジェクトを含む場合は、FormArrayオブジェクトを使用する)
 
・フォーム内の各コントロール全体としてのバリデーションチェックを行うことができる。
 
・定義したFormGroupオブジェクトをテンプレート内のDOMにバインドするには、formGroupディレクティブを使用する。
 
例)

loginForm: FormGroup;
constructor() {
  this.loginForm = new FormGroup({
    login: new FormControl("", Validators.required),
    password: new FormControl("", Validators.required)
  });
}

<form [formGroup]="loginForm">

カスタムフォームの作成
1)FormBuilderを使ってカスタムフォーム定義
 
・FormBuilderクラスのgroupインスタンスメンバでFormGroupを定義して、カスタムフォームを定義する。
 
・作成したFormGroupをテンプレート内でformGroupディレクティブを使ってDOMにバインドする。
 
例)

loginForm: formGroup;
constructor(builder: FormBuilder) {
  this.loginForm = builder.group({
    login: ["", Validators.required],
    passwordRetry: builder.group({
      password: ["", Validators.required],
      passwordConfirmation: ["", Validators.required, asyncValidator]
    })
  });
}

<form [formGroup]="loginForm">
  <p>Login <input formControlName="login" ngModel /></p>
・・・

 
2)テンプレート内でフォームコントロールのバリデーション結果、状態を取得
 
以下の定義のカスタムフォームの場合を例に示します。
public myForm: FormGroup;
constructor(builder: FormBuilder) {
 this.myForm = builder.group({
  user_name: [“”, Validators.required],
 
①インスタンス変数を使用
 
インスタンス変数が”myForm”の場合
(フォーム)
<button type=”submit” class=”btn btn-primary”
[disabled]=”!myForm.valid”>登録</button>
 
(各フォームコントロール)
・controlsメンバ使用
<span [hidden]=”!myForm.controls.user_name.errors.required “>・・・<span>
 
②ローカルテンプレート変数を使用
 
・form要素に指定したローカルテンプレート変数を使用
<form #f=”ngForm”・・・
 <div class=”errorMessage” *ngIf=”!f.form.controls.user_name.valid”>
   ・・・
・各フォームコントロールに指定したローカルテンプレート変数を使用
<input type=”text” name=”user_name” #name=”ngModel” ngModel />
<div *ngIf=”!name.control.valid”>

デモ

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';

function zipValidator(zip: FormControl) {
  var valid = /^\d{7}$/.test(zip.value);
  if(zip.value == "" || valid) {
    return null;
  } else {
    return {"invalidZip":true};
  }
}

class User {
  name: string;
  email: string;
  zip: string;
}

@Component({
  selector: 'my-app',
  styles:[`
    form.ng-invalid.ng-dirty { background-color: lightpink; }
    form.ng-valid.ng-dirty { background-color: lightgreen; }
    .ng-valid {
      border-left: 5px solid lightgreen;
    }
    .ng-invalid {
      border-left: 5px solid lightpink;
    }
    form { padding: 10px;}
  `],
  template: `
<strong>Angular2のカスタムフォームで入力チェック、CSS設定</strong>
<form (ngSubmit)="onSubmit(myForm.value)" [formGroup]="myForm" novalidate>
<div class="well">
  <div class="form-group">
    <label>会員名(必須項目、半角英大文字5~10文字)</label>
    <input type="text" class="form-control"
      formControlName="user_name" ngModel />
    <div *ngIf="myForm.controls.user_name.dirty && 
                myForm.controls.user_name.errors">
      <span class="text-danger"
        [hidden]="!myForm.controls.user_name.errors.required ">
        必須項目</span>
      <span class="text-danger"
        [hidden]="!myForm.controls.user_name.errors.minlength ">
        最小文字数:5</span>
      <span class="text-danger"
        [hidden]="!myForm.controls.user_name.errors.maxlength ">
        最大文字数:10</span>
      <span class="text-danger"
        [hidden]="!myForm.controls.user_name.errors.pattern ">
        文字種:半角英大文字、数字</span>
    </div>
  </div>
  <div class="form-group">
    <label>メールアドレス(必須項目、メールフォーマットチェック)</label>
    <input type="email" class="form-control"
      formControlName="user_email" ngModel />
    <div *ngIf="myForm.controls.user_email.dirty && 
                myForm.controls.user_email.errors">
      <span class="text-danger"
        [hidden]="!myForm.controls.user_email.errors.required ">
        必須項目</span>
      <span class="text-danger"
        [hidden]="!myForm.controls.user_email.errors.pattern ">
        メールフォーマットエラー</span>
    </div>
  </div>
  <div class="form-group">
    <label>郵便番号("-"なしの7桁の数値)</label>
    <input type="text" class="form-control"
      formControlName="user_zip" ngModel />
    <div *ngIf="myForm.controls.user_zip.dirty && 
                myForm.controls.user_zip.errors">
      <span class="text-danger"
        [hidden]="!myForm.controls.user_zip.errors.invalidZip">
        フォーマットエラー</span>
    </div>
  </div>
  <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 master: User;
  public myForm: FormGroup;
  constructor(fb: FormBuilder) {
    this.myForm = fb.group({
      "user_name": ['A1234', Validators.compose([
         Validators.required,
         Validators.minLength(5),
         Validators.maxLength(10),
         Validators.pattern('[A-Z0-9]+')])],
      "user_email": ['test@example.com',Validators.compose([
         Validators.required,
         Validators.pattern('[A-Za-z0-9.\-]+@[A-Za-z0-9\-]+[.][A-Za-z0-9.\-]+')])],
      "user_zip": ['1234567', Validators.compose([zipValidator])]
    });
  }

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

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

platformBrowserDynamic().bootstrapModule(AppModule);

関連記事の目次

コメントを残す

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