/ AutoComplete / Form Support
Search results

Form Support in Angular AutoComplete component

21 Dec 2022 / 3 minutes to read

The AutoComplete supports both the reactive and template-driven form-building technologies.

Template-Driven Forms

The template-drive forms uses the ng directives in view to handle the forms controls. To enable the template-driven, import the FormsModule into corresponding app component.

For more details about template-driven Forms refer to:https://angular.io/guide/forms#template-driven-forms.

Mention the name attribute to Autocomplete element which will be used to identify the form element. To register an Autocomplete element to ngForm, give the ngModel to it so the FormsModule will automatically detect the AutoComplete as a form element. After that, the AutoComplete value will be selected based on the ngModel value.

The following example demonstrates how to achieve a two-way data binding.

Copied to clipboard
import { Component, OnInit } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { BrowserModule } from '@angular/platform-browser';
@Component({
    selector: 'app-root',
    templateUrl: './form-support.html'
})
export class AppComponent {
    // defined the array of data
    public skillset: string[] = [
                                      'ASP.NET', 'ActionScript', 'Basic',
                                      'C++' , 'C#' , 'dBase' , 'Delphi' ,
                                      'ESPOL' , 'F#' , 'FoxPro' , 'Java',
                                      'J#' , 'Lisp' , 'Logo' , 'PHP'
                                  ];
    public placeholder: String = 'e.g: ActionScript';

    constructor() {
    }
        skillForm = {
            skillname: null,
            sname: '',
            smail: ''
        };
}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { FormsModule, ReactiveFormsModule } from '@angular/forms';
import { AppComponent } from './app.component';
import { AutoCompleteModule } from '@syncfusion/ej2-angular-dropdowns';
import { ButtonModule } from '@syncfusion/ej2-angular-buttons';
/**
 * Module
 */
@NgModule({
    imports: [
        BrowserModule,FormsModule, ReactiveFormsModule, AutoCompleteModule, ButtonModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Copied to clipboard
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);
Copied to clipboard
<!DOCTYPE html>
<html lang="en">

<head>
            <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js"></script>
    <title>Angular AutoComplete</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="description" content="Typescript Toolbar Controls" />
    <meta name="author" content="Syncfusion" />
    <link href="index.css" rel="stylesheet" />
    <link href="//cdn.syncfusion.com/ej2/20.4.38/ej2-dropdowns/styles/material.css" rel="stylesheet" />

    <script src="https://cdnjs.cloudflare.com/ajax/libs/core-js/2.4.1/core.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/zone.js/0.6.25/zone.min.js"></script>
    <script src="https://unpkg.com/reflect-metadata@0.1.3"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
    <script src="systemjs.config.js"></script>
</head>

<body>
    <div class="row" style="width:500px;">
        <div class="col-xs-7 col-sm-7 col-lg-7 col-md-7" style="padding-top:20px;">
            <div style="webkit-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
     box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
     margin:0 auto;height:330px;">
                <div style="padding:30px;">
                    <form #form="ngForm">
                        <div class="form-group">
                            <ejs-autocomplete name="skillname" #value='ngModel' required [(ngModel)]='skillname'
                                allowCustom=false [dataSource]='skillset' [placeholder]='placeholder'
                                floatLabelType='Auto'>
                            </ejs-autocomplete>
                            <div *ngIf="(value.invalid && (value.dirty || value.touched))" class="alert alert-danger">
                                <div *ngIf="value.errors.required">
                                    Value is required.
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding-top:10px;">
                            <div class="e-float-input">
                                <input type="text" #name='ngModel' required [(ngModel)]="sname" name="sname"
                                    maxlength="10" />
                                <span class="e-float-line e-label-top"></span>
                                <label class="e-float-text e-label-top">Name:</label>
                                <div *ngIf="(name.invalid && (name.dirty || name.touched))" class="alert alert-danger">
                                    <div *ngIf="name.errors.required">
                                        Name is required.
                                    </div>
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding-top:10px;">
                            <div class="e-float-input">
                                <input type="text" #email='ngModel' required [(ngModel)]="smail" name="smail"
                                    maxlength="15" />
                                <span class="e-float-line e-label-top"></span>
                                <label class="e-float-text e-label-top">Email:</label>
                                <div *ngIf="(email.invalid && (email.dirty || email.touched))"
                                    class="alert alert-danger">
                                    <div *ngIf="email.errors.required">
                                        Email is required.
                                    </div>
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding:10px;">
                            <button ejs-button [disabled]="!form.valid">Done</button>
                            <button ejs-button type="reset" [disabled]="!form.valid">Cancel</button>
                        </div>
                    </form>
                </div>
            </div>
        </div>
        <div class="col-xs-5 col-sm-5 col-lg-5 col-md-5" style="padding-top:20px;">
            <div style="webkit-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
     box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
     margin:0 auto;height:330px;">
                <div style="padding:30px;">
                    <div class="form-group">
                        <span style="font-weight:800;">Selected Language: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.skillname }}</span>
                    </div>
                    <div class="form-group" style="padding-top:50px;">
                        <span style="font-weight:800;">Buyer Name: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.sname }}</span>
                    </div>
                    <div class="form-group" style="padding-top:50px;">
                        <span style="font-weight:800;">Buyer Mail ID: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.smail }}</span>
                    </div>
                </div>
            </div>
        </div>
        <link href='https://unpkg.com/bootstrap@3.3.7/dist/css/bootstrap.min.css' rel='stylesheet' />
    </div>

