web-dev-qa-db-ja.com

リアクティブフォーム-フィールドをタッチ済みとしてマークする

すべてのフォームのフィールドをタッチ済みとしてマークする方法を見つけるのに苦労しています。主な問題は、フィールドに触れずにフォームを送信しようとすると、検証エラーが表示されないことです。コントローラーにそのコードのプレースホルダーがあります。
私の考えは簡単です：

  1. ユーザーが送信ボタンをクリックする
  2. すべてのフィールドがタッチ済みとしてマークされます
  3. エラーフォーマッタが再実行され、検証エラーが表示されます

新しいメソッドを実装せずに、送信時にエラーを表示する方法が他にある場合は、共有してください。ありがとう！

私の簡易フォーム：

<form class="form-horizontal" [formGroup]="form" (ngSubmit)="onSubmit(form.value)">
  <input type="text" id="title" class="form-control" formControlName="title">
  <span class="help-block" *ngIf="formErrors.title">{{ formErrors.title }}</span>
  <button>Submit</button>
</form>

そして私のコントローラー：

import {Component, OnInit} from '@angular/core';
import {FormGroup, FormBuilder, Validators} from '@angular/forms';

@Component({
  selector   : 'Pastebin-root',
  templateUrl: './app.component.html',
  styleUrls  : ['./app.component.css']
})
export class AppComponent implements OnInit {
  form: FormGroup;
  formErrors = {
    'title': ''
  };
  validationMessages = {
    'title': {
      'required': 'Title is required.'
    }
  };

  constructor(private fb: FormBuilder) {
  }

  ngOnInit(): void {
    this.buildForm();
  }

  onSubmit(form: any): void {
    // somehow touch all elements so onValueChanged will generate correct error messages

    this.onValueChanged();
    if (this.form.valid) {
      console.log(form);
    }
  }

  buildForm(): void {
    this.form = this.fb.group({
      'title': ['', Validators.required]
    });
    this.form.valueChanges
      .subscribe(data => this.onValueChanged(data));
  }

  onValueChanged(data?: any) {
    if (!this.form) {
      return;
    }
    const form = this.form;
    for (const field in this.formErrors) {
      if (!this.formErrors.hasOwnProperty(field)) {
        continue;
      }

      // clear previous error message (if any)
      this.formErrors[field] = '';
      const control = form.get(field);
      if (control && control.touched && !control.valid) {
        const messages = this.validationMessages[field];
        for (const key in control.errors) {
          if (!control.errors.hasOwnProperty(key)) {
            continue;
          }
          this.formErrors[field] += messages[key] + ' ';
        }
      }
    }
  }
}
angularangular2-formsangular2-formbuilder
44
Giedrius Kiršys

次の関数は、フォームグループ内のコントロールを再帰的に繰り返し、それらに優しく触れます。 controlsフィールドはオブジェクトであるため、コードはフォームグループのcontrolフィールドでObject.values（）を呼び出します。

  /**
   * Marks all controls in a form group as touched
   * @param formGroup - The form group to touch
   */
  private markFormGroupTouched(formGroup: FormGroup) {
    (<any>Object).values(formGroup.controls).forEach(control => {
      control.markAsTouched();

      if (control.controls) {
        this.markFormGroupTouched(control);
      }
    });
  }
98
masterwok

Angular 8 +では、単に使用できます

this.form.markAllAsTouched();

コントロールとその子孫コントロールをタッチ済みとしてマークします。

10
hovado

@masterworkの答えに関して。私はその解決策を試みましたが、この行でFormGroupの代わりにFormControl引数を渡すため、関数がFormGroup内で再帰的にDigを実行しようとしたときにエラーが発生しました：

control.controls.forEach(c => this.markFormGroupTouched(c));

ここに私の解決策があります

markFormGroupTouched(formGroup: FormGroup) {
 (<any>Object).values(formGroup.controls).forEach(control => {
   if (control.controls) { // control is a FormGroup
     markFormGroupTouched(control);
   } else { // control is a FormControl
     control.markAsTouched();
   }
 });
}
9
GarryOne

フォームコントロールをループし、タッチされたものとしてマークすることもできます。

for(let i in this.form.controls)
    this.form.controls[i].markAsTouched();
6
jsertx

Angular v8から、markAllAsTouchedメソッドの助けを借りてこの組み込み機能を使用できます。

例として、次のように使用できます

form.markAllAsTouched();

公式ドキュメントを参照してください： https://angular.io/api/forms/AbstractControl#markallastouched

3
ylerjen

