Angular2でフォームのバリデーションチェック、動的にCSS追加

wp-admin

7年前

Angular2でフォームのバリデーションチェック、動的にCSSの追加を行い、エラー時に色を変えたり、メッセージを表示する方法をまとめました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。（デモはv4.4.3、v2.0.0で動作確認）

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

１．FormsModuleのインポート
２．NgModelディレクティブを使ったシンプルなフォーム作成例（バリデーションチェックなし）
３．バリデーションチェック、動的にCSS追加
４．フォームの作成方法
５．デモ

FormsModuleのインポート

Angular2のフォームの機能を使用する場合、別途フォームのモジュールをインポートする必要があります。
　
一般的なAngular2のフォーム機能を使用する場合、FormsModuleをインポートします。
※ダイナミックフォームを使用する場合は、ReactiveFormsModuleをインポートする。詳細は以下を参照。
Dynamic Forms
　
例）FormsModuleのインポート

import { FormsModule }   from '@angular/forms';
　：
　：
@NgModule({
  imports: [
    BrowserModule,
    FormsModule
  ],
　：

NgModelディレクティブを使ったシンプルなフォーム作成例（バリデーションチェックなし）

NgModelディレクティブによる2Wayバインディングを使い、バリデーションチェックなしのファーム作成例を示します。

@Component({
  selector: 'my-app',
  template: `
<strong>Angular2のバリデーションチェックなし</strong>
<form (ngSubmit)="onSubmit()"novalidate>
<div class="well">
  <div class="form-group">
    <label>会員名</label>
    <input type="text" class="form-control" required
      [(ngModel)]="user.name" name="name" />
  </div>
  <div class="form-group">
    <label>メールアドレス</label>
    <input type="email" class="form-control" required
      [(ngModel)]="user.email" name="email" />
  </div>
  <div class="text-center">
    <button type="submit" class="btn btn-primary">登録</button>
  </div>
</div>
</form>

<div class="well" ng-if="master">
  <strong>入力内容</strong><br />
  {{master | json}}
</div>
  `
})
export class MyApp {
  public user: User = {
    name: 'A1234',
    email: 'test@example.com'
  };

  public maste: User;
  onSubmit(){
    this.master = Object.assign({}, this.user);
  }
}

バリデーションチェック、動的にCSS追加

１）<form>タグとNgFormディレクティブ
　
・FormsModuleをインポートすると、<form>タグ指定時にこのディレクティブはデフォルトでアクティブになる。明示的にセレクターを追加する必要はない。
　
・NgFormディレクティブは、FormGroupインスタンスを生成してフォームとバインドし、フォームの値とバリデーションステータスを追跡する。
　
・以下のように記述することによって
#myForm=”ngForm”
ディレクティブをテンプレートリファレンス変数にエクスポートすることができる。
そして、テンプレートビュー内でこのテンプレートリファレンス変数を使ってフォーム内の各フォームコントロールの値、バリデーションステータスにアクセスすることができる。
　
・ユーザーがフォームの送信を行うとNgSubmitイベントが発火する。
　
・フォームコントロールの値は、ngFormのvalue属性でJSONオブジェクトとして参照できる。
　
２）FormControlオブジェクト
　
・Angular2のフォームシステムでは、input要素などのフォームコントロールはFormControlオブジェクトによって扱われる。
　
・FormControlオブジェクトは、各フォームコントロールの入力値、バリデーション状態などを保持する。
　
・テンプレートビュー内でNgModelディレクティブを使用すると自動的に生成される。
　
・コンポーネントクラス内で明示的に定義することもできる。
例）
const ctrl = new FormControl(”, Validators.required);
※詳細は以下の記事参照
Angular2でカスタムバリデート、カスタムフォーム
　
●フォームコントロールの状態遷移
　
フォームが最初に表示されてからユーザーがフォームに入力し終わるまでの間の各状態を管理する。
※詳細はスーパークラスのAbstractControlを参照。
AbstractControl
　
・untouched
　フォームのコントロールにタッチする前
・touched
　フォームのコントロールにタッチした後
・pristine
　コントロールの値が変化する前
・dirty
　コントロールの値が変化
・valid
　コントロールの値がvalid
・invalid
　コントロールの値がinvalid
　
●動的に追加されるCSSクラス
　
各フォームコントロールの状態に応じて以下のCSSクラスを動的に追加する。
ng-untouched、ng-touched、ng-pristine、ng-dirty、ng-valid、ng-invalid
　
●バリデーションチェック
　
・デフォルトで以下のバリデーションチェックがサポートされる。
required、minlength、maxlength、pattern
　
・上記バリデーションチェック時のエラーメッセージは”errors”オブジェクトにキー（required、minlength、maxlength、pattern）とエラーメッセージのペアで保持される。
　
３）NgModelディレクティブ
　
・ドメインモデルからFormControlインスタンスを生成し、テンプレートビューのフォームのコントロール要素とバインドさせる。
　
・<form>タグ内でngModelを使用する場合、フォームコントロールに”name”属性を指定する必要があり、このname属性で指定した名前を使って親フォームのコントロールに登録して、アクセスする。
　
・FormControlインスタンスのバリデーションステータスをチェックしたい場合、以下のようにローカルテンプレート変数にエクスポートする事によって、テンプレートビュー内でローカルテンプレート変数を介してバリデーションステータスを取得することができる。
#myVar=”ngModel”
このとき、ディレクティブの”control”属性を使ってコントロールにアクセスすることができるが、”valid”や”dirty”などの多くの属性は”control”を介して指定しなくても直接指定することも出来る。（この属性についてはAbstractControlDirectiveに定義されている。）
　
・ドメインから初期値をフォームの初期値として指定する場合、リアルタイムにドメインと同期させたい場合は、NgModelを1way、2Wayデータバインディングで利用する必要がある。
　
・フォームで送信したデータは、NgFormのvalue属性でJSONオブジェクトとして参照できる。各フォームコントロールは、name属性で指定した名前でアクセスできる。

<form #userForm="ngForm" (ngSubmit)="onSubmit(userForm.value)">
  <input name="name" #v_name="ngModel" ngModel>
  <input name="email" #v_email="ngModel" ngModel>
  <button>Submit</button>
</form>
<p>Name value: {{ v_name.value }}</p>
<p>Name valid: {{ v_name.valid }}</p>
<p>Form value: {{ userForm.value | json }}</p>
<p>Form valid: {{ userForm.valid }}</p>
　　↓
ユーザー送信データ　userForm.value
{ "name": "test1234", "email": "test@sample.com" }

フォームの作成方法

①form要素にNgFormディレクティブを適用
　
<form #userForm=”ngForm”>
テンプレートリファレンス変数に”ngForm”を指定。
　
②各フォームコントロールにngModelディレクティブを適用
　
<input name=”name” ngModel>
　
③各フォームコントロールにテンプレートリファレンス変数で”ngModel”を指定
　
<input name=”name” #v_name=”ngModel” ngModel>
テンプレートリファレンス変数”v_name”に”ngModel”を指定する事によって、FormControlオブジェクトのインスタンスにアクセスでき、コントロールのバリデーション状態を取得できる。
　
④上記③のテンプレートリファレンス変数を介してバリデーション結果を取得し、エラーメッセージを表示
　
例）テンプレートリファレンス変数”v_name”を介してバリデーション結果を取得。エラーの場合のみ、エラーメッセージを表示

<input type="text" class="form-control" required
  name="name" #v_name="ngModel"
  minlength="5" maxlength="10" pattern="[A-Z0-9]+" ngModel />
<div *ngIf="v_name.dirty && v_name.errors">
  <span class="text-danger"
    [hidden]="!v_name.errors.required ">
    必須項目</span>
  <span class="text-danger"
    [hidden]="!v_name.errors.minlength ">
    最小文字数：5</span>
  <span class="text-danger"
    [hidden]="!v_name.errors.maxlength ">
    最大文字数：10</span>
  <span class="text-danger"
    [hidden]="!v_name.errors.pattern ">
    文字種：半角英大文字、数字</span>
</div>

　
⑤フォーム全体のバリデーションチェック
　
例）テンプレートリファレンス変数”userForm”を介してフォーム全体のバリデーションチェック結果を取得。フォーム全体がvalidにならないとボタンを無効にする
　
<form (ngSubmit)=”onSubmit(userForm.value)” #userForm=”ngForm”>
・・・・
<button type=”submit” class=”btn btn-primary”
　　　[disabled]=”!userForm.form.valid”>登録</button>
　
⑥フォームのデータ送信
　
NgFormディレクティブのvalue属性でフォームコントロールの入力値を取得
　
例）
<form (ngSubmit)=”onSubmit(userForm.value)” #userForm=”ngForm”>

デモ

●サンプルコードの補足
　
①各フォームコントロールのCSS
　
・valid、invalid、dirtyの状態に応じてテキストボックスの色を変化させるため、以下のCSS設定を追加。
.ng-valid.ng-dirty {
　border-left: 5px solid lightgreen;
}
.ng-invalid.ng-dirty {
　border-left: 5px solid lightpink;
}
　
・エラーメッセージをBootstrap3のtext-dangerクラスを使って文字色などを設定。
NgIfディレクティブ、[hidden]を使って各フォームコントロールのバリデーションがエラーの場合のみエラーメッセージを表示。
　
②各入力項目のチェック内容
　
・フォームの各入力項目は必須項目なので”required”を指定。
・会員名は、英半角大文字の5～10文字に制限。
minlength=”5″ maxlength=”10″ pattern=”/^[A-Z0-9]+$/”
・メールアドレスの文字列チェック
pattern=”[A-Za-z0-9.\-]+@[A-Za-z0-9\-]+[.][A-Za-z0-9.\-]+” />
　
③フォーム全体のCSS
　
・初期状態は背景色無し。すべての入力項目が正常に入力されたらフォーム全体の背景色をライトグリーン。正常の状態で無い場合はライトピンク。
　
フォーム全体の状態に応じて自動でCSSを追加する機能は無いようなので、NgClassディレクティブを使って’form-valid’、’form-invalid’というCSSクラスを動的に追加。
　
<form (ngSubmit)=”onSubmit(userForm.value)” #userForm=”ngForm” novalidate
　[ngClass]=”userForm.form.valid ? ‘form-valid’ : ‘form-invalid'”
>
　
④NgModelディレクティブを使用する場合
　
コンポーネントクラス内のモデルデータとテンプレートをバインドさせる場合は、NgModelディレクティブで2Wayバインドさせる。

（テンプレート）
<form (ngSubmit)="onSubmit()" #userForm="ngForm">
・・・・
    <input type="text" class="form-control" required
      [(ngModel)]="user.name" #v_name="ngModel"
      minlength="5" maxlength="10" pattern="[A-Z0-9]+"/>
　
（コンポーネントクラス）
  public user: User = {
    name: 'A1234',
    email: 'test@example.com'
  };

　
●デモ
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 }   from '@angular/forms';

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

@Component({
  selector: 'my-app',
  styles:[`
    .ng-valid.ng-dirty {
      border-left: 5px solid lightgreen;
    }
    .ng-invalid.ng-dirty {
      border-left: 5px solid lightpink;
    }
    .form-invalid { background-color: lightpink; }
    .form-valid { background-color: lightgreen; }
    form { padding: 10px;}
  `],
  template: `
<strong>Angular2のフォームで入力チェック、CSS設定</strong>
<form (ngSubmit)="onSubmit(userForm.value)" #userForm="ngForm" novalidate
  [ngClass]="userForm.form.valid ? 'form-valid' : 'form-invalid'">
<div class="well">
  <div class="form-group">
    <label>会員名（必須項目、半角英大文字、数値5～10文字）</label>
    <input type="text" class="form-control" required
      name="name" #v_name="ngModel"
      minlength="5" maxlength="10" pattern="[A-Z0-9]+" ngModel />
    <div *ngIf="v_name.dirty && v_name.errors">
      <span class="text-danger"
        [hidden]="!v_name.errors.required ">
        必須項目</span>
      <span class="text-danger"
        [hidden]="!v_name.errors.minlength ">
        最小文字数：5</span>
      <span class="text-danger"
        [hidden]="!v_name.errors.maxlength ">
        最大文字数：10</span>
      <span class="text-danger"
        [hidden]="!v_name.errors.pattern ">
        文字種：半角英大文字、数字</span>
    </div>
  </div>
  <div class="form-group">
    <label>メールアドレス（必須項目、メールフォーマットチェック）</label>
    <input type="email" class="form-control" required
      name="email" #v_email="ngModel"
      pattern="[A-Za-z0-9.\-]+@[A-Za-z0-9\-]+[.][A-Za-z0-9.\-]+" ngModel />
    <div *ngIf="v_email.dirty && v_email.errors">
      <span class="text-danger"
        [hidden]="!v_email.errors.required ">
        必須項目</span>
      <span class="text-danger"
        [hidden]="!v_email.errors.pattern ">
        メールフォーマットエラー</span>
    </div>
  </div>
  <div class="text-center">
    <button type="submit" class="btn btn-primary"
        [disabled]="!userForm.form.valid">登録</button>
  </div>
</div>
</form>

<div class="well" ng-if="master">
  <strong>入力内容</strong><br />
  {{master | json}}
</div>
  `
})
export class AppComponent {
  onSubmit(user){
    this.master = user;
  }
}
@NgModule({
  imports: [
    BrowserModule,
    FormsModule
  ],
  declarations: [
    AppComponent
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule { }

platformBrowserDynamic().bootstrapModule(AppModule);

モバイルバージョンを終了