</body>

</html>

Reactive Forms

The reactive forms uses the reactive model-driven technique to handle form data between component and view, due to that we also call it as the model-driven forms. It’s listen the form data changes between App component and view also returns the valid states and values of form elements.

For more details about Reactive Forms refer: https://angular.io/guide/reactive-forms.

For the reactive forms you should import a ReactiveFormsModule into app module as well as the FormGroup,FormControl should be imported to app component. The FormGroup is used to declare formGroupName for the form and the FormControl is used to declare formControlName for form controls. You can declare the formControlName to AutoComplete as usual. then,you must create a value object to the FormGroup and each value will be the default value of the form control.

The following example demonstrates how to use the reactive forms.

Copied to clipboard
import { Component, OnInit, Inject } from '@angular/core';
import { FormBuilder, FormGroup, Validators } from '@angular/forms';
import { BrowserModule } from '@angular/platform-browser';
@Component({
    selector: 'app-root',
    templateUrl: './reactive-form.html'
})
export class AppComponent {
    // defined the array of data
    public skillset: string[] = [
                                      'ASP.NET', 'ActionScript', 'Basic',
                                      'C++' , 'C#' , 'dBase' , 'Delphi' ,
                                      'ESPOL' , 'F#' , 'FoxPro' , 'Java',
                                      'J#' , 'Lisp' , 'Logo' , 'PHP'
                                  ];
    public placeholder: String = 'e.g: ActionScript';
    skillForm: FormGroup;
    fb: FormBuilder;

    constructor(@Inject(FormBuilder) private builder: FormBuilder) {
        this.fb = builder;
        this.createForm();
    }
    createForm() {
        this.skillForm = this.fb.group({
            skillname: ['', Validators.required],
            sname: ['', Validators.required],
            smail: ['', Validators.required]
        });
    }
}
Copied to clipboard
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { FormsModule, ReactiveFormsModule } from '@angular/forms';
import { AppComponent } from './app.component';
import { AutoCompleteModule } from '@syncfusion/ej2-angular-dropdowns';
import { ButtonModule } from '@syncfusion/ej2-angular-buttons';
/**
 * Module
 */
@NgModule({
    imports: [
        BrowserModule,FormsModule, ReactiveFormsModule, AutoCompleteModule, ButtonModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent]
})
export class AppModule { }
Copied to clipboard
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { enableProdMode } from '@angular/core';
import { AppModule } from './app.module';

