FormsModule

ngmodule

Exports the required providers and directives for template-driven forms, making them available for import by NgModules that import this module.

class FormsModule {
  static withConfig(opts: { warnOnDeprecatedNgFormSelector?: "never" | "once" | "always"; }): ModuleWithProviders<FormsModule>
}

Static methods

withConfig()

Provides options for configuring the template-driven forms module.

`static withConfig(opts: { warnOnDeprecatedNgFormSelector?: "never" | "once" | "always"; }): ModuleWithProviders<FormsModule>`

Parameters

opts

object

An object of configuration options

warnOnDeprecatedNgFormSelector Configures when to emit a warning when the deprecated ngForm selector is used.

Returns

ModuleWithProviders<FormsModule>

Providers

Provider
RadioControlRegistry

Directives

Name	Description
CheckboxControlValueAccessor	A `ControlValueAccessor` for writing a value and listening to changes on a checkbox input element.
CheckboxRequiredValidator	A Directive that adds the `required` validator to checkbox controls marked with the `required` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.
DefaultValueAccessor	The default `ControlValueAccessor` for writing a value and listening to changes on input elements. The accessor is used by the `FormControlDirective`, `FormControlName`, and `NgModel` directives.
EmailValidator	A directive that adds the `email` validator to controls marked with the `email` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.
MaxLengthValidator	A directive that adds max length validation to controls marked with the `maxlength` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.
MinLengthValidator	A directive that adds minimum length validation to controls marked with the `minlength` attribute. The directive is provided with the `NG_VALIDATORS` mult-provider list.
NgControlStatus	Directive automatically applied to Angular form controls that sets CSS classes based on control status.
NgControlStatusGroup	Directive automatically applied to Angular form groups that sets CSS classes based on control status (valid/invalid/dirty/etc).
NgForm	Creates a top-level `FormGroup` instance and binds it to a form to track aggregate form value and validation status.
NgFormSelectorWarning	Deprecated: in Angular v6 and will be removed in Angular v9. This directive is solely used to display warnings when the deprecated `ngForm` selector is used.
NgModel	Creates a `FormControl` instance from a domain model and binds it to a form control element.
NgModelGroup	Creates and binds a `FormGroup` instance to a DOM element.
NgSelectOption	Marks `<option>` as dynamic, so Angular can be notified when options change.
PatternValidator	A directive that adds regex pattern validation to controls marked with the `pattern` attribute. The regex must match the entire control value. The directive is provided with the `NG_VALIDATORS` multi-provider list.
RadioControlValueAccessor	The `ControlValueAccessor` for writing radio control values and listening to radio control changes. The value accessor is used by the `FormControlDirective`, `FormControlName`, and `NgModel` directives.
RequiredValidator	A directive that adds the `required` validator to any controls marked with the `required` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.
SelectControlValueAccessor	The `ControlValueAccessor` for writing select control values and listening to select control changes. The value accessor is used by the `FormControlDirective`, `FormControlName`, and `NgModel` directives.
SelectMultipleControlValueAccessor	The `ControlValueAccessor` for writing multi-select control values and listening to multi-select control changes. The value accessor is used by the `FormControlDirective`, `FormControlName`, and `NgModel` directives.

© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v7.angular.io/api/forms/FormsModule