NgForm
Creates a top-level FormGroup
instance and binds it to a form
to track aggregate form value and validation status.
NgModule
Selectors
Properties
Property | Description |
---|---|
submitted: boolean
|
Read-only.
Returns whether the form submission has been triggered. |
form: FormGroup
|
The |
@Output()
|
Event emitter for the "ngSubmit" event |
@Input('ngFormOptions')
|
Tracks options for the updateOn: Sets the default |
formDirective: Form
|
Read-only.
The directive instance. |
control: FormGroup
|
Read-only.
The internal |
path: string[]
|
Read-only.
Returns an array representing the path to this group. Because this directive always lives at the top level of a form, it is always an empty array. |
controls: {
[key: string]: AbstractControl;
}
|
Read-only.
Returns a map of the controls in this group. |
Inherited from ControlContainer
Inherited from AbstractControlDirective
-
abstract control: AbstractControl | null
-
value: any
-
valid: boolean | null
-
invalid: boolean | null
-
pending: boolean | null
-
disabled: boolean | null
-
enabled: boolean | null
-
errors: ValidationErrors | null
-
pristine: boolean | null
-
dirty: boolean | null
-
touched: boolean | null
-
status: string | null
-
untouched: boolean | null
-
statusChanges: Observable<any> | null
-
valueChanges: Observable<any> | null
-
path: string[] | null
Template variable references
Identifier | Usage |
---|---|
ngForm |
#myTemplateVar="ngForm" |
Description
As soon as you import the FormsModule
, this directive becomes active by default on
all <form>
tags. You don't need to add a special selector.
You optionally export the directive into a local template variable using ngForm
as the key
(ex: #myForm="ngForm"
). This is optional, but useful. Many properties from the underlying
FormGroup
instance are duplicated on the directive itself, so a reference to it
gives you access to the aggregate value and validity status of the form, as well as
user interaction properties like dirty
and touched
.
To register child controls with the form, use NgModel
with a name
attribute. You may use NgModelGroup
to create sub-groups within the form.
If necessary, listen to the directive's ngSubmit
event to be notified when the user has
triggered a form submission. The ngSubmit
event emits the original form
submission event.
In template driven forms, all <form>
tags are automatically tagged as NgForm
.
To import the FormsModule
but skip its usage in some forms,
for example, to use native HTML5 validation, add the ngNoForm
and the <form>
tags won't create an NgForm
directive. In reactive forms, using ngNoForm
is
unnecessary because the <form>
tags are inert. In that case, you would
refrain from using the formGroup
directive.
Migrating from deprecated ngForm selector
Support for using ngForm
element selector has been deprecated in Angular v6 and will be removed
in Angular v9.
This has been deprecated to keep selectors consistent with other core Angular selectors, as element selectors are typically written in kebab-case.
Now deprecated:
<ngForm #myForm="ngForm">
After:
<ng-form #myForm="ngForm">
Listening for form submission
The following example shows how to capture the form values from the "ngSubmit" event.
- import {Component} from '@angular/core';
- import {NgForm} from '@angular/forms';
-
- @Component({
- selector: 'example-app',
- template: `
- <form #f="ngForm" (ngSubmit)="onSubmit(f)" novalidate>
- <input name="first" ngModel required #first="ngModel">
- <input name="last" ngModel>
- <button>Submit</button>
- </form>
-
- <p>First name value: {{ first.value }}</p>
- <p>First name valid: {{ first.valid }}</p>
- <p>Form value: {{ f.value | json }}</p>
- <p>Form valid: {{ f.valid }}</p>
- `,
- })
- export class SimpleFormComp {
- onSubmit(f: NgForm) {
- console.log(f.value); // { first: '', last: '' }
- console.log(f.valid); // false
- }
- }
Setting the update options
The following example shows you how to change the "updateOn" option from its default using ngFormOptions.
<form [ngFormOptions]="{updateOn: 'blur'}">
<input name="one" ngModel> <!-- this ngModel will update on blur -->
</form>
Methods
Lifecycle method called after the view is initialized. For internal use only. |
ParametersThere are no parameters. |
Method that sets up the control directive in this group, re-calculates its value and validity, and adds the instance to the internal list of directives. |
Retrieves the |
|||
Parameters
Returns |
Removes the |
Adds a new |
|||
Parameters
Returns
|
Removes the |
|||
Parameters
Returns
|
Retrieves the |
|||
Parameters
Returns |
Sets the new value for the provided |
Sets the value for this |
Method called when the "submit" event is triggered on the form.
Triggers the |
Method called when the "reset" event is triggered on the form. |
ParametersThere are no parameters. Returns
|
Resets the form to an initial value and resets its submitted status. |