enableProdMode();
platformBrowserDynamic().bootstrapModule(AppModule);
Copied to clipboard
<!DOCTYPE html>
<html lang="en">

<head>
            <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js"></script>
    <title>Angular AutoComplete</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="description" content="Typescript Toolbar Controls" />
    <meta name="author" content="Syncfusion" />
    <link href="index.css" rel="stylesheet" />
    <link href="//cdn.syncfusion.com/ej2/20.4.38/ej2-dropdowns/styles/material.css" rel="stylesheet" />

    <script src="https://cdnjs.cloudflare.com/ajax/libs/core-js/2.4.1/core.min.js"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/zone.js/0.6.25/zone.min.js"></script>
    <script src="https://unpkg.com/reflect-metadata@0.1.3"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
    <script src="systemjs.config.js"></script>
</head>

<body>
    <div class="row" style="width:500px">
        <div class="col-xs-7 col-sm-7 col-lg-7 col-md-7" style="padding-top:20px;">
            <div style="webkit-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
   box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
   margin:0 auto;height:330px;">
                <div style="padding:30px;">
                    <form [formGroup]="skillForm" novalidate id="formId">
                        <div class="form-group">
                            <ejs-autocomplete formControlName="skillname" name="skillname" [dataSource]='skillset'
                                [placeholder]='placeholder' floatLabelType='Auto'>
                            </ejs-autocomplete>
                            <div *ngIf="skillForm.controls.skillname.invalid && (skillForm.controls.skillname.dirty || skillForm.controls.skillname.touched)"
                                class="alert alert-danger">
                                <div *ngIf="skillForm.controls.skillname.errors.required">
                                    Value is required.
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding-top:10px;">
                            <div class="e-float-input">
                                <input type="text" formControlName="sname" name="sname" maxlength="10" />
                                <span class="e-float-line e-label-top"></span>
                                <label class="e-float-text e-label-top">Name:</label>
                                <div *ngIf="skillForm.controls.sname.invalid && (skillForm.controls.sname.dirty || skillForm.controls.sname.touched)"
                                    class="alert alert-danger">
                                    <div *ngIf="skillForm.controls.sname.errors.required">
                                        Name is required.
                                    </div>
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding-top:10px;">
                            <div class="e-float-input">
                                <input type="text" formControlName="smail" maxlength="15" />
                                <span class="e-float-line e-label-top"></span>
                                <label class="e-float-text e-label-top">Email:</label>
                                <div *ngIf="skillForm.controls.smail.invalid && (skillForm.controls.smail.dirty || skillForm.controls.smail.touched)"
                                    class="alert alert-danger">
                                    <div *ngIf="skillForm.controls.smail.errors.required">
                                        Email is required.
                                    </div>
                                </div>
                            </div>
                        </div>
                        <div class="form-group" style="padding:10px;">
                            <button ejs-button [disabled]="!skillForm.valid">Done</button>
                            <button ejs-button type="reset" [disabled]="!skillForm.valid">Cancel</button>
                        </div>
                    </form>
                </div>
            </div>
        </div>
        <div class="col-xs-5 col-sm-5 col-lg-5 col-md-5" style="padding-top:20px;">
            <div style="webkit-box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
   box-shadow: 0 2px 2px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
   margin:0 auto;height:330px;">
                <div style="padding:30px;">
                    <div class="form-group">
                        <span style="font-weight:800;">Selected Language: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.get('skillname').value }}</span>
                    </div>
                    <div class="form-group" style="padding-top:50px;">
                        <span style="font-weight:800;">Buyer Name: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.get('sname').value }}</span>
                    </div>
                    <div class="form-group" style="padding-top:50px;">
                        <span style="font-weight:800;">Buyer Mail ID: </span>
                        <span style="font-style:oblique;color:#8a2be2;">
                            {{ skillForm.get('smail').value }}</span>
                    </div>
                </div>
            </div>
        </div>
        <link href='https://unpkg.com/bootstrap@3.3.7/dist/css/bootstrap.min.css' rel='stylesheet' />
    </div>


</body>

</html>