Динамические формы

Отображение динамических форм с FormGroup.

Мы не всегда можем оправдать затраты и время на создание ручных форм, особенно если нам потребуется большое количество форм, они будут похожи друг на друга, и они часто будут меняться, чтобы соответствовать быстро меняющимся бизнес- и нормативным требованиям.

Может быть экономичнее создать формы динамически, основываясь на метаданных, описывающих модель бизнес-объекта.

В этом руководстве показано, как использовать formGroup для динамического отображения простой формы с различными типами элементов управления и валидацией. Это базовый пример. Он может быть расширен, чтобы поддерживать более богатый набор вопросов, более плавное отображение и улучшенный пользовательский интерфейс. Все великое начинается с малого.

В нашем примере мы используем динамическую форму для создания онлайн-опытного приложения для героев, ищущих работу. Агентство постоянно вносит изменения в процесс подачи заявок. Мы можем создавать формы на лету без изменения кода нашего приложения.

Оглавление

Bootstrap

Модель вопросов

Компонент формы

Метаданные опросника

Динамический шаблон

См..

Bootstrap

Мы начинаем с создания NgModule с именем AppModule.

В нашем примере мы будем использовать Реактивные формы.

Реактивные формы относятся к другому NgModule с именем ReactiveFormsModule, поэтому для доступа к любым директивам Реактивных форм нам нужно импортировать ReactiveFormsModule из библиотеки @angular/forms.

Мы инициализируем наше AppModule в файле main.ts.

import { BrowserModule }                from '@angular/platform-browser';
import { ReactiveFormsModule }          from '@angular/forms';
import { NgModule }                     from '@angular/core';

import { AppComponent }                 from './app.component';
import { DynamicFormComponent }         from './dynamic-form.component';
import { DynamicFormQuestionComponent } from './dynamic-form-question.component';

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

import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

platformBrowserDynamic().bootstrapModule(AppModule);

Модель вопросов

Следующий шаг — определить модель объекта, которая может описать все сценарии, необходимые для функциональности формы. Процесс подачи заявки героем включает форму с множеством вопросов. «Вопрос» — это самый фундаментальный объект в модели.

Мы создали QuestionBase в качестве базового класса вопросов.

export class QuestionBase<T>{
  value: T;
  key: string;
  label: string;
  required: boolean;
  order: number;
  controlType: string;

  constructor(options: {
      value?: T,
      key?: string,
      label?: string,
      required?: boolean,
      order?: number,
      controlType?: string
    } = {}) {
    this.value = options.value;
    this.key = options.key || '';
    this.label = options.label || '';
    this.required = !!options.required;
    this.order = options.order === undefined ? 1 : options.order;
    this.controlType = options.controlType || '';
  }
}

Из этого базового класса мы вывели два новых класса в TextboxQuestion и DropdownQuestion, которые представляют текстовые и выпадающие списки вопросов. Идея в том, что форма будет связана с определенными типами вопросов и динамически отображать соответствующие элементы управления.

TextboxQuestion поддерживает несколько типов HTML5, таких как текст, электронная почта, URL и т. д., через свойство type.

import { QuestionBase } from './question-base';

export class TextboxQuestion extends QuestionBase<string> {
  controlType = 'textbox';
  type: string;

  constructor(options: {} = {}) {
    super(options);
    this.type = options['type'] || '';
  }
}

DropdownQuestion представляет список вариантов в раскрывающемся списке.

import { QuestionBase } from './question-base';

export class DropdownQuestion extends QuestionBase<string> {
  controlType = 'dropdown';
  options: {key: string, value: string}[] = [];

  constructor(options: {} = {}) {
    super(options);
    this.options = options['options'] || [];
  }
}

Далее мы определили QuestionControlService, простой сервис для преобразования наших вопросов в FormGroup. Вкратце, группа форм использует метаданные из модели вопросов и позволяет нам задавать значения по умолчанию и правила валидации.

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

import { QuestionBase } from './question-base';

@Injectable()
export class QuestionControlService {
  constructor() { }

  toFormGroup(questions: QuestionBase<any>[] ) {
    let group: any = {};

    questions.forEach(question => {
      group[question.key] = question.required ? new FormControl(question.value || '', Validators.required)
                                              : new FormControl(question.value || '');
    });
    return new FormGroup(group);
  }
}

Компоненты формы вопроса

Теперь, когда мы определили полную модель, мы готовы создать компоненты для представления динамической формы.

DynamicFormComponent является точкой входа и основным контейнером для формы.

<div>
  <form (ngSubmit)="onSubmit()" [formGroup]="form">

    <div *ngFor="let question of questions" class="form-row">
      <df-question [question]="question" [form]="form"></df-question>
    </div>

    <div class="form-row">
      <button type="submit" [disabled]="!form.valid">Save</button>
    </div>
  </form>

  <div *ngIf="payLoad" class="form-row">
    <strong>Saved the following values</strong><br>{{payLoad}}
  </div>
</div>

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

import { QuestionBase }              from './question-base';
import { QuestionControlService }    from './question-control.service';

@Component({
  selector: 'dynamic-form',
  templateUrl: './dynamic-form.component.html',
  providers: [ QuestionControlService ]
})
export class DynamicFormComponent implements OnInit {

