@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.
Files changed (554) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +24 -25
  3. package/compodoc/changelog.html +6 -0
  4. package/compodoc/dependencies.html +9 -9
  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 +21 -19
  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,707 @@
1
+ [**@rxap/forms**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/forms](../globals.md) / FormGroupNameDirective
6
+
7
+ # Class: ~~FormGroupNameDirective~~
8
+
9
+ Defined in: [packages/angular/forms/src/lib/directives/form-group-name.directive.ts:35](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form-group-name.directive.ts#L35)
10
+
11
+ A full exertion of FormGroupName from @angular/forms. The only change is the
12
+ ability to access the control container outside of the current component
13
+
14
+ ## Deprecated
15
+
16
+ use the ParentControlContainerDirective
17
+
18
+ ## Extends
19
+
20
+ - `FormGroupName`
21
+
22
+ ## Constructors
23
+
24
+ ### new FormGroupNameDirective()
25
+
26
+ > **new FormGroupNameDirective**(`parent`, `validators`, `asyncValidators`): [`FormGroupNameDirective`](FormGroupNameDirective.md)
27
+
28
+ Defined in: [packages/angular/forms/src/lib/directives/form-group-name.directive.ts:45](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form-group-name.directive.ts#L45)
29
+
30
+ #### Parameters
31
+
32
+ ##### parent
33
+
34
+ `ControlContainer`
35
+
36
+ ##### validators
37
+
38
+ `any`[]
39
+
40
+ ##### asyncValidators
41
+
42
+ `any`[]
43
+
44
+ #### Returns
45
+
46
+ [`FormGroupNameDirective`](FormGroupNameDirective.md)
47
+
48
+ #### Overrides
49
+
50
+ `FormGroupName.constructor`
51
+
52
+ ## Properties
53
+
54
+ ### ~~name~~
55
+
56
+ > **name**: `null` \| `string` \| `number`
57
+
58
+ Defined in: [packages/angular/forms/src/lib/directives/form-group-name.directive.ts:38](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form-group-name.directive.ts#L38)
59
+
60
+ #### Description
61
+
62
+ Tracks the name of the `FormGroup` bound to the directive. The name corresponds
63
+ to a key in the parent `FormGroup` or `FormArray`.
64
+ Accepts a name as a string or a number.
65
+ The name in the form of a string is useful for individual forms,
66
+ while the numerical form allows for form groups to be bound
67
+ to indices when iterating over groups in a `FormArray`.
68
+
69
+ #### Overrides
70
+
71
+ `FormGroupName.name`
72
+
73
+ ***
74
+
75
+ ### ~~ɵdir~~
76
+
77
+ > `static` **ɵdir**: `unknown`
78
+
79
+ Defined in: node\_modules/@angular/forms/index.d.ts:3105
80
+
81
+ #### Inherited from
82
+
83
+ `FormGroupName.ɵdir`
84
+
85
+ ***
86
+
87
+ ### ~~ɵfac~~
88
+
89
+ > `static` **ɵfac**: `unknown`
90
+
91
+ Defined in: node\_modules/@angular/forms/index.d.ts:3104
92
+
93
+ #### Inherited from
94
+
95
+ `FormGroupName.ɵfac`
96
+
97
+ ## Accessors
98
+
99
+ ### ~~asyncValidator~~
100
+
101
+ #### Get Signature
102
+
103
+ > **get** **asyncValidator**(): `null` \| `AsyncValidatorFn`
104
+
105
+ Defined in: node\_modules/@angular/forms/index.d.ts:826
106
+
107
+ ##### Description
108
+
109
+ Asynchronous validator function composed of all the asynchronous validators registered with
110
+ this directive.
111
+
112
+ ##### Returns
113
+
114
+ `null` \| `AsyncValidatorFn`
115
+
116
+ #### Inherited from
117
+
118
+ `FormGroupName.asyncValidator`
119
+
120
+ ***
121
+
122
+ ### ~~control~~
123
+
124
+ #### Get Signature
125
+
126
+ > **get** **control**(): [`RxapFormGroup`](RxapFormGroup.md)
127
+
128
+ Defined in: [packages/angular/forms/src/lib/directives/form-group-name.directive.ts:40](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/forms/src/lib/directives/form-group-name.directive.ts#L40)
129
+
130
+ ##### Description
131
+
132
+ The `FormGroup` bound to this directive.
133
+
134
+ ##### Returns
135
+
136
+ [`RxapFormGroup`](RxapFormGroup.md)
137
+
138
+ #### Overrides
139
+
140
+ `FormGroupName.control`
141
+
142
+ ***
143
+
144
+ ### ~~dirty~~
145
+
146
+ #### Get Signature
147
+
148
+ > **get** **dirty**(): `null` \| `boolean`
149
+
150
+ Defined in: node\_modules/@angular/forms/index.d.ts:766
151
+
152
+ ##### Description
153
+
154
+ Reports whether the control is dirty, meaning that the user has changed
155
+ the value in the UI. If the control is not present, null is returned.
156
+
157
+ ##### Returns
158
+
159
+ `null` \| `boolean`
160
+
161
+ #### Inherited from
162
+
163
+ `FormGroupName.dirty`
164
+
165
+ ***
166
+
167
+ ### ~~disabled~~
168
+
169
+ #### Get Signature
170
+
171
+ > **get** **disabled**(): `null` \| `boolean`
172
+
173
+ Defined in: node\_modules/@angular/forms/index.d.ts:743
174
+
175
+ ##### Description
176
+
177
+ Reports whether the control is disabled, meaning that the control is disabled
178
+ in the UI and is exempt from validation checks and excluded from aggregate
179
+ values of ancestor controls. If the control is not present, null is returned.
180
+
181
+ ##### Returns
182
+
183
+ `null` \| `boolean`
184
+
185
+ #### Inherited from
186
+
187
+ `FormGroupName.disabled`
188
+
189
+ ***
190
+
191
+ ### ~~enabled~~
192
+
193
+ #### Get Signature
194
+
195
+ > **get** **enabled**(): `null` \| `boolean`
196
+
197
+ Defined in: node\_modules/@angular/forms/index.d.ts:749
198
+
199
+ ##### Description
200
+
201
+ Reports whether the control is enabled, meaning that the control is included in ancestor
202
+ calculations of validity or value. If the control is not present, null is returned.
203
+
204
+ ##### Returns
205
+
206
+ `null` \| `boolean`
207
+
208
+ #### Inherited from
209
+
210
+ `FormGroupName.enabled`
211
+
212
+ ***
213
+
214
+ ### ~~errors~~
215
+
216
+ #### Get Signature
217
+
218
+ > **get** **errors**(): `null` \| `ValidationErrors`
219
+
220
+ Defined in: node\_modules/@angular/forms/index.d.ts:754
221
+
222
+ ##### Description
223
+
224
+ Reports the control's validation errors. If the control is not present, null is returned.
225
+
226
+ ##### Returns
227
+
228
+ `null` \| `ValidationErrors`
229
+
230
+ #### Inherited from
231
+
232
+ `FormGroupName.errors`
233
+
234
+ ***
235
+
236
+ ### ~~formDirective~~
237
+
238
+ #### Get Signature
239
+
240
+ > **get** **formDirective**(): `null` \| `Form`
241
+
242
+ Defined in: node\_modules/@angular/forms/index.d.ts:955
243
+
244
+ ##### Description
245
+
246
+ The top-level directive for this group if present, otherwise null.
247
+
248
+ ##### Returns
249
+
250
+ `null` \| `Form`
251
+
252
+ #### Inherited from
253
+
254
+ `FormGroupName.formDirective`
255
+
256
+ ***
257
+
258
+ ### ~~invalid~~
259
+
260
+ #### Get Signature
261
+
262
+ > **get** **invalid**(): `null` \| `boolean`
263
+
264
+ Defined in: node\_modules/@angular/forms/index.d.ts:729
265
+
266
+ ##### Description
267
+
268
+ Reports whether the control is invalid, meaning that an error exists in the input value.
269
+ If the control is not present, null is returned.
270
+
271
+ ##### Returns
272
+
273
+ `null` \| `boolean`
274
+
275
+ #### Inherited from
276
+
277
+ `FormGroupName.invalid`
278
+
279
+ ***
280
+
281
+ ### ~~path~~
282
+
283
+ #### Get Signature
284
+
285
+ > **get** **path**(): `string`[]
286
+
287
+ Defined in: node\_modules/@angular/forms/index.d.ts:950
288
+
289
+ ##### Description
290
+
291
+ The path to this group from the top-level directive.
292
+
293
+ ##### Returns
294
+
295
+ `string`[]
296
+
297
+ #### Inherited from
298
+
299
+ `FormGroupName.path`
300
+
301
+ ***
302
+
303
+ ### ~~pending~~
304
+
305
+ #### Get Signature
306
+
307
+ > **get** **pending**(): `null` \| `boolean`
308
+
309
+ Defined in: node\_modules/@angular/forms/index.d.ts:736
310
+
311
+ ##### Description
312
+
313
+ Reports whether a control is pending, meaning that async validation is occurring and
314
+ errors are not yet available for the input value. If the control is not present, null is
315
+ returned.
316
+
317
+ ##### Returns
318
+
319
+ `null` \| `boolean`
320
+
321
+ #### Inherited from
322
+
323
+ `FormGroupName.pending`
324
+
325
+ ***
326
+
327
+ ### ~~pristine~~
328
+
329
+ #### Get Signature
330
+
331
+ > **get** **pristine**(): `null` \| `boolean`
332
+
333
+ Defined in: node\_modules/@angular/forms/index.d.ts:760
334
+
335
+ ##### Description
336
+
337
+ Reports whether the control is pristine, meaning that the user has not yet changed
338
+ the value in the UI. If the control is not present, null is returned.
339
+
340
+ ##### Returns
341
+
342
+ `null` \| `boolean`
343
+
344
+ #### Inherited from
345
+
346
+ `FormGroupName.pristine`
347
+
348
+ ***
349
+
350
+ ### ~~status~~
351
+
352
+ #### Get Signature
353
+
354
+ > **get** **status**(): `null` \| `string`
355
+
356
+ Defined in: node\_modules/@angular/forms/index.d.ts:779
357
+
358
+ ##### Description
359
+
360
+ Reports the validation status of the control. Possible values include:
361
+ 'VALID', 'INVALID', 'DISABLED', and 'PENDING'.
362
+ If the control is not present, null is returned.
363
+
364
+ ##### Returns
365
+
366
+ `null` \| `string`
367
+
368
+ #### Inherited from
369
+
370
+ `FormGroupName.status`
371
+
372
+ ***
373
+
374
+ ### ~~statusChanges~~
375
+
376
+ #### Get Signature
377
+
378
+ > **get** **statusChanges**(): `null` \| `Observable`\<`any`\>
379
+
380
+ Defined in: node\_modules/@angular/forms/index.d.ts:791
381
+
382
+ ##### Description
383
+
384
+ Returns a multicasting observable that emits a validation status whenever it is
385
+ calculated for the control. If the control is not present, null is returned.
386
+
387
+ ##### Returns
388
+
389
+ `null` \| `Observable`\<`any`\>
390
+
391
+ #### Inherited from
392
+
393
+ `FormGroupName.statusChanges`
394
+
395
+ ***
396
+
397
+ ### ~~touched~~
398
+
399
+ #### Get Signature
400
+
401
+ > **get** **touched**(): `null` \| `boolean`
402
+
403
+ Defined in: node\_modules/@angular/forms/index.d.ts:772
404
+
405
+ ##### Description
406
+
407
+ Reports whether the control is touched, meaning that the user has triggered
408
+ a `blur` event on it. If the control is not present, null is returned.
409
+
410
+ ##### Returns
411
+
412
+ `null` \| `boolean`
413
+
414
+ #### Inherited from
415
+
416
+ `FormGroupName.touched`
417
+
418
+ ***
419
+
420
+ ### ~~untouched~~
421
+
422
+ #### Get Signature
423
+
424
+ > **get** **untouched**(): `null` \| `boolean`
425
+
426
+ Defined in: node\_modules/@angular/forms/index.d.ts:785
427
+
428
+ ##### Description
429
+
430
+ Reports whether the control is untouched, meaning that the user has not yet triggered
431
+ a `blur` event on it. If the control is not present, null is returned.
432
+
433
+ ##### Returns
434
+
435
+ `null` \| `boolean`
436
+
437
+ #### Inherited from
438
+
439
+ `FormGroupName.untouched`
440
+
441
+ ***
442
+
443
+ ### ~~valid~~
444
+
445
+ #### Get Signature
446
+
447
+ > **get** **valid**(): `null` \| `boolean`
448
+
449
+ Defined in: node\_modules/@angular/forms/index.d.ts:723
450
+
451
+ ##### Description
452
+
453
+ Reports whether the control is valid. A control is considered valid if no
454
+ validation errors exist with the current value.
455
+ If the control is not present, null is returned.
456
+
457
+ ##### Returns
458
+
459
+ `null` \| `boolean`
460
+
461
+ #### Inherited from
462
+
463
+ `FormGroupName.valid`
464
+
465
+ ***
466
+
467
+ ### ~~validator~~
468
+
469
+ #### Get Signature
470
+
471
+ > **get** **validator**(): `null` \| `ValidatorFn`
472
+
473
+ Defined in: node\_modules/@angular/forms/index.d.ts:820
474
+
475
+ ##### Description
476
+
477
+ Synchronous validator function composed of all the synchronous validators registered with this
478
+ directive.
479
+
480
+ ##### Returns
481
+
482
+ `null` \| `ValidatorFn`
483
+
484
+ #### Inherited from
485
+
486
+ `FormGroupName.validator`
487
+
488
+ ***
489
+
490
+ ### ~~value~~
491
+
492
+ #### Get Signature
493
+
494
+ > **get** **value**(): `any`
495
+
496
+ Defined in: node\_modules/@angular/forms/index.d.ts:716
497
+
498
+ ##### Description
499
+
500
+ Reports the value of the control if it is present, otherwise null.
501
+
502
+ ##### Returns
503
+
504
+ `any`
505
+
506
+ #### Inherited from
507
+
508
+ `FormGroupName.value`
509
+
510
+ ***
511
+
512
+ ### ~~valueChanges~~
513
+
514
+ #### Get Signature
515
+
516
+ > **get** **valueChanges**(): `null` \| `Observable`\<`any`\>
517
+
518
+ Defined in: node\_modules/@angular/forms/index.d.ts:798
519
+
520
+ ##### Description
521
+
522
+ Returns a multicasting observable of value changes for the control that emits every time the
523
+ value of the control changes in the UI or programmatically.
524
+ If the control is not present, null is returned.
525
+
526
+ ##### Returns
527
+
528
+ `null` \| `Observable`\<`any`\>
529
+
530
+ #### Inherited from
531
+
532
+ `FormGroupName.valueChanges`
533
+
534
+ ## Methods
535
+
536
+ ### ~~getError()~~
537
+
538
+ > **getError**(`errorCode`, `path`?): `any`
539
+
540
+ Defined in: node\_modules/@angular/forms/index.d.ts:891
541
+
542
+ #### Parameters
543
+
544
+ ##### errorCode
545
+
546
+ `string`
547
+
548
+ The code of the error to check
549
+
550
+ ##### path?
551
+
552
+ A list of control names that designates how to move from the current control
553
+ to the control that should be queried for errors.
554
+
555
+ `string` | (`string` \| `number`)[]
556
+
557
+ #### Returns
558
+
559
+ `any`
560
+
561
+ error data for that particular error. If the control or error is not present,
562
+ null is returned.
563
+
564
+ #### Description
565
+
566
+ Reports error data for the control with the given path.
567
+
568
+ #### Usage Notes
569
+
570
+ For example, for the following `FormGroup`:
571
+
572
+ ```ts
573
+ form = new FormGroup({
574
+ address: new FormGroup({ street: new FormControl() })
575
+ });
576
+ ```
577
+
578
+ The path to the 'street' control from the root form would be 'address' -> 'street'.
579
+
580
+ It can be provided to this method in one of two formats:
581
+
582
+ 1. An array of string control names, e.g. `['address', 'street']`
583
+ 1. A period-delimited list of control names in one string, e.g. `'address.street'`
584
+
585
+ #### Inherited from
586
+
587
+ `FormGroupName.getError`
588
+
589
+ ***
590
+
591
+ ### ~~hasError()~~
592
+
593
+ > **hasError**(`errorCode`, `path`?): `boolean`
594
+
595
+ Defined in: node\_modules/@angular/forms/index.d.ts:863
596
+
597
+ #### Parameters
598
+
599
+ ##### errorCode
600
+
601
+ `string`
602
+
603
+ The code of the error to check
604
+
605
+ ##### path?
606
+
607
+ A list of control names that designates how to move from the current control
608
+ to the control that should be queried for errors.
609
+
610
+ `string` | (`string` \| `number`)[]
611
+
612
+ #### Returns
613
+
614
+ `boolean`
615
+
616
+ whether the given error is present in the control at the given path.
617
+
618
+ If the control is not present, false is returned.
619
+
620
+ #### Description
621
+
622
+ Reports whether the control with the given path has the error specified.
623
+
624
+ #### Usage Notes
625
+
626
+ For example, for the following `FormGroup`:
627
+
628
+ ```ts
629
+ form = new FormGroup({
630
+ address: new FormGroup({ street: new FormControl() })
631
+ });
632
+ ```
633
+
634
+ The path to the 'street' control from the root form would be 'address' -> 'street'.
635
+
636
+ It can be provided to this method in one of two formats:
637
+
638
+ 1. An array of string control names, e.g. `['address', 'street']`
639
+ 1. A period-delimited list of control names in one string, e.g. `'address.street'`
640
+
641
+ If no path is given, this method checks for the error on the current control.
642
+
643
+ #### Inherited from
644
+
645
+ `FormGroupName.hasError`
646
+
647
+ ***
648
+
649
+ ### ~~ngOnDestroy()~~
650
+
651
+ > **ngOnDestroy**(): `void`
652
+
653
+ Defined in: node\_modules/@angular/forms/index.d.ts:940
654
+
655
+ #### Returns
656
+
657
+ `void`
658
+
659
+ #### Nodoc
660
+
661
+ #### Inherited from
662
+
663
+ `FormGroupName.ngOnDestroy`
664
+
665
+ ***
666
+
667
+ ### ~~ngOnInit()~~
668
+
669
+ > **ngOnInit**(): `void`
670
+
671
+ Defined in: node\_modules/@angular/forms/index.d.ts:938
672
+
673
+ #### Returns
674
+
675
+ `void`
676
+
677
+ #### Nodoc
678
+
679
+ #### Inherited from
680
+
681
+ `FormGroupName.ngOnInit`
682
+
683
+ ***
684
+
685
+ ### ~~reset()~~
686
+
687
+ > **reset**(`value`?): `void`
688
+
689
+ Defined in: node\_modules/@angular/forms/index.d.ts:832
690
+
691
+ #### Parameters
692
+
693
+ ##### value?
694
+
695
+ `any`
696
+
697
+ #### Returns
698
+
699
+ `void`
700
+
701
+ #### Description
702
+
703
+ Resets the control with the provided value if the control is present.
704
+
705
+ #### Inherited from
706
+
707
+ `FormGroupName.reset`