これは私の解決策です

      static markFormGroupTouched (FormControls: { [key: string]: AbstractControl } | AbstractControl[]): void {
        const markFormGroupTouchedRecursive = (controls: { [key: string]: AbstractControl } | AbstractControl[]): void => {
          _.forOwn(controls, (c, controlKey) => {
            if (c instanceof FormGroup || c instanceof FormArray) {
              markFormGroupTouchedRecursive(c.controls);
            } else {
              c.markAsTouched();
            }
          });
        };
        markFormGroupTouchedRecursive(FormControls);
      }
3
Aladdin Mhemed

私はこの問題を抱えていましたが、今まで見つけたどのAngularチュートリアルにも含まれていないにもかかわらず、「正しい」方法を見つけました。

HTMLのformタグで、Reactive Formsの例で使用するものに加えて、テンプレート駆動型の例で使用するものと同じテンプレート参照変数#myVariable='ngForm'（「ハッシュタグ」変数）を追加します。

<form [formGroup]="myFormGroup" #myForm="ngForm" (ngSubmit)="submit()">

これで、myForm.submittedの代わりに（またはそれに加えて）使用できるテンプレートのmyFormGroup.controls.X.touchedにアクセスできます。

<div *ngIf="myForm.submitted" class="text-error"> <span *ngIf="myFormGroup.controls.myFieldX.errors?.badDate">invalid date format</span> <span *ngIf="myFormGroup.controls.myFieldX.errors?.isPastDate">date cannot be in the past.</span> </div>

myForm.form === myFormGroupの部分を忘れない限り、="ngForm"が正しいことを知ってください。 #myFormを単独で使用する場合、varは要素を駆動するディレクティブではなくHtmlElementに設定されるため、機能しません。

myFormGroupは、Reactive Formsチュートリアルに従ってコンポーネントのTypeScriptコードに表示されますが、submit(myForm)からsubmit(myForm: NgForm): void {...}などのメソッド呼び出しで渡さない限り、myFormは表示されません。 （注意：NgFormはTypeScriptではタイトルキャップにありますが、HTMLではキャメルケースです。）

2
Ron Newcomb

ここに私がそれをする方法があります。送信ボタンが押される（またはフォームがタッチされる）までエラーフィールドを表示したくありません。

import {FormBuilder, FormGroup, Validators} from "@angular/forms";

import {OnInit} from "@angular/core";

export class MyFormComponent implements OnInit {
  doValidation = false;
  form: FormGroup;


  constructor(fb: FormBuilder) {
    this.form = fb.group({
      title: ["", Validators.required]
    });

  }

  ngOnInit() {

  }
  clickSubmitForm() {
    this.doValidation = true;
    if (this.form.valid) {
      console.log(this.form.value);
    };
  }
}
<form class="form-horizontal" [formGroup]="form" >
  <input type="text" class="form-control" formControlName="title">
  <div *ngIf="form.get('title').hasError('required') && doValidation" class="alert alert-danger">
            title is required
        </div>
  <button (click)="clickSubmitForm()">Submit</button>
</form>
1
brando
onSubmit(form: any): void {
  if (!this.form) {
    this.form.markAsTouched();
    // this.form.markAsDirty(); <-- this can be useful 
  }
}
1
Vlado Tesanovic

このコードは私のために機能します：

markAsRequired(formGroup: FormGroup) {
  if (Reflect.getOwnPropertyDescriptor(formGroup, 'controls')) {
    (<any>Object).values(formGroup.controls).forEach(control => {
      if (control instanceof FormGroup) {
        // FormGroup
        markAsRequired(control);
      }
      // FormControl
      control.markAsTouched();
    });
  }
}
1
Dionis Oros

同じ問題にぶつかりましたが、これを処理するコードでコンポーネントを「汚染」したくありません。特にこれは多くの形で必要であり、さまざまな機会でコードを繰り返したくないので。

したがって、ディレクティブを作成しました（これまでに投稿された回答を使用）。ディレクティブは、NgFormのonSubmit- Methodを修飾します。フォームが無効な場合、すべてのフィールドにタッチ済みのマークを付け、送信を中止します。それ以外の場合、通常のonSubmit-Methodは正常に実行されます。

import {Directive, Host} from '@angular/core';
import {NgForm} from '@angular/forms';

@Directive({
    selector: '[appValidateOnSubmit]'
})
export class ValidateOnSubmitDirective {

