API Documentation for UserModel.createForm()

Getting started

Decorators

UserModel.createForm(): FormGroup

Description: The createForm() static method is a utility function provided by the UserModel class to create an Angular FormGroup object representing a form based on the properties and decorators defined in the UserModel class. The FormGroup object can be used with Angular's reactive forms module to manage form controls and handle form validations.

Returns:

Usage:

typescriptCopy code
import { UserModel } from 'path-to-user-model';

// Create a new instance of the UserModel form
this.form = UserModel.createForm();

Example:

typescriptCopy code
// UserModel.ts
import { GV, GVModel } from 'some-library';
import { FormGroup, FormControl, Validators } from '@angular/forms';

export class UserModel extends GVModel {
  @GV.maxLength(120)
  @GV.minLength(5)
  @GV.required()
  firstName: string;

  @GV.maxLength(120)
  @GV.minLength(5)
  @GV.required()
  lastName: string;

  @GV.required()
  @GV.email()
  email: string;

  // ... other properties and methods ...
}

// SomeComponent.ts
import { Component } from '@angular/core';
import { UserModel } from 'path-to-user-model';
import { FormGroup } from '@angular/forms';

@Component({
  selector: 'app-some',
  templateUrl: './some.component.html',
  styleUrls: ['./some.component.css'],
})
export class SomeComponent {
  form: FormGroup;

  constructor() {
    // Create a new instance of the UserModel form
    this.form = UserModel.createForm();
  }
}

Note

Typically, the createForm() method would use the property decorators and validation rules defined in the UserModel class to create corresponding form controls within the FormGroup.

It's important to ensure that the Angular Reactive Forms module is imported and available in your Angular application when using the createForm() method. Additionally, the UserModel class should have all the required decorators and validation rules correctly defined for the form controls to be set up properly. Always refer to the official documentation or source code of the library or framework being used for more detailed information about the createForm() method's implementation.

Directive

Validators

Custom Validators

Error messages

Customise\Override Error Messages

Complex forms \ Schemas