@rxap/forms 19.0.1-dev.2 → 19.0.1-dev.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/README.md +24 -25
- package/compodoc/changelog.html +6 -0
- package/compodoc/dependencies.html +9 -9
- package/compodoc/index.html +26 -17
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/properties.html +4 -1
- package/docs/documentation.json +13986 -15658
- package/docs/html/assets/hierarchy.js +1 -0
- package/docs/{assets → html/assets}/highlight.css +27 -20
- package/docs/html/assets/icons.js +18 -0
- package/docs/html/assets/icons.svg +1 -0
- package/docs/{assets → html/assets}/main.js +5 -4
- package/docs/html/assets/navigation.js +1 -0
- package/docs/html/assets/search.js +1 -0
- package/docs/html/assets/style.css +1611 -0
- package/docs/html/classes/ControlValueAccessor.html +46 -0
- package/docs/html/classes/FormArrayControlManager.html +4 -0
- package/docs/html/classes/FormControlErrorDirective.html +14 -0
- package/docs/html/classes/FormControlMarkDirtyDirective.html +3 -0
- package/docs/html/classes/FormControlMarkPristineDirective.html +3 -0
- package/docs/html/classes/FormControlMarkTouchedDirective.html +3 -0
- package/docs/html/classes/FormControlMarkUntouchedDirective.html +3 -0
- package/docs/html/classes/FormControlNameDirective.html +122 -0
- package/docs/html/classes/FormDirective.html +198 -0
- package/docs/html/classes/FormGroupNameDirective.html +110 -0
- package/docs/html/classes/FormLoadedDirective.html +9 -0
- package/docs/html/classes/FormLoadingDirective.html +9 -0
- package/docs/html/classes/FormLoadingErrorDirective.html +9 -0
- package/docs/html/classes/FormResetDirective.html +7 -0
- package/docs/html/classes/FormSubmitDirective.html +13 -0
- package/docs/html/classes/FormSubmitFailedDirective.html +9 -0
- package/docs/html/classes/FormSubmitInvalidDirective.html +9 -0
- package/docs/html/classes/FormSubmitSuccessfulDirective.html +9 -0
- package/docs/html/classes/FormSubmittingDirective.html +9 -0
- package/docs/html/classes/ParentControlContainerDirective.html +2 -0
- package/docs/html/classes/RxapFormArray.html +528 -0
- package/docs/html/classes/RxapFormBuilder.html +3 -0
- package/docs/html/classes/RxapFormControl.html +453 -0
- package/docs/html/classes/RxapFormGroup.html +499 -0
- package/docs/html/classes/RxapFormsModule.html +2 -0
- package/docs/html/enums/MetadataKeys.html +9 -0
- package/docs/html/functions/ControlAsyncValidator.html +1 -0
- package/docs/html/functions/ControlChange.html +1 -0
- package/docs/html/functions/ControlSetValue.html +1 -0
- package/docs/html/functions/ControlValidator.html +1 -0
- package/docs/html/functions/IsArray.html +1 -0
- package/docs/html/functions/IsBoolean.html +1 -0
- package/docs/html/functions/IsComplex.html +1 -0
- package/docs/html/functions/IsDate.html +1 -0
- package/docs/html/functions/IsEmail.html +1 -0
- package/docs/html/functions/IsEnum.html +1 -0
- package/docs/html/functions/IsIP.html +1 -0
- package/docs/html/functions/IsInt.html +1 -0
- package/docs/html/functions/IsNumber-1.html +2 -0
- package/docs/html/functions/IsObject.html +1 -0
- package/docs/html/functions/IsPhoneNumber.html +1 -0
- package/docs/html/functions/IsPort.html +1 -0
- package/docs/html/functions/IsString.html +1 -0
- package/docs/html/functions/IsUUID.html +1 -0
- package/docs/html/functions/IsUrl.html +1 -0
- package/docs/html/functions/RxapForm.html +1 -0
- package/docs/html/functions/ToFormMethod.html +1 -0
- package/docs/html/functions/ToFormSubmitMethod.html +3 -0
- package/docs/html/functions/ToMethodWithInjectionContext.html +1 -0
- package/docs/html/functions/ToMethodWithInjectionContextFactory.html +1 -0
- package/docs/html/functions/UseFormArrayControl.html +1 -0
- package/docs/html/functions/UseFormArrayGroup.html +1 -0
- package/docs/html/functions/UseFormControl.html +1 -0
- package/docs/html/functions/UseFormGroup.html +1 -0
- package/docs/html/functions/_IsNumber.html +1 -0
- package/docs/html/functions/controlDisabledWhile.html +1 -0
- package/docs/html/functions/controlDisabled_.html +1 -0
- package/docs/html/functions/controlEnabledWhile.html +1 -0
- package/docs/html/functions/controlEnabled_.html +1 -0
- package/docs/html/functions/controlErrorChanges_.html +1 -0
- package/docs/html/functions/controlReadonly_.html +1 -0
- package/docs/html/functions/controlStatusChanges_.html +1 -0
- package/docs/html/functions/controlValueChanges_.html +1 -0
- package/docs/html/functions/disableControl.html +1 -0
- package/docs/html/functions/enableControl.html +1 -0
- package/docs/html/functions/hasErrorAndDirty.html +1 -0
- package/docs/html/functions/hasErrorAndTouched.html +1 -0
- package/docs/html/functions/isNumber.html +2 -0
- package/docs/html/functions/markAllDirty.html +1 -0
- package/docs/html/functions/markAllPristine.html +1 -0
- package/docs/html/functions/markAllUntouched.html +1 -0
- package/docs/html/functions/mergeControlValidators.html +1 -0
- package/docs/html/functions/selectControlValue_.html +1 -0
- package/docs/html/functions/validateControlOn.html +1 -0
- package/docs/html/hierarchy.html +1 -0
- package/docs/html/index.html +33 -0
- package/docs/html/interfaces/AbstractControl.html +387 -0
- package/docs/html/interfaces/AbstractControlOptions.html +7 -0
- package/docs/html/interfaces/BoxedValue.html +3 -0
- package/docs/html/interfaces/ComplexityOptions.html +11 -0
- package/docs/html/interfaces/ControlOptions.html +20 -0
- package/docs/html/interfaces/ControlSetValueOptions.html +3 -0
- package/docs/html/interfaces/FormArrayOptions.html +16 -0
- package/docs/html/interfaces/FormDefinition.html +13 -0
- package/docs/html/interfaces/FormDefinitionArray.html +176 -0
- package/docs/html/interfaces/FormDefinitionMetadata.html +17 -0
- package/docs/html/interfaces/FormGroupOptions.html +13 -0
- package/docs/html/interfaces/FormLoadFailedMethod.html +3 -0
- package/docs/html/interfaces/FormLoadMethod.html +3 -0
- package/docs/html/interfaces/FormLoadSuccessfulMethod.html +3 -0
- package/docs/html/interfaces/FormOptions.html +13 -0
- package/docs/html/interfaces/FormSubmitFailedMethod.html +3 -0
- package/docs/html/interfaces/FormSubmitMethod.html +3 -0
- package/docs/html/interfaces/FormSubmitSuccessfulMethod.html +3 -0
- package/docs/html/interfaces/InjectableValidator.html +3 -0
- package/docs/html/interfaces/IsNumberOptions.html +6 -0
- package/docs/html/interfaces/NgValidatorsErrors.html +8 -0
- package/docs/html/interfaces/RxapAbstractControlOptionsWithDefinition.html +13 -0
- package/docs/html/interfaces/_RxapAbstractControlOptions.html +12 -0
- package/docs/html/modules.html +1 -0
- package/docs/html/types/AsyncValidator.html +1 -0
- package/docs/html/types/AsyncValidatorFn.html +1 -0
- package/docs/html/types/ChangeFn.html +1 -0
- package/docs/html/types/ControlEventOptions.html +1 -0
- package/docs/html/types/ControlInsertedFn.html +1 -0
- package/docs/html/types/ControlPath.html +1 -0
- package/docs/html/types/ControlRemovedFn.html +1 -0
- package/docs/html/types/ControlState.html +1 -0
- package/docs/html/types/EmitEvent.html +1 -0
- package/docs/html/types/ExtractAbstractControl.html +1 -0
- package/docs/html/types/ExtractStrings.html +1 -0
- package/docs/html/types/FormBuilderFn.html +1 -0
- package/docs/html/types/FormType.html +1 -0
- package/docs/html/types/KeyValueControls.html +1 -0
- package/docs/html/types/OnlySelf.html +1 -0
- package/docs/html/types/OrBoxedValue.html +1 -0
- package/docs/html/types/RxapAbstractControlOptions.html +1 -0
- package/docs/html/types/SetValueFn.html +1 -0
- package/docs/html/types/ValidationErrors.html +1 -0
- package/docs/html/types/Validator.html +1 -0
- package/docs/html/types/ValidatorFn.html +1 -0
- package/docs/html/types/ValidatorOrOpts.html +1 -0
- package/docs/html/variables/RXAP_FORM_CONTEXT.html +1 -0
- package/docs/html/variables/RXAP_FORM_DEFINITION.html +1 -0
- package/docs/html/variables/RXAP_FORM_DEFINITION_BUILDER.html +1 -0
- package/docs/html/variables/RXAP_FORM_INITIAL_STATE.html +1 -0
- package/docs/html/variables/RXAP_FORM_LOAD_FAILED_METHOD.html +1 -0
- package/docs/html/variables/RXAP_FORM_LOAD_METHOD.html +1 -0
- package/docs/html/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.html +1 -0
- package/docs/html/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.html +1 -0
- package/docs/html/variables/RXAP_FORM_SUBMIT_METHOD.html +1 -0
- package/docs/html/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.html +1 -0
- package/docs/html/variables/RxapValidators.html +1 -0
- package/docs/markdown/README.md +37 -0
- package/docs/markdown/classes/ControlValueAccessor.md +230 -0
- package/docs/markdown/classes/FormArrayControlManager.md +75 -0
- package/docs/markdown/classes/FormControlErrorDirective.md +101 -0
- package/docs/markdown/classes/FormControlMarkDirtyDirective.md +39 -0
- package/docs/markdown/classes/FormControlMarkPristineDirective.md +39 -0
- package/docs/markdown/classes/FormControlMarkTouchedDirective.md +39 -0
- package/docs/markdown/classes/FormControlMarkUntouchedDirective.md +39 -0
- package/docs/markdown/classes/FormControlNameDirective.md +816 -0
- package/docs/markdown/classes/FormDirective.md +1596 -0
- package/docs/markdown/classes/FormGroupNameDirective.md +707 -0
- package/docs/markdown/classes/FormLoadedDirective.md +79 -0
- package/docs/markdown/classes/FormLoadingDirective.md +79 -0
- package/docs/markdown/classes/FormLoadingErrorDirective.md +79 -0
- package/docs/markdown/classes/FormResetDirective.md +115 -0
- package/docs/markdown/classes/FormSubmitDirective.md +178 -0
- package/docs/markdown/classes/FormSubmitFailedDirective.md +79 -0
- package/docs/markdown/classes/FormSubmitInvalidDirective.md +79 -0
- package/docs/markdown/classes/FormSubmitSuccessfulDirective.md +79 -0
- package/docs/markdown/classes/FormSubmittingDirective.md +79 -0
- package/docs/markdown/classes/ParentControlContainerDirective.md +19 -0
- package/docs/markdown/classes/RxapFormArray.md +2645 -0
- package/docs/markdown/classes/RxapFormBuilder.md +67 -0
- package/docs/markdown/classes/RxapFormControl.md +2204 -0
- package/docs/markdown/classes/RxapFormGroup.md +3002 -0
- package/docs/markdown/classes/RxapFormsModule.md +19 -0
- package/docs/markdown/enumerations/MetadataKeys.md +73 -0
- package/docs/markdown/functions/ControlAsyncValidator.md +35 -0
- package/docs/markdown/functions/ControlChange.md +35 -0
- package/docs/markdown/functions/ControlSetValue.md +39 -0
- package/docs/markdown/functions/ControlValidator.md +35 -0
- package/docs/markdown/functions/IsArray.md +33 -0
- package/docs/markdown/functions/IsBoolean.md +33 -0
- package/docs/markdown/functions/IsComplex.md +37 -0
- package/docs/markdown/functions/IsDate.md +33 -0
- package/docs/markdown/functions/IsEmail.md +37 -0
- package/docs/markdown/functions/IsEnum.md +37 -0
- package/docs/markdown/functions/IsIP.md +37 -0
- package/docs/markdown/functions/IsInt.md +37 -0
- package/docs/markdown/functions/IsNumber-2.md +25 -0
- package/docs/markdown/functions/IsNumber.md +37 -0
- package/docs/markdown/functions/IsObject.md +33 -0
- package/docs/markdown/functions/IsPhoneNumber.md +41 -0
- package/docs/markdown/functions/IsPort.md +33 -0
- package/docs/markdown/functions/IsString.md +33 -0
- package/docs/markdown/functions/IsUUID.md +37 -0
- package/docs/markdown/functions/IsUrl.md +37 -0
- package/docs/markdown/functions/RxapForm.md +39 -0
- package/docs/markdown/functions/ToFormMethod.md +31 -0
- package/docs/markdown/functions/ToFormSubmitMethod.md +31 -0
- package/docs/markdown/functions/ToMethodWithInjectionContext.md +37 -0
- package/docs/markdown/functions/ToMethodWithInjectionContextFactory.md +43 -0
- package/docs/markdown/functions/UseFormArrayControl.md +35 -0
- package/docs/markdown/functions/UseFormArrayGroup.md +39 -0
- package/docs/markdown/functions/UseFormControl.md +35 -0
- package/docs/markdown/functions/UseFormGroup.md +39 -0
- package/docs/markdown/functions/controlDisabled$.md +25 -0
- package/docs/markdown/functions/controlDisabledWhile.md +33 -0
- package/docs/markdown/functions/controlEnabled$.md +25 -0
- package/docs/markdown/functions/controlEnabledWhile.md +33 -0
- package/docs/markdown/functions/controlErrorChanges$.md +25 -0
- package/docs/markdown/functions/controlReadonly$.md +25 -0
- package/docs/markdown/functions/controlStatusChanges$.md +25 -0
- package/docs/markdown/functions/controlValueChanges$.md +25 -0
- package/docs/markdown/functions/disableControl.md +33 -0
- package/docs/markdown/functions/enableControl.md +33 -0
- package/docs/markdown/functions/hasErrorAndDirty.md +33 -0
- package/docs/markdown/functions/hasErrorAndTouched.md +33 -0
- package/docs/markdown/functions/isNumber-1.md +27 -0
- package/docs/markdown/functions/markAllDirty.md +25 -0
- package/docs/markdown/functions/markAllPristine.md +25 -0
- package/docs/markdown/functions/markAllUntouched.md +25 -0
- package/docs/markdown/functions/mergeControlValidators.md +31 -0
- package/docs/markdown/functions/selectControlValue$.md +31 -0
- package/docs/markdown/functions/validateControlOn.md +29 -0
- package/docs/markdown/globals.md +153 -0
- package/docs/markdown/interfaces/AbstractControl.md +1691 -0
- package/docs/markdown/interfaces/AbstractControlOptions.md +67 -0
- package/docs/markdown/interfaces/BoxedValue.md +29 -0
- package/docs/markdown/interfaces/ComplexityOptions.md +89 -0
- package/docs/markdown/interfaces/ControlOptions.md +85 -0
- package/docs/markdown/interfaces/ControlSetValueOptions.md +25 -0
- package/docs/markdown/interfaces/FormArrayOptions.md +157 -0
- package/docs/markdown/interfaces/FormDefinition.md +80 -0
- package/docs/markdown/interfaces/FormDefinitionArray.md +1443 -0
- package/docs/markdown/interfaces/FormDefinitionMetadata.md +156 -0
- package/docs/markdown/interfaces/FormGroupOptions.md +133 -0
- package/docs/markdown/interfaces/FormLoadFailedMethod.md +47 -0
- package/docs/markdown/interfaces/FormLoadMethod.md +45 -0
- package/docs/markdown/interfaces/FormLoadSuccessfulMethod.md +51 -0
- package/docs/markdown/interfaces/FormOptions.md +137 -0
- package/docs/markdown/interfaces/FormSubmitFailedMethod.md +47 -0
- package/docs/markdown/interfaces/FormSubmitMethod.md +55 -0
- package/docs/markdown/interfaces/FormSubmitSuccessfulMethod.md +51 -0
- package/docs/markdown/interfaces/InjectableValidator.md +25 -0
- package/docs/markdown/interfaces/IsNumberOptions.md +43 -0
- package/docs/markdown/interfaces/NgValidatorsErrors.md +105 -0
- package/docs/markdown/interfaces/RxapAbstractControlOptions.md +103 -0
- package/docs/markdown/interfaces/RxapAbstractControlOptionsWithDefinition.md +133 -0
- package/docs/markdown/type-aliases/AsyncValidator.md +11 -0
- package/docs/markdown/type-aliases/AsyncValidatorFn.md +27 -0
- package/docs/markdown/type-aliases/ChangeFn.md +29 -0
- package/docs/markdown/type-aliases/ControlEventOptions.md +11 -0
- package/docs/markdown/type-aliases/ControlInsertedFn.md +25 -0
- package/docs/markdown/type-aliases/ControlPath.md +11 -0
- package/docs/markdown/type-aliases/ControlRemovedFn.md +21 -0
- package/docs/markdown/type-aliases/ControlState.md +11 -0
- package/docs/markdown/type-aliases/EmitEvent.md +11 -0
- package/docs/markdown/type-aliases/ExtractAbstractControl.md +17 -0
- package/docs/markdown/type-aliases/ExtractStrings.md +15 -0
- package/docs/markdown/type-aliases/FormBuilderFn.md +33 -0
- package/docs/markdown/type-aliases/FormType.md +15 -0
- package/docs/markdown/type-aliases/KeyValueControls.md +15 -0
- package/docs/markdown/type-aliases/OnlySelf.md +11 -0
- package/docs/markdown/type-aliases/OrBoxedValue.md +15 -0
- package/docs/markdown/type-aliases/RxapAbstractControlOptions.md +15 -0
- package/docs/markdown/type-aliases/SetValueFn.md +29 -0
- package/docs/markdown/type-aliases/ValidationErrors.md +15 -0
- package/docs/markdown/type-aliases/Validator.md +11 -0
- package/docs/markdown/type-aliases/ValidatorFn.md +27 -0
- package/docs/markdown/type-aliases/ValidatorOrOpts.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_CONTEXT.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_DEFINITION.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_DEFINITION_BUILDER.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_INITIAL_STATE.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_LOAD_FAILED_METHOD.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_LOAD_METHOD.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_SUBMIT_METHOD.md +11 -0
- package/docs/markdown/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.md +11 -0
- package/docs/markdown/variables/RxapValidators.md +443 -0
- package/docs/wiki/Class.ControlValueAccessor.md +226 -0
- package/docs/wiki/Class.FormArrayControlManager.md +71 -0
- package/docs/wiki/Class.FormControlErrorDirective.md +97 -0
- package/docs/wiki/Class.FormControlMarkDirtyDirective.md +35 -0
- package/docs/wiki/Class.FormControlMarkPristineDirective.md +35 -0
- package/docs/wiki/Class.FormControlMarkTouchedDirective.md +35 -0
- package/docs/wiki/Class.FormControlMarkUntouchedDirective.md +35 -0
- package/docs/wiki/Class.FormControlNameDirective.md +812 -0
- package/docs/wiki/Class.FormDirective.md +1592 -0
- package/docs/wiki/Class.FormGroupNameDirective.md +703 -0
- package/docs/wiki/Class.FormLoadedDirective.md +75 -0
- package/docs/wiki/Class.FormLoadingDirective.md +75 -0
- package/docs/wiki/Class.FormLoadingErrorDirective.md +75 -0
- package/docs/wiki/Class.FormResetDirective.md +111 -0
- package/docs/wiki/Class.FormSubmitDirective.md +174 -0
- package/docs/wiki/Class.FormSubmitFailedDirective.md +75 -0
- package/docs/wiki/Class.FormSubmitInvalidDirective.md +75 -0
- package/docs/wiki/Class.FormSubmitSuccessfulDirective.md +75 -0
- package/docs/wiki/Class.FormSubmittingDirective.md +75 -0
- package/docs/wiki/Class.ParentControlContainerDirective.md +15 -0
- package/docs/wiki/Class.RxapFormArray.md +2641 -0
- package/docs/wiki/Class.RxapFormBuilder.md +63 -0
- package/docs/wiki/Class.RxapFormControl.md +2200 -0
- package/docs/wiki/Class.RxapFormGroup.md +2998 -0
- package/docs/wiki/Class.RxapFormsModule.md +15 -0
- package/docs/wiki/Enumeration.MetadataKeys.md +69 -0
- package/docs/wiki/Function.ControlAsyncValidator.md +31 -0
- package/docs/wiki/Function.ControlChange.md +31 -0
- package/docs/wiki/Function.ControlSetValue.md +35 -0
- package/docs/wiki/Function.ControlValidator.md +31 -0
- package/docs/wiki/Function.IsArray.md +29 -0
- package/docs/wiki/Function.IsBoolean.md +29 -0
- package/docs/wiki/Function.IsComplex.md +33 -0
- package/docs/wiki/Function.IsDate.md +29 -0
- package/docs/wiki/Function.IsEmail.md +33 -0
- package/docs/wiki/Function.IsEnum.md +33 -0
- package/docs/wiki/Function.IsIP.md +33 -0
- package/docs/wiki/Function.IsInt.md +33 -0
- package/docs/wiki/Function.IsNumber.md +21 -0
- package/docs/wiki/Function.IsObject.md +29 -0
- package/docs/wiki/Function.IsPhoneNumber.md +37 -0
- package/docs/wiki/Function.IsPort.md +29 -0
- package/docs/wiki/Function.IsString.md +29 -0
- package/docs/wiki/Function.IsUUID.md +33 -0
- package/docs/wiki/Function.IsUrl.md +33 -0
- package/docs/wiki/Function.RxapForm.md +35 -0
- package/docs/wiki/Function.ToFormMethod.md +27 -0
- package/docs/wiki/Function.ToFormSubmitMethod.md +27 -0
- package/docs/wiki/Function.ToMethodWithInjectionContext.md +33 -0
- package/docs/wiki/Function.ToMethodWithInjectionContextFactory.md +39 -0
- package/docs/wiki/Function.UseFormArrayControl.md +31 -0
- package/docs/wiki/Function.UseFormArrayGroup.md +35 -0
- package/docs/wiki/Function.UseFormControl.md +31 -0
- package/docs/wiki/Function.UseFormGroup.md +35 -0
- package/docs/wiki/Function._IsNumber.md +33 -0
- package/docs/wiki/Function.controlDisabled$.md +21 -0
- package/docs/wiki/Function.controlDisabledWhile.md +29 -0
- package/docs/wiki/Function.controlEnabled$.md +21 -0
- package/docs/wiki/Function.controlEnabledWhile.md +29 -0
- package/docs/wiki/Function.controlErrorChanges$.md +21 -0
- package/docs/wiki/Function.controlReadonly$.md +21 -0
- package/docs/wiki/Function.controlStatusChanges$.md +21 -0
- package/docs/wiki/Function.controlValueChanges$.md +21 -0
- package/docs/wiki/Function.disableControl.md +29 -0
- package/docs/wiki/Function.enableControl.md +29 -0
- package/docs/wiki/Function.hasErrorAndDirty.md +29 -0
- package/docs/wiki/Function.hasErrorAndTouched.md +29 -0
- package/docs/wiki/Function.isNumber.md +23 -0
- package/docs/wiki/Function.markAllDirty.md +21 -0
- package/docs/wiki/Function.markAllPristine.md +21 -0
- package/docs/wiki/Function.markAllUntouched.md +21 -0
- package/docs/wiki/Function.mergeControlValidators.md +27 -0
- package/docs/wiki/Function.selectControlValue$.md +27 -0
- package/docs/wiki/Function.validateControlOn.md +25 -0
- package/docs/wiki/Home.md +33 -0
- package/docs/wiki/Interface.AbstractControl.md +1687 -0
- package/docs/wiki/Interface.AbstractControlOptions.md +63 -0
- package/docs/wiki/Interface.BoxedValue.md +25 -0
- package/docs/wiki/Interface.ComplexityOptions.md +85 -0
- package/docs/wiki/Interface.ControlOptions.md +81 -0
- package/docs/wiki/Interface.ControlSetValueOptions.md +21 -0
- package/docs/wiki/Interface.FormArrayOptions.md +153 -0
- package/docs/wiki/Interface.FormDefinition.md +76 -0
- package/docs/wiki/Interface.FormDefinitionArray.md +1439 -0
- package/docs/wiki/Interface.FormDefinitionMetadata.md +152 -0
- package/docs/wiki/Interface.FormGroupOptions.md +129 -0
- package/docs/wiki/Interface.FormLoadFailedMethod.md +43 -0
- package/docs/wiki/Interface.FormLoadMethod.md +41 -0
- package/docs/wiki/Interface.FormLoadSuccessfulMethod.md +47 -0
- package/docs/wiki/Interface.FormOptions.md +133 -0
- package/docs/wiki/Interface.FormSubmitFailedMethod.md +43 -0
- package/docs/wiki/Interface.FormSubmitMethod.md +51 -0
- package/docs/wiki/Interface.FormSubmitSuccessfulMethod.md +47 -0
- package/docs/wiki/Interface.InjectableValidator.md +21 -0
- package/docs/wiki/Interface.IsNumberOptions.md +39 -0
- package/docs/wiki/Interface.NgValidatorsErrors.md +101 -0
- package/docs/wiki/Interface.RxapAbstractControlOptionsWithDefinition.md +129 -0
- package/docs/wiki/Interface._RxapAbstractControlOptions.md +99 -0
- package/docs/wiki/TypeAlias.AsyncValidator.md +7 -0
- package/docs/wiki/TypeAlias.AsyncValidatorFn.md +23 -0
- package/docs/wiki/TypeAlias.ChangeFn.md +25 -0
- package/docs/wiki/TypeAlias.ControlEventOptions.md +7 -0
- package/docs/wiki/TypeAlias.ControlInsertedFn.md +21 -0
- package/docs/wiki/TypeAlias.ControlPath.md +7 -0
- package/docs/wiki/TypeAlias.ControlRemovedFn.md +17 -0
- package/docs/wiki/TypeAlias.ControlState.md +7 -0
- package/docs/wiki/TypeAlias.EmitEvent.md +7 -0
- package/docs/wiki/TypeAlias.ExtractAbstractControl.md +13 -0
- package/docs/wiki/TypeAlias.ExtractStrings.md +11 -0
- package/docs/wiki/TypeAlias.FormBuilderFn.md +29 -0
- package/docs/wiki/TypeAlias.FormType.md +11 -0
- package/docs/wiki/TypeAlias.KeyValueControls.md +11 -0
- package/docs/wiki/TypeAlias.OnlySelf.md +7 -0
- package/docs/wiki/TypeAlias.OrBoxedValue.md +11 -0
- package/docs/wiki/TypeAlias.RxapAbstractControlOptions.md +11 -0
- package/docs/wiki/TypeAlias.SetValueFn.md +25 -0
- package/docs/wiki/TypeAlias.ValidationErrors.md +11 -0
- package/docs/wiki/TypeAlias.Validator.md +7 -0
- package/docs/wiki/TypeAlias.ValidatorFn.md +23 -0
- package/docs/wiki/TypeAlias.ValidatorOrOpts.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_CONTEXT.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_DEFINITION.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_DEFINITION_BUILDER.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_INITIAL_STATE.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_LOAD_FAILED_METHOD.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_LOAD_METHOD.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_LOAD_SUCCESSFUL_METHOD.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_SUBMIT_FAILED_METHOD.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_SUBMIT_METHOD.md +7 -0
- package/docs/wiki/Variable.RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.md +7 -0
- package/docs/wiki/Variable.RxapValidators.md +439 -0
- package/docs/wiki/_Sidebar.md +149 -0
- package/docs/wiki/globals.md +149 -0
- package/package.json +21 -19
- package/docs/assets/icons.js +0 -15
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1412
- package/docs/classes/ControlValueAccessor.html +0 -8
- package/docs/classes/FormArrayControlManager.html +0 -6
- package/docs/classes/FormControlErrorDirective.html +0 -11
- package/docs/classes/FormControlMarkDirtyDirective.html +0 -4
- package/docs/classes/FormControlMarkPristineDirective.html +0 -4
- package/docs/classes/FormControlMarkTouchedDirective.html +0 -4
- package/docs/classes/FormControlMarkUntouchedDirective.html +0 -4
- package/docs/classes/FormControlNameDirective.html +0 -113
- package/docs/classes/FormDirective.html +0 -188
- package/docs/classes/FormGroupNameDirective.html +0 -101
- package/docs/classes/FormLoadedDirective.html +0 -8
- package/docs/classes/FormLoadingDirective.html +0 -8
- package/docs/classes/FormLoadingErrorDirective.html +0 -8
- package/docs/classes/FormResetDirective.html +0 -8
- package/docs/classes/FormSubmitDirective.html +0 -15
- package/docs/classes/FormSubmitFailedDirective.html +0 -8
- package/docs/classes/FormSubmitInvalidDirective.html +0 -8
- package/docs/classes/FormSubmitSuccessfulDirective.html +0 -8
- package/docs/classes/FormSubmittingDirective.html +0 -8
- package/docs/classes/ParentControlContainerDirective.html +0 -2
- package/docs/classes/RxapFormArray.html +0 -425
- package/docs/classes/RxapFormBuilder.html +0 -65
- package/docs/classes/RxapFormControl.html +0 -264
- package/docs/classes/RxapFormGroup.html +0 -260
- package/docs/classes/RxapFormsModule.html +0 -2
- package/docs/enums/MetadataKeys.html +0 -9
- package/docs/functions/ControlAsyncValidator.html +0 -1
- package/docs/functions/ControlChange.html +0 -1
- package/docs/functions/ControlSetValue.html +0 -1
- package/docs/functions/ControlValidator.html +0 -1
- package/docs/functions/IsArray.html +0 -1
- package/docs/functions/IsBoolean.html +0 -1
- package/docs/functions/IsComplex.html +0 -1
- package/docs/functions/IsDate.html +0 -1
- package/docs/functions/IsEmail.html +0 -1
- package/docs/functions/IsEnum.html +0 -1
- package/docs/functions/IsIP.html +0 -1
- package/docs/functions/IsInt.html +0 -1
- package/docs/functions/IsNumber.html +0 -2
- package/docs/functions/IsObject.html +0 -1
- package/docs/functions/IsPhoneNumber.html +0 -1
- package/docs/functions/IsPort.html +0 -1
- package/docs/functions/IsString.html +0 -1
- package/docs/functions/IsUUID.html +0 -1
- package/docs/functions/IsUrl.html +0 -1
- package/docs/functions/RxapForm.html +0 -1
- package/docs/functions/ToFormMethod.html +0 -1
- package/docs/functions/ToFormSubmitMethod.html +0 -3
- package/docs/functions/ToMethodWithInjectionContext.html +0 -1
- package/docs/functions/ToMethodWithInjectionContextFactory.html +0 -1
- package/docs/functions/UseFormArrayControl.html +0 -1
- package/docs/functions/UseFormArrayGroup.html +0 -1
- package/docs/functions/UseFormControl.html +0 -1
- package/docs/functions/UseFormGroup.html +0 -1
- package/docs/functions/_IsNumber.html +0 -1
- package/docs/functions/controlDisabledWhile.html +0 -1
- package/docs/functions/controlDisabled_.html +0 -1
- package/docs/functions/controlEnabledWhile.html +0 -1
- package/docs/functions/controlEnabled_.html +0 -1
- package/docs/functions/controlErrorChanges_.html +0 -1
- package/docs/functions/controlReadonly_.html +0 -1
- package/docs/functions/controlStatusChanges_.html +0 -1
- package/docs/functions/controlValueChanges_.html +0 -1
- package/docs/functions/disableControl.html +0 -1
- package/docs/functions/enableControl.html +0 -1
- package/docs/functions/hasErrorAndDirty.html +0 -1
- package/docs/functions/hasErrorAndTouched.html +0 -1
- package/docs/functions/isNumber-1.html +0 -2
- package/docs/functions/markAllDirty.html +0 -1
- package/docs/functions/markAllPristine.html +0 -1
- package/docs/functions/markAllUntouched.html +0 -1
- package/docs/functions/mergeControlValidators.html +0 -1
- package/docs/functions/selectControlValue_.html +0 -1
- package/docs/functions/validateControlOn.html +0 -1
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -25
- package/docs/interfaces/AbstractControl.html +0 -373
- package/docs/interfaces/AbstractControlOptions.html +0 -5
- package/docs/interfaces/BoxedValue.html +0 -3
- package/docs/interfaces/ComplexityOptions.html +0 -11
- package/docs/interfaces/ControlOptions.html +0 -20
- package/docs/interfaces/ControlSetValueOptions.html +0 -3
- package/docs/interfaces/FormArrayOptions.html +0 -16
- package/docs/interfaces/FormDefinition.html +0 -13
- package/docs/interfaces/FormDefinitionArray.html +0 -175
- package/docs/interfaces/FormDefinitionMetadata.html +0 -17
- package/docs/interfaces/FormGroupOptions.html +0 -13
- package/docs/interfaces/FormLoadFailedMethod.html +0 -3
- package/docs/interfaces/FormLoadMethod.html +0 -3
- package/docs/interfaces/FormLoadSuccessfulMethod.html +0 -3
- package/docs/interfaces/FormOptions.html +0 -13
- package/docs/interfaces/FormSubmitFailedMethod.html +0 -3
- package/docs/interfaces/FormSubmitMethod.html +0 -3
- package/docs/interfaces/FormSubmitSuccessfulMethod.html +0 -3
- package/docs/interfaces/InjectableValidator.html +0 -3
- package/docs/interfaces/IsNumberOptions.html +0 -6
- package/docs/interfaces/NgValidatorsErrors.html +0 -8
- package/docs/interfaces/RxapAbstractControlOptionsWithDefinition.html +0 -13
- package/docs/interfaces/_RxapAbstractControlOptions.html +0 -12
- package/docs/modules.html +0 -131
- package/docs/types/AsyncValidator.html +0 -1
- package/docs/types/AsyncValidatorFn.html +0 -1
- package/docs/types/ChangeFn.html +0 -1
- package/docs/types/ControlEventOptions.html +0 -1
- package/docs/types/ControlInsertedFn.html +0 -1
- package/docs/types/ControlPath.html +0 -1
- package/docs/types/ControlRemovedFn.html +0 -1
- package/docs/types/ControlState.html +0 -1
- package/docs/types/EmitEvent.html +0 -1
- package/docs/types/ExtractAbstractControl.html +0 -1
- package/docs/types/ExtractStrings.html +0 -1
- package/docs/types/FormBuilderFn.html +0 -1
- package/docs/types/FormType.html +0 -1
- package/docs/types/KeyValueControls.html +0 -1
- package/docs/types/OnlySelf.html +0 -1
- package/docs/types/OrBoxedValue.html +0 -1
- package/docs/types/RxapAbstractControlOptions.html +0 -1
- package/docs/types/SetValueFn.html +0 -1
- package/docs/types/ValidationErrors.html +0 -1
- package/docs/types/Validator.html +0 -1
- package/docs/types/ValidatorFn.html +0 -1
- package/docs/types/ValidatorOrOpts.html +0 -1
- package/docs/variables/RXAP_FORM_CONTEXT.html +0 -1
- package/docs/variables/RXAP_FORM_DEFINITION.html +0 -1
- package/docs/variables/RXAP_FORM_DEFINITION_BUILDER.html +0 -1
- package/docs/variables/RXAP_FORM_INITIAL_STATE.html +0 -1
- package/docs/variables/RXAP_FORM_LOAD_FAILED_METHOD.html +0 -1
- package/docs/variables/RXAP_FORM_LOAD_METHOD.html +0 -1
- package/docs/variables/RXAP_FORM_LOAD_SUCCESSFUL_METHOD.html +0 -1
- package/docs/variables/RXAP_FORM_SUBMIT_FAILED_METHOD.html +0 -1
- package/docs/variables/RXAP_FORM_SUBMIT_METHOD.html +0 -1
- package/docs/variables/RXAP_FORM_SUBMIT_SUCCESSFUL_METHOD.html +0 -1
- package/docs/variables/RxapValidators.html +0 -1
- /package/docs/{.nojekyll → html/.nojekyll} +0 -0
|
@@ -0,0 +1,1592 @@
|
|
|
1
|
+
[@rxap/forms](../wiki/globals) / FormDirective
|
|
2
|
+
|
|
3
|
+
# Class: FormDirective\<T\>
|
|
4
|
+
|
|
5
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:113](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L113)
|
|
6
|
+
|
|
7
|
+
## Extends
|
|
8
|
+
|
|
9
|
+
- `FormGroupDirective`
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
• **T** = `any`
|
|
14
|
+
|
|
15
|
+
## Implements
|
|
16
|
+
|
|
17
|
+
- `OnInit`
|
|
18
|
+
- `OnChanges`
|
|
19
|
+
- `OnDestroy`
|
|
20
|
+
|
|
21
|
+
## Constructors
|
|
22
|
+
|
|
23
|
+
### new FormDirective()
|
|
24
|
+
|
|
25
|
+
> **new FormDirective**\<`T`\>(`cdr`, `formDefinition`, `submitMethod`, `loadMethod`, `loadFailedMethod`, `loadSuccessfulMethod`, `submitFailedMethod`, `submitSuccessfulMethod`, `formDefinitionBuilder`, `loadingIndicatorService`): [`FormDirective`](../wiki/Class.FormDirective)\<`T`\>
|
|
26
|
+
|
|
27
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:205](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L205)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
##### cdr
|
|
32
|
+
|
|
33
|
+
`ChangeDetectorRef`
|
|
34
|
+
|
|
35
|
+
##### formDefinition
|
|
36
|
+
|
|
37
|
+
`null` | [`FormDefinition`](../wiki/Interface.FormDefinition)\<`any`, `any`, `any`\>
|
|
38
|
+
|
|
39
|
+
##### submitMethod
|
|
40
|
+
|
|
41
|
+
`null` | [`FormSubmitMethod`](../wiki/Interface.FormSubmitMethod)\<`any`\>
|
|
42
|
+
|
|
43
|
+
##### loadMethod
|
|
44
|
+
|
|
45
|
+
`null` | [`FormLoadMethod`](../wiki/Interface.FormLoadMethod)\<`any`\>
|
|
46
|
+
|
|
47
|
+
##### loadFailedMethod
|
|
48
|
+
|
|
49
|
+
`null` | [`FormLoadFailedMethod`](../wiki/Interface.FormLoadFailedMethod)
|
|
50
|
+
|
|
51
|
+
##### loadSuccessfulMethod
|
|
52
|
+
|
|
53
|
+
`null` | [`FormLoadSuccessfulMethod`](../wiki/Interface.FormLoadSuccessfulMethod)\<`any`\>
|
|
54
|
+
|
|
55
|
+
##### submitFailedMethod
|
|
56
|
+
|
|
57
|
+
`null` | [`FormSubmitFailedMethod`](../wiki/Interface.FormSubmitFailedMethod)
|
|
58
|
+
|
|
59
|
+
##### submitSuccessfulMethod
|
|
60
|
+
|
|
61
|
+
`null` | [`FormSubmitSuccessfulMethod`](../wiki/Interface.FormSubmitSuccessfulMethod)\<`any`\>
|
|
62
|
+
|
|
63
|
+
##### formDefinitionBuilder
|
|
64
|
+
|
|
65
|
+
`null` | [`RxapFormBuilder`](../wiki/Class.RxapFormBuilder)\<`any`, [`FormType`](../wiki/TypeAlias.FormType)\<`any`\>\>
|
|
66
|
+
|
|
67
|
+
##### loadingIndicatorService
|
|
68
|
+
|
|
69
|
+
`null` | `LoadingIndicatorService`
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
[`FormDirective`](../wiki/Class.FormDirective)\<`T`\>
|
|
74
|
+
|
|
75
|
+
#### Overrides
|
|
76
|
+
|
|
77
|
+
`FormGroupDirective.constructor`
|
|
78
|
+
|
|
79
|
+
## Properties
|
|
80
|
+
|
|
81
|
+
### \_formDefinition
|
|
82
|
+
|
|
83
|
+
> `protected` **\_formDefinition**: [`FormDefinition`](../wiki/Interface.FormDefinition)\<`T`\>
|
|
84
|
+
|
|
85
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:183](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L183)
|
|
86
|
+
|
|
87
|
+
***
|
|
88
|
+
|
|
89
|
+
### cdr
|
|
90
|
+
|
|
91
|
+
> `readonly` **cdr**: `ChangeDetectorRef`
|
|
92
|
+
|
|
93
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:206](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L206)
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### context
|
|
98
|
+
|
|
99
|
+
> `readonly` **context**: `InputSignal`\<`Record`\<`string`, `unknown`\>\>
|
|
100
|
+
|
|
101
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:121](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L121)
|
|
102
|
+
|
|
103
|
+
***
|
|
104
|
+
|
|
105
|
+
### directives
|
|
106
|
+
|
|
107
|
+
> **directives**: `FormControlName`[]
|
|
108
|
+
|
|
109
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2915
|
|
110
|
+
|
|
111
|
+
#### Description
|
|
112
|
+
|
|
113
|
+
Tracks the list of added `FormControlName` instances
|
|
114
|
+
|
|
115
|
+
#### Inherited from
|
|
116
|
+
|
|
117
|
+
`FormGroupDirective.directives`
|
|
118
|
+
|
|
119
|
+
***
|
|
120
|
+
|
|
121
|
+
### form
|
|
122
|
+
|
|
123
|
+
> **form**: [`RxapFormGroup`](../wiki/Class.RxapFormGroup)\<`T`\>
|
|
124
|
+
|
|
125
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:116](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L116)
|
|
126
|
+
|
|
127
|
+
#### Description
|
|
128
|
+
|
|
129
|
+
Tracks the `FormGroup` bound to this directive.
|
|
130
|
+
|
|
131
|
+
#### Overrides
|
|
132
|
+
|
|
133
|
+
`FormGroupDirective.form`
|
|
134
|
+
|
|
135
|
+
***
|
|
136
|
+
|
|
137
|
+
### formDefinitionBuilder
|
|
138
|
+
|
|
139
|
+
> `protected` `readonly` **formDefinitionBuilder**: `null` \| [`RxapFormBuilder`](../wiki/Class.RxapFormBuilder)\<`any`, [`FormType`](../wiki/TypeAlias.FormType)\<`any`\>\> = `null`
|
|
140
|
+
|
|
141
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:244](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L244)
|
|
142
|
+
|
|
143
|
+
***
|
|
144
|
+
|
|
145
|
+
### initial?
|
|
146
|
+
|
|
147
|
+
> `optional` **initial**: `T`
|
|
148
|
+
|
|
149
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:119](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L119)
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
### invalidSubmit
|
|
154
|
+
|
|
155
|
+
> **invalidSubmit**: `EventEmitter`\<`Record`\<`string`, `any`\>\>
|
|
156
|
+
|
|
157
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:134](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L134)
|
|
158
|
+
|
|
159
|
+
***
|
|
160
|
+
|
|
161
|
+
### loaded$
|
|
162
|
+
|
|
163
|
+
> `readonly` **loaded$**: `ToggleSubject`
|
|
164
|
+
|
|
165
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:180](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L180)
|
|
166
|
+
|
|
167
|
+
***
|
|
168
|
+
|
|
169
|
+
### loadFailedMethod
|
|
170
|
+
|
|
171
|
+
> **loadFailedMethod**: `null` \| [`FormLoadFailedMethod`](../wiki/Interface.FormLoadFailedMethod) = `null`
|
|
172
|
+
|
|
173
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:192](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L192)
|
|
174
|
+
|
|
175
|
+
***
|
|
176
|
+
|
|
177
|
+
### loading$
|
|
178
|
+
|
|
179
|
+
> `readonly` **loading$**: `ToggleSubject`
|
|
180
|
+
|
|
181
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:179](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L179)
|
|
182
|
+
|
|
183
|
+
***
|
|
184
|
+
|
|
185
|
+
### loadingError$
|
|
186
|
+
|
|
187
|
+
> `readonly` **loadingError$**: `BehaviorSubject`\<`null` \| `Error`\>
|
|
188
|
+
|
|
189
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:181](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L181)
|
|
190
|
+
|
|
191
|
+
***
|
|
192
|
+
|
|
193
|
+
### loadingIndicatorService
|
|
194
|
+
|
|
195
|
+
> `protected` `readonly` **loadingIndicatorService**: `null` \| `LoadingIndicatorService` = `null`
|
|
196
|
+
|
|
197
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:247](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L247)
|
|
198
|
+
|
|
199
|
+
***
|
|
200
|
+
|
|
201
|
+
### loadMethod
|
|
202
|
+
|
|
203
|
+
> **loadMethod**: `null` \| [`FormLoadMethod`](../wiki/Interface.FormLoadMethod)\<`any`\> = `null`
|
|
204
|
+
|
|
205
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:189](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L189)
|
|
206
|
+
|
|
207
|
+
***
|
|
208
|
+
|
|
209
|
+
### loadSuccessfulMethod
|
|
210
|
+
|
|
211
|
+
> **loadSuccessfulMethod**: `null` \| [`FormLoadSuccessfulMethod`](../wiki/Interface.FormLoadSuccessfulMethod)\<`any`\> = `null`
|
|
212
|
+
|
|
213
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:195](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L195)
|
|
214
|
+
|
|
215
|
+
***
|
|
216
|
+
|
|
217
|
+
### name
|
|
218
|
+
|
|
219
|
+
> **name**: `null` \| `string` \| `number`
|
|
220
|
+
|
|
221
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:1205
|
|
222
|
+
|
|
223
|
+
#### Description
|
|
224
|
+
|
|
225
|
+
The name for the control
|
|
226
|
+
|
|
227
|
+
#### Inherited from
|
|
228
|
+
|
|
229
|
+
`FormGroupDirective.name`
|
|
230
|
+
|
|
231
|
+
***
|
|
232
|
+
|
|
233
|
+
### ngSubmit
|
|
234
|
+
|
|
235
|
+
> **ngSubmit**: `EventEmitter`\<`any`\>
|
|
236
|
+
|
|
237
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2925
|
|
238
|
+
|
|
239
|
+
#### Description
|
|
240
|
+
|
|
241
|
+
Emits an event when the form submission has been triggered.
|
|
242
|
+
|
|
243
|
+
#### Inherited from
|
|
244
|
+
|
|
245
|
+
`FormGroupDirective.ngSubmit`
|
|
246
|
+
|
|
247
|
+
***
|
|
248
|
+
|
|
249
|
+
### rxapSubmit
|
|
250
|
+
|
|
251
|
+
> **rxapSubmit**: `EventEmitter`\<`any`\>
|
|
252
|
+
|
|
253
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:131](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L131)
|
|
254
|
+
|
|
255
|
+
Emits when the submit method is executed without errors. The result of the
|
|
256
|
+
submit method is passed as event object.
|
|
257
|
+
|
|
258
|
+
If no submit method is defined then emit after the submit button
|
|
259
|
+
is clicked.
|
|
260
|
+
|
|
261
|
+
***
|
|
262
|
+
|
|
263
|
+
### submitError$
|
|
264
|
+
|
|
265
|
+
> `readonly` **submitError$**: `BehaviorSubject`\<`null` \| `Error`\>
|
|
266
|
+
|
|
267
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:178](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L178)
|
|
268
|
+
|
|
269
|
+
***
|
|
270
|
+
|
|
271
|
+
### submitFailedMethod
|
|
272
|
+
|
|
273
|
+
> **submitFailedMethod**: `null` \| [`FormSubmitFailedMethod`](../wiki/Interface.FormSubmitFailedMethod) = `null`
|
|
274
|
+
|
|
275
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:198](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L198)
|
|
276
|
+
|
|
277
|
+
***
|
|
278
|
+
|
|
279
|
+
### submitMethod
|
|
280
|
+
|
|
281
|
+
> **submitMethod**: `null` \| [`FormSubmitMethod`](../wiki/Interface.FormSubmitMethod)\<`any`\> = `null`
|
|
282
|
+
|
|
283
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:186](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L186)
|
|
284
|
+
|
|
285
|
+
***
|
|
286
|
+
|
|
287
|
+
### submitSuccessful$
|
|
288
|
+
|
|
289
|
+
> **submitSuccessful$**: `EventEmitter`\<`any`\>
|
|
290
|
+
|
|
291
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:138](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L138)
|
|
292
|
+
|
|
293
|
+
***
|
|
294
|
+
|
|
295
|
+
### submitSuccessfulMethod
|
|
296
|
+
|
|
297
|
+
> **submitSuccessfulMethod**: `null` \| [`FormSubmitSuccessfulMethod`](../wiki/Interface.FormSubmitSuccessfulMethod)\<`any`\> = `null`
|
|
298
|
+
|
|
299
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:201](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L201)
|
|
300
|
+
|
|
301
|
+
***
|
|
302
|
+
|
|
303
|
+
### submitting$
|
|
304
|
+
|
|
305
|
+
> `readonly` **submitting$**: `ToggleSubject`
|
|
306
|
+
|
|
307
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:177](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L177)
|
|
308
|
+
|
|
309
|
+
***
|
|
310
|
+
|
|
311
|
+
### ɵdir
|
|
312
|
+
|
|
313
|
+
> `static` **ɵdir**: `unknown`
|
|
314
|
+
|
|
315
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3042
|
|
316
|
+
|
|
317
|
+
#### Inherited from
|
|
318
|
+
|
|
319
|
+
`FormGroupDirective.ɵdir`
|
|
320
|
+
|
|
321
|
+
***
|
|
322
|
+
|
|
323
|
+
### ɵfac
|
|
324
|
+
|
|
325
|
+
> `static` **ɵfac**: `unknown`
|
|
326
|
+
|
|
327
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3041
|
|
328
|
+
|
|
329
|
+
#### Inherited from
|
|
330
|
+
|
|
331
|
+
`FormGroupDirective.ɵfac`
|
|
332
|
+
|
|
333
|
+
## Accessors
|
|
334
|
+
|
|
335
|
+
### asyncValidator
|
|
336
|
+
|
|
337
|
+
#### Get Signature
|
|
338
|
+
|
|
339
|
+
> **get** **asyncValidator**(): `null` \| `AsyncValidatorFn`
|
|
340
|
+
|
|
341
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:826
|
|
342
|
+
|
|
343
|
+
##### Description
|
|
344
|
+
|
|
345
|
+
Asynchronous validator function composed of all the asynchronous validators registered with
|
|
346
|
+
this directive.
|
|
347
|
+
|
|
348
|
+
##### Returns
|
|
349
|
+
|
|
350
|
+
`null` \| `AsyncValidatorFn`
|
|
351
|
+
|
|
352
|
+
#### Inherited from
|
|
353
|
+
|
|
354
|
+
`FormGroupDirective.asyncValidator`
|
|
355
|
+
|
|
356
|
+
***
|
|
357
|
+
|
|
358
|
+
### control
|
|
359
|
+
|
|
360
|
+
#### Get Signature
|
|
361
|
+
|
|
362
|
+
> **get** **control**(): `FormGroup`
|
|
363
|
+
|
|
364
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2940
|
|
365
|
+
|
|
366
|
+
##### Description
|
|
367
|
+
|
|
368
|
+
Returns the `FormGroup` bound to this directive.
|
|
369
|
+
|
|
370
|
+
##### Returns
|
|
371
|
+
|
|
372
|
+
`FormGroup`
|
|
373
|
+
|
|
374
|
+
#### Inherited from
|
|
375
|
+
|
|
376
|
+
`FormGroupDirective.control`
|
|
377
|
+
|
|
378
|
+
***
|
|
379
|
+
|
|
380
|
+
### dirty
|
|
381
|
+
|
|
382
|
+
#### Get Signature
|
|
383
|
+
|
|
384
|
+
> **get** **dirty**(): `null` \| `boolean`
|
|
385
|
+
|
|
386
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:766
|
|
387
|
+
|
|
388
|
+
##### Description
|
|
389
|
+
|
|
390
|
+
Reports whether the control is dirty, meaning that the user has changed
|
|
391
|
+
the value in the UI. If the control is not present, null is returned.
|
|
392
|
+
|
|
393
|
+
##### Returns
|
|
394
|
+
|
|
395
|
+
`null` \| `boolean`
|
|
396
|
+
|
|
397
|
+
#### Inherited from
|
|
398
|
+
|
|
399
|
+
`FormGroupDirective.dirty`
|
|
400
|
+
|
|
401
|
+
***
|
|
402
|
+
|
|
403
|
+
### disabled
|
|
404
|
+
|
|
405
|
+
#### Get Signature
|
|
406
|
+
|
|
407
|
+
> **get** **disabled**(): `null` \| `boolean`
|
|
408
|
+
|
|
409
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:743
|
|
410
|
+
|
|
411
|
+
##### Description
|
|
412
|
+
|
|
413
|
+
Reports whether the control is disabled, meaning that the control is disabled
|
|
414
|
+
in the UI and is exempt from validation checks and excluded from aggregate
|
|
415
|
+
values of ancestor controls. If the control is not present, null is returned.
|
|
416
|
+
|
|
417
|
+
##### Returns
|
|
418
|
+
|
|
419
|
+
`null` \| `boolean`
|
|
420
|
+
|
|
421
|
+
#### Inherited from
|
|
422
|
+
|
|
423
|
+
`FormGroupDirective.disabled`
|
|
424
|
+
|
|
425
|
+
***
|
|
426
|
+
|
|
427
|
+
### enabled
|
|
428
|
+
|
|
429
|
+
#### Get Signature
|
|
430
|
+
|
|
431
|
+
> **get** **enabled**(): `null` \| `boolean`
|
|
432
|
+
|
|
433
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:749
|
|
434
|
+
|
|
435
|
+
##### Description
|
|
436
|
+
|
|
437
|
+
Reports whether the control is enabled, meaning that the control is included in ancestor
|
|
438
|
+
calculations of validity or value. If the control is not present, null is returned.
|
|
439
|
+
|
|
440
|
+
##### Returns
|
|
441
|
+
|
|
442
|
+
`null` \| `boolean`
|
|
443
|
+
|
|
444
|
+
#### Inherited from
|
|
445
|
+
|
|
446
|
+
`FormGroupDirective.enabled`
|
|
447
|
+
|
|
448
|
+
***
|
|
449
|
+
|
|
450
|
+
### errors
|
|
451
|
+
|
|
452
|
+
#### Get Signature
|
|
453
|
+
|
|
454
|
+
> **get** **errors**(): `null` \| `ValidationErrors`
|
|
455
|
+
|
|
456
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:754
|
|
457
|
+
|
|
458
|
+
##### Description
|
|
459
|
+
|
|
460
|
+
Reports the control's validation errors. If the control is not present, null is returned.
|
|
461
|
+
|
|
462
|
+
##### Returns
|
|
463
|
+
|
|
464
|
+
`null` \| `ValidationErrors`
|
|
465
|
+
|
|
466
|
+
#### Inherited from
|
|
467
|
+
|
|
468
|
+
`FormGroupDirective.errors`
|
|
469
|
+
|
|
470
|
+
***
|
|
471
|
+
|
|
472
|
+
### formDefinition
|
|
473
|
+
|
|
474
|
+
#### Get Signature
|
|
475
|
+
|
|
476
|
+
> **get** **formDefinition**(): [`FormDefinition`](../wiki/Interface.FormDefinition)\<`T`\>
|
|
477
|
+
|
|
478
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:173](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L173)
|
|
479
|
+
|
|
480
|
+
##### Returns
|
|
481
|
+
|
|
482
|
+
[`FormDefinition`](../wiki/Interface.FormDefinition)\<`T`\>
|
|
483
|
+
|
|
484
|
+
***
|
|
485
|
+
|
|
486
|
+
### formDirective
|
|
487
|
+
|
|
488
|
+
#### Get Signature
|
|
489
|
+
|
|
490
|
+
> **get** **formDirective**(): `Form`
|
|
491
|
+
|
|
492
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2935
|
|
493
|
+
|
|
494
|
+
##### Description
|
|
495
|
+
|
|
496
|
+
Returns this directive's instance.
|
|
497
|
+
|
|
498
|
+
##### Returns
|
|
499
|
+
|
|
500
|
+
`Form`
|
|
501
|
+
|
|
502
|
+
#### Inherited from
|
|
503
|
+
|
|
504
|
+
`FormGroupDirective.formDirective`
|
|
505
|
+
|
|
506
|
+
***
|
|
507
|
+
|
|
508
|
+
### invalid
|
|
509
|
+
|
|
510
|
+
#### Get Signature
|
|
511
|
+
|
|
512
|
+
> **get** **invalid**(): `null` \| `boolean`
|
|
513
|
+
|
|
514
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:729
|
|
515
|
+
|
|
516
|
+
##### Description
|
|
517
|
+
|
|
518
|
+
Reports whether the control is invalid, meaning that an error exists in the input value.
|
|
519
|
+
If the control is not present, null is returned.
|
|
520
|
+
|
|
521
|
+
##### Returns
|
|
522
|
+
|
|
523
|
+
`null` \| `boolean`
|
|
524
|
+
|
|
525
|
+
#### Inherited from
|
|
526
|
+
|
|
527
|
+
`FormGroupDirective.invalid`
|
|
528
|
+
|
|
529
|
+
***
|
|
530
|
+
|
|
531
|
+
### loaded
|
|
532
|
+
|
|
533
|
+
#### Get Signature
|
|
534
|
+
|
|
535
|
+
> **get** **loaded**(): `boolean`
|
|
536
|
+
|
|
537
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:156](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L156)
|
|
538
|
+
|
|
539
|
+
##### Returns
|
|
540
|
+
|
|
541
|
+
`boolean`
|
|
542
|
+
|
|
543
|
+
***
|
|
544
|
+
|
|
545
|
+
### loading
|
|
546
|
+
|
|
547
|
+
#### Get Signature
|
|
548
|
+
|
|
549
|
+
> **get** **loading**(): `boolean`
|
|
550
|
+
|
|
551
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:151](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L151)
|
|
552
|
+
|
|
553
|
+
##### Returns
|
|
554
|
+
|
|
555
|
+
`boolean`
|
|
556
|
+
|
|
557
|
+
***
|
|
558
|
+
|
|
559
|
+
### loadingError
|
|
560
|
+
|
|
561
|
+
#### Get Signature
|
|
562
|
+
|
|
563
|
+
> **get** **loadingError**(): `null` \| `Error`
|
|
564
|
+
|
|
565
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:161](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L161)
|
|
566
|
+
|
|
567
|
+
##### Returns
|
|
568
|
+
|
|
569
|
+
`null` \| `Error`
|
|
570
|
+
|
|
571
|
+
***
|
|
572
|
+
|
|
573
|
+
### path
|
|
574
|
+
|
|
575
|
+
#### Get Signature
|
|
576
|
+
|
|
577
|
+
> **get** **path**(): `string`[]
|
|
578
|
+
|
|
579
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2946
|
|
580
|
+
|
|
581
|
+
##### Description
|
|
582
|
+
|
|
583
|
+
Returns an array representing the path to this group. Because this directive
|
|
584
|
+
always lives at the top level of a form, it always an empty array.
|
|
585
|
+
|
|
586
|
+
##### Returns
|
|
587
|
+
|
|
588
|
+
`string`[]
|
|
589
|
+
|
|
590
|
+
#### Inherited from
|
|
591
|
+
|
|
592
|
+
`FormGroupDirective.path`
|
|
593
|
+
|
|
594
|
+
***
|
|
595
|
+
|
|
596
|
+
### pending
|
|
597
|
+
|
|
598
|
+
#### Get Signature
|
|
599
|
+
|
|
600
|
+
> **get** **pending**(): `null` \| `boolean`
|
|
601
|
+
|
|
602
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:736
|
|
603
|
+
|
|
604
|
+
##### Description
|
|
605
|
+
|
|
606
|
+
Reports whether a control is pending, meaning that async validation is occurring and
|
|
607
|
+
errors are not yet available for the input value. If the control is not present, null is
|
|
608
|
+
returned.
|
|
609
|
+
|
|
610
|
+
##### Returns
|
|
611
|
+
|
|
612
|
+
`null` \| `boolean`
|
|
613
|
+
|
|
614
|
+
#### Inherited from
|
|
615
|
+
|
|
616
|
+
`FormGroupDirective.pending`
|
|
617
|
+
|
|
618
|
+
***
|
|
619
|
+
|
|
620
|
+
### pristine
|
|
621
|
+
|
|
622
|
+
#### Get Signature
|
|
623
|
+
|
|
624
|
+
> **get** **pristine**(): `null` \| `boolean`
|
|
625
|
+
|
|
626
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:760
|
|
627
|
+
|
|
628
|
+
##### Description
|
|
629
|
+
|
|
630
|
+
Reports whether the control is pristine, meaning that the user has not yet changed
|
|
631
|
+
the value in the UI. If the control is not present, null is returned.
|
|
632
|
+
|
|
633
|
+
##### Returns
|
|
634
|
+
|
|
635
|
+
`null` \| `boolean`
|
|
636
|
+
|
|
637
|
+
#### Inherited from
|
|
638
|
+
|
|
639
|
+
`FormGroupDirective.pristine`
|
|
640
|
+
|
|
641
|
+
***
|
|
642
|
+
|
|
643
|
+
### status
|
|
644
|
+
|
|
645
|
+
#### Get Signature
|
|
646
|
+
|
|
647
|
+
> **get** **status**(): `null` \| `string`
|
|
648
|
+
|
|
649
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:779
|
|
650
|
+
|
|
651
|
+
##### Description
|
|
652
|
+
|
|
653
|
+
Reports the validation status of the control. Possible values include:
|
|
654
|
+
'VALID', 'INVALID', 'DISABLED', and 'PENDING'.
|
|
655
|
+
If the control is not present, null is returned.
|
|
656
|
+
|
|
657
|
+
##### Returns
|
|
658
|
+
|
|
659
|
+
`null` \| `string`
|
|
660
|
+
|
|
661
|
+
#### Inherited from
|
|
662
|
+
|
|
663
|
+
`FormGroupDirective.status`
|
|
664
|
+
|
|
665
|
+
***
|
|
666
|
+
|
|
667
|
+
### statusChanges
|
|
668
|
+
|
|
669
|
+
#### Get Signature
|
|
670
|
+
|
|
671
|
+
> **get** **statusChanges**(): `null` \| `Observable`\<`any`\>
|
|
672
|
+
|
|
673
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:791
|
|
674
|
+
|
|
675
|
+
##### Description
|
|
676
|
+
|
|
677
|
+
Returns a multicasting observable that emits a validation status whenever it is
|
|
678
|
+
calculated for the control. If the control is not present, null is returned.
|
|
679
|
+
|
|
680
|
+
##### Returns
|
|
681
|
+
|
|
682
|
+
`null` \| `Observable`\<`any`\>
|
|
683
|
+
|
|
684
|
+
#### Inherited from
|
|
685
|
+
|
|
686
|
+
`FormGroupDirective.statusChanges`
|
|
687
|
+
|
|
688
|
+
***
|
|
689
|
+
|
|
690
|
+
### submitError
|
|
691
|
+
|
|
692
|
+
#### Get Signature
|
|
693
|
+
|
|
694
|
+
> **get** **submitError**(): `null` \| `Error`
|
|
695
|
+
|
|
696
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:146](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L146)
|
|
697
|
+
|
|
698
|
+
##### Returns
|
|
699
|
+
|
|
700
|
+
`null` \| `Error`
|
|
701
|
+
|
|
702
|
+
***
|
|
703
|
+
|
|
704
|
+
### submitted
|
|
705
|
+
|
|
706
|
+
#### Get Signature
|
|
707
|
+
|
|
708
|
+
> **get** **submitted**(): `boolean`
|
|
709
|
+
|
|
710
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2898
|
|
711
|
+
|
|
712
|
+
##### Description
|
|
713
|
+
|
|
714
|
+
Reports whether the form submission has been triggered.
|
|
715
|
+
|
|
716
|
+
##### Returns
|
|
717
|
+
|
|
718
|
+
`boolean`
|
|
719
|
+
|
|
720
|
+
#### Set Signature
|
|
721
|
+
|
|
722
|
+
> **set** **submitted**(`value`): `void`
|
|
723
|
+
|
|
724
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2899
|
|
725
|
+
|
|
726
|
+
##### Parameters
|
|
727
|
+
|
|
728
|
+
###### value
|
|
729
|
+
|
|
730
|
+
`boolean`
|
|
731
|
+
|
|
732
|
+
##### Returns
|
|
733
|
+
|
|
734
|
+
`void`
|
|
735
|
+
|
|
736
|
+
#### Inherited from
|
|
737
|
+
|
|
738
|
+
`FormGroupDirective.submitted`
|
|
739
|
+
|
|
740
|
+
***
|
|
741
|
+
|
|
742
|
+
### submitting
|
|
743
|
+
|
|
744
|
+
#### Get Signature
|
|
745
|
+
|
|
746
|
+
> **get** **submitting**(): `boolean`
|
|
747
|
+
|
|
748
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:141](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L141)
|
|
749
|
+
|
|
750
|
+
##### Returns
|
|
751
|
+
|
|
752
|
+
`boolean`
|
|
753
|
+
|
|
754
|
+
***
|
|
755
|
+
|
|
756
|
+
### touched
|
|
757
|
+
|
|
758
|
+
#### Get Signature
|
|
759
|
+
|
|
760
|
+
> **get** **touched**(): `null` \| `boolean`
|
|
761
|
+
|
|
762
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:772
|
|
763
|
+
|
|
764
|
+
##### Description
|
|
765
|
+
|
|
766
|
+
Reports whether the control is touched, meaning that the user has triggered
|
|
767
|
+
a `blur` event on it. If the control is not present, null is returned.
|
|
768
|
+
|
|
769
|
+
##### Returns
|
|
770
|
+
|
|
771
|
+
`null` \| `boolean`
|
|
772
|
+
|
|
773
|
+
#### Inherited from
|
|
774
|
+
|
|
775
|
+
`FormGroupDirective.touched`
|
|
776
|
+
|
|
777
|
+
***
|
|
778
|
+
|
|
779
|
+
### untouched
|
|
780
|
+
|
|
781
|
+
#### Get Signature
|
|
782
|
+
|
|
783
|
+
> **get** **untouched**(): `null` \| `boolean`
|
|
784
|
+
|
|
785
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:785
|
|
786
|
+
|
|
787
|
+
##### Description
|
|
788
|
+
|
|
789
|
+
Reports whether the control is untouched, meaning that the user has not yet triggered
|
|
790
|
+
a `blur` event on it. If the control is not present, null is returned.
|
|
791
|
+
|
|
792
|
+
##### Returns
|
|
793
|
+
|
|
794
|
+
`null` \| `boolean`
|
|
795
|
+
|
|
796
|
+
#### Inherited from
|
|
797
|
+
|
|
798
|
+
`FormGroupDirective.untouched`
|
|
799
|
+
|
|
800
|
+
***
|
|
801
|
+
|
|
802
|
+
### useFormDefinition
|
|
803
|
+
|
|
804
|
+
#### Set Signature
|
|
805
|
+
|
|
806
|
+
> **set** **useFormDefinition**(`value`): `void`
|
|
807
|
+
|
|
808
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:166](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L166)
|
|
809
|
+
|
|
810
|
+
##### Parameters
|
|
811
|
+
|
|
812
|
+
###### value
|
|
813
|
+
|
|
814
|
+
`""` | [`FormDefinition`](../wiki/Interface.FormDefinition)\<`T`, `any`, `any`\>
|
|
815
|
+
|
|
816
|
+
##### Returns
|
|
817
|
+
|
|
818
|
+
`void`
|
|
819
|
+
|
|
820
|
+
***
|
|
821
|
+
|
|
822
|
+
### valid
|
|
823
|
+
|
|
824
|
+
#### Get Signature
|
|
825
|
+
|
|
826
|
+
> **get** **valid**(): `null` \| `boolean`
|
|
827
|
+
|
|
828
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:723
|
|
829
|
+
|
|
830
|
+
##### Description
|
|
831
|
+
|
|
832
|
+
Reports whether the control is valid. A control is considered valid if no
|
|
833
|
+
validation errors exist with the current value.
|
|
834
|
+
If the control is not present, null is returned.
|
|
835
|
+
|
|
836
|
+
##### Returns
|
|
837
|
+
|
|
838
|
+
`null` \| `boolean`
|
|
839
|
+
|
|
840
|
+
#### Inherited from
|
|
841
|
+
|
|
842
|
+
`FormGroupDirective.valid`
|
|
843
|
+
|
|
844
|
+
***
|
|
845
|
+
|
|
846
|
+
### validator
|
|
847
|
+
|
|
848
|
+
#### Get Signature
|
|
849
|
+
|
|
850
|
+
> **get** **validator**(): `null` \| `ValidatorFn`
|
|
851
|
+
|
|
852
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:820
|
|
853
|
+
|
|
854
|
+
##### Description
|
|
855
|
+
|
|
856
|
+
Synchronous validator function composed of all the synchronous validators registered with this
|
|
857
|
+
directive.
|
|
858
|
+
|
|
859
|
+
##### Returns
|
|
860
|
+
|
|
861
|
+
`null` \| `ValidatorFn`
|
|
862
|
+
|
|
863
|
+
#### Inherited from
|
|
864
|
+
|
|
865
|
+
`FormGroupDirective.validator`
|
|
866
|
+
|
|
867
|
+
***
|
|
868
|
+
|
|
869
|
+
### value
|
|
870
|
+
|
|
871
|
+
#### Get Signature
|
|
872
|
+
|
|
873
|
+
> **get** **value**(): `any`
|
|
874
|
+
|
|
875
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:716
|
|
876
|
+
|
|
877
|
+
##### Description
|
|
878
|
+
|
|
879
|
+
Reports the value of the control if it is present, otherwise null.
|
|
880
|
+
|
|
881
|
+
##### Returns
|
|
882
|
+
|
|
883
|
+
`any`
|
|
884
|
+
|
|
885
|
+
#### Inherited from
|
|
886
|
+
|
|
887
|
+
`FormGroupDirective.value`
|
|
888
|
+
|
|
889
|
+
***
|
|
890
|
+
|
|
891
|
+
### valueChanges
|
|
892
|
+
|
|
893
|
+
#### Get Signature
|
|
894
|
+
|
|
895
|
+
> **get** **valueChanges**(): `null` \| `Observable`\<`any`\>
|
|
896
|
+
|
|
897
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:798
|
|
898
|
+
|
|
899
|
+
##### Description
|
|
900
|
+
|
|
901
|
+
Returns a multicasting observable of value changes for the control that emits every time the
|
|
902
|
+
value of the control changes in the UI or programmatically.
|
|
903
|
+
If the control is not present, null is returned.
|
|
904
|
+
|
|
905
|
+
##### Returns
|
|
906
|
+
|
|
907
|
+
`null` \| `Observable`\<`any`\>
|
|
908
|
+
|
|
909
|
+
#### Inherited from
|
|
910
|
+
|
|
911
|
+
`FormGroupDirective.valueChanges`
|
|
912
|
+
|
|
913
|
+
## Methods
|
|
914
|
+
|
|
915
|
+
### addControl()
|
|
916
|
+
|
|
917
|
+
> **addControl**(`dir`): `FormControl`
|
|
918
|
+
|
|
919
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2954
|
|
920
|
+
|
|
921
|
+
#### Parameters
|
|
922
|
+
|
|
923
|
+
##### dir
|
|
924
|
+
|
|
925
|
+
`FormControlName`
|
|
926
|
+
|
|
927
|
+
The `FormControlName` directive instance.
|
|
928
|
+
|
|
929
|
+
#### Returns
|
|
930
|
+
|
|
931
|
+
`FormControl`
|
|
932
|
+
|
|
933
|
+
#### Description
|
|
934
|
+
|
|
935
|
+
Method that sets up the control directive in this group, re-calculates its value
|
|
936
|
+
and validity, and adds the instance to the internal list of directives.
|
|
937
|
+
|
|
938
|
+
#### Inherited from
|
|
939
|
+
|
|
940
|
+
`FormGroupDirective.addControl`
|
|
941
|
+
|
|
942
|
+
***
|
|
943
|
+
|
|
944
|
+
### addFormArray()
|
|
945
|
+
|
|
946
|
+
> **addFormArray**(`dir`): `void`
|
|
947
|
+
|
|
948
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2994
|
|
949
|
+
|
|
950
|
+
Performs the necessary setup when a `FormArrayName` directive instance is added to the view.
|
|
951
|
+
|
|
952
|
+
#### Parameters
|
|
953
|
+
|
|
954
|
+
##### dir
|
|
955
|
+
|
|
956
|
+
`FormArrayName`
|
|
957
|
+
|
|
958
|
+
The `FormArrayName` directive instance.
|
|
959
|
+
|
|
960
|
+
#### Returns
|
|
961
|
+
|
|
962
|
+
`void`
|
|
963
|
+
|
|
964
|
+
#### Inherited from
|
|
965
|
+
|
|
966
|
+
`FormGroupDirective.addFormArray`
|
|
967
|
+
|
|
968
|
+
***
|
|
969
|
+
|
|
970
|
+
### addFormGroup()
|
|
971
|
+
|
|
972
|
+
> **addFormGroup**(`dir`): `void`
|
|
973
|
+
|
|
974
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2974
|
|
975
|
+
|
|
976
|
+
Adds a new `FormGroupName` directive instance to the form.
|
|
977
|
+
|
|
978
|
+
#### Parameters
|
|
979
|
+
|
|
980
|
+
##### dir
|
|
981
|
+
|
|
982
|
+
`FormGroupName`
|
|
983
|
+
|
|
984
|
+
The `FormGroupName` directive instance.
|
|
985
|
+
|
|
986
|
+
#### Returns
|
|
987
|
+
|
|
988
|
+
`void`
|
|
989
|
+
|
|
990
|
+
#### Inherited from
|
|
991
|
+
|
|
992
|
+
`FormGroupDirective.addFormGroup`
|
|
993
|
+
|
|
994
|
+
***
|
|
995
|
+
|
|
996
|
+
### getControl()
|
|
997
|
+
|
|
998
|
+
> **getControl**(`dir`): `FormControl`
|
|
999
|
+
|
|
1000
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2961
|
|
1001
|
+
|
|
1002
|
+
#### Parameters
|
|
1003
|
+
|
|
1004
|
+
##### dir
|
|
1005
|
+
|
|
1006
|
+
`FormControlName`
|
|
1007
|
+
|
|
1008
|
+
The `FormControlName` directive instance.
|
|
1009
|
+
|
|
1010
|
+
#### Returns
|
|
1011
|
+
|
|
1012
|
+
`FormControl`
|
|
1013
|
+
|
|
1014
|
+
#### Description
|
|
1015
|
+
|
|
1016
|
+
Retrieves the `FormControl` instance from the provided `FormControlName` directive
|
|
1017
|
+
|
|
1018
|
+
#### Inherited from
|
|
1019
|
+
|
|
1020
|
+
`FormGroupDirective.getControl`
|
|
1021
|
+
|
|
1022
|
+
***
|
|
1023
|
+
|
|
1024
|
+
### getError()
|
|
1025
|
+
|
|
1026
|
+
> **getError**(`errorCode`, `path`?): `any`
|
|
1027
|
+
|
|
1028
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:891
|
|
1029
|
+
|
|
1030
|
+
#### Parameters
|
|
1031
|
+
|
|
1032
|
+
##### errorCode
|
|
1033
|
+
|
|
1034
|
+
`string`
|
|
1035
|
+
|
|
1036
|
+
The code of the error to check
|
|
1037
|
+
|
|
1038
|
+
##### path?
|
|
1039
|
+
|
|
1040
|
+
A list of control names that designates how to move from the current control
|
|
1041
|
+
to the control that should be queried for errors.
|
|
1042
|
+
|
|
1043
|
+
`string` | (`string` \| `number`)[]
|
|
1044
|
+
|
|
1045
|
+
#### Returns
|
|
1046
|
+
|
|
1047
|
+
`any`
|
|
1048
|
+
|
|
1049
|
+
error data for that particular error. If the control or error is not present,
|
|
1050
|
+
null is returned.
|
|
1051
|
+
|
|
1052
|
+
#### Description
|
|
1053
|
+
|
|
1054
|
+
Reports error data for the control with the given path.
|
|
1055
|
+
|
|
1056
|
+
#### Usage Notes
|
|
1057
|
+
|
|
1058
|
+
For example, for the following `FormGroup`:
|
|
1059
|
+
|
|
1060
|
+
```ts
|
|
1061
|
+
form = new FormGroup({
|
|
1062
|
+
address: new FormGroup({ street: new FormControl() })
|
|
1063
|
+
});
|
|
1064
|
+
```
|
|
1065
|
+
|
|
1066
|
+
The path to the 'street' control from the root form would be 'address' -> 'street'.
|
|
1067
|
+
|
|
1068
|
+
It can be provided to this method in one of two formats:
|
|
1069
|
+
|
|
1070
|
+
1. An array of string control names, e.g. `['address', 'street']`
|
|
1071
|
+
1. A period-delimited list of control names in one string, e.g. `'address.street'`
|
|
1072
|
+
|
|
1073
|
+
#### Inherited from
|
|
1074
|
+
|
|
1075
|
+
`FormGroupDirective.getError`
|
|
1076
|
+
|
|
1077
|
+
***
|
|
1078
|
+
|
|
1079
|
+
### getFormArray()
|
|
1080
|
+
|
|
1081
|
+
> **getFormArray**(`dir`): `FormArray`
|
|
1082
|
+
|
|
1083
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3008
|
|
1084
|
+
|
|
1085
|
+
#### Parameters
|
|
1086
|
+
|
|
1087
|
+
##### dir
|
|
1088
|
+
|
|
1089
|
+
`FormArrayName`
|
|
1090
|
+
|
|
1091
|
+
The `FormArrayName` directive instance.
|
|
1092
|
+
|
|
1093
|
+
#### Returns
|
|
1094
|
+
|
|
1095
|
+
`FormArray`
|
|
1096
|
+
|
|
1097
|
+
#### Description
|
|
1098
|
+
|
|
1099
|
+
Retrieves the `FormArray` for a provided `FormArrayName` directive instance.
|
|
1100
|
+
|
|
1101
|
+
#### Inherited from
|
|
1102
|
+
|
|
1103
|
+
`FormGroupDirective.getFormArray`
|
|
1104
|
+
|
|
1105
|
+
***
|
|
1106
|
+
|
|
1107
|
+
### getFormGroup()
|
|
1108
|
+
|
|
1109
|
+
> **getFormGroup**(`dir`): `FormGroup`
|
|
1110
|
+
|
|
1111
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2988
|
|
1112
|
+
|
|
1113
|
+
#### Parameters
|
|
1114
|
+
|
|
1115
|
+
##### dir
|
|
1116
|
+
|
|
1117
|
+
`FormGroupName`
|
|
1118
|
+
|
|
1119
|
+
The `FormGroupName` directive instance.
|
|
1120
|
+
|
|
1121
|
+
#### Returns
|
|
1122
|
+
|
|
1123
|
+
`FormGroup`
|
|
1124
|
+
|
|
1125
|
+
#### Description
|
|
1126
|
+
|
|
1127
|
+
Retrieves the `FormGroup` for a provided `FormGroupName` directive instance
|
|
1128
|
+
|
|
1129
|
+
#### Inherited from
|
|
1130
|
+
|
|
1131
|
+
`FormGroupDirective.getFormGroup`
|
|
1132
|
+
|
|
1133
|
+
***
|
|
1134
|
+
|
|
1135
|
+
### getSubmitValue()
|
|
1136
|
+
|
|
1137
|
+
> `protected` **getSubmitValue**(): `T`
|
|
1138
|
+
|
|
1139
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:474](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L474)
|
|
1140
|
+
|
|
1141
|
+
#### Returns
|
|
1142
|
+
|
|
1143
|
+
`T`
|
|
1144
|
+
|
|
1145
|
+
***
|
|
1146
|
+
|
|
1147
|
+
### hasError()
|
|
1148
|
+
|
|
1149
|
+
> **hasError**(`errorCode`, `path`?): `boolean`
|
|
1150
|
+
|
|
1151
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:863
|
|
1152
|
+
|
|
1153
|
+
#### Parameters
|
|
1154
|
+
|
|
1155
|
+
##### errorCode
|
|
1156
|
+
|
|
1157
|
+
`string`
|
|
1158
|
+
|
|
1159
|
+
The code of the error to check
|
|
1160
|
+
|
|
1161
|
+
##### path?
|
|
1162
|
+
|
|
1163
|
+
A list of control names that designates how to move from the current control
|
|
1164
|
+
to the control that should be queried for errors.
|
|
1165
|
+
|
|
1166
|
+
`string` | (`string` \| `number`)[]
|
|
1167
|
+
|
|
1168
|
+
#### Returns
|
|
1169
|
+
|
|
1170
|
+
`boolean`
|
|
1171
|
+
|
|
1172
|
+
whether the given error is present in the control at the given path.
|
|
1173
|
+
|
|
1174
|
+
If the control is not present, false is returned.
|
|
1175
|
+
|
|
1176
|
+
#### Description
|
|
1177
|
+
|
|
1178
|
+
Reports whether the control with the given path has the error specified.
|
|
1179
|
+
|
|
1180
|
+
#### Usage Notes
|
|
1181
|
+
|
|
1182
|
+
For example, for the following `FormGroup`:
|
|
1183
|
+
|
|
1184
|
+
```ts
|
|
1185
|
+
form = new FormGroup({
|
|
1186
|
+
address: new FormGroup({ street: new FormControl() })
|
|
1187
|
+
});
|
|
1188
|
+
```
|
|
1189
|
+
|
|
1190
|
+
The path to the 'street' control from the root form would be 'address' -> 'street'.
|
|
1191
|
+
|
|
1192
|
+
It can be provided to this method in one of two formats:
|
|
1193
|
+
|
|
1194
|
+
1. An array of string control names, e.g. `['address', 'street']`
|
|
1195
|
+
1. A period-delimited list of control names in one string, e.g. `'address.street'`
|
|
1196
|
+
|
|
1197
|
+
If no path is given, this method checks for the error on the current control.
|
|
1198
|
+
|
|
1199
|
+
#### Inherited from
|
|
1200
|
+
|
|
1201
|
+
`FormGroupDirective.hasError`
|
|
1202
|
+
|
|
1203
|
+
***
|
|
1204
|
+
|
|
1205
|
+
### loadFailed()
|
|
1206
|
+
|
|
1207
|
+
> `protected` **loadFailed**(`error`): `void`
|
|
1208
|
+
|
|
1209
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:464](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L464)
|
|
1210
|
+
|
|
1211
|
+
#### Parameters
|
|
1212
|
+
|
|
1213
|
+
##### error
|
|
1214
|
+
|
|
1215
|
+
`Error`
|
|
1216
|
+
|
|
1217
|
+
#### Returns
|
|
1218
|
+
|
|
1219
|
+
`void`
|
|
1220
|
+
|
|
1221
|
+
***
|
|
1222
|
+
|
|
1223
|
+
### loadInitialState()
|
|
1224
|
+
|
|
1225
|
+
> `protected` **loadInitialState**(`form`): `void`
|
|
1226
|
+
|
|
1227
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:404](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L404)
|
|
1228
|
+
|
|
1229
|
+
#### Parameters
|
|
1230
|
+
|
|
1231
|
+
##### form
|
|
1232
|
+
|
|
1233
|
+
[`RxapFormGroup`](../wiki/Class.RxapFormGroup)
|
|
1234
|
+
|
|
1235
|
+
#### Returns
|
|
1236
|
+
|
|
1237
|
+
`void`
|
|
1238
|
+
|
|
1239
|
+
***
|
|
1240
|
+
|
|
1241
|
+
### loadSuccessful()
|
|
1242
|
+
|
|
1243
|
+
> `protected` **loadSuccessful**(`value`): `void`
|
|
1244
|
+
|
|
1245
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:454](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L454)
|
|
1246
|
+
|
|
1247
|
+
#### Parameters
|
|
1248
|
+
|
|
1249
|
+
##### value
|
|
1250
|
+
|
|
1251
|
+
`any`
|
|
1252
|
+
|
|
1253
|
+
#### Returns
|
|
1254
|
+
|
|
1255
|
+
`void`
|
|
1256
|
+
|
|
1257
|
+
***
|
|
1258
|
+
|
|
1259
|
+
### ngOnChanges()
|
|
1260
|
+
|
|
1261
|
+
> **ngOnChanges**(`changes`): `void`
|
|
1262
|
+
|
|
1263
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:267](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L267)
|
|
1264
|
+
|
|
1265
|
+
#### Parameters
|
|
1266
|
+
|
|
1267
|
+
##### changes
|
|
1268
|
+
|
|
1269
|
+
`SimpleChanges`
|
|
1270
|
+
|
|
1271
|
+
#### Returns
|
|
1272
|
+
|
|
1273
|
+
`void`
|
|
1274
|
+
|
|
1275
|
+
#### Nodoc
|
|
1276
|
+
|
|
1277
|
+
#### Implementation of
|
|
1278
|
+
|
|
1279
|
+
`OnChanges.ngOnChanges`
|
|
1280
|
+
|
|
1281
|
+
#### Overrides
|
|
1282
|
+
|
|
1283
|
+
`FormGroupDirective.ngOnChanges`
|
|
1284
|
+
|
|
1285
|
+
***
|
|
1286
|
+
|
|
1287
|
+
### ngOnDestroy()
|
|
1288
|
+
|
|
1289
|
+
> **ngOnDestroy**(): `void`
|
|
1290
|
+
|
|
1291
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:559](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L559)
|
|
1292
|
+
|
|
1293
|
+
#### Returns
|
|
1294
|
+
|
|
1295
|
+
`void`
|
|
1296
|
+
|
|
1297
|
+
#### Nodoc
|
|
1298
|
+
|
|
1299
|
+
#### Implementation of
|
|
1300
|
+
|
|
1301
|
+
`OnDestroy.ngOnDestroy`
|
|
1302
|
+
|
|
1303
|
+
#### Overrides
|
|
1304
|
+
|
|
1305
|
+
`FormGroupDirective.ngOnDestroy`
|
|
1306
|
+
|
|
1307
|
+
***
|
|
1308
|
+
|
|
1309
|
+
### ngOnInit()
|
|
1310
|
+
|
|
1311
|
+
> **ngOnInit**(): `void`
|
|
1312
|
+
|
|
1313
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:277](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L277)
|
|
1314
|
+
|
|
1315
|
+
A callback method that is invoked immediately after the
|
|
1316
|
+
default change detector has checked the directive's
|
|
1317
|
+
data-bound properties for the first time,
|
|
1318
|
+
and before any of the view or content children have been checked.
|
|
1319
|
+
It is invoked only once when the directive is instantiated.
|
|
1320
|
+
|
|
1321
|
+
#### Returns
|
|
1322
|
+
|
|
1323
|
+
`void`
|
|
1324
|
+
|
|
1325
|
+
#### Implementation of
|
|
1326
|
+
|
|
1327
|
+
`OnInit.ngOnInit`
|
|
1328
|
+
|
|
1329
|
+
***
|
|
1330
|
+
|
|
1331
|
+
### onReset()
|
|
1332
|
+
|
|
1333
|
+
> **onReset**(): `void`
|
|
1334
|
+
|
|
1335
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3028
|
|
1336
|
+
|
|
1337
|
+
#### Returns
|
|
1338
|
+
|
|
1339
|
+
`void`
|
|
1340
|
+
|
|
1341
|
+
#### Description
|
|
1342
|
+
|
|
1343
|
+
Method called when the "reset" event is triggered on the form.
|
|
1344
|
+
|
|
1345
|
+
#### Inherited from
|
|
1346
|
+
|
|
1347
|
+
`FormGroupDirective.onReset`
|
|
1348
|
+
|
|
1349
|
+
***
|
|
1350
|
+
|
|
1351
|
+
### onSubmit()
|
|
1352
|
+
|
|
1353
|
+
> **onSubmit**(`$event`): `boolean`
|
|
1354
|
+
|
|
1355
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:322](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L322)
|
|
1356
|
+
|
|
1357
|
+
#### Parameters
|
|
1358
|
+
|
|
1359
|
+
##### $event
|
|
1360
|
+
|
|
1361
|
+
`Event`
|
|
1362
|
+
|
|
1363
|
+
The "submit" event object
|
|
1364
|
+
|
|
1365
|
+
#### Returns
|
|
1366
|
+
|
|
1367
|
+
`boolean`
|
|
1368
|
+
|
|
1369
|
+
#### Description
|
|
1370
|
+
|
|
1371
|
+
Method called with the "submit" event is triggered on the form.
|
|
1372
|
+
Triggers the `ngSubmit` emitter to emit the "submit" event as its payload.
|
|
1373
|
+
|
|
1374
|
+
#### Overrides
|
|
1375
|
+
|
|
1376
|
+
`FormGroupDirective.onSubmit`
|
|
1377
|
+
|
|
1378
|
+
***
|
|
1379
|
+
|
|
1380
|
+
### removeControl()
|
|
1381
|
+
|
|
1382
|
+
> **removeControl**(`dir`): `void`
|
|
1383
|
+
|
|
1384
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2968
|
|
1385
|
+
|
|
1386
|
+
#### Parameters
|
|
1387
|
+
|
|
1388
|
+
##### dir
|
|
1389
|
+
|
|
1390
|
+
`FormControlName`
|
|
1391
|
+
|
|
1392
|
+
The `FormControlName` directive instance.
|
|
1393
|
+
|
|
1394
|
+
#### Returns
|
|
1395
|
+
|
|
1396
|
+
`void`
|
|
1397
|
+
|
|
1398
|
+
#### Description
|
|
1399
|
+
|
|
1400
|
+
Removes the `FormControlName` instance from the internal list of directives
|
|
1401
|
+
|
|
1402
|
+
#### Inherited from
|
|
1403
|
+
|
|
1404
|
+
`FormGroupDirective.removeControl`
|
|
1405
|
+
|
|
1406
|
+
***
|
|
1407
|
+
|
|
1408
|
+
### removeFormArray()
|
|
1409
|
+
|
|
1410
|
+
> **removeFormArray**(`dir`): `void`
|
|
1411
|
+
|
|
1412
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3001
|
|
1413
|
+
|
|
1414
|
+
Performs the necessary cleanup when a `FormArrayName` directive instance is removed from the
|
|
1415
|
+
view.
|
|
1416
|
+
|
|
1417
|
+
#### Parameters
|
|
1418
|
+
|
|
1419
|
+
##### dir
|
|
1420
|
+
|
|
1421
|
+
`FormArrayName`
|
|
1422
|
+
|
|
1423
|
+
The `FormArrayName` directive instance.
|
|
1424
|
+
|
|
1425
|
+
#### Returns
|
|
1426
|
+
|
|
1427
|
+
`void`
|
|
1428
|
+
|
|
1429
|
+
#### Inherited from
|
|
1430
|
+
|
|
1431
|
+
`FormGroupDirective.removeFormArray`
|
|
1432
|
+
|
|
1433
|
+
***
|
|
1434
|
+
|
|
1435
|
+
### removeFormGroup()
|
|
1436
|
+
|
|
1437
|
+
> **removeFormGroup**(`dir`): `void`
|
|
1438
|
+
|
|
1439
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:2981
|
|
1440
|
+
|
|
1441
|
+
Performs the necessary cleanup when a `FormGroupName` directive instance is removed from the
|
|
1442
|
+
view.
|
|
1443
|
+
|
|
1444
|
+
#### Parameters
|
|
1445
|
+
|
|
1446
|
+
##### dir
|
|
1447
|
+
|
|
1448
|
+
`FormGroupName`
|
|
1449
|
+
|
|
1450
|
+
The `FormGroupName` directive instance.
|
|
1451
|
+
|
|
1452
|
+
#### Returns
|
|
1453
|
+
|
|
1454
|
+
`void`
|
|
1455
|
+
|
|
1456
|
+
#### Inherited from
|
|
1457
|
+
|
|
1458
|
+
`FormGroupDirective.removeFormGroup`
|
|
1459
|
+
|
|
1460
|
+
***
|
|
1461
|
+
|
|
1462
|
+
### reset()
|
|
1463
|
+
|
|
1464
|
+
> **reset**(`value`?): `void`
|
|
1465
|
+
|
|
1466
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:832
|
|
1467
|
+
|
|
1468
|
+
#### Parameters
|
|
1469
|
+
|
|
1470
|
+
##### value?
|
|
1471
|
+
|
|
1472
|
+
`any`
|
|
1473
|
+
|
|
1474
|
+
#### Returns
|
|
1475
|
+
|
|
1476
|
+
`void`
|
|
1477
|
+
|
|
1478
|
+
#### Description
|
|
1479
|
+
|
|
1480
|
+
Resets the control with the provided value if the control is present.
|
|
1481
|
+
|
|
1482
|
+
#### Inherited from
|
|
1483
|
+
|
|
1484
|
+
`FormGroupDirective.reset`
|
|
1485
|
+
|
|
1486
|
+
***
|
|
1487
|
+
|
|
1488
|
+
### resetForm()
|
|
1489
|
+
|
|
1490
|
+
> **resetForm**(`value`?): `void`
|
|
1491
|
+
|
|
1492
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3035
|
|
1493
|
+
|
|
1494
|
+
#### Parameters
|
|
1495
|
+
|
|
1496
|
+
##### value?
|
|
1497
|
+
|
|
1498
|
+
`any`
|
|
1499
|
+
|
|
1500
|
+
The new value for the form.
|
|
1501
|
+
|
|
1502
|
+
#### Returns
|
|
1503
|
+
|
|
1504
|
+
`void`
|
|
1505
|
+
|
|
1506
|
+
#### Description
|
|
1507
|
+
|
|
1508
|
+
Resets the form to an initial value and resets its submitted status.
|
|
1509
|
+
|
|
1510
|
+
#### Inherited from
|
|
1511
|
+
|
|
1512
|
+
`FormGroupDirective.resetForm`
|
|
1513
|
+
|
|
1514
|
+
***
|
|
1515
|
+
|
|
1516
|
+
### submit()
|
|
1517
|
+
|
|
1518
|
+
> `protected` **submit**(): `void`
|
|
1519
|
+
|
|
1520
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:488](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L488)
|
|
1521
|
+
|
|
1522
|
+
#### Returns
|
|
1523
|
+
|
|
1524
|
+
`void`
|
|
1525
|
+
|
|
1526
|
+
***
|
|
1527
|
+
|
|
1528
|
+
### submitFailed()
|
|
1529
|
+
|
|
1530
|
+
> `protected` **submitFailed**(`error`): `void`
|
|
1531
|
+
|
|
1532
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:534](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L534)
|
|
1533
|
+
|
|
1534
|
+
#### Parameters
|
|
1535
|
+
|
|
1536
|
+
##### error
|
|
1537
|
+
|
|
1538
|
+
`Error`
|
|
1539
|
+
|
|
1540
|
+
#### Returns
|
|
1541
|
+
|
|
1542
|
+
`void`
|
|
1543
|
+
|
|
1544
|
+
***
|
|
1545
|
+
|
|
1546
|
+
### submitSuccessful()
|
|
1547
|
+
|
|
1548
|
+
> `protected` **submitSuccessful**(`value`): `void`
|
|
1549
|
+
|
|
1550
|
+
Defined in: [packages/angular/forms/src/lib/directives/form.directive.ts:547](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form.directive.ts#L547)
|
|
1551
|
+
|
|
1552
|
+
#### Parameters
|
|
1553
|
+
|
|
1554
|
+
##### value
|
|
1555
|
+
|
|
1556
|
+
`any`
|
|
1557
|
+
|
|
1558
|
+
#### Returns
|
|
1559
|
+
|
|
1560
|
+
`void`
|
|
1561
|
+
|
|
1562
|
+
***
|
|
1563
|
+
|
|
1564
|
+
### updateModel()
|
|
1565
|
+
|
|
1566
|
+
> **updateModel**(`dir`, `value`): `void`
|
|
1567
|
+
|
|
1568
|
+
Defined in: node\_modules/@angular/forms/index.d.ts:3015
|
|
1569
|
+
|
|
1570
|
+
Sets the new value for the provided `FormControlName` directive.
|
|
1571
|
+
|
|
1572
|
+
#### Parameters
|
|
1573
|
+
|
|
1574
|
+
##### dir
|
|
1575
|
+
|
|
1576
|
+
`FormControlName`
|
|
1577
|
+
|
|
1578
|
+
The `FormControlName` directive instance.
|
|
1579
|
+
|
|
1580
|
+
##### value
|
|
1581
|
+
|
|
1582
|
+
`any`
|
|
1583
|
+
|
|
1584
|
+
The new value for the directive's control.
|
|
1585
|
+
|
|
1586
|
+
#### Returns
|
|
1587
|
+
|
|
1588
|
+
`void`
|
|
1589
|
+
|
|
1590
|
+
#### Inherited from
|
|
1591
|
+
|
|
1592
|
+
`FormGroupDirective.updateModel`
|