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