    constructor(@Host() form: NgForm) {
        const oldSubmit = form.onSubmit;

        form.onSubmit = function (): boolean {
            if (form.invalid) {
                const controls = form.controls;
                Object.keys(controls).forEach(controlName => controls[controlName].markAsTouched());
                return false;
            }
            return oldSubmit.apply(form, arguments);
        };
    }
}

使用法：

<form (ngSubmit)="submit()" appValidateOnSubmit>
    <!-- ... form controls ... -->
</form>
1
yankee

これは私が実際に使用しているコードです。

validateAllFormFields(formGroup: any) {
    // This code also works in IE 11
    Object.keys(formGroup.controls).forEach(field => {
        const control = formGroup.get(field);

        if (control instanceof FormControl) {
            control.markAsTouched({ onlySelf: true });
        } else if (control instanceof FormGroup) {               
            this.validateAllFormFields(control);
        } else if (control instanceof FormArray) {  
            this.validateAllFormFields(control);
        }
    });
}
1
Leonardo Moreira

再帰のない解決策

パフォーマンスが心配な人のために、再帰を使用しないソリューションを考え出しましたが、それでもすべてのレベルのすべてのコントロールを反復処理します。

 /**
  * Iterates over a FormGroup or FormArray and mark all controls as
  * touched, including its children.
  *
  * @param {(FormGroup | FormArray)} rootControl - Root form
  * group or form array
  * @param {boolean} [visitChildren=true] - Specify whether it should
  * iterate over nested controls
  */
  public markControlsAsTouched(rootControl: FormGroup | FormArray,
    visitChildren: boolean = true) {

    let stack: (FormGroup | FormArray)[] = [];

    // Stack the root FormGroup or FormArray
    if (rootControl &&
      (rootControl instanceof FormGroup || rootControl instanceof FormArray)) {
      stack.Push(rootControl);
    }

    while (stack.length > 0) {
      let currentControl = stack.pop();
      (<any>Object).values(currentControl.controls).forEach((control) => {
        // If there are nested forms or formArrays, stack them to visit later
        if (visitChildren &&
            (control instanceof FormGroup || control instanceof FormArray)
           ) {
           stack.Push(control);
        } else {
           control.markAsTouched();
        }
      });
    }
  }

このソリューションは、FormGroupとFormArrayの両方で機能します。

ここでそれをいじることができます： angular-mark-as-touched

1
Arthur Silva

this gem を参照してください。これまで見た中で最もエレガントなソリューション。

完全なコード

import { Injectable } from '@angular/core';
import { FormGroup } from '@angular/forms';

const TOUCHED = 'markAsTouched';
const UNTOUCHED = 'markAsUntouched';
const DIRTY = 'markAsDirty';
const PENDING = 'markAsPending';
const PRISTINE = 'markAsPristine';

const FORM_CONTROL_STATES: Array<string> = [TOUCHED, UNTOUCHED, DIRTY, PENDING, PRISTINE];

@Injectable({
  providedIn: 'root'
})
export class FormStateService {

  markAs (form: FormGroup, state: string): FormGroup {
    if (FORM_CONTROL_STATES.indexOf(state) === -1) {
      return form;
    }

    const controls: Array<string> = Object.keys(form.controls);

    for (const control of controls) {
      form.controls[control][state]();
    }

    return form;
  }

  markAsTouched (form: FormGroup): FormGroup {
    return this.markAs(form, TOUCHED);
  }

  markAsUntouched (form: FormGroup): FormGroup {
    return this.markAs(form, UNTOUCHED);
  }

  markAsDirty (form: FormGroup): FormGroup {
    return this.markAs(form, DIRTY);
  }

  markAsPending (form: FormGroup): FormGroup {
    return this.markAs(form, PENDING);
  }

  markAsPristine (form: FormGroup): FormGroup {
    return this.markAs(form, PRISTINE);
  }
}
0
David Votrubec

OPのフラストレーションを完全に理解しています。私は次を使用します：

ユーティリティ関数：

/**
 * Determines if the given form is valid by touching its controls 
 * and updating their validity.
 * @param formGroup the container of the controls to be checked
 * @returns {boolean} whether or not the form was invalid.
 */
export function formValid(formGroup: FormGroup): boolean {
  return !Object.keys(formGroup.controls)
    .map(controlName => formGroup.controls[controlName])
    .filter(control => {
      control.markAsTouched();
      control.updateValueAndValidity();
      return !control.valid;
    }).length;
}

使用法：

onSubmit() {
  if (!formValid(this.formGroup)) {
    return;
  }
  // ... TODO: logic if form is valid.
}

この関数は、ネストされたコントロールにはまだ対応していないことに注意してください。

0
Stephen Paul