W3cubDocs

ReactiveFormsModule

ngmodule

Exports the required infrastructure and directives for reactive forms, making them available for import by NgModules that import this module.

class ReactiveFormsModule {
  static withConfig(opts: { warnOnNgModelWithFormControl?: "always" | "never" | "once"; callSetDisabledState?: SetDisabledStateOption; }): ModuleWithProviders<ReactiveFormsModule>
}

Description

Providers associated with this module:

FormBuilder
RadioControlRegistry

Static methods

withConfig()

Provides options for configuring the reactive forms module.

`static withConfig(opts: { warnOnNgModelWithFormControl?: "always" | "never" | "once"; callSetDisabledState?: SetDisabledStateOption; }): ModuleWithProviders<ReactiveFormsModule>`

Parameters

opts

object

An object of configuration options

warnOnNgModelWithFormControl Configures when to emit a warning when an ngModel binding is used with reactive form directives.
callSetDisabledState Configures whether to always call setDisabledState, which is more correct, or to only call it whenDisabled, which is the legacy behavior.

Returns

ModuleWithProviders<ReactiveFormsModule>

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.
FormArrayName	Syncs a nested `FormArray` to a DOM element.
FormControlDirective	Synchronizes a standalone `FormControl` instance to a form control element.
FormControlName	Syncs a `FormControl` in an existing `FormGroup` to a form control element by name.
FormGroupDirective	Binds an existing `FormGroup` or `FormRecord` to a DOM element.
FormGroupName	Syncs a nested `FormGroup` or `FormRecord` to a DOM element.
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.
MaxValidator	A directive which installs the `MaxValidator` for any `formControlName`, `formControl`, or control with `ngModel` that also has a `max` attribute.
MinLengthValidator	A directive that adds minimum length validation to controls marked with the `minlength` attribute. The directive is provided with the `NG_VALIDATORS` multi-provider list.
MinValidator	A directive which installs the `MinValidator` for any `formControlName`, `formControl`, or control with `ngModel` that also has a `min` attribute.
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). On groups, this includes the additional class ng-submitted.
NgSelectOption	Marks `<option>` as dynamic, so Angular can be notified when options change.
NumberValueAccessor	The `ControlValueAccessor` for writing a number value and listening to number input changes. The value accessor is used by the `FormControlDirective`, `FormControlName`, and `NgModel` directives.
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.
RangeValueAccessor	The `ControlValueAccessor` for writing a range value and listening to range input 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–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/forms/ReactiveFormsModule