  @Input() questions: QuestionBase<any>[] = [];
  form: FormGroup;
  payLoad = '';

  constructor(private qcs: QuestionControlService) {  }

  ngOnInit() {
    this.form = this.qcs.toFormGroup(this.questions);
  }

  onSubmit() {
    this.payLoad = JSON.stringify(this.form.value);
  }
}

Он представляет список вопросов, каждый из которых связан с элементом компонента <df-question>. Тэг <df-question> соответствует DynamicFormQuestionComponent, компоненту, ответственному за отображение деталей каждого отдельного вопроса на основе значений в связанном данными объекте вопроса.

<div [formGroup]="form">
  <label [attr.for]="question.key">{{question.label}}</label>

  <div [ngSwitch]="question.controlType">

    <input *ngSwitchCase="'textbox'" [formControlName]="question.key"
            [id]="question.key" [type]="question.type">

    <select [id]="question.key" *ngSwitchCase="'dropdown'" [formControlName]="question.key">
      <option *ngFor="let opt of question.options" [value]="opt.key">{{opt.value}}</option>
    </select>

  </div> 

  <div class="errorMessage" *ngIf="!isValid">{{question.label}} is required</div>
</div>

import { Component, Input } from '@angular/core';
import { FormGroup }        from '@angular/forms';

import { QuestionBase }     from './question-base';

@Component({
  selector: 'df-question',
  templateUrl: './dynamic-form-question.component.html'
})
export class DynamicFormQuestionComponent {
  @Input() question: QuestionBase<any>;
  @Input() form: FormGroup;
  get isValid() { return this.form.controls[this.question.key].valid; }
}

Обратите внимание, что этот компонент может представлять любой тип вопроса в нашей модели. В данный момент у нас есть только два типа вопросов, но мы можем представить себе множество других. ngSwitch определяет, какой тип вопроса отобразить.

В обоих компонентах мы полагаемся на formGroup Angular для подключения шаблона HTML к объектам управления, заполненных из модели вопроса с правилами отображения и валидации.

formControlName и formGroup — это директивы, определенные в ReactiveFormsModule. Наши шаблоны могут напрямую обращаться к этим директивам, так как мы импортировали ReactiveFormsModule из AppModule.

Метаданные опросника

DynamicFormComponent ожидает список вопросов в виде массива, привязанного к @Input() questions.

Набор вопросов, определенных для заявки на работу героя, возвращается из QuestionService. В реальном приложении эти вопросы мы бы получали из хранилища.

Суть в том, что мы полностью контролируем вопросы заявки на работу героя с помощью объектов, возвращаемых из QuestionService. Обновление опросника — это простая задача добавления, обновления и удаления объектов из массива questions.

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

import { DropdownQuestion } from './question-dropdown';
import { QuestionBase }     from './question-base';
import { TextboxQuestion }  from './question-textbox';

@Injectable()
export class QuestionService {

  // Todo: get from a remote source of question metadata
  // Todo: make asynchronous
  getQuestions() {

    let questions: QuestionBase<any>[] = [

      new DropdownQuestion({
        key: 'brave',
        label: 'Bravery Rating',
        options: [
          {key: 'solid',  value: 'Solid'},
          {key: 'great',  value: 'Great'},
          {key: 'good',   value: 'Good'},
          {key: 'unproven', value: 'Unproven'}
        ],
        order: 3
      }),

      new TextboxQuestion({
        key: 'firstName',
        label: 'First name',
        value: 'Bombasto',
        required: true,
        order: 1
      }),

      new TextboxQuestion({
        key: 'emailAddress',
        label: 'Email',
        type: 'email',
        order: 2
      })
    ];

    return questions.sort((a, b) => a.order - b.order);
  }
}

Наконец, мы отображаем экземпляр формы в оболочке AppComponent.

import { Component }       from '@angular/core';

import { QuestionService } from './question.service';

@Component({
  selector: 'my-app',
  template: `
    <div>
      <h2>Job Application for Heroes</h2>
      <dynamic-form [questions]="questions"></dynamic-form>
    </div>
  `,
  providers:  [QuestionService]
})
export class AppComponent {
  questions: any[];

  constructor(service: QuestionService) {
    this.questions = service.getQuestions();
  }
}

Динамический шаблон

Хотя в этом примере мы моделируем заявку на работу для героя, нигде за пределами объектов, возвращаемых QuestionService, нет ссылок на конкретные вопросы о героях.

Это очень важно, поскольку это позволяет нам повторно использовать компоненты для любого типа опроса, совместимого с нашей моделью объекта «вопрос». Ключевым моментом является динамическая привязка метаданных, используемых для отображения формы без создания жестких предположений о конкретных вопросах. В дополнение к метаданным управления, мы также динамически добавляем валидацию.

Кнопка «Сохранить» отключена до тех пор, пока форма не будет в валидном состоянии. Когда форма валидна, мы можем нажать «Сохранить», и приложение отобразит текущие значения формы в формате JSON. Это доказывает, что любой ввод пользователя связан обратно с моделью данных. Сохранение и извлечение данных — тема для другого раза.

Итоговая форма выглядит так: