envoc-form 4.0.1-9 → 5.0.1

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 (276) hide show
  1. package/README.md +5173 -12
  2. package/es/AddressInput/AddressInput.d.ts +24 -15
  3. package/es/AddressInput/AddressInput.js +20 -21
  4. package/es/AddressInput/UsStates.d.ts +3 -3
  5. package/es/AddressInput/UsStates.js +53 -53
  6. package/es/ConfirmBaseForm/ConfirmBaseForm.d.ts +26 -12
  7. package/es/ConfirmBaseForm/ConfirmBaseForm.js +42 -36
  8. package/es/ConfirmDeleteForm/ConfirmDeleteForm.d.ts +24 -11
  9. package/es/ConfirmDeleteForm/ConfirmDeleteForm.js +60 -55
  10. package/es/DatePicker/DatePickerGroup.d.ts +13 -9
  11. package/es/DatePicker/DatePickerGroup.js +87 -77
  12. package/es/DatePicker/DatePickerHelper.d.ts +3 -3
  13. package/es/DatePicker/DatePickerHelper.js +1 -1
  14. package/es/DatePicker/StringDateOnlyPickerGroup.d.ts +9 -5
  15. package/es/DatePicker/StringDateOnlyPickerGroup.js +29 -24
  16. package/es/DatePicker/StringDatePickerGroup.d.ts +9 -5
  17. package/es/DatePicker/StringDatePickerGroup.js +24 -19
  18. package/es/Field/CustomFieldInputProps.d.ts +7 -7
  19. package/es/Field/CustomFieldInputProps.js +1 -1
  20. package/es/Field/CustomFieldMetaProps.d.ts +4 -4
  21. package/es/Field/CustomFieldMetaProps.js +1 -1
  22. package/es/Field/Field.d.ts +28 -22
  23. package/es/Field/Field.js +51 -46
  24. package/es/Field/FieldErrorScrollTarget.d.ts +2 -2
  25. package/es/Field/FieldErrorScrollTarget.js +12 -11
  26. package/es/Field/FieldNameContext.d.ts +3 -3
  27. package/es/Field/FieldNameContext.js +3 -3
  28. package/es/Field/FieldSection.d.ts +7 -7
  29. package/es/Field/FieldSection.js +9 -20
  30. package/es/Field/InjectedFieldProps.d.ts +7 -7
  31. package/es/Field/InjectedFieldProps.js +1 -1
  32. package/es/Field/StandAloneInput.d.ts +13 -9
  33. package/es/Field/StandAloneInput.js +50 -49
  34. package/es/Field/useStandardField.d.ts +21 -15
  35. package/es/Field/useStandardField.js +92 -93
  36. package/es/FieldArray/FieldArray.d.ts +24 -15
  37. package/es/FieldArray/FieldArray.js +77 -83
  38. package/es/File/FileGroup.d.ts +10 -8
  39. package/es/File/FileGroup.js +53 -52
  40. package/es/File/FileList.d.ts +5 -6
  41. package/es/File/FileList.js +10 -21
  42. package/es/File/humanFileSize.d.ts +1 -1
  43. package/es/File/humanFileSize.js +6 -6
  44. package/es/Form/FocusError.d.ts +7 -5
  45. package/es/Form/FocusError.js +42 -41
  46. package/es/Form/Form.d.ts +33 -27
  47. package/es/Form/Form.js +141 -140
  48. package/es/Form/FormBasedPreventNavigation.d.ts +6 -5
  49. package/es/Form/FormBasedPreventNavigation.js +20 -53
  50. package/es/Form/LegacyFormBasedPreventNavigation.d.ts +17 -0
  51. package/es/Form/LegacyFormBasedPreventNavigation.js +69 -0
  52. package/es/Form/NewFormBasedPreventNavigation.d.ts +14 -0
  53. package/es/Form/NewFormBasedPreventNavigation.js +39 -0
  54. package/es/Form/ServerErrorContext.d.ts +11 -10
  55. package/es/Form/ServerErrorContext.js +9 -8
  56. package/es/FormActions.d.ts +12 -7
  57. package/es/FormActions.js +16 -26
  58. package/es/FormDefaults.d.ts +4 -3
  59. package/es/FormDefaults.js +2 -1
  60. package/es/Group.d.ts +16 -13
  61. package/es/Group.js +14 -24
  62. package/es/Input/IconInputGroup.d.ts +12 -9
  63. package/es/Input/IconInputGroup.js +43 -41
  64. package/es/Input/InputGroup.d.ts +12 -12
  65. package/es/Input/InputGroup.js +34 -34
  66. package/es/Input/MoneyInputGroup.d.ts +9 -7
  67. package/es/Input/MoneyInputGroup.js +43 -42
  68. package/es/Input/NumberInputGroup.d.ts +9 -7
  69. package/es/Input/NumberInputGroup.js +43 -42
  70. package/es/Input/StringInputGroup.d.ts +8 -7
  71. package/es/Input/StringInputGroup.js +43 -41
  72. package/es/Normalization/NormalizationFunction.d.ts +4 -4
  73. package/es/Normalization/NormalizationFunction.js +1 -1
  74. package/es/Normalization/normalizers.d.ts +4 -2
  75. package/es/Normalization/normalizers.js +32 -30
  76. package/es/Select/BooleanSelectGroup.d.ts +7 -7
  77. package/es/Select/BooleanSelectGroup.js +28 -27
  78. package/es/Select/NumberSelectGroup.d.ts +9 -8
  79. package/es/Select/NumberSelectGroup.js +21 -19
  80. package/es/Select/SelectGroup.d.ts +27 -22
  81. package/es/Select/SelectGroup.js +65 -64
  82. package/es/Select/SelectGroupPropsHelper.d.ts +3 -3
  83. package/es/Select/SelectGroupPropsHelper.js +1 -1
  84. package/es/Select/StringSelectGroup.d.ts +9 -8
  85. package/es/Select/StringSelectGroup.js +21 -19
  86. package/es/StandardFormActions.d.ts +11 -6
  87. package/es/StandardFormActions.js +14 -24
  88. package/es/SubmitFormButton.d.ts +10 -7
  89. package/es/SubmitFormButton.js +40 -39
  90. package/es/TextArea/TextAreaGroup.d.ts +9 -8
  91. package/es/TextArea/TextAreaGroup.js +35 -34
  92. package/es/Validation/ValidatedApiResult.d.ts +6 -6
  93. package/es/Validation/ValidatedApiResult.js +1 -1
  94. package/es/Validation/ValidationError.d.ts +5 -5
  95. package/es/Validation/ValidationError.js +1 -1
  96. package/es/Validation/ValidationFunction.d.ts +4 -4
  97. package/es/Validation/ValidationFunction.js +1 -1
  98. package/es/Validation/validators.d.ts +18 -15
  99. package/es/Validation/validators.js +77 -73
  100. package/es/index.d.ts +73 -73
  101. package/es/index.js +50 -50
  102. package/es/setupTests.d.ts +1 -0
  103. package/es/setupTests.js +1 -0
  104. package/es/utils/objectContainsNonSerializableProperty.d.ts +1 -1
  105. package/es/utils/objectContainsNonSerializableProperty.js +14 -14
  106. package/es/utils/objectToFormData.d.ts +10 -10
  107. package/es/utils/objectToFormData.js +77 -77
  108. package/es/utils/typeChecks.d.ts +8 -8
  109. package/es/utils/typeChecks.js +18 -18
  110. package/lib/AddressInput/AddressInput.d.ts +24 -15
  111. package/lib/AddressInput/AddressInput.js +26 -27
  112. package/lib/AddressInput/UsStates.d.ts +3 -3
  113. package/lib/AddressInput/UsStates.js +55 -55
  114. package/lib/ConfirmBaseForm/ConfirmBaseForm.d.ts +26 -12
  115. package/lib/ConfirmBaseForm/ConfirmBaseForm.js +48 -42
  116. package/lib/ConfirmDeleteForm/ConfirmDeleteForm.d.ts +24 -11
  117. package/lib/ConfirmDeleteForm/ConfirmDeleteForm.js +66 -61
  118. package/lib/DatePicker/DatePickerGroup.d.ts +13 -9
  119. package/lib/DatePicker/DatePickerGroup.js +95 -85
  120. package/lib/DatePicker/DatePickerHelper.d.ts +3 -3
  121. package/lib/DatePicker/DatePickerHelper.js +2 -2
  122. package/lib/DatePicker/StringDateOnlyPickerGroup.d.ts +9 -5
  123. package/lib/DatePicker/StringDateOnlyPickerGroup.js +35 -30
  124. package/lib/DatePicker/StringDatePickerGroup.d.ts +9 -5
  125. package/lib/DatePicker/StringDatePickerGroup.js +30 -25
  126. package/lib/Field/CustomFieldInputProps.d.ts +7 -7
  127. package/lib/Field/CustomFieldInputProps.js +2 -2
  128. package/lib/Field/CustomFieldMetaProps.d.ts +4 -4
  129. package/lib/Field/CustomFieldMetaProps.js +2 -2
  130. package/lib/Field/Field.d.ts +28 -22
  131. package/lib/Field/Field.js +56 -51
  132. package/lib/Field/FieldErrorScrollTarget.d.ts +2 -2
  133. package/lib/Field/FieldErrorScrollTarget.js +15 -14
  134. package/lib/Field/FieldNameContext.d.ts +3 -3
  135. package/lib/Field/FieldNameContext.js +9 -9
  136. package/lib/Field/FieldSection.d.ts +7 -7
  137. package/lib/Field/FieldSection.js +12 -23
  138. package/lib/Field/InjectedFieldProps.d.ts +7 -7
  139. package/lib/Field/InjectedFieldProps.js +2 -2
  140. package/lib/Field/StandAloneInput.d.ts +13 -9
  141. package/lib/Field/StandAloneInput.js +76 -75
  142. package/lib/Field/useStandardField.d.ts +21 -15
  143. package/lib/Field/useStandardField.js +95 -96
  144. package/lib/FieldArray/FieldArray.d.ts +24 -15
  145. package/lib/FieldArray/FieldArray.js +83 -89
  146. package/lib/File/FileGroup.d.ts +10 -8
  147. package/lib/File/FileGroup.js +58 -57
  148. package/lib/File/FileList.d.ts +5 -6
  149. package/lib/File/FileList.js +13 -24
  150. package/lib/File/humanFileSize.d.ts +1 -1
  151. package/lib/File/humanFileSize.js +10 -10
  152. package/lib/Form/FocusError.d.ts +7 -5
  153. package/lib/Form/FocusError.js +48 -47
  154. package/lib/Form/Form.d.ts +33 -27
  155. package/lib/Form/Form.js +147 -146
  156. package/lib/Form/FormBasedPreventNavigation.d.ts +6 -5
  157. package/lib/Form/FormBasedPreventNavigation.js +26 -56
  158. package/lib/Form/LegacyFormBasedPreventNavigation.d.ts +17 -0
  159. package/lib/Form/LegacyFormBasedPreventNavigation.js +72 -0
  160. package/lib/Form/NewFormBasedPreventNavigation.d.ts +14 -0
  161. package/lib/Form/NewFormBasedPreventNavigation.js +42 -0
  162. package/lib/Form/ServerErrorContext.d.ts +11 -10
  163. package/lib/Form/ServerErrorContext.js +15 -14
  164. package/lib/FormActions.d.ts +12 -7
  165. package/lib/FormActions.js +22 -32
  166. package/lib/FormDefaults.d.ts +4 -3
  167. package/lib/FormDefaults.js +5 -4
  168. package/lib/Group.d.ts +16 -13
  169. package/lib/Group.js +20 -30
  170. package/lib/Input/IconInputGroup.d.ts +12 -9
  171. package/lib/Input/IconInputGroup.js +48 -46
  172. package/lib/Input/InputGroup.d.ts +12 -12
  173. package/lib/Input/InputGroup.js +39 -39
  174. package/lib/Input/MoneyInputGroup.d.ts +9 -7
  175. package/lib/Input/MoneyInputGroup.js +48 -47
  176. package/lib/Input/NumberInputGroup.d.ts +9 -7
  177. package/lib/Input/NumberInputGroup.js +48 -47
  178. package/lib/Input/StringInputGroup.d.ts +8 -7
  179. package/lib/Input/StringInputGroup.js +48 -46
  180. package/lib/Normalization/NormalizationFunction.d.ts +4 -4
  181. package/lib/Normalization/NormalizationFunction.js +2 -2
  182. package/lib/Normalization/normalizers.d.ts +4 -2
  183. package/lib/Normalization/normalizers.js +37 -35
  184. package/lib/Select/BooleanSelectGroup.d.ts +7 -7
  185. package/lib/Select/BooleanSelectGroup.js +35 -34
  186. package/lib/Select/NumberSelectGroup.d.ts +9 -8
  187. package/lib/Select/NumberSelectGroup.js +29 -27
  188. package/lib/Select/SelectGroup.d.ts +27 -22
  189. package/lib/Select/SelectGroup.js +71 -70
  190. package/lib/Select/SelectGroupPropsHelper.d.ts +3 -3
  191. package/lib/Select/SelectGroupPropsHelper.js +2 -2
  192. package/lib/Select/StringSelectGroup.d.ts +9 -8
  193. package/lib/Select/StringSelectGroup.js +29 -27
  194. package/lib/StandardFormActions.d.ts +11 -6
  195. package/lib/StandardFormActions.js +20 -30
  196. package/lib/SubmitFormButton.d.ts +10 -7
  197. package/lib/SubmitFormButton.js +45 -44
  198. package/lib/TextArea/TextAreaGroup.d.ts +9 -8
  199. package/lib/TextArea/TextAreaGroup.js +40 -39
  200. package/lib/Validation/ValidatedApiResult.d.ts +6 -6
  201. package/lib/Validation/ValidatedApiResult.js +2 -2
  202. package/lib/Validation/ValidationError.d.ts +5 -5
  203. package/lib/Validation/ValidationError.js +2 -2
  204. package/lib/Validation/ValidationFunction.d.ts +4 -4
  205. package/lib/Validation/ValidationFunction.js +2 -2
  206. package/lib/Validation/validators.d.ts +18 -15
  207. package/lib/Validation/validators.js +90 -86
  208. package/lib/index.d.ts +73 -73
  209. package/lib/index.js +117 -117
  210. package/lib/setupTests.d.ts +1 -0
  211. package/lib/setupTests.js +3 -0
  212. package/lib/utils/objectContainsNonSerializableProperty.d.ts +1 -1
  213. package/lib/utils/objectContainsNonSerializableProperty.js +17 -17
  214. package/lib/utils/objectToFormData.d.ts +10 -10
  215. package/lib/utils/objectToFormData.js +79 -79
  216. package/lib/utils/typeChecks.d.ts +8 -8
  217. package/lib/utils/typeChecks.js +29 -29
  218. package/package.json +14 -11
  219. package/src/AddressInput/AddressInput.tsx +15 -5
  220. package/src/AddressInput/__snapshots__/AddressInput.test.tsx.snap +14 -12
  221. package/src/ConfirmBaseForm/ConfirmBaseForm.tsx +14 -0
  222. package/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx +13 -0
  223. package/src/DatePicker/DatePicker.test.tsx +1 -1
  224. package/src/DatePicker/DatePickerGroup.tsx +18 -7
  225. package/src/DatePicker/StringDateOnlyPickerGroup.tsx +7 -2
  226. package/src/DatePicker/StringDatePickerGroup.tsx +7 -1
  227. package/src/Field/Field.tsx +20 -7
  228. package/src/Field/FieldErrorScrollTarget.tsx +1 -0
  229. package/src/Field/StandAloneInput.tsx +4 -0
  230. package/src/Field/useStandardField.ts +13 -9
  231. package/src/FieldArray/FieldArray.tsx +14 -5
  232. package/src/File/FileGroup.tsx +9 -3
  233. package/src/File/FileList.tsx +2 -2
  234. package/src/Form/FocusError.tsx +3 -0
  235. package/src/Form/Form.tsx +6 -0
  236. package/src/Form/FormBasedPreventNavigation.tsx +28 -46
  237. package/src/Form/LegacyFormBasedPreventNavigation.tsx +77 -0
  238. package/src/Form/NewFormBasedPreventNavigation.tsx +59 -0
  239. package/src/Form/ServerErrorContext.ts +1 -0
  240. package/src/FormActions.tsx +7 -0
  241. package/src/FormDefaults.ts +1 -0
  242. package/src/Group.tsx +12 -4
  243. package/src/Input/IconInputGroup.tsx +5 -2
  244. package/src/Input/InputGroup.tsx +13 -5
  245. package/src/Input/MoneyInputGroup.tsx +3 -1
  246. package/src/Input/NumberInputGroup.tsx +3 -1
  247. package/src/Input/StringInputGroup.tsx +3 -2
  248. package/src/Input/__Tests__/__snapshots__/IconInputGroup.test.tsx.snap +1 -0
  249. package/src/Input/__Tests__/__snapshots__/MoneyInputGroup.test.tsx.snap +1 -0
  250. package/src/Input/__Tests__/__snapshots__/NumberInputGroup.test.tsx.snap +1 -0
  251. package/src/Input/__Tests__/__snapshots__/StringInputGroup.test.tsx.snap +1 -0
  252. package/src/Normalization/normalizers.ts +4 -2
  253. package/src/Select/BooleanSelectGroup.tsx +2 -1
  254. package/src/Select/NumberSelectGroup.tsx +4 -2
  255. package/src/Select/SelectGroup.tsx +13 -2
  256. package/src/Select/StringSelectGroup.tsx +2 -0
  257. package/src/Select/__tests__/__snapshots__/BooleanSelectGroup.test.tsx.snap +6 -8
  258. package/src/Select/__tests__/__snapshots__/NumberSelectGroup.test.tsx.snap +12 -16
  259. package/src/Select/__tests__/__snapshots__/StringSelectGroup.test.tsx.snap +12 -16
  260. package/src/StandardFormActions.tsx +5 -0
  261. package/src/SubmitFormButton.tsx +5 -1
  262. package/src/TextArea/TextAreaGroup.tsx +6 -4
  263. package/src/Validation/validators.ts +19 -14
  264. package/src/__Tests__/FormTestBase.tsx +9 -8
  265. package/src/__Tests__/RealisticForm.test.tsx +82 -0
  266. package/src/index.ts +4 -4
  267. package/src/setupTests.ts +1 -0
  268. package/src/utils/objectToFormData.test.tsx +1 -1
  269. package/es/__Tests__/FormTestBase.d.ts +0 -27
  270. package/es/__Tests__/FormTestBase.js +0 -83
  271. package/es/__Tests__/index.d.ts +0 -2
  272. package/es/__Tests__/index.js +0 -2
  273. package/lib/__Tests__/FormTestBase.d.ts +0 -27
  274. package/lib/__Tests__/FormTestBase.js +0 -86
  275. package/lib/__Tests__/index.d.ts +0 -2
  276. package/lib/__Tests__/index.js +0 -8
package/README.md CHANGED
@@ -1,17 +1,5178 @@
1
- # envoc-form
2
-
3
- [![npm package][npm-badge]][npm]
4
-
5
- Base form package for envoc projects.
6
-
7
- [npm-badge]: https://img.shields.io/npm/v/envoc-form.png?style=flat
8
- [npm]: https://www.npmjs.com/package/envoc-form
9
-
10
- Important naming conventions for our sanity while creating envoc-form types:
11
-
1
+
2
+ <a name="readmemd"></a>
3
+
4
+ envoc-form / [Exports](#modulesmd)
5
+
6
+ # envoc-form
7
+
8
+ [![npm package][npm-badge]][npm]
9
+
10
+ Base form package for envoc projects.
11
+
12
+ [npm-badge]: https://img.shields.io/npm/v/envoc-form.png?style=flat
13
+ [npm]: https://www.npmjs.com/package/envoc-form
14
+ Important naming conventions for our sanity while creating envoc-form types:
15
+
12
16
  - TForm = The type of the some form. e.g. LoginDto
13
17
  - TProp = The key / symbol of a individual property of some form. e.g. TProp would be literally "Username" for the prop of the same name for a LoginDto
14
18
  - TValue = The value of an individual property of some form. e.g. a "Username" property would probably have a TValue of string
15
19
  - Field = the abstract thing that deals with some specific TProp. Might represent several composed elements (e.g. label, input, helperText, etc) or may just be a direct component
16
20
  - TRenderComponent = The type of any 'Component' passed to a Field, e.g. 'StandardTextInputGroup' passed to Component means TRenderComponent is typeof(StandardTextInputGroup)
17
- - TComponentProps = For any 'Component' passed to a Field as a prop, this represents that Component's props
21
+ - TComponentProps = For any 'Component' passed to a Field as a prop, this represents that Component's props
22
+
23
+ # Interfaces
24
+
25
+
26
+ <a name="interfacesaddressinputpropsmd"></a>
27
+
28
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / AddressInputProps
29
+
30
+ ## Interface: AddressInputProps
31
+
32
+ ### Table of contents
33
+
34
+ #### Properties
35
+
36
+ - [fieldBuilder](#fieldbuilder)
37
+ - [name](#name)
38
+
39
+ ### Properties
40
+
41
+ #### fieldBuilder
42
+
43
+ • **fieldBuilder**: `Pick`<[`FormBuilderProp`](#formbuilderprop)<`AddressDto`\>, ``"Field"``\>
44
+
45
+ ##### Defined in
46
+
47
+ packages/envoc-form/src/AddressInput/AddressInput.tsx:14
48
+
49
+ ___
50
+
51
+ #### name
52
+
53
+ • **name**: `string`
54
+
55
+ ##### Defined in
56
+
57
+ packages/envoc-form/src/AddressInput/AddressInput.tsx:15
58
+
59
+
60
+ <a name="interfacesbooleanselectgrouppropsmd"></a>
61
+
62
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / BooleanSelectGroupProps
63
+
64
+ ## Interface: BooleanSelectGroupProps
65
+
66
+ ### Hierarchy
67
+
68
+ - `Omit`<[`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`boolean` \| `undefined` \| ``null``\>, ``"options"``\>
69
+
70
+ ↳ **`BooleanSelectGroupProps`**
71
+
72
+ ### Table of contents
73
+
74
+ #### Properties
75
+
76
+ - [className](#classname)
77
+ - [disabled](#disabled)
78
+ - [helpText](#helptext)
79
+ - [input](#input)
80
+ - [label](#label)
81
+ - [meta](#meta)
82
+ - [options](#options)
83
+ - [placeholder](#placeholder)
84
+ - [required](#required)
85
+
86
+ ### Properties
87
+
88
+ #### className
89
+
90
+ • `Optional` **className**: `string`
91
+
92
+ Extra class names to apply.
93
+
94
+ ##### Inherited from
95
+
96
+ Omit.className
97
+
98
+ ##### Defined in
99
+
100
+ packages/envoc-form/src/Group.tsx:8
101
+
102
+ ___
103
+
104
+ #### disabled
105
+
106
+ • `Optional` **disabled**: `boolean`
107
+
108
+ Whether the field should be disabled.
109
+
110
+ ##### Inherited from
111
+
112
+ Omit.disabled
113
+
114
+ ##### Defined in
115
+
116
+ packages/envoc-form/src/Group.tsx:19
117
+
118
+ ___
119
+
120
+ #### helpText
121
+
122
+ • `Optional` **helpText**: `ReactNode`
123
+
124
+ Simple helper text after the input.
125
+
126
+ ##### Inherited from
127
+
128
+ Omit.helpText
129
+
130
+ ##### Defined in
131
+
132
+ packages/envoc-form/src/Group.tsx:16
133
+
134
+ ___
135
+
136
+ #### input
137
+
138
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `boolean`\>
139
+
140
+ ##### Inherited from
141
+
142
+ Omit.input
143
+
144
+ ##### Defined in
145
+
146
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
147
+
148
+ ___
149
+
150
+ #### label
151
+
152
+ • `Optional` **label**: `string`
153
+
154
+ Simple text label before the input.
155
+
156
+ ##### Inherited from
157
+
158
+ Omit.label
159
+
160
+ ##### Defined in
161
+
162
+ packages/envoc-form/src/Group.tsx:13
163
+
164
+ ___
165
+
166
+ #### meta
167
+
168
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `boolean`\>
169
+
170
+ ##### Inherited from
171
+
172
+ Omit.meta
173
+
174
+ ##### Defined in
175
+
176
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
177
+
178
+ ___
179
+
180
+ #### options
181
+
182
+ • `Optional` **options**: [`SelectOption`](#interfacesselectoptionmd)<`boolean`\>[]
183
+
184
+ ##### Defined in
185
+
186
+ packages/envoc-form/src/Select/BooleanSelectGroup.tsx:17
187
+
188
+ ___
189
+
190
+ #### placeholder
191
+
192
+ • `Optional` **placeholder**: `string`
193
+
194
+ Text diplayed when no value is selected.
195
+
196
+ ##### Inherited from
197
+
198
+ Omit.placeholder
199
+
200
+ ##### Defined in
201
+
202
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
203
+
204
+ ___
205
+
206
+ #### required
207
+
208
+ • `Optional` **required**: `boolean`
209
+
210
+ ##### Inherited from
211
+
212
+ Omit.required
213
+
214
+ ##### Defined in
215
+
216
+ packages/envoc-form/src/Group.tsx:21
217
+
218
+
219
+ <a name="interfacesconfirmbaseformpropsmd"></a>
220
+
221
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ConfirmBaseFormProps
222
+
223
+ ## Interface: ConfirmBaseFormProps
224
+
225
+ ### Table of contents
226
+
227
+ #### Properties
228
+
229
+ - [children](#children)
230
+ - [confirmButtonClass](#confirmbuttonclass)
231
+ - [confirmButtonText](#confirmbuttontext)
232
+ - [handleCancel](#handlecancel)
233
+ - [request](#request)
234
+ - [style](#style)
235
+ - [title](#title)
236
+
237
+ ### Properties
238
+
239
+ #### children
240
+
241
+ • `Optional` **children**: `ReactNode`
242
+
243
+ Any components to be rendered in between the title and the buttons.
244
+
245
+ ##### Defined in
246
+
247
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:23
248
+
249
+ ___
250
+
251
+ #### confirmButtonClass
252
+
253
+ • `Optional` **confirmButtonClass**: `string`
254
+
255
+ CSS class for the buttons.
256
+
257
+ ##### Defined in
258
+
259
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:21
260
+
261
+ ___
262
+
263
+ #### confirmButtonText
264
+
265
+ • `Optional` **confirmButtonText**: `string`
266
+
267
+ Custom confirm button text.
268
+
269
+ **`Default Value`**
270
+
271
+ `Confirm`
272
+
273
+ ##### Defined in
274
+
275
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:19
276
+
277
+ ___
278
+
279
+ #### handleCancel
280
+
281
+ • `Optional` **handleCancel**: `MouseEventHandler`<`HTMLButtonElement`\>
282
+
283
+ Function to run when cancel button is clicked.
284
+
285
+ ##### Defined in
286
+
287
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:10
288
+
289
+ ___
290
+
291
+ #### request
292
+
293
+ • **request**: `default`
294
+
295
+ Axios request upon confirmation
296
+
297
+ ##### Defined in
298
+
299
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:12
300
+
301
+ ___
302
+
303
+ #### style
304
+
305
+ • `Optional` **style**: `CSSProperties`
306
+
307
+ ##### Defined in
308
+
309
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:13
310
+
311
+ ___
312
+
313
+ #### title
314
+
315
+ • `Optional` **title**: `string`
316
+
317
+ `<h3/>` title text on top of the form.
318
+
319
+ ##### Defined in
320
+
321
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:15
322
+
323
+
324
+ <a name="interfacesconfirmdeleteformpropsmd"></a>
325
+
326
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ConfirmDeleteFormProps
327
+
328
+ ## Interface: ConfirmDeleteFormProps
329
+
330
+ ### Hierarchy
331
+
332
+ - `Pick`<[`ConfirmBaseFormProps`](#interfacesconfirmbaseformpropsmd), ``"style"``\>
333
+
334
+ ↳ **`ConfirmDeleteFormProps`**
335
+
336
+ ### Table of contents
337
+
338
+ #### Properties
339
+
340
+ - [children](#children)
341
+ - [form](#form)
342
+ - [handleComplete](#handlecomplete)
343
+ - [handleError](#handleerror)
344
+ - [style](#style)
345
+ - [successUrl](#successurl)
346
+ - [title](#title)
347
+
348
+ ### Properties
349
+
350
+ #### children
351
+
352
+ • `Optional` **children**: `ReactNode`
353
+
354
+ Any components to be rendered in between the title and the buttons.
355
+
356
+ ##### Defined in
357
+
358
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:25
359
+
360
+ ___
361
+
362
+ #### form
363
+
364
+ • **form**: `string`
365
+
366
+ Form name (key) to apply the confirmation on.
367
+
368
+ ##### Defined in
369
+
370
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:15
371
+
372
+ ___
373
+
374
+ #### handleComplete
375
+
376
+ • `Optional` **handleComplete**: `Function`
377
+
378
+ Custom function when the axios request succeeds.
379
+
380
+ ##### Defined in
381
+
382
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:21
383
+
384
+ ___
385
+
386
+ #### handleError
387
+
388
+ • `Optional` **handleError**: `Function`
389
+
390
+ Custom function when the axios request fails.
391
+
392
+ ##### Defined in
393
+
394
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:23
395
+
396
+ ___
397
+
398
+ #### style
399
+
400
+ • `Optional` **style**: `CSSProperties`
401
+
402
+ ##### Inherited from
403
+
404
+ Pick.style
405
+
406
+ ##### Defined in
407
+
408
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:13
409
+
410
+ ___
411
+
412
+ #### successUrl
413
+
414
+ • `Optional` **successUrl**: `string`
415
+
416
+ Url to navigate to on success.
417
+
418
+ ##### Defined in
419
+
420
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:13
421
+
422
+ ___
423
+
424
+ #### title
425
+
426
+ • `Optional` **title**: `string`
427
+
428
+ Custom message to display.
429
+
430
+ **`Default Value`**
431
+
432
+ `Are you sure you want to delete this?`
433
+
434
+ ##### Defined in
435
+
436
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:19
437
+
438
+
439
+ <a name="interfacesdatepickergrouppropsmd"></a>
440
+
441
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / DatePickerGroupProps
442
+
443
+ ## Interface: DatePickerGroupProps<T\>
444
+
445
+ Defines what is injected by a Field wrapper of some TRenderComponent
446
+
447
+ ### Type parameters
448
+
449
+ | Name |
450
+ | :------ |
451
+ | `T` |
452
+
453
+ ### Hierarchy
454
+
455
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T` \| `undefined` \| ``null``\>
456
+
457
+ - `Omit`<`DatePickerProps`, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"name"`` \| ``"value"`` \| ``"className"``\>
458
+
459
+ - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`T`\> \| ``"children"``\>
460
+
461
+ ↳ **`DatePickerGroupProps`**
462
+
463
+ ### Table of contents
464
+
465
+ #### Properties
466
+
467
+ - [className](#classname)
468
+ - [convert](#convert)
469
+ - [helpText](#helptext)
470
+ - [input](#input)
471
+ - [label](#label)
472
+ - [meta](#meta)
473
+
474
+ ### Properties
475
+
476
+ #### className
477
+
478
+ • `Optional` **className**: `string`
479
+
480
+ Extra class names to apply.
481
+
482
+ ##### Inherited from
483
+
484
+ Omit.className
485
+
486
+ ##### Defined in
487
+
488
+ packages/envoc-form/src/Group.tsx:8
489
+
490
+ ___
491
+
492
+ #### convert
493
+
494
+ • **convert**: (`arg`: `Date`) => `T`
495
+
496
+ ##### Type declaration
497
+
498
+ ▸ (`arg`): `T`
499
+
500
+ ###### Parameters
501
+
502
+ | Name | Type |
503
+ | :------ | :------ |
504
+ | `arg` | `Date` |
505
+
506
+ ###### Returns
507
+
508
+ `T`
509
+
510
+ ##### Defined in
511
+
512
+ packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:18
513
+
514
+ ___
515
+
516
+ #### helpText
517
+
518
+ • `Optional` **helpText**: `ReactNode`
519
+
520
+ Simple helper text after the input.
521
+
522
+ ##### Inherited from
523
+
524
+ Omit.helpText
525
+
526
+ ##### Defined in
527
+
528
+ packages/envoc-form/src/Group.tsx:16
529
+
530
+ ___
531
+
532
+ #### input
533
+
534
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `T`\>
535
+
536
+ ##### Inherited from
537
+
538
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
539
+
540
+ ##### Defined in
541
+
542
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
543
+
544
+ ___
545
+
546
+ #### label
547
+
548
+ • `Optional` **label**: `string`
549
+
550
+ Simple text label before the input.
551
+
552
+ ##### Inherited from
553
+
554
+ Omit.label
555
+
556
+ ##### Defined in
557
+
558
+ packages/envoc-form/src/Group.tsx:13
559
+
560
+ ___
561
+
562
+ #### meta
563
+
564
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `T`\>
565
+
566
+ ##### Inherited from
567
+
568
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
569
+
570
+ ##### Defined in
571
+
572
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
573
+
574
+
575
+ <a name="interfacesdatepickerhelpermd"></a>
576
+
577
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / DatePickerHelper
578
+
579
+ ## Interface: DatePickerHelper<T\>
580
+
581
+ ### Type parameters
582
+
583
+ | Name |
584
+ | :------ |
585
+ | `T` |
586
+
587
+ ### Hierarchy
588
+
589
+ - `Omit`<[`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)<`T`\>, ``"convert"``\>
590
+
591
+ ↳ **`DatePickerHelper`**
592
+
593
+ ↳↳ [`StringDatePickerGroupProps`](#interfacesstringdatepickergrouppropsmd)
594
+
595
+ ↳↳ [`StringDateOnlyPickerGroupProps`](#interfacesstringdateonlypickergrouppropsmd)
596
+
597
+ ### Table of contents
598
+
599
+ #### Properties
600
+
601
+ - [className](#classname)
602
+ - [helpText](#helptext)
603
+ - [input](#input)
604
+ - [label](#label)
605
+ - [meta](#meta)
606
+
607
+ ### Properties
608
+
609
+ #### className
610
+
611
+ • `Optional` **className**: `string`
612
+
613
+ Extra class names to apply.
614
+
615
+ ##### Inherited from
616
+
617
+ Omit.className
618
+
619
+ ##### Defined in
620
+
621
+ packages/envoc-form/src/Group.tsx:8
622
+
623
+ ___
624
+
625
+ #### helpText
626
+
627
+ • `Optional` **helpText**: `ReactNode`
628
+
629
+ Simple helper text after the input.
630
+
631
+ ##### Inherited from
632
+
633
+ Omit.helpText
634
+
635
+ ##### Defined in
636
+
637
+ packages/envoc-form/src/Group.tsx:16
638
+
639
+ ___
640
+
641
+ #### input
642
+
643
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `T`\>
644
+
645
+ ##### Inherited from
646
+
647
+ Omit.input
648
+
649
+ ##### Defined in
650
+
651
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
652
+
653
+ ___
654
+
655
+ #### label
656
+
657
+ • `Optional` **label**: `string`
658
+
659
+ Simple text label before the input.
660
+
661
+ ##### Inherited from
662
+
663
+ Omit.label
664
+
665
+ ##### Defined in
666
+
667
+ packages/envoc-form/src/Group.tsx:13
668
+
669
+ ___
670
+
671
+ #### meta
672
+
673
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `T`\>
674
+
675
+ ##### Inherited from
676
+
677
+ Omit.meta
678
+
679
+ ##### Defined in
680
+
681
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
682
+
683
+
684
+ <a name="interfacesfilegrouppropsmd"></a>
685
+
686
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / FileGroupProps
687
+
688
+ ## Interface: FileGroupProps
689
+
690
+ Defines what is injected by a Field wrapper of some TRenderComponent
691
+
692
+ ### Hierarchy
693
+
694
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any` \| `undefined` \| ``null``\>
695
+
696
+ - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\>
697
+
698
+ - `Omit`<`React.HTMLProps`<`HTMLInputElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"``\>
699
+
700
+ ↳ **`FileGroupProps`**
701
+
702
+ ### Table of contents
703
+
704
+ #### Properties
705
+
706
+ - [className](#classname)
707
+ - [disabled](#disabled)
708
+ - [helpText](#helptext)
709
+ - [input](#input)
710
+ - [label](#label)
711
+ - [meta](#meta)
712
+ - [multiple](#multiple)
713
+ - [required](#required)
714
+
715
+ ### Properties
716
+
717
+ #### className
718
+
719
+ • `Optional` **className**: `string`
720
+
721
+ Extra class names to apply.
722
+
723
+ ##### Inherited from
724
+
725
+ Omit.className
726
+
727
+ ##### Defined in
728
+
729
+ packages/envoc-form/src/Group.tsx:8
730
+
731
+ ___
732
+
733
+ #### disabled
734
+
735
+ • `Optional` **disabled**: `boolean`
736
+
737
+ Whether the field should be disabled.
738
+
739
+ ##### Inherited from
740
+
741
+ Omit.disabled
742
+
743
+ ##### Defined in
744
+
745
+ packages/envoc-form/src/Group.tsx:19
746
+
747
+ ___
748
+
749
+ #### helpText
750
+
751
+ • `Optional` **helpText**: `ReactNode`
752
+
753
+ Simple helper text after the input.
754
+
755
+ ##### Inherited from
756
+
757
+ Omit.helpText
758
+
759
+ ##### Defined in
760
+
761
+ packages/envoc-form/src/Group.tsx:16
762
+
763
+ ___
764
+
765
+ #### input
766
+
767
+ • **input**: `CustomFieldInputProps`<`any`\>
768
+
769
+ ##### Inherited from
770
+
771
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
772
+
773
+ ##### Defined in
774
+
775
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
776
+
777
+ ___
778
+
779
+ #### label
780
+
781
+ • `Optional` **label**: `string`
782
+
783
+ Simple text label before the input.
784
+
785
+ ##### Inherited from
786
+
787
+ Omit.label
788
+
789
+ ##### Defined in
790
+
791
+ packages/envoc-form/src/Group.tsx:13
792
+
793
+ ___
794
+
795
+ #### meta
796
+
797
+ • **meta**: `CustomFieldMetaProps`<`any`\>
798
+
799
+ ##### Inherited from
800
+
801
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
802
+
803
+ ##### Defined in
804
+
805
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
806
+
807
+ ___
808
+
809
+ #### multiple
810
+
811
+ • `Optional` **multiple**: `boolean`
812
+
813
+ Allow multiple files to be uploaded.
814
+
815
+ ##### Overrides
816
+
817
+ Omit.multiple
818
+
819
+ ##### Defined in
820
+
821
+ packages/envoc-form/src/File/FileGroup.tsx:17
822
+
823
+ ___
824
+
825
+ #### required
826
+
827
+ • `Optional` **required**: `boolean`
828
+
829
+ ##### Inherited from
830
+
831
+ Omit.required
832
+
833
+ ##### Defined in
834
+
835
+ packages/envoc-form/src/Group.tsx:21
836
+
837
+
838
+ <a name="interfacesformactionspropsmd"></a>
839
+
840
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / FormActionsProps
841
+
842
+ ## Interface: FormActionsProps
843
+
844
+ ### Table of contents
845
+
846
+ #### Properties
847
+
848
+ - [allowPristineSubmit](#allowpristinesubmit)
849
+ - [disabled](#disabled)
850
+ - [handleCancel](#handlecancel)
851
+
852
+ ### Properties
853
+
854
+ #### allowPristineSubmit
855
+
856
+ • `Optional` **allowPristineSubmit**: `boolean`
857
+
858
+ Allow the form to be submitted without any changes. By default this is not allowed.
859
+
860
+ ##### Defined in
861
+
862
+ packages/envoc-form/src/FormActions.tsx:7
863
+
864
+ ___
865
+
866
+ #### disabled
867
+
868
+ • `Optional` **disabled**: `boolean`
869
+
870
+ Whether both buttons should be disabled.
871
+
872
+ ##### Defined in
873
+
874
+ packages/envoc-form/src/FormActions.tsx:13
875
+
876
+ ___
877
+
878
+ #### handleCancel
879
+
880
+ • `Optional` **handleCancel**: () => `void`
881
+
882
+ ##### Type declaration
883
+
884
+ ▸ (): `void`
885
+
886
+ The cancel button's `onClick`.
887
+
888
+ **`Default Value`**
889
+
890
+ `window.history.back()`
891
+
892
+ ###### Returns
893
+
894
+ `void`
895
+
896
+ ##### Defined in
897
+
898
+ packages/envoc-form/src/FormActions.tsx:11
899
+
900
+
901
+ <a name="interfacesgrouppropsmd"></a>
902
+
903
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / GroupProps
904
+
905
+ ## Interface: GroupProps
906
+
907
+ Defines what is injected by a Field wrapper of some TRenderComponent
908
+
909
+ ### Hierarchy
910
+
911
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\>
912
+
913
+ ↳ **`GroupProps`**
914
+
915
+ ### Table of contents
916
+
917
+ #### Properties
918
+
919
+ - [children](#children)
920
+ - [className](#classname)
921
+ - [disabled](#disabled)
922
+ - [helpText](#helptext)
923
+ - [input](#input)
924
+ - [label](#label)
925
+ - [meta](#meta)
926
+ - [required](#required)
927
+
928
+ ### Properties
929
+
930
+ #### children
931
+
932
+ • **children**: `ReactNode`
933
+
934
+ ##### Defined in
935
+
936
+ packages/envoc-form/src/Group.tsx:10
937
+
938
+ ___
939
+
940
+ #### className
941
+
942
+ • `Optional` **className**: `string`
943
+
944
+ Extra class names to apply.
945
+
946
+ ##### Defined in
947
+
948
+ packages/envoc-form/src/Group.tsx:8
949
+
950
+ ___
951
+
952
+ #### disabled
953
+
954
+ • `Optional` **disabled**: `boolean`
955
+
956
+ Whether the field should be disabled.
957
+
958
+ ##### Defined in
959
+
960
+ packages/envoc-form/src/Group.tsx:19
961
+
962
+ ___
963
+
964
+ #### helpText
965
+
966
+ • `Optional` **helpText**: `ReactNode`
967
+
968
+ Simple helper text after the input.
969
+
970
+ ##### Defined in
971
+
972
+ packages/envoc-form/src/Group.tsx:16
973
+
974
+ ___
975
+
976
+ #### input
977
+
978
+ • **input**: `CustomFieldInputProps`<`any`\>
979
+
980
+ ##### Inherited from
981
+
982
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
983
+
984
+ ##### Defined in
985
+
986
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
987
+
988
+ ___
989
+
990
+ #### label
991
+
992
+ • `Optional` **label**: `string`
993
+
994
+ Simple text label before the input.
995
+
996
+ ##### Defined in
997
+
998
+ packages/envoc-form/src/Group.tsx:13
999
+
1000
+ ___
1001
+
1002
+ #### meta
1003
+
1004
+ • **meta**: `CustomFieldMetaProps`<`any`\>
1005
+
1006
+ ##### Inherited from
1007
+
1008
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
1009
+
1010
+ ##### Defined in
1011
+
1012
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1013
+
1014
+ ___
1015
+
1016
+ #### required
1017
+
1018
+ • `Optional` **required**: `boolean`
1019
+
1020
+ ##### Defined in
1021
+
1022
+ packages/envoc-form/src/Group.tsx:21
1023
+
1024
+
1025
+ <a name="interfacesiconinputgrouppropsmd"></a>
1026
+
1027
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / IconInputGroupProps
1028
+
1029
+ ## Interface: IconInputGroupProps
1030
+
1031
+ ### Hierarchy
1032
+
1033
+ - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\>
1034
+
1035
+ ↳ **`IconInputGroupProps`**
1036
+
1037
+ ### Table of contents
1038
+
1039
+ #### Properties
1040
+
1041
+ - [className](#classname)
1042
+ - [helpText](#helptext)
1043
+ - [icon](#icon)
1044
+ - [input](#input)
1045
+ - [label](#label)
1046
+ - [meta](#meta)
1047
+ - [type](#type)
1048
+
1049
+ ### Properties
1050
+
1051
+ #### className
1052
+
1053
+ • `Optional` **className**: `string`
1054
+
1055
+ Extra class names to apply.
1056
+
1057
+ ##### Inherited from
1058
+
1059
+ Omit.className
1060
+
1061
+ ##### Defined in
1062
+
1063
+ packages/envoc-form/src/Group.tsx:8
1064
+
1065
+ ___
1066
+
1067
+ #### helpText
1068
+
1069
+ • `Optional` **helpText**: `string`
1070
+
1071
+ Text to display after the input group to give more information to the user.
1072
+
1073
+ ##### Overrides
1074
+
1075
+ Omit.helpText
1076
+
1077
+ ##### Defined in
1078
+
1079
+ packages/envoc-form/src/Input/IconInputGroup.tsx:17
1080
+
1081
+ ___
1082
+
1083
+ #### icon
1084
+
1085
+ • **icon**: `ReactNode`
1086
+
1087
+ Icon to display on the input group.
1088
+
1089
+ ##### Overrides
1090
+
1091
+ Omit.icon
1092
+
1093
+ ##### Defined in
1094
+
1095
+ packages/envoc-form/src/Input/IconInputGroup.tsx:15
1096
+
1097
+ ___
1098
+
1099
+ #### input
1100
+
1101
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
1102
+
1103
+ ##### Inherited from
1104
+
1105
+ Omit.input
1106
+
1107
+ ##### Defined in
1108
+
1109
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1110
+
1111
+ ___
1112
+
1113
+ #### label
1114
+
1115
+ • `Optional` **label**: `string`
1116
+
1117
+ Simple text label before the input.
1118
+
1119
+ ##### Inherited from
1120
+
1121
+ Omit.label
1122
+
1123
+ ##### Defined in
1124
+
1125
+ packages/envoc-form/src/Group.tsx:13
1126
+
1127
+ ___
1128
+
1129
+ #### meta
1130
+
1131
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
1132
+
1133
+ ##### Inherited from
1134
+
1135
+ Omit.meta
1136
+
1137
+ ##### Defined in
1138
+
1139
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1140
+
1141
+ ___
1142
+
1143
+ #### type
1144
+
1145
+ • `Optional` **type**: ``"color"`` \| ``"search"`` \| ``"text"`` \| ``"tel"`` \| ``"url"`` \| ``"email"``
1146
+
1147
+ ##### Defined in
1148
+
1149
+ packages/envoc-form/src/Input/IconInputGroup.tsx:13
1150
+
1151
+
1152
+ <a name="interfacesinjectedfieldpropsmd"></a>
1153
+
1154
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / InjectedFieldProps
1155
+
1156
+ ## Interface: InjectedFieldProps<TValue\>
1157
+
1158
+ Defines what is injected by a Field wrapper of some TRenderComponent
1159
+
1160
+ ### Type parameters
1161
+
1162
+ | Name |
1163
+ | :------ |
1164
+ | `TValue` |
1165
+
1166
+ ### Hierarchy
1167
+
1168
+ - **`InjectedFieldProps`**
1169
+
1170
+ ↳ [`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)
1171
+
1172
+ ↳ [`FileGroupProps`](#interfacesfilegrouppropsmd)
1173
+
1174
+ ↳ [`GroupProps`](#interfacesgrouppropsmd)
1175
+
1176
+ ↳ [`InputGroupProps`](#interfacesinputgrouppropsmd)
1177
+
1178
+ ↳ [`SelectGroupProps`](#interfacesselectgrouppropsmd)
1179
+
1180
+ ↳ [`TextAreaGroupProps`](#interfacestextareagrouppropsmd)
1181
+
1182
+ ### Table of contents
1183
+
1184
+ #### Properties
1185
+
1186
+ - [input](#input)
1187
+ - [meta](#meta)
1188
+
1189
+ ### Properties
1190
+
1191
+ #### input
1192
+
1193
+ • **input**: `CustomFieldInputProps`<`TValue`\>
1194
+
1195
+ ##### Defined in
1196
+
1197
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1198
+
1199
+ ___
1200
+
1201
+ #### meta
1202
+
1203
+ • **meta**: `CustomFieldMetaProps`<`TValue`\>
1204
+
1205
+ ##### Defined in
1206
+
1207
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1208
+
1209
+
1210
+ <a name="interfacesinputgrouppropsmd"></a>
1211
+
1212
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / InputGroupProps
1213
+
1214
+ ## Interface: InputGroupProps<TValue\>
1215
+
1216
+ Defines what is injected by a Field wrapper of some TRenderComponent
1217
+
1218
+ ### Type parameters
1219
+
1220
+ | Name |
1221
+ | :------ |
1222
+ | `TValue` |
1223
+
1224
+ ### Hierarchy
1225
+
1226
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue`\>
1227
+
1228
+ - `Omit`<`React.HTMLProps`<`HTMLInputElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"`` \| ``"value"``\>
1229
+
1230
+ - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\>
1231
+
1232
+ ↳ **`InputGroupProps`**
1233
+
1234
+ ### Table of contents
1235
+
1236
+ #### Properties
1237
+
1238
+ - [className](#classname)
1239
+ - [helpText](#helptext)
1240
+ - [icon](#icon)
1241
+ - [input](#input)
1242
+ - [label](#label)
1243
+ - [meta](#meta)
1244
+ - [onChange](#onchange)
1245
+ - [value](#value)
1246
+
1247
+ ### Properties
1248
+
1249
+ #### className
1250
+
1251
+ • `Optional` **className**: `string`
1252
+
1253
+ Extra class names to apply.
1254
+
1255
+ ##### Inherited from
1256
+
1257
+ Omit.className
1258
+
1259
+ ##### Defined in
1260
+
1261
+ packages/envoc-form/src/Group.tsx:8
1262
+
1263
+ ___
1264
+
1265
+ #### helpText
1266
+
1267
+ • `Optional` **helpText**: `ReactNode`
1268
+
1269
+ Simple helper text after the input.
1270
+
1271
+ ##### Inherited from
1272
+
1273
+ Omit.helpText
1274
+
1275
+ ##### Defined in
1276
+
1277
+ packages/envoc-form/src/Group.tsx:16
1278
+
1279
+ ___
1280
+
1281
+ #### icon
1282
+
1283
+ • `Optional` **icon**: `ReactNode`
1284
+
1285
+ ##### Defined in
1286
+
1287
+ packages/envoc-form/src/Input/InputGroup.tsx:20
1288
+
1289
+ ___
1290
+
1291
+ #### input
1292
+
1293
+ • **input**: `CustomFieldInputProps`<`TValue`\>
1294
+
1295
+ ##### Inherited from
1296
+
1297
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
1298
+
1299
+ ##### Defined in
1300
+
1301
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1302
+
1303
+ ___
1304
+
1305
+ #### label
1306
+
1307
+ • `Optional` **label**: `string`
1308
+
1309
+ Simple text label before the input.
1310
+
1311
+ ##### Inherited from
1312
+
1313
+ Omit.label
1314
+
1315
+ ##### Defined in
1316
+
1317
+ packages/envoc-form/src/Group.tsx:13
1318
+
1319
+ ___
1320
+
1321
+ #### meta
1322
+
1323
+ • **meta**: `CustomFieldMetaProps`<`TValue`\>
1324
+
1325
+ ##### Inherited from
1326
+
1327
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
1328
+
1329
+ ##### Defined in
1330
+
1331
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1332
+
1333
+ ___
1334
+
1335
+ #### onChange
1336
+
1337
+ • **onChange**: `ChangeEventHandler`<`HTMLInputElement`\>
1338
+
1339
+ ##### Overrides
1340
+
1341
+ Omit.onChange
1342
+
1343
+ ##### Defined in
1344
+
1345
+ packages/envoc-form/src/Input/InputGroup.tsx:18
1346
+
1347
+ ___
1348
+
1349
+ #### value
1350
+
1351
+ • **value**: `undefined` \| ``null`` \| `string` \| `number`
1352
+
1353
+ ##### Defined in
1354
+
1355
+ packages/envoc-form/src/Input/InputGroup.tsx:19
1356
+
1357
+
1358
+ <a name="interfacesmoneyinputgrouppropsmd"></a>
1359
+
1360
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / MoneyInputGroupProps
1361
+
1362
+ ## Interface: MoneyInputGroupProps
1363
+
1364
+ ### Hierarchy
1365
+
1366
+ - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`number` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\>
1367
+
1368
+ ↳ **`MoneyInputGroupProps`**
1369
+
1370
+ ### Table of contents
1371
+
1372
+ #### Properties
1373
+
1374
+ - [className](#classname)
1375
+ - [helpText](#helptext)
1376
+ - [icon](#icon)
1377
+ - [input](#input)
1378
+ - [label](#label)
1379
+ - [meta](#meta)
1380
+ - [parseFunc](#parsefunc)
1381
+
1382
+ ### Properties
1383
+
1384
+ #### className
1385
+
1386
+ • `Optional` **className**: `string`
1387
+
1388
+ Extra class names to apply.
1389
+
1390
+ ##### Inherited from
1391
+
1392
+ Omit.className
1393
+
1394
+ ##### Defined in
1395
+
1396
+ packages/envoc-form/src/Group.tsx:8
1397
+
1398
+ ___
1399
+
1400
+ #### helpText
1401
+
1402
+ • `Optional` **helpText**: `ReactNode`
1403
+
1404
+ Simple helper text after the input.
1405
+
1406
+ ##### Inherited from
1407
+
1408
+ Omit.helpText
1409
+
1410
+ ##### Defined in
1411
+
1412
+ packages/envoc-form/src/Group.tsx:16
1413
+
1414
+ ___
1415
+
1416
+ #### icon
1417
+
1418
+ • `Optional` **icon**: `ReactNode`
1419
+
1420
+ ##### Inherited from
1421
+
1422
+ Omit.icon
1423
+
1424
+ ##### Defined in
1425
+
1426
+ packages/envoc-form/src/Input/InputGroup.tsx:20
1427
+
1428
+ ___
1429
+
1430
+ #### input
1431
+
1432
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`\>
1433
+
1434
+ ##### Inherited from
1435
+
1436
+ Omit.input
1437
+
1438
+ ##### Defined in
1439
+
1440
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1441
+
1442
+ ___
1443
+
1444
+ #### label
1445
+
1446
+ • `Optional` **label**: `string`
1447
+
1448
+ Simple text label before the input.
1449
+
1450
+ ##### Inherited from
1451
+
1452
+ Omit.label
1453
+
1454
+ ##### Defined in
1455
+
1456
+ packages/envoc-form/src/Group.tsx:13
1457
+
1458
+ ___
1459
+
1460
+ #### meta
1461
+
1462
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`\>
1463
+
1464
+ ##### Inherited from
1465
+
1466
+ Omit.meta
1467
+
1468
+ ##### Defined in
1469
+
1470
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1471
+
1472
+ ___
1473
+
1474
+ #### parseFunc
1475
+
1476
+ • `Optional` **parseFunc**: (`string`: `string`) => `number` \| (`string`: `string`, `radix?`: `number`) => `number`
1477
+
1478
+ Custom parsing function when the value changes.
1479
+
1480
+ ##### Defined in
1481
+
1482
+ packages/envoc-form/src/Input/MoneyInputGroup.tsx:12
1483
+
1484
+
1485
+ <a name="interfacesmultinumberselectgrouppropsmd"></a>
1486
+
1487
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / MultiNumberSelectGroupProps
1488
+
1489
+ ## Interface: MultiNumberSelectGroupProps
1490
+
1491
+ ### Hierarchy
1492
+
1493
+ - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`number`[] \| `undefined` \| ``null``\>
1494
+
1495
+ ↳ **`MultiNumberSelectGroupProps`**
1496
+
1497
+ ### Table of contents
1498
+
1499
+ #### Properties
1500
+
1501
+ - [className](#classname)
1502
+ - [disabled](#disabled)
1503
+ - [helpText](#helptext)
1504
+ - [input](#input)
1505
+ - [label](#label)
1506
+ - [meta](#meta)
1507
+ - [options](#options)
1508
+ - [placeholder](#placeholder)
1509
+ - [required](#required)
1510
+
1511
+ ### Properties
1512
+
1513
+ #### className
1514
+
1515
+ • `Optional` **className**: `string`
1516
+
1517
+ Extra class names to apply.
1518
+
1519
+ ##### Inherited from
1520
+
1521
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname)
1522
+
1523
+ ##### Defined in
1524
+
1525
+ packages/envoc-form/src/Group.tsx:8
1526
+
1527
+ ___
1528
+
1529
+ #### disabled
1530
+
1531
+ • `Optional` **disabled**: `boolean`
1532
+
1533
+ Whether the field should be disabled.
1534
+
1535
+ ##### Inherited from
1536
+
1537
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled)
1538
+
1539
+ ##### Defined in
1540
+
1541
+ packages/envoc-form/src/Group.tsx:19
1542
+
1543
+ ___
1544
+
1545
+ #### helpText
1546
+
1547
+ • `Optional` **helpText**: `ReactNode`
1548
+
1549
+ Simple helper text after the input.
1550
+
1551
+ ##### Inherited from
1552
+
1553
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext)
1554
+
1555
+ ##### Defined in
1556
+
1557
+ packages/envoc-form/src/Group.tsx:16
1558
+
1559
+ ___
1560
+
1561
+ #### input
1562
+
1563
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`[]\>
1564
+
1565
+ ##### Inherited from
1566
+
1567
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input)
1568
+
1569
+ ##### Defined in
1570
+
1571
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1572
+
1573
+ ___
1574
+
1575
+ #### label
1576
+
1577
+ • `Optional` **label**: `string`
1578
+
1579
+ Simple text label before the input.
1580
+
1581
+ ##### Inherited from
1582
+
1583
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label)
1584
+
1585
+ ##### Defined in
1586
+
1587
+ packages/envoc-form/src/Group.tsx:13
1588
+
1589
+ ___
1590
+
1591
+ #### meta
1592
+
1593
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`[]\>
1594
+
1595
+ ##### Inherited from
1596
+
1597
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta)
1598
+
1599
+ ##### Defined in
1600
+
1601
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1602
+
1603
+ ___
1604
+
1605
+ #### options
1606
+
1607
+ • **options**: `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`[]\> \| [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`[]\>[]
1608
+
1609
+ Options for the dropdown. Includes the label and value.
1610
+
1611
+ ##### Inherited from
1612
+
1613
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#options)
1614
+
1615
+ ##### Defined in
1616
+
1617
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
1618
+
1619
+ ___
1620
+
1621
+ #### placeholder
1622
+
1623
+ • `Optional` **placeholder**: `string`
1624
+
1625
+ Text diplayed when no value is selected.
1626
+
1627
+ ##### Inherited from
1628
+
1629
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder)
1630
+
1631
+ ##### Defined in
1632
+
1633
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
1634
+
1635
+ ___
1636
+
1637
+ #### required
1638
+
1639
+ • `Optional` **required**: `boolean`
1640
+
1641
+ ##### Inherited from
1642
+
1643
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required)
1644
+
1645
+ ##### Defined in
1646
+
1647
+ packages/envoc-form/src/Group.tsx:21
1648
+
1649
+
1650
+ <a name="interfacesmultistringselectgrouppropsmd"></a>
1651
+
1652
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / MultiStringSelectGroupProps
1653
+
1654
+ ## Interface: MultiStringSelectGroupProps
1655
+
1656
+ ### Hierarchy
1657
+
1658
+ - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`string`[]\>
1659
+
1660
+ ↳ **`MultiStringSelectGroupProps`**
1661
+
1662
+ ### Table of contents
1663
+
1664
+ #### Properties
1665
+
1666
+ - [className](#classname)
1667
+ - [disabled](#disabled)
1668
+ - [helpText](#helptext)
1669
+ - [input](#input)
1670
+ - [label](#label)
1671
+ - [meta](#meta)
1672
+ - [options](#options)
1673
+ - [placeholder](#placeholder)
1674
+ - [required](#required)
1675
+
1676
+ ### Properties
1677
+
1678
+ #### className
1679
+
1680
+ • `Optional` **className**: `string`
1681
+
1682
+ Extra class names to apply.
1683
+
1684
+ ##### Inherited from
1685
+
1686
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname)
1687
+
1688
+ ##### Defined in
1689
+
1690
+ packages/envoc-form/src/Group.tsx:8
1691
+
1692
+ ___
1693
+
1694
+ #### disabled
1695
+
1696
+ • `Optional` **disabled**: `boolean`
1697
+
1698
+ Whether the field should be disabled.
1699
+
1700
+ ##### Inherited from
1701
+
1702
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled)
1703
+
1704
+ ##### Defined in
1705
+
1706
+ packages/envoc-form/src/Group.tsx:19
1707
+
1708
+ ___
1709
+
1710
+ #### helpText
1711
+
1712
+ • `Optional` **helpText**: `ReactNode`
1713
+
1714
+ Simple helper text after the input.
1715
+
1716
+ ##### Inherited from
1717
+
1718
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext)
1719
+
1720
+ ##### Defined in
1721
+
1722
+ packages/envoc-form/src/Group.tsx:16
1723
+
1724
+ ___
1725
+
1726
+ #### input
1727
+
1728
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`[]\>
1729
+
1730
+ ##### Inherited from
1731
+
1732
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input)
1733
+
1734
+ ##### Defined in
1735
+
1736
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1737
+
1738
+ ___
1739
+
1740
+ #### label
1741
+
1742
+ • `Optional` **label**: `string`
1743
+
1744
+ Simple text label before the input.
1745
+
1746
+ ##### Inherited from
1747
+
1748
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label)
1749
+
1750
+ ##### Defined in
1751
+
1752
+ packages/envoc-form/src/Group.tsx:13
1753
+
1754
+ ___
1755
+
1756
+ #### meta
1757
+
1758
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`[]\>
1759
+
1760
+ ##### Inherited from
1761
+
1762
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta)
1763
+
1764
+ ##### Defined in
1765
+
1766
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1767
+
1768
+ ___
1769
+
1770
+ #### options
1771
+
1772
+ • **options**: `OptionsUseServiceResult`<`string`[]\> \| [`SelectOption`](#interfacesselectoptionmd)<`string`[]\>[]
1773
+
1774
+ Options for the dropdown. Includes the label and value.
1775
+
1776
+ ##### Inherited from
1777
+
1778
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#options)
1779
+
1780
+ ##### Defined in
1781
+
1782
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
1783
+
1784
+ ___
1785
+
1786
+ #### placeholder
1787
+
1788
+ • `Optional` **placeholder**: `string`
1789
+
1790
+ Text diplayed when no value is selected.
1791
+
1792
+ ##### Inherited from
1793
+
1794
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder)
1795
+
1796
+ ##### Defined in
1797
+
1798
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
1799
+
1800
+ ___
1801
+
1802
+ #### required
1803
+
1804
+ • `Optional` **required**: `boolean`
1805
+
1806
+ ##### Inherited from
1807
+
1808
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required)
1809
+
1810
+ ##### Defined in
1811
+
1812
+ packages/envoc-form/src/Group.tsx:21
1813
+
1814
+
1815
+ <a name="interfacesnormalizationfunctionmd"></a>
1816
+
1817
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / NormalizationFunction
1818
+
1819
+ ## Interface: NormalizationFunction<TValue\>
1820
+
1821
+ Normalization of values
1822
+
1823
+ ### Type parameters
1824
+
1825
+ | Name |
1826
+ | :------ |
1827
+ | `TValue` |
1828
+
1829
+ ### Callable
1830
+
1831
+ #### NormalizationFunction
1832
+
1833
+ ▸ **NormalizationFunction**(`value`): `TValue`
1834
+
1835
+ ##### Parameters
1836
+
1837
+ | Name | Type |
1838
+ | :------ | :------ |
1839
+ | `value` | `TValue` |
1840
+
1841
+ ##### Returns
1842
+
1843
+ `TValue`
1844
+
1845
+ ##### Defined in
1846
+
1847
+ packages/envoc-form/src/Normalization/NormalizationFunction.ts:3
1848
+
1849
+
1850
+ <a name="interfacesnumberinputgrouppropsmd"></a>
1851
+
1852
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / NumberInputGroupProps
1853
+
1854
+ ## Interface: NumberInputGroupProps
1855
+
1856
+ ### Hierarchy
1857
+
1858
+ - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`number` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\>
1859
+
1860
+ ↳ **`NumberInputGroupProps`**
1861
+
1862
+ ### Table of contents
1863
+
1864
+ #### Properties
1865
+
1866
+ - [className](#classname)
1867
+ - [helpText](#helptext)
1868
+ - [icon](#icon)
1869
+ - [input](#input)
1870
+ - [label](#label)
1871
+ - [meta](#meta)
1872
+ - [parseFunc](#parsefunc)
1873
+
1874
+ ### Properties
1875
+
1876
+ #### className
1877
+
1878
+ • `Optional` **className**: `string`
1879
+
1880
+ Extra class names to apply.
1881
+
1882
+ ##### Inherited from
1883
+
1884
+ Omit.className
1885
+
1886
+ ##### Defined in
1887
+
1888
+ packages/envoc-form/src/Group.tsx:8
1889
+
1890
+ ___
1891
+
1892
+ #### helpText
1893
+
1894
+ • `Optional` **helpText**: `ReactNode`
1895
+
1896
+ Simple helper text after the input.
1897
+
1898
+ ##### Inherited from
1899
+
1900
+ Omit.helpText
1901
+
1902
+ ##### Defined in
1903
+
1904
+ packages/envoc-form/src/Group.tsx:16
1905
+
1906
+ ___
1907
+
1908
+ #### icon
1909
+
1910
+ • `Optional` **icon**: `ReactNode`
1911
+
1912
+ ##### Inherited from
1913
+
1914
+ Omit.icon
1915
+
1916
+ ##### Defined in
1917
+
1918
+ packages/envoc-form/src/Input/InputGroup.tsx:20
1919
+
1920
+ ___
1921
+
1922
+ #### input
1923
+
1924
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`\>
1925
+
1926
+ ##### Inherited from
1927
+
1928
+ Omit.input
1929
+
1930
+ ##### Defined in
1931
+
1932
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
1933
+
1934
+ ___
1935
+
1936
+ #### label
1937
+
1938
+ • `Optional` **label**: `string`
1939
+
1940
+ Simple text label before the input.
1941
+
1942
+ ##### Inherited from
1943
+
1944
+ Omit.label
1945
+
1946
+ ##### Defined in
1947
+
1948
+ packages/envoc-form/src/Group.tsx:13
1949
+
1950
+ ___
1951
+
1952
+ #### meta
1953
+
1954
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`\>
1955
+
1956
+ ##### Inherited from
1957
+
1958
+ Omit.meta
1959
+
1960
+ ##### Defined in
1961
+
1962
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
1963
+
1964
+ ___
1965
+
1966
+ #### parseFunc
1967
+
1968
+ • `Optional` **parseFunc**: (`string`: `string`) => `number` \| (`string`: `string`, `radix?`: `number`) => `number`
1969
+
1970
+ Custom parsing function when the value changes.
1971
+
1972
+ ##### Defined in
1973
+
1974
+ packages/envoc-form/src/Input/NumberInputGroup.tsx:12
1975
+
1976
+
1977
+ <a name="interfacesobjecttoformdatacfgpropsmd"></a>
1978
+
1979
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ObjectToFormDataCfgProps
1980
+
1981
+ ## Interface: ObjectToFormDataCfgProps
1982
+
1983
+ ### Table of contents
1984
+
1985
+ #### Properties
1986
+
1987
+ - [allowEmptyArrays](#allowemptyarrays)
1988
+ - [booleansAsIntegers](#booleansasintegers)
1989
+ - [dotNotation](#dotnotation)
1990
+ - [indices](#indices)
1991
+ - [noFileListBrackets](#nofilelistbrackets)
1992
+ - [nullsAsUndefineds](#nullsasundefineds)
1993
+
1994
+ ### Properties
1995
+
1996
+ #### allowEmptyArrays
1997
+
1998
+ • **allowEmptyArrays**: `boolean`
1999
+
2000
+ ##### Defined in
2001
+
2002
+ packages/envoc-form/src/utils/objectToFormData.ts:18
2003
+
2004
+ ___
2005
+
2006
+ #### booleansAsIntegers
2007
+
2008
+ • `Optional` **booleansAsIntegers**: `boolean`
2009
+
2010
+ ##### Defined in
2011
+
2012
+ packages/envoc-form/src/utils/objectToFormData.ts:21
2013
+
2014
+ ___
2015
+
2016
+ #### dotNotation
2017
+
2018
+ • **dotNotation**: `boolean`
2019
+
2020
+ ##### Defined in
2021
+
2022
+ packages/envoc-form/src/utils/objectToFormData.ts:17
2023
+
2024
+ ___
2025
+
2026
+ #### indices
2027
+
2028
+ • **indices**: `boolean`
2029
+
2030
+ ##### Defined in
2031
+
2032
+ packages/envoc-form/src/utils/objectToFormData.ts:16
2033
+
2034
+ ___
2035
+
2036
+ #### noFileListBrackets
2037
+
2038
+ • **noFileListBrackets**: `boolean`
2039
+
2040
+ ##### Defined in
2041
+
2042
+ packages/envoc-form/src/utils/objectToFormData.ts:19
2043
+
2044
+ ___
2045
+
2046
+ #### nullsAsUndefineds
2047
+
2048
+ • `Optional` **nullsAsUndefineds**: `boolean`
2049
+
2050
+ ##### Defined in
2051
+
2052
+ packages/envoc-form/src/utils/objectToFormData.ts:20
2053
+
2054
+
2055
+ <a name="interfacesselectgrouppropsmd"></a>
2056
+
2057
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SelectGroupProps
2058
+
2059
+ ## Interface: SelectGroupProps<TValue\>
2060
+
2061
+ Defines what is injected by a Field wrapper of some TRenderComponent
2062
+
2063
+ ### Type parameters
2064
+
2065
+ | Name |
2066
+ | :------ |
2067
+ | `TValue` |
2068
+
2069
+ ### Hierarchy
2070
+
2071
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\>
2072
+
2073
+ - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), ``"input"`` \| ``"meta"`` \| ``"children"``\>
2074
+
2075
+ ↳ **`SelectGroupProps`**
2076
+
2077
+ ### Table of contents
2078
+
2079
+ #### Properties
2080
+
2081
+ - [className](#classname)
2082
+ - [disabled](#disabled)
2083
+ - [helpText](#helptext)
2084
+ - [input](#input)
2085
+ - [label](#label)
2086
+ - [meta](#meta)
2087
+ - [multiple](#multiple)
2088
+ - [options](#options)
2089
+ - [placeholder](#placeholder)
2090
+ - [required](#required)
2091
+
2092
+ ### Properties
2093
+
2094
+ #### className
2095
+
2096
+ • `Optional` **className**: `string`
2097
+
2098
+ Extra class names to apply.
2099
+
2100
+ ##### Inherited from
2101
+
2102
+ Omit.className
2103
+
2104
+ ##### Defined in
2105
+
2106
+ packages/envoc-form/src/Group.tsx:8
2107
+
2108
+ ___
2109
+
2110
+ #### disabled
2111
+
2112
+ • `Optional` **disabled**: `boolean`
2113
+
2114
+ Whether the field should be disabled.
2115
+
2116
+ ##### Inherited from
2117
+
2118
+ Omit.disabled
2119
+
2120
+ ##### Defined in
2121
+
2122
+ packages/envoc-form/src/Group.tsx:19
2123
+
2124
+ ___
2125
+
2126
+ #### helpText
2127
+
2128
+ • `Optional` **helpText**: `ReactNode`
2129
+
2130
+ Simple helper text after the input.
2131
+
2132
+ ##### Inherited from
2133
+
2134
+ Omit.helpText
2135
+
2136
+ ##### Defined in
2137
+
2138
+ packages/envoc-form/src/Group.tsx:16
2139
+
2140
+ ___
2141
+
2142
+ #### input
2143
+
2144
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `TValue`\>
2145
+
2146
+ ##### Inherited from
2147
+
2148
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
2149
+
2150
+ ##### Defined in
2151
+
2152
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
2153
+
2154
+ ___
2155
+
2156
+ #### label
2157
+
2158
+ • `Optional` **label**: `string`
2159
+
2160
+ Simple text label before the input.
2161
+
2162
+ ##### Inherited from
2163
+
2164
+ Omit.label
2165
+
2166
+ ##### Defined in
2167
+
2168
+ packages/envoc-form/src/Group.tsx:13
2169
+
2170
+ ___
2171
+
2172
+ #### meta
2173
+
2174
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `TValue`\>
2175
+
2176
+ ##### Inherited from
2177
+
2178
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
2179
+
2180
+ ##### Defined in
2181
+
2182
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
2183
+
2184
+ ___
2185
+
2186
+ #### multiple
2187
+
2188
+ • **multiple**: `TValue` extends `any`[] ? ``true`` : ``false``
2189
+
2190
+ Whether the user should be able to have multiple values selected.
2191
+
2192
+ ##### Defined in
2193
+
2194
+ packages/envoc-form/src/Select/SelectGroup.tsx:36
2195
+
2196
+ ___
2197
+
2198
+ #### options
2199
+
2200
+ • **options**: `OptionsUseServiceResult`<`TValue`\> \| [`SelectOption`](#interfacesselectoptionmd)<`TValue`\>[]
2201
+
2202
+ Options for the dropdown. Includes the label and value.
2203
+
2204
+ ##### Defined in
2205
+
2206
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
2207
+
2208
+ ___
2209
+
2210
+ #### placeholder
2211
+
2212
+ • `Optional` **placeholder**: `string`
2213
+
2214
+ Text diplayed when no value is selected.
2215
+
2216
+ ##### Defined in
2217
+
2218
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
2219
+
2220
+ ___
2221
+
2222
+ #### required
2223
+
2224
+ • `Optional` **required**: `boolean`
2225
+
2226
+ ##### Inherited from
2227
+
2228
+ Omit.required
2229
+
2230
+ ##### Defined in
2231
+
2232
+ packages/envoc-form/src/Group.tsx:21
2233
+
2234
+
2235
+ <a name="interfacesselectgrouppropshelpermd"></a>
2236
+
2237
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SelectGroupPropsHelper
2238
+
2239
+ ## Interface: SelectGroupPropsHelper<T\>
2240
+
2241
+ ### Type parameters
2242
+
2243
+ | Name |
2244
+ | :------ |
2245
+ | `T` |
2246
+
2247
+ ### Hierarchy
2248
+
2249
+ - `Omit`<[`SelectGroupProps`](#interfacesselectgrouppropsmd)<`T`\>, ``"multiple"``\>
2250
+
2251
+ ↳ **`SelectGroupPropsHelper`**
2252
+
2253
+ ↳↳ [`MultiNumberSelectGroupProps`](#interfacesmultinumberselectgrouppropsmd)
2254
+
2255
+ ↳↳ [`SingleNumberSelectGroupProps`](#interfacessinglenumberselectgrouppropsmd)
2256
+
2257
+ ↳↳ [`MultiStringSelectGroupProps`](#interfacesmultistringselectgrouppropsmd)
2258
+
2259
+ ↳↳ [`SingleStringSelectGroupProps`](#interfacessinglestringselectgrouppropsmd)
2260
+
2261
+ ### Table of contents
2262
+
2263
+ #### Properties
2264
+
2265
+ - [className](#classname)
2266
+ - [disabled](#disabled)
2267
+ - [helpText](#helptext)
2268
+ - [input](#input)
2269
+ - [label](#label)
2270
+ - [meta](#meta)
2271
+ - [options](#options)
2272
+ - [placeholder](#placeholder)
2273
+ - [required](#required)
2274
+
2275
+ ### Properties
2276
+
2277
+ #### className
2278
+
2279
+ • `Optional` **className**: `string`
2280
+
2281
+ Extra class names to apply.
2282
+
2283
+ ##### Inherited from
2284
+
2285
+ Omit.className
2286
+
2287
+ ##### Defined in
2288
+
2289
+ packages/envoc-form/src/Group.tsx:8
2290
+
2291
+ ___
2292
+
2293
+ #### disabled
2294
+
2295
+ • `Optional` **disabled**: `boolean`
2296
+
2297
+ Whether the field should be disabled.
2298
+
2299
+ ##### Inherited from
2300
+
2301
+ Omit.disabled
2302
+
2303
+ ##### Defined in
2304
+
2305
+ packages/envoc-form/src/Group.tsx:19
2306
+
2307
+ ___
2308
+
2309
+ #### helpText
2310
+
2311
+ • `Optional` **helpText**: `ReactNode`
2312
+
2313
+ Simple helper text after the input.
2314
+
2315
+ ##### Inherited from
2316
+
2317
+ Omit.helpText
2318
+
2319
+ ##### Defined in
2320
+
2321
+ packages/envoc-form/src/Group.tsx:16
2322
+
2323
+ ___
2324
+
2325
+ #### input
2326
+
2327
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `T`\>
2328
+
2329
+ ##### Inherited from
2330
+
2331
+ Omit.input
2332
+
2333
+ ##### Defined in
2334
+
2335
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
2336
+
2337
+ ___
2338
+
2339
+ #### label
2340
+
2341
+ • `Optional` **label**: `string`
2342
+
2343
+ Simple text label before the input.
2344
+
2345
+ ##### Inherited from
2346
+
2347
+ Omit.label
2348
+
2349
+ ##### Defined in
2350
+
2351
+ packages/envoc-form/src/Group.tsx:13
2352
+
2353
+ ___
2354
+
2355
+ #### meta
2356
+
2357
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `T`\>
2358
+
2359
+ ##### Inherited from
2360
+
2361
+ Omit.meta
2362
+
2363
+ ##### Defined in
2364
+
2365
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
2366
+
2367
+ ___
2368
+
2369
+ #### options
2370
+
2371
+ • **options**: `OptionsUseServiceResult`<`T`\> \| [`SelectOption`](#interfacesselectoptionmd)<`T`\>[]
2372
+
2373
+ Options for the dropdown. Includes the label and value.
2374
+
2375
+ ##### Inherited from
2376
+
2377
+ Omit.options
2378
+
2379
+ ##### Defined in
2380
+
2381
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
2382
+
2383
+ ___
2384
+
2385
+ #### placeholder
2386
+
2387
+ • `Optional` **placeholder**: `string`
2388
+
2389
+ Text diplayed when no value is selected.
2390
+
2391
+ ##### Inherited from
2392
+
2393
+ Omit.placeholder
2394
+
2395
+ ##### Defined in
2396
+
2397
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
2398
+
2399
+ ___
2400
+
2401
+ #### required
2402
+
2403
+ • `Optional` **required**: `boolean`
2404
+
2405
+ ##### Inherited from
2406
+
2407
+ Omit.required
2408
+
2409
+ ##### Defined in
2410
+
2411
+ packages/envoc-form/src/Group.tsx:21
2412
+
2413
+
2414
+ <a name="interfacesselectoptionmd"></a>
2415
+
2416
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SelectOption
2417
+
2418
+ ## Interface: SelectOption<TValue\>
2419
+
2420
+ ### Type parameters
2421
+
2422
+ | Name |
2423
+ | :------ |
2424
+ | `TValue` |
2425
+
2426
+ ### Table of contents
2427
+
2428
+ #### Properties
2429
+
2430
+ - [label](#label)
2431
+ - [value](#value)
2432
+
2433
+ ### Properties
2434
+
2435
+ #### label
2436
+
2437
+ • **label**: `string`
2438
+
2439
+ Label for the select. This is displayed to the user.
2440
+
2441
+ ##### Defined in
2442
+
2443
+ packages/envoc-form/src/Select/SelectGroup.tsx:11
2444
+
2445
+ ___
2446
+
2447
+ #### value
2448
+
2449
+ • **value**: `undefined` \| `TValue` extends `P`[] ? `P` : `TValue`
2450
+
2451
+ Value for the select. This will be sent to the API.
2452
+
2453
+ ##### Defined in
2454
+
2455
+ packages/envoc-form/src/Select/SelectGroup.tsx:9
2456
+
2457
+
2458
+ <a name="interfacesservererrorcontextpropsmd"></a>
2459
+
2460
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ServerErrorContextProps
2461
+
2462
+ ## Interface: ServerErrorContextProps
2463
+
2464
+ ### Table of contents
2465
+
2466
+ #### Properties
2467
+
2468
+ - [errors](#errors)
2469
+ - [getError](#geterror)
2470
+ - [setError](#seterror)
2471
+
2472
+ ### Properties
2473
+
2474
+ #### errors
2475
+
2476
+ • **errors**: [`ServerErrors`](#interfacesservererrorsmd)
2477
+
2478
+ ##### Defined in
2479
+
2480
+ packages/envoc-form/src/Form/ServerErrorContext.ts:7
2481
+
2482
+ ___
2483
+
2484
+ #### getError
2485
+
2486
+ • **getError**: (`path`: `string`) => `undefined` \| `string`
2487
+
2488
+ ##### Type declaration
2489
+
2490
+ ▸ (`path`): `undefined` \| `string`
2491
+
2492
+ ###### Parameters
2493
+
2494
+ | Name | Type |
2495
+ | :------ | :------ |
2496
+ | `path` | `string` |
2497
+
2498
+ ###### Returns
2499
+
2500
+ `undefined` \| `string`
2501
+
2502
+ ##### Defined in
2503
+
2504
+ packages/envoc-form/src/Form/ServerErrorContext.ts:8
2505
+
2506
+ ___
2507
+
2508
+ #### setError
2509
+
2510
+ • **setError**: (`path`: `string`, `errorMessage`: `undefined` \| `string`) => `void`
2511
+
2512
+ ##### Type declaration
2513
+
2514
+ ▸ (`path`, `errorMessage`): `void`
2515
+
2516
+ ###### Parameters
2517
+
2518
+ | Name | Type |
2519
+ | :------ | :------ |
2520
+ | `path` | `string` |
2521
+ | `errorMessage` | `undefined` \| `string` |
2522
+
2523
+ ###### Returns
2524
+
2525
+ `void`
2526
+
2527
+ ##### Defined in
2528
+
2529
+ packages/envoc-form/src/Form/ServerErrorContext.ts:9
2530
+
2531
+
2532
+ <a name="interfacesservererrorsmd"></a>
2533
+
2534
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ServerErrors
2535
+
2536
+ ## Interface: ServerErrors
2537
+
2538
+ ### Indexable
2539
+
2540
+ ▪ [path: `string`]: `string`
2541
+
2542
+
2543
+ <a name="interfacessinglenumberselectgrouppropsmd"></a>
2544
+
2545
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SingleNumberSelectGroupProps
2546
+
2547
+ ## Interface: SingleNumberSelectGroupProps
2548
+
2549
+ ### Hierarchy
2550
+
2551
+ - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`number` \| `undefined` \| ``null``\>
2552
+
2553
+ ↳ **`SingleNumberSelectGroupProps`**
2554
+
2555
+ ### Table of contents
2556
+
2557
+ #### Properties
2558
+
2559
+ - [className](#classname)
2560
+ - [disabled](#disabled)
2561
+ - [helpText](#helptext)
2562
+ - [input](#input)
2563
+ - [label](#label)
2564
+ - [meta](#meta)
2565
+ - [options](#options)
2566
+ - [placeholder](#placeholder)
2567
+ - [required](#required)
2568
+
2569
+ ### Properties
2570
+
2571
+ #### className
2572
+
2573
+ • `Optional` **className**: `string`
2574
+
2575
+ Extra class names to apply.
2576
+
2577
+ ##### Inherited from
2578
+
2579
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname)
2580
+
2581
+ ##### Defined in
2582
+
2583
+ packages/envoc-form/src/Group.tsx:8
2584
+
2585
+ ___
2586
+
2587
+ #### disabled
2588
+
2589
+ • `Optional` **disabled**: `boolean`
2590
+
2591
+ Whether the field should be disabled.
2592
+
2593
+ ##### Inherited from
2594
+
2595
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled)
2596
+
2597
+ ##### Defined in
2598
+
2599
+ packages/envoc-form/src/Group.tsx:19
2600
+
2601
+ ___
2602
+
2603
+ #### helpText
2604
+
2605
+ • `Optional` **helpText**: `ReactNode`
2606
+
2607
+ Simple helper text after the input.
2608
+
2609
+ ##### Inherited from
2610
+
2611
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext)
2612
+
2613
+ ##### Defined in
2614
+
2615
+ packages/envoc-form/src/Group.tsx:16
2616
+
2617
+ ___
2618
+
2619
+ #### input
2620
+
2621
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `number`\>
2622
+
2623
+ ##### Inherited from
2624
+
2625
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input)
2626
+
2627
+ ##### Defined in
2628
+
2629
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
2630
+
2631
+ ___
2632
+
2633
+ #### label
2634
+
2635
+ • `Optional` **label**: `string`
2636
+
2637
+ Simple text label before the input.
2638
+
2639
+ ##### Inherited from
2640
+
2641
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label)
2642
+
2643
+ ##### Defined in
2644
+
2645
+ packages/envoc-form/src/Group.tsx:13
2646
+
2647
+ ___
2648
+
2649
+ #### meta
2650
+
2651
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `number`\>
2652
+
2653
+ ##### Inherited from
2654
+
2655
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta)
2656
+
2657
+ ##### Defined in
2658
+
2659
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
2660
+
2661
+ ___
2662
+
2663
+ #### options
2664
+
2665
+ • **options**: `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`\> \| [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`\>[]
2666
+
2667
+ Options for the dropdown. Includes the label and value.
2668
+
2669
+ ##### Inherited from
2670
+
2671
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#options)
2672
+
2673
+ ##### Defined in
2674
+
2675
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
2676
+
2677
+ ___
2678
+
2679
+ #### placeholder
2680
+
2681
+ • `Optional` **placeholder**: `string`
2682
+
2683
+ Text diplayed when no value is selected.
2684
+
2685
+ ##### Inherited from
2686
+
2687
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder)
2688
+
2689
+ ##### Defined in
2690
+
2691
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
2692
+
2693
+ ___
2694
+
2695
+ #### required
2696
+
2697
+ • `Optional` **required**: `boolean`
2698
+
2699
+ ##### Inherited from
2700
+
2701
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required)
2702
+
2703
+ ##### Defined in
2704
+
2705
+ packages/envoc-form/src/Group.tsx:21
2706
+
2707
+
2708
+ <a name="interfacessinglestringselectgrouppropsmd"></a>
2709
+
2710
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SingleStringSelectGroupProps
2711
+
2712
+ ## Interface: SingleStringSelectGroupProps
2713
+
2714
+ ### Hierarchy
2715
+
2716
+ - [`SelectGroupPropsHelper`](#interfacesselectgrouppropshelpermd)<`string`\>
2717
+
2718
+ ↳ **`SingleStringSelectGroupProps`**
2719
+
2720
+ ### Table of contents
2721
+
2722
+ #### Properties
2723
+
2724
+ - [className](#classname)
2725
+ - [disabled](#disabled)
2726
+ - [helpText](#helptext)
2727
+ - [input](#input)
2728
+ - [label](#label)
2729
+ - [meta](#meta)
2730
+ - [options](#options)
2731
+ - [placeholder](#placeholder)
2732
+ - [required](#required)
2733
+
2734
+ ### Properties
2735
+
2736
+ #### className
2737
+
2738
+ • `Optional` **className**: `string`
2739
+
2740
+ Extra class names to apply.
2741
+
2742
+ ##### Inherited from
2743
+
2744
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[className](#classname)
2745
+
2746
+ ##### Defined in
2747
+
2748
+ packages/envoc-form/src/Group.tsx:8
2749
+
2750
+ ___
2751
+
2752
+ #### disabled
2753
+
2754
+ • `Optional` **disabled**: `boolean`
2755
+
2756
+ Whether the field should be disabled.
2757
+
2758
+ ##### Inherited from
2759
+
2760
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[disabled](#disabled)
2761
+
2762
+ ##### Defined in
2763
+
2764
+ packages/envoc-form/src/Group.tsx:19
2765
+
2766
+ ___
2767
+
2768
+ #### helpText
2769
+
2770
+ • `Optional` **helpText**: `ReactNode`
2771
+
2772
+ Simple helper text after the input.
2773
+
2774
+ ##### Inherited from
2775
+
2776
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[helpText](#helptext)
2777
+
2778
+ ##### Defined in
2779
+
2780
+ packages/envoc-form/src/Group.tsx:16
2781
+
2782
+ ___
2783
+
2784
+ #### input
2785
+
2786
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
2787
+
2788
+ ##### Inherited from
2789
+
2790
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[input](#input)
2791
+
2792
+ ##### Defined in
2793
+
2794
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
2795
+
2796
+ ___
2797
+
2798
+ #### label
2799
+
2800
+ • `Optional` **label**: `string`
2801
+
2802
+ Simple text label before the input.
2803
+
2804
+ ##### Inherited from
2805
+
2806
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[label](#label)
2807
+
2808
+ ##### Defined in
2809
+
2810
+ packages/envoc-form/src/Group.tsx:13
2811
+
2812
+ ___
2813
+
2814
+ #### meta
2815
+
2816
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
2817
+
2818
+ ##### Inherited from
2819
+
2820
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[meta](#meta)
2821
+
2822
+ ##### Defined in
2823
+
2824
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
2825
+
2826
+ ___
2827
+
2828
+ #### options
2829
+
2830
+ • **options**: [`SelectOption`](#interfacesselectoptionmd)<`string`\>[] \| `OptionsUseServiceResult`<`string`\>
2831
+
2832
+ Options for the dropdown. Includes the label and value.
2833
+
2834
+ ##### Inherited from
2835
+
2836
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[options](#options)
2837
+
2838
+ ##### Defined in
2839
+
2840
+ packages/envoc-form/src/Select/SelectGroup.tsx:34
2841
+
2842
+ ___
2843
+
2844
+ #### placeholder
2845
+
2846
+ • `Optional` **placeholder**: `string`
2847
+
2848
+ Text diplayed when no value is selected.
2849
+
2850
+ ##### Inherited from
2851
+
2852
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[placeholder](#placeholder)
2853
+
2854
+ ##### Defined in
2855
+
2856
+ packages/envoc-form/src/Select/SelectGroup.tsx:38
2857
+
2858
+ ___
2859
+
2860
+ #### required
2861
+
2862
+ • `Optional` **required**: `boolean`
2863
+
2864
+ ##### Inherited from
2865
+
2866
+ [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd).[required](#required)
2867
+
2868
+ ##### Defined in
2869
+
2870
+ packages/envoc-form/src/Group.tsx:21
2871
+
2872
+
2873
+ <a name="interfacesstandardformactionspropsmd"></a>
2874
+
2875
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / StandardFormActionsProps
2876
+
2877
+ ## Interface: StandardFormActionsProps
2878
+
2879
+ ### Table of contents
2880
+
2881
+ #### Properties
2882
+
2883
+ - [allowPristineSubmit](#allowpristinesubmit)
2884
+ - [handleCancel](#handlecancel)
2885
+
2886
+ ### Properties
2887
+
2888
+ #### allowPristineSubmit
2889
+
2890
+ • `Optional` **allowPristineSubmit**: `boolean`
2891
+
2892
+ Allow the form to be submitted without any changes. By default this is not allowed.
2893
+
2894
+ ##### Defined in
2895
+
2896
+ packages/envoc-form/src/StandardFormActions.tsx:9
2897
+
2898
+ ___
2899
+
2900
+ #### handleCancel
2901
+
2902
+ • `Optional` **handleCancel**: `MouseEventHandler`<`HTMLButtonElement`\>
2903
+
2904
+ The cancel button's `onClick`.
2905
+
2906
+ **`Default Value`**
2907
+
2908
+ `window.history.back()`
2909
+
2910
+ ##### Defined in
2911
+
2912
+ packages/envoc-form/src/StandardFormActions.tsx:13
2913
+
2914
+
2915
+ <a name="interfacesstringdateonlypickergrouppropsmd"></a>
2916
+
2917
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / StringDateOnlyPickerGroupProps
2918
+
2919
+ ## Interface: StringDateOnlyPickerGroupProps
2920
+
2921
+ ### Hierarchy
2922
+
2923
+ - [`DatePickerHelper`](#interfacesdatepickerhelpermd)<`string` \| `undefined` \| ``null``\>
2924
+
2925
+ ↳ **`StringDateOnlyPickerGroupProps`**
2926
+
2927
+ ### Table of contents
2928
+
2929
+ #### Properties
2930
+
2931
+ - [className](#classname)
2932
+ - [helpText](#helptext)
2933
+ - [input](#input)
2934
+ - [label](#label)
2935
+ - [meta](#meta)
2936
+
2937
+ ### Properties
2938
+
2939
+ #### className
2940
+
2941
+ • `Optional` **className**: `string`
2942
+
2943
+ Extra class names to apply.
2944
+
2945
+ ##### Inherited from
2946
+
2947
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[className](#classname)
2948
+
2949
+ ##### Defined in
2950
+
2951
+ packages/envoc-form/src/Group.tsx:8
2952
+
2953
+ ___
2954
+
2955
+ #### helpText
2956
+
2957
+ • `Optional` **helpText**: `ReactNode`
2958
+
2959
+ Simple helper text after the input.
2960
+
2961
+ ##### Inherited from
2962
+
2963
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[helpText](#helptext)
2964
+
2965
+ ##### Defined in
2966
+
2967
+ packages/envoc-form/src/Group.tsx:16
2968
+
2969
+ ___
2970
+
2971
+ #### input
2972
+
2973
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
2974
+
2975
+ ##### Inherited from
2976
+
2977
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[input](#input)
2978
+
2979
+ ##### Defined in
2980
+
2981
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
2982
+
2983
+ ___
2984
+
2985
+ #### label
2986
+
2987
+ • `Optional` **label**: `string`
2988
+
2989
+ Simple text label before the input.
2990
+
2991
+ ##### Inherited from
2992
+
2993
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[label](#label)
2994
+
2995
+ ##### Defined in
2996
+
2997
+ packages/envoc-form/src/Group.tsx:13
2998
+
2999
+ ___
3000
+
3001
+ #### meta
3002
+
3003
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
3004
+
3005
+ ##### Inherited from
3006
+
3007
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[meta](#meta)
3008
+
3009
+ ##### Defined in
3010
+
3011
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
3012
+
3013
+
3014
+ <a name="interfacesstringdatepickergrouppropsmd"></a>
3015
+
3016
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / StringDatePickerGroupProps
3017
+
3018
+ ## Interface: StringDatePickerGroupProps
3019
+
3020
+ ### Hierarchy
3021
+
3022
+ - [`DatePickerHelper`](#interfacesdatepickerhelpermd)<`string` \| `undefined` \| ``null``\>
3023
+
3024
+ ↳ **`StringDatePickerGroupProps`**
3025
+
3026
+ ### Table of contents
3027
+
3028
+ #### Properties
3029
+
3030
+ - [className](#classname)
3031
+ - [helpText](#helptext)
3032
+ - [input](#input)
3033
+ - [label](#label)
3034
+ - [meta](#meta)
3035
+
3036
+ ### Properties
3037
+
3038
+ #### className
3039
+
3040
+ • `Optional` **className**: `string`
3041
+
3042
+ Extra class names to apply.
3043
+
3044
+ ##### Inherited from
3045
+
3046
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[className](#classname)
3047
+
3048
+ ##### Defined in
3049
+
3050
+ packages/envoc-form/src/Group.tsx:8
3051
+
3052
+ ___
3053
+
3054
+ #### helpText
3055
+
3056
+ • `Optional` **helpText**: `ReactNode`
3057
+
3058
+ Simple helper text after the input.
3059
+
3060
+ ##### Inherited from
3061
+
3062
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[helpText](#helptext)
3063
+
3064
+ ##### Defined in
3065
+
3066
+ packages/envoc-form/src/Group.tsx:16
3067
+
3068
+ ___
3069
+
3070
+ #### input
3071
+
3072
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
3073
+
3074
+ ##### Inherited from
3075
+
3076
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[input](#input)
3077
+
3078
+ ##### Defined in
3079
+
3080
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
3081
+
3082
+ ___
3083
+
3084
+ #### label
3085
+
3086
+ • `Optional` **label**: `string`
3087
+
3088
+ Simple text label before the input.
3089
+
3090
+ ##### Inherited from
3091
+
3092
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[label](#label)
3093
+
3094
+ ##### Defined in
3095
+
3096
+ packages/envoc-form/src/Group.tsx:13
3097
+
3098
+ ___
3099
+
3100
+ #### meta
3101
+
3102
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
3103
+
3104
+ ##### Inherited from
3105
+
3106
+ [DatePickerHelper](#interfacesdatepickerhelpermd).[meta](#meta)
3107
+
3108
+ ##### Defined in
3109
+
3110
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
3111
+
3112
+
3113
+ <a name="interfacesstringinputgrouppropsmd"></a>
3114
+
3115
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / StringInputGroupProps
3116
+
3117
+ ## Interface: StringInputGroupProps
3118
+
3119
+ ### Hierarchy
3120
+
3121
+ - `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\>
3122
+
3123
+ ↳ **`StringInputGroupProps`**
3124
+
3125
+ ### Table of contents
3126
+
3127
+ #### Properties
3128
+
3129
+ - [className](#classname)
3130
+ - [helpText](#helptext)
3131
+ - [icon](#icon)
3132
+ - [input](#input)
3133
+ - [label](#label)
3134
+ - [meta](#meta)
3135
+ - [type](#type)
3136
+
3137
+ ### Properties
3138
+
3139
+ #### className
3140
+
3141
+ • `Optional` **className**: `string`
3142
+
3143
+ Extra class names to apply.
3144
+
3145
+ ##### Inherited from
3146
+
3147
+ Omit.className
3148
+
3149
+ ##### Defined in
3150
+
3151
+ packages/envoc-form/src/Group.tsx:8
3152
+
3153
+ ___
3154
+
3155
+ #### helpText
3156
+
3157
+ • `Optional` **helpText**: `ReactNode`
3158
+
3159
+ Simple helper text after the input.
3160
+
3161
+ ##### Inherited from
3162
+
3163
+ Omit.helpText
3164
+
3165
+ ##### Defined in
3166
+
3167
+ packages/envoc-form/src/Group.tsx:16
3168
+
3169
+ ___
3170
+
3171
+ #### icon
3172
+
3173
+ • `Optional` **icon**: `ReactNode`
3174
+
3175
+ ##### Inherited from
3176
+
3177
+ Omit.icon
3178
+
3179
+ ##### Defined in
3180
+
3181
+ packages/envoc-form/src/Input/InputGroup.tsx:20
3182
+
3183
+ ___
3184
+
3185
+ #### input
3186
+
3187
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
3188
+
3189
+ ##### Inherited from
3190
+
3191
+ Omit.input
3192
+
3193
+ ##### Defined in
3194
+
3195
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
3196
+
3197
+ ___
3198
+
3199
+ #### label
3200
+
3201
+ • `Optional` **label**: `string`
3202
+
3203
+ Simple text label before the input.
3204
+
3205
+ ##### Inherited from
3206
+
3207
+ Omit.label
3208
+
3209
+ ##### Defined in
3210
+
3211
+ packages/envoc-form/src/Group.tsx:13
3212
+
3213
+ ___
3214
+
3215
+ #### meta
3216
+
3217
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
3218
+
3219
+ ##### Inherited from
3220
+
3221
+ Omit.meta
3222
+
3223
+ ##### Defined in
3224
+
3225
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
3226
+
3227
+ ___
3228
+
3229
+ #### type
3230
+
3231
+ • `Optional` **type**: ``"color"`` \| ``"search"`` \| ``"textarea"`` \| ``"text"`` \| ``"tel"`` \| ``"url"`` \| ``"email"`` \| ``"password"``
3232
+
3233
+ ##### Defined in
3234
+
3235
+ packages/envoc-form/src/Input/StringInputGroup.tsx:11
3236
+
3237
+
3238
+ <a name="interfacessubmitformbuttonpropsmd"></a>
3239
+
3240
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / SubmitFormButtonProps
3241
+
3242
+ ## Interface: SubmitFormButtonProps
3243
+
3244
+ ### Hierarchy
3245
+
3246
+ - `Omit`<`React.HTMLProps`<`HTMLButtonElement`\>, ``"type"``\>
3247
+
3248
+ ↳ **`SubmitFormButtonProps`**
3249
+
3250
+ ### Table of contents
3251
+
3252
+ #### Properties
3253
+
3254
+ - [allowPristineSubmit](#allowpristinesubmit)
3255
+ - [children](#children)
3256
+
3257
+ ### Properties
3258
+
3259
+ #### allowPristineSubmit
3260
+
3261
+ • `Optional` **allowPristineSubmit**: `boolean`
3262
+
3263
+ Allow the form to be submitted without any changes. By default this is not allowed.
3264
+
3265
+ ##### Defined in
3266
+
3267
+ packages/envoc-form/src/SubmitFormButton.tsx:9
3268
+
3269
+ ___
3270
+
3271
+ #### children
3272
+
3273
+ • `Optional` **children**: `ReactNode`
3274
+
3275
+ Text to display on the button. Default text is 'Submit'.
3276
+
3277
+ ##### Overrides
3278
+
3279
+ Omit.children
3280
+
3281
+ ##### Defined in
3282
+
3283
+ packages/envoc-form/src/SubmitFormButton.tsx:11
3284
+
3285
+
3286
+ <a name="interfacestextareagrouppropsmd"></a>
3287
+
3288
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / TextAreaGroupProps
3289
+
3290
+ ## Interface: TextAreaGroupProps
3291
+
3292
+ Defines what is injected by a Field wrapper of some TRenderComponent
3293
+
3294
+ ### Hierarchy
3295
+
3296
+ - [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`string` \| `undefined` \| ``null``\>
3297
+
3298
+ - `Omit`<`React.HTMLProps`<`HTMLTextAreaElement`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"`` \| ``"className"`` \| ``"label"``\>
3299
+
3300
+ - `Omit`<[`GroupProps`](#interfacesgrouppropsmd), keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\> \| ``"children"``\>
3301
+
3302
+ ↳ **`TextAreaGroupProps`**
3303
+
3304
+ ### Table of contents
3305
+
3306
+ #### Properties
3307
+
3308
+ - [className](#classname)
3309
+ - [helpText](#helptext)
3310
+ - [icon](#icon)
3311
+ - [input](#input)
3312
+ - [label](#label)
3313
+ - [meta](#meta)
3314
+
3315
+ ### Properties
3316
+
3317
+ #### className
3318
+
3319
+ • `Optional` **className**: `string`
3320
+
3321
+ Extra class names to apply.
3322
+
3323
+ ##### Inherited from
3324
+
3325
+ Omit.className
3326
+
3327
+ ##### Defined in
3328
+
3329
+ packages/envoc-form/src/Group.tsx:8
3330
+
3331
+ ___
3332
+
3333
+ #### helpText
3334
+
3335
+ • `Optional` **helpText**: `ReactNode`
3336
+
3337
+ Simple helper text after the input.
3338
+
3339
+ ##### Inherited from
3340
+
3341
+ Omit.helpText
3342
+
3343
+ ##### Defined in
3344
+
3345
+ packages/envoc-form/src/Group.tsx:16
3346
+
3347
+ ___
3348
+
3349
+ #### icon
3350
+
3351
+ • `Optional` **icon**: `ReactNode`
3352
+
3353
+ ##### Defined in
3354
+
3355
+ packages/envoc-form/src/TextArea/TextAreaGroup.tsx:14
3356
+
3357
+ ___
3358
+
3359
+ #### input
3360
+
3361
+ • **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
3362
+
3363
+ ##### Inherited from
3364
+
3365
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[input](#input)
3366
+
3367
+ ##### Defined in
3368
+
3369
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:6
3370
+
3371
+ ___
3372
+
3373
+ #### label
3374
+
3375
+ • `Optional` **label**: `string`
3376
+
3377
+ Simple text label before the input.
3378
+
3379
+ ##### Inherited from
3380
+
3381
+ Omit.label
3382
+
3383
+ ##### Defined in
3384
+
3385
+ packages/envoc-form/src/Group.tsx:13
3386
+
3387
+ ___
3388
+
3389
+ #### meta
3390
+
3391
+ • **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
3392
+
3393
+ ##### Inherited from
3394
+
3395
+ [InjectedFieldProps](#interfacesinjectedfieldpropsmd).[meta](#meta)
3396
+
3397
+ ##### Defined in
3398
+
3399
+ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
3400
+
3401
+
3402
+ <a name="interfacesvalidatedapiresultmd"></a>
3403
+
3404
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ValidatedApiResult
3405
+
3406
+ ## Interface: ValidatedApiResult
3407
+
3408
+ The root result from a typical envoc API call when forms are returned
3409
+
3410
+ ### Table of contents
3411
+
3412
+ #### Properties
3413
+
3414
+ - [hasErrors](#haserrors)
3415
+ - [validationFailures](#validationfailures)
3416
+
3417
+ ### Properties
3418
+
3419
+ #### hasErrors
3420
+
3421
+ • `Optional` **hasErrors**: `boolean`
3422
+
3423
+ ##### Defined in
3424
+
3425
+ packages/envoc-form/src/Validation/ValidatedApiResult.ts:7
3426
+
3427
+ ___
3428
+
3429
+ #### validationFailures
3430
+
3431
+ • `Optional` **validationFailures**: [`ValidationError`](#interfacesvalidationerrormd)[]
3432
+
3433
+ ##### Defined in
3434
+
3435
+ packages/envoc-form/src/Validation/ValidatedApiResult.ts:6
3436
+
3437
+
3438
+ <a name="interfacesvalidationerrormd"></a>
3439
+
3440
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ValidationError
3441
+
3442
+ ## Interface: ValidationError
3443
+
3444
+ Represents a server side validation failure - only 'standard' for envoc
3445
+
3446
+ ### Table of contents
3447
+
3448
+ #### Properties
3449
+
3450
+ - [errorMessage](#errormessage)
3451
+ - [propertyName](#propertyname)
3452
+
3453
+ ### Properties
3454
+
3455
+ #### errorMessage
3456
+
3457
+ • `Optional` **errorMessage**: `string`
3458
+
3459
+ ##### Defined in
3460
+
3461
+ packages/envoc-form/src/Validation/ValidationError.ts:5
3462
+
3463
+ ___
3464
+
3465
+ #### propertyName
3466
+
3467
+ • `Optional` **propertyName**: `string`
3468
+
3469
+ ##### Defined in
3470
+
3471
+ packages/envoc-form/src/Validation/ValidationError.ts:4
3472
+
3473
+
3474
+ <a name="interfacesvalidationfunctionmd"></a>
3475
+
3476
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / ValidationFunction
3477
+
3478
+ ## Interface: ValidationFunction<TValue\>
3479
+
3480
+ Client side validation function
3481
+
3482
+ ### Type parameters
3483
+
3484
+ | Name |
3485
+ | :------ |
3486
+ | `TValue` |
3487
+
3488
+ ### Callable
3489
+
3490
+ #### ValidationFunction
3491
+
3492
+ ▸ **ValidationFunction**(`value`): `undefined` \| `string`
3493
+
3494
+ ##### Parameters
3495
+
3496
+ | Name | Type |
3497
+ | :------ | :------ |
3498
+ | `value` | `TValue` |
3499
+
3500
+ ##### Returns
3501
+
3502
+ `undefined` \| `string`
3503
+
3504
+ ##### Defined in
3505
+
3506
+ packages/envoc-form/src/Validation/ValidationFunction.ts:3
3507
+
3508
+
3509
+ <a name="interfacesusestandardfieldpropsmd"></a>
3510
+
3511
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / useStandardFieldProps
3512
+
3513
+ ## Interface: useStandardFieldProps<TValue\>
3514
+
3515
+ ### Type parameters
3516
+
3517
+ | Name |
3518
+ | :------ |
3519
+ | `TValue` |
3520
+
3521
+ ### Table of contents
3522
+
3523
+ #### Properties
3524
+
3525
+ - [disabled](#disabled)
3526
+ - [id](#id)
3527
+ - [name](#name)
3528
+ - [normalize](#normalize)
3529
+ - [validate](#validate)
3530
+
3531
+ ### Properties
3532
+
3533
+ #### disabled
3534
+
3535
+ • `Optional` **disabled**: `boolean`
3536
+
3537
+ Whether the field should be disabled.
3538
+
3539
+ ##### Defined in
3540
+
3541
+ packages/envoc-form/src/Field/useStandardField.ts:16
3542
+
3543
+ ___
3544
+
3545
+ #### id
3546
+
3547
+ • `Optional` **id**: `string`
3548
+
3549
+ Id of the field.
3550
+
3551
+ ##### Defined in
3552
+
3553
+ packages/envoc-form/src/Field/useStandardField.ts:12
3554
+
3555
+ ___
3556
+
3557
+ #### name
3558
+
3559
+ • **name**: `string`
3560
+
3561
+ Name of the field.
3562
+
3563
+ ##### Defined in
3564
+
3565
+ packages/envoc-form/src/Field/useStandardField.ts:14
3566
+
3567
+ ___
3568
+
3569
+ #### normalize
3570
+
3571
+ • `Optional` **normalize**: [`NormalizationFunction`](#interfacesnormalizationfunctionmd)<`TValue`\>
3572
+
3573
+ Function to modify the field value without making the form dirty. (e.g. phone number)
3574
+
3575
+ ##### Defined in
3576
+
3577
+ packages/envoc-form/src/Field/useStandardField.ts:20
3578
+
3579
+ ___
3580
+
3581
+ #### validate
3582
+
3583
+ • `Optional` **validate**: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TValue`\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TValue`\>[]
3584
+
3585
+ Function to validate the field.
3586
+
3587
+ ##### Defined in
3588
+
3589
+ packages/envoc-form/src/Field/useStandardField.ts:18
3590
+
3591
+
3592
+ <a name="modulesmd"></a>
3593
+
3594
+ [envoc-form](#readmemd) / Exports
3595
+
3596
+ # envoc-form
3597
+
3598
+ ## Table of contents
3599
+
3600
+ ### Namespaces
3601
+
3602
+ - [Form](#modulesformmd)
3603
+ - [normalizers](#modulesnormalizersmd)
3604
+ - [validators](#modulesvalidatorsmd)
3605
+
3606
+ ### Interfaces
3607
+
3608
+ - [AddressInputProps](#interfacesaddressinputpropsmd)
3609
+ - [BooleanSelectGroupProps](#interfacesbooleanselectgrouppropsmd)
3610
+ - [ConfirmBaseFormProps](#interfacesconfirmbaseformpropsmd)
3611
+ - [ConfirmDeleteFormProps](#interfacesconfirmdeleteformpropsmd)
3612
+ - [DatePickerGroupProps](#interfacesdatepickergrouppropsmd)
3613
+ - [DatePickerHelper](#interfacesdatepickerhelpermd)
3614
+ - [FileGroupProps](#interfacesfilegrouppropsmd)
3615
+ - [FormActionsProps](#interfacesformactionspropsmd)
3616
+ - [GroupProps](#interfacesgrouppropsmd)
3617
+ - [IconInputGroupProps](#interfacesiconinputgrouppropsmd)
3618
+ - [InjectedFieldProps](#interfacesinjectedfieldpropsmd)
3619
+ - [InputGroupProps](#interfacesinputgrouppropsmd)
3620
+ - [MoneyInputGroupProps](#interfacesmoneyinputgrouppropsmd)
3621
+ - [MultiNumberSelectGroupProps](#interfacesmultinumberselectgrouppropsmd)
3622
+ - [MultiStringSelectGroupProps](#interfacesmultistringselectgrouppropsmd)
3623
+ - [NormalizationFunction](#interfacesnormalizationfunctionmd)
3624
+ - [NumberInputGroupProps](#interfacesnumberinputgrouppropsmd)
3625
+ - [ObjectToFormDataCfgProps](#interfacesobjecttoformdatacfgpropsmd)
3626
+ - [SelectGroupProps](#interfacesselectgrouppropsmd)
3627
+ - [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd)
3628
+ - [SelectOption](#interfacesselectoptionmd)
3629
+ - [ServerErrorContextProps](#interfacesservererrorcontextpropsmd)
3630
+ - [ServerErrors](#interfacesservererrorsmd)
3631
+ - [SingleNumberSelectGroupProps](#interfacessinglenumberselectgrouppropsmd)
3632
+ - [SingleStringSelectGroupProps](#interfacessinglestringselectgrouppropsmd)
3633
+ - [StandardFormActionsProps](#interfacesstandardformactionspropsmd)
3634
+ - [StringDateOnlyPickerGroupProps](#interfacesstringdateonlypickergrouppropsmd)
3635
+ - [StringDatePickerGroupProps](#interfacesstringdatepickergrouppropsmd)
3636
+ - [StringInputGroupProps](#interfacesstringinputgrouppropsmd)
3637
+ - [SubmitFormButtonProps](#interfacessubmitformbuttonpropsmd)
3638
+ - [TextAreaGroupProps](#interfacestextareagrouppropsmd)
3639
+ - [ValidatedApiResult](#interfacesvalidatedapiresultmd)
3640
+ - [ValidationError](#interfacesvalidationerrormd)
3641
+ - [ValidationFunction](#interfacesvalidationfunctionmd)
3642
+ - [useStandardFieldProps](#interfacesusestandardfieldpropsmd)
3643
+
3644
+ ### Type Aliases
3645
+
3646
+ - [ArrayFormBuilderProp](#arrayformbuilderprop)
3647
+ - [FieldArrayProps](#fieldarrayprops)
3648
+ - [FieldProps](#fieldprops)
3649
+ - [FormBuilderProp](#formbuilderprop)
3650
+ - [FormProps](#formprops)
3651
+ - [RenderComponent](#rendercomponent)
3652
+ - [RenderComponentProps](#rendercomponentprops)
3653
+ - [StandAloneInputProps](#standaloneinputprops)
3654
+
3655
+ ### Variables
3656
+
3657
+ - [FieldNameContext](#fieldnamecontext)
3658
+ - [FileGroup](#filegroup)
3659
+ - [FormDefaults](#formdefaults)
3660
+ - [IconInputGroup](#iconinputgroup)
3661
+ - [NumberInputGroup](#numberinputgroup)
3662
+ - [ServerErrorContext](#servererrorcontext)
3663
+ - [StringInputGroup](#stringinputgroup)
3664
+ - [TextAreaGroup](#textareagroup)
3665
+
3666
+ ### Functions
3667
+
3668
+ - [AddressInput](#addressinput)
3669
+ - [BooleanSelectGroup](#booleanselectgroup)
3670
+ - [ConfirmBaseForm](#confirmbaseform)
3671
+ - [ConfirmDeleteForm](#confirmdeleteform)
3672
+ - [DatePickerGroup](#datepickergroup)
3673
+ - [Field](#field)
3674
+ - [FieldArray](#fieldarray)
3675
+ - [FieldErrorScrollTarget](#fielderrorscrolltarget)
3676
+ - [Form](#form)
3677
+ - [FormActions](#formactions)
3678
+ - [Group](#group)
3679
+ - [InputGroup](#inputgroup)
3680
+ - [MoneyInputGroup](#moneyinputgroup)
3681
+ - [MultiNumberSelectGroup](#multinumberselectgroup)
3682
+ - [MultiStringSelectGroup](#multistringselectgroup)
3683
+ - [SelectGroup](#selectgroup)
3684
+ - [SingleNumberSelectGroup](#singlenumberselectgroup)
3685
+ - [SingleStringSelectGroup](#singlestringselectgroup)
3686
+ - [StandAloneInput](#standaloneinput)
3687
+ - [StandardFormActions](#standardformactions)
3688
+ - [StringDateOnlyPickerGroup](#stringdateonlypickergroup)
3689
+ - [StringDatePickerGroup](#stringdatepickergroup)
3690
+ - [SubmitFormButton](#submitformbutton)
3691
+ - [convertToTimeZoneInsensitiveISOString](#converttotimezoneinsensitiveisostring)
3692
+ - [isArray](#isarray)
3693
+ - [isBlob](#isblob)
3694
+ - [isBoolean](#isboolean)
3695
+ - [isDate](#isdate)
3696
+ - [isFile](#isfile)
3697
+ - [isNull](#isnull)
3698
+ - [isObject](#isobject)
3699
+ - [isUndefined](#isundefined)
3700
+ - [objectContainsNonSerializableProperty](#objectcontainsnonserializableproperty)
3701
+ - [serialize](#serialize)
3702
+ - [useStandardField](#usestandardfield)
3703
+
3704
+ ## Type Aliases
3705
+
3706
+ ### ArrayFormBuilderProp
3707
+
3708
+ Ƭ **ArrayFormBuilderProp**<`TValue`\>: `TValue` extends infer TForm[] \| `undefined` \| ``null`` ? `TForm` extends `object` ? { `Field`: <TProp, TRenderComponent\>(`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `JSX.Element` ; `FieldArray`: <TProp\>(`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `JSX.Element` } : `never` : `never`
3709
+
3710
+ #### Type parameters
3711
+
3712
+ | Name | Type |
3713
+ | :------ | :------ |
3714
+ | `TValue` | extends `any`[] \| `undefined` \| ``null`` |
3715
+
3716
+ #### Defined in
3717
+
3718
+ packages/envoc-form/src/FieldArray/FieldArray.tsx:30
3719
+
3720
+ ___
3721
+
3722
+ ### FieldArrayProps
3723
+
3724
+ Ƭ **FieldArrayProps**<`TForm`, `TProp`\>: `TForm`[`TProp`] extends `any`[] \| `undefined` \| ``null`` ? { `children`: (`formBuilder`: [`ArrayFormBuilderProp`](#arrayformbuilderprop)<`TForm`[`TProp`]\>) => `JSX.Element` ; `disabled?`: `boolean` ; `label?`: `string` ; `name`: `TProp` ; `validate?`: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\>[] } : `never`
3725
+
3726
+ #### Type parameters
3727
+
3728
+ | Name | Type |
3729
+ | :------ | :------ |
3730
+ | `TForm` | extends `object` |
3731
+ | `TProp` | extends keyof `TForm` |
3732
+
3733
+ #### Defined in
3734
+
3735
+ packages/envoc-form/src/FieldArray/FieldArray.tsx:9
3736
+
3737
+ ___
3738
+
3739
+ ### FieldProps
3740
+
3741
+ Ƭ **FieldProps**<`TForm`, `TProp`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TForm`[`TProp`], `TRenderComponent`\> ; `disabled?`: `boolean` ; `id?`: `string` ; `name`: `TProp` ; `normalize?`: [`NormalizationFunction`](#interfacesnormalizationfunctionmd)<`TForm`[`TProp`]\> ; `validate?`: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\>[] } & `Omit`<[`RenderComponentProps`](#rendercomponentprops)<`TForm`[`TProp`], `TRenderComponent`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TForm`[`TProp`]\>\>
3742
+
3743
+ A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable
3744
+
3745
+ #### Type parameters
3746
+
3747
+ | Name | Type |
3748
+ | :------ | :------ |
3749
+ | `TForm` | extends `object` |
3750
+ | `TProp` | extends keyof `TForm` |
3751
+ | `TRenderComponent` | extends `ElementType` |
3752
+
3753
+ #### Defined in
3754
+
3755
+ packages/envoc-form/src/Field/Field.tsx:32
3756
+
3757
+ ___
3758
+
3759
+ ### FormBuilderProp
3760
+
3761
+ Ƭ **FormBuilderProp**<`TForm`\>: `Object`
3762
+
3763
+ #### Type parameters
3764
+
3765
+ | Name | Type |
3766
+ | :------ | :------ |
3767
+ | `TForm` | extends `object` |
3768
+
3769
+ #### Type declaration
3770
+
3771
+ | Name | Type |
3772
+ | :------ | :------ |
3773
+ | `Field` | <TProp, TRenderComponent\>(`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `JSX.Element` |
3774
+ | `FieldArray` | <TProp\>(`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `JSX.Element` |
3775
+
3776
+ #### Defined in
3777
+
3778
+ packages/envoc-form/src/Form/Form.tsx:32
3779
+
3780
+ ___
3781
+
3782
+ ### FormProps
3783
+
3784
+ Ƭ **FormProps**<`TForm`\>: `RequireAtLeastOne`<`FullFormProps`<`TForm`\>, ``"onSubmit"`` \| ``"onFormDataSubmit"``\>
3785
+
3786
+ #### Type parameters
3787
+
3788
+ | Name | Type |
3789
+ | :------ | :------ |
3790
+ | `TForm` | extends `object` |
3791
+
3792
+ #### Defined in
3793
+
3794
+ packages/envoc-form/src/Form/Form.tsx:72
3795
+
3796
+ ___
3797
+
3798
+ ### RenderComponent
3799
+
3800
+ Ƭ **RenderComponent**<`TValue`, `TRenderComponent`\>: `Partial`<`ComponentProps`<`TRenderComponent`\>\> extends `Partial`<[`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\>\> ? `TRenderComponent` : `never`
3801
+
3802
+ #### Type parameters
3803
+
3804
+ | Name | Type |
3805
+ | :------ | :------ |
3806
+ | `TValue` | `TValue` |
3807
+ | `TRenderComponent` | extends `ElementType` |
3808
+
3809
+ #### Defined in
3810
+
3811
+ packages/envoc-form/src/Field/Field.tsx:13
3812
+
3813
+ ___
3814
+
3815
+ ### RenderComponentProps
3816
+
3817
+ Ƭ **RenderComponentProps**<`TValue`, `TRenderComponent`\>: `Partial`<`ComponentProps`<`TRenderComponent`\>\> extends `Partial`<[`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue` \| `undefined` \| ``null``\>\> ? `ComponentProps`<`TRenderComponent`\> : `never`
3818
+
3819
+ #### Type parameters
3820
+
3821
+ | Name | Type |
3822
+ | :------ | :------ |
3823
+ | `TValue` | `TValue` |
3824
+ | `TRenderComponent` | extends `ElementType` |
3825
+
3826
+ #### Defined in
3827
+
3828
+ packages/envoc-form/src/Field/Field.tsx:22
3829
+
3830
+ ___
3831
+
3832
+ ### StandAloneInputProps
3833
+
3834
+ Ƭ **StandAloneInputProps**<`TValue`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TValue`, `TRenderComponent`\> ; `onChange`: (`arg`: `TValue`) => `void` ; `value`: `TValue` } & `Omit`<[`RenderComponentProps`](#rendercomponentprops)<`TValue`, `TRenderComponent`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue`\> \| ``"value"`` \| ``"onChange"`` \| ``"normalize"`` \| ``"validate"``\>
3835
+
3836
+ #### Type parameters
3837
+
3838
+ | Name | Type |
3839
+ | :------ | :------ |
3840
+ | `TValue` | `TValue` |
3841
+ | `TRenderComponent` | extends `ElementType` |
3842
+
3843
+ #### Defined in
3844
+
3845
+ packages/envoc-form/src/Field/StandAloneInput.tsx:8
3846
+
3847
+ ## Variables
3848
+
3849
+ ### FieldNameContext
3850
+
3851
+ • `Const` **FieldNameContext**: `Context`<`undefined` \| `string`\>
3852
+
3853
+ provides the full, qualified name of the current field name - including nested fields, path/dot delimited
3854
+
3855
+ #### Defined in
3856
+
3857
+ packages/envoc-form/src/Field/FieldNameContext.ts:4
3858
+
3859
+ ___
3860
+
3861
+ ### FileGroup
3862
+
3863
+ • `Const` **FileGroup**: `ComponentType`<[`FileGroupProps`](#interfacesfilegrouppropsmd)\>
3864
+
3865
+ File upload input group.
3866
+
3867
+ #### Defined in
3868
+
3869
+ packages/envoc-form/src/File/FileGroup.tsx:81
3870
+
3871
+ ___
3872
+
3873
+ ### FormDefaults
3874
+
3875
+ • `Const` **FormDefaults**: `Object`
3876
+
3877
+ `envoc-form-` CSS class prefix
3878
+
3879
+ #### Type declaration
3880
+
3881
+ | Name | Type |
3882
+ | :------ | :------ |
3883
+ | `cssClassPrefix` | `string` |
3884
+
3885
+ #### Defined in
3886
+
3887
+ packages/envoc-form/src/FormDefaults.ts:2
3888
+
3889
+ ___
3890
+
3891
+ ### IconInputGroup
3892
+
3893
+ • `Const` **IconInputGroup**: `ComponentType`<[`IconInputGroupProps`](#interfacesiconinputgrouppropsmd)\>
3894
+
3895
+ Input group with an icon.
3896
+
3897
+ #### Defined in
3898
+
3899
+ packages/envoc-form/src/Input/IconInputGroup.tsx:50
3900
+
3901
+ ___
3902
+
3903
+ ### NumberInputGroup
3904
+
3905
+ • `Const` **NumberInputGroup**: `ComponentType`<[`NumberInputGroupProps`](#interfacesnumberinputgrouppropsmd)\>
3906
+
3907
+ Standard number input group. By default allows for float values.
3908
+
3909
+ #### Defined in
3910
+
3911
+ packages/envoc-form/src/Input/NumberInputGroup.tsx:44
3912
+
3913
+ ___
3914
+
3915
+ ### ServerErrorContext
3916
+
3917
+ • `Const` **ServerErrorContext**: `Context`<[`ServerErrorContextProps`](#interfacesservererrorcontextpropsmd)\>
3918
+
3919
+ Context to store the API errors from the server for the form.
3920
+
3921
+ #### Defined in
3922
+
3923
+ packages/envoc-form/src/Form/ServerErrorContext.ts:12
3924
+
3925
+ ___
3926
+
3927
+ ### StringInputGroup
3928
+
3929
+ • `Const` **StringInputGroup**: `ComponentType`<[`StringInputGroupProps`](#interfacesstringinputgrouppropsmd)\>
3930
+
3931
+ Standard string input group.
3932
+
3933
+ #### Defined in
3934
+
3935
+ packages/envoc-form/src/Input/StringInputGroup.tsx:49
3936
+
3937
+ ___
3938
+
3939
+ ### TextAreaGroup
3940
+
3941
+ • `Const` **TextAreaGroup**: `ComponentType`<[`TextAreaGroupProps`](#interfacestextareagrouppropsmd)\>
3942
+
3943
+ Generic controlled `<textarea/>` wrapped by a `<Group/>`
3944
+
3945
+ #### Defined in
3946
+
3947
+ packages/envoc-form/src/TextArea/TextAreaGroup.tsx:60
3948
+
3949
+ ## Functions
3950
+
3951
+ ### AddressInput
3952
+
3953
+ ▸ **AddressInput**(`«destructured»`): `Element`
3954
+
3955
+ Collection of `<Field/>`s for inputting an address. Includes:
3956
+ ```txt
3957
+ Address 1
3958
+ Address 2
3959
+ City
3960
+ State
3961
+ Zip
3962
+ ```
3963
+
3964
+ #### Parameters
3965
+
3966
+ | Name | Type |
3967
+ | :------ | :------ |
3968
+ | `«destructured»` | [`AddressInputProps`](#interfacesaddressinputpropsmd) |
3969
+
3970
+ #### Returns
3971
+
3972
+ `Element`
3973
+
3974
+ #### Defined in
3975
+
3976
+ packages/envoc-form/src/AddressInput/AddressInput.tsx:36
3977
+
3978
+ ___
3979
+
3980
+ ### BooleanSelectGroup
3981
+
3982
+ ▸ **BooleanSelectGroup**(`props`): `Element`
3983
+
3984
+ A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`.
3985
+
3986
+ #### Parameters
3987
+
3988
+ | Name | Type |
3989
+ | :------ | :------ |
3990
+ | `props` | [`BooleanSelectGroupProps`](#interfacesbooleanselectgrouppropsmd) |
3991
+
3992
+ #### Returns
3993
+
3994
+ `Element`
3995
+
3996
+ #### Defined in
3997
+
3998
+ packages/envoc-form/src/Select/BooleanSelectGroup.tsx:20
3999
+
4000
+ ___
4001
+
4002
+ ### ConfirmBaseForm
4003
+
4004
+ ▸ **ConfirmBaseForm**(`«destructured»`): `Element`
4005
+
4006
+ Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
4007
+ Commonly used for confirming delete and archive.
4008
+
4009
+ See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
4010
+
4011
+ #### Parameters
4012
+
4013
+ | Name | Type |
4014
+ | :------ | :------ |
4015
+ | `«destructured»` | [`ConfirmBaseFormProps`](#interfacesconfirmbaseformpropsmd) |
4016
+
4017
+ #### Returns
4018
+
4019
+ `Element`
4020
+
4021
+ #### Defined in
4022
+
4023
+ packages/envoc-form/src/ConfirmBaseForm/ConfirmBaseForm.tsx:33
4024
+
4025
+ ___
4026
+
4027
+ ### ConfirmDeleteForm
4028
+
4029
+ ▸ **ConfirmDeleteForm**(`«destructured»`): `Element`
4030
+
4031
+ Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
4032
+
4033
+ Wraps `<ConfirmBaseForm/>`.
4034
+
4035
+ #### Parameters
4036
+
4037
+ | Name | Type |
4038
+ | :------ | :------ |
4039
+ | `«destructured»` | [`ConfirmDeleteFormProps`](#interfacesconfirmdeleteformpropsmd) |
4040
+
4041
+ #### Returns
4042
+
4043
+ `Element`
4044
+
4045
+ #### Defined in
4046
+
4047
+ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:33
4048
+
4049
+ ___
4050
+
4051
+ ### DatePickerGroup
4052
+
4053
+ ▸ **DatePickerGroup**<`T`\>(`«destructured»`): `Element`
4054
+
4055
+ Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
4056
+
4057
+ Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
4058
+
4059
+ #### Type parameters
4060
+
4061
+ | Name |
4062
+ | :------ |
4063
+ | `T` |
4064
+
4065
+ #### Parameters
4066
+
4067
+ | Name | Type |
4068
+ | :------ | :------ |
4069
+ | `«destructured»` | [`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)<`T`\> |
4070
+
4071
+ #### Returns
4072
+
4073
+ `Element`
4074
+
4075
+ #### Defined in
4076
+
4077
+ packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:26
4078
+
4079
+ ___
4080
+
4081
+ ### Field
4082
+
4083
+ ▸ **Field**<`TForm`, `TProp`, `TRenderComponent`\>(`«destructured»`, `ref`): `Element`
4084
+
4085
+ Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field.
4086
+ Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])
4087
+
4088
+ #### Type parameters
4089
+
4090
+ | Name | Type |
4091
+ | :------ | :------ |
4092
+ | `TForm` | extends `object` |
4093
+ | `TProp` | extends `string` \| `number` \| `symbol` |
4094
+ | `TRenderComponent` | extends `ElementType` |
4095
+
4096
+ #### Parameters
4097
+
4098
+ | Name | Type |
4099
+ | :------ | :------ |
4100
+ | `«destructured»` | [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\> |
4101
+ | `ref` | `LegacyRef`<`any`\> |
4102
+
4103
+ #### Returns
4104
+
4105
+ `Element`
4106
+
4107
+ #### Defined in
4108
+
4109
+ packages/envoc-form/src/Field/Field.tsx:60
4110
+
4111
+ ___
4112
+
4113
+ ### FieldArray
4114
+
4115
+ ▸ **FieldArray**<`TForm`, `TProp`\>(`«destructured»`): `Element`
4116
+
4117
+ An array of fields that allows the user to add multiple instances of the same field.
4118
+
4119
+ Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
4120
+
4121
+ #### Type parameters
4122
+
4123
+ | Name | Type |
4124
+ | :------ | :------ |
4125
+ | `TForm` | extends `object` |
4126
+ | `TProp` | extends `string` \| `number` \| `symbol` |
4127
+
4128
+ #### Parameters
4129
+
4130
+ | Name | Type |
4131
+ | :------ | :------ |
4132
+ | `«destructured»` | [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\> |
4133
+
4134
+ #### Returns
4135
+
4136
+ `Element`
4137
+
4138
+ #### Defined in
4139
+
4140
+ packages/envoc-form/src/FieldArray/FieldArray.tsx:53
4141
+
4142
+ ___
4143
+
4144
+ ### FieldErrorScrollTarget
4145
+
4146
+ ▸ **FieldErrorScrollTarget**(): ``null`` \| `Element`
4147
+
4148
+ Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs.
4149
+
4150
+ #### Returns
4151
+
4152
+ ``null`` \| `Element`
4153
+
4154
+ #### Defined in
4155
+
4156
+ packages/envoc-form/src/Field/FieldErrorScrollTarget.tsx:5
4157
+
4158
+ ___
4159
+
4160
+ ### Form
4161
+
4162
+ ▸ **Form**<`TForm`\>(`«destructured»`): `Element`
4163
+
4164
+ Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components.
4165
+
4166
+ #### Type parameters
4167
+
4168
+ | Name | Type |
4169
+ | :------ | :------ |
4170
+ | `TForm` | extends `object` |
4171
+
4172
+ #### Parameters
4173
+
4174
+ | Name | Type |
4175
+ | :------ | :------ |
4176
+ | `«destructured»` | [`FormProps`](#formprops)<`TForm`\> |
4177
+
4178
+ #### Returns
4179
+
4180
+ `Element`
4181
+
4182
+ #### Defined in
4183
+
4184
+ packages/envoc-form/src/Form/Form.tsx:78
4185
+
4186
+ ___
4187
+
4188
+ ### FormActions
4189
+
4190
+ ▸ **FormActions**(`«destructured»`): `Element`
4191
+
4192
+ Standard cancel and submit buttons.
4193
+
4194
+ #### Parameters
4195
+
4196
+ | Name | Type |
4197
+ | :------ | :------ |
4198
+ | `«destructured»` | [`FormActionsProps`](#interfacesformactionspropsmd) |
4199
+
4200
+ #### Returns
4201
+
4202
+ `Element`
4203
+
4204
+ #### Defined in
4205
+
4206
+ packages/envoc-form/src/FormActions.tsx:17
4207
+
4208
+ ___
4209
+
4210
+ ### Group
4211
+
4212
+ ▸ **Group**(`«destructured»`): `Element`
4213
+
4214
+ Contains standard field bits like a label, helper text, error scroll target, validation message container, etc.
4215
+
4216
+ #### Parameters
4217
+
4218
+ | Name | Type |
4219
+ | :------ | :------ |
4220
+ | `«destructured»` | [`GroupProps`](#interfacesgrouppropsmd) |
4221
+
4222
+ #### Returns
4223
+
4224
+ `Element`
4225
+
4226
+ #### Defined in
4227
+
4228
+ packages/envoc-form/src/Group.tsx:25
4229
+
4230
+ ___
4231
+
4232
+ ### InputGroup
4233
+
4234
+ ▸ **InputGroup**<`TValue`\>(`«destructured»`, `ref`): `Element`
4235
+
4236
+ Generic controlled `<input/>` wrapped by a `<Group/>`
4237
+
4238
+ #### Type parameters
4239
+
4240
+ | Name |
4241
+ | :------ |
4242
+ | `TValue` |
4243
+
4244
+ #### Parameters
4245
+
4246
+ | Name | Type |
4247
+ | :------ | :------ |
4248
+ | `«destructured»` | [`InputGroupProps`](#interfacesinputgrouppropsmd)<`TValue`\> |
4249
+ | `ref` | `LegacyRef`<`HTMLInputElement`\> |
4250
+
4251
+ #### Returns
4252
+
4253
+ `Element`
4254
+
4255
+ #### Defined in
4256
+
4257
+ packages/envoc-form/src/Input/InputGroup.tsx:23
4258
+
4259
+ ___
4260
+
4261
+ ### MoneyInputGroup
4262
+
4263
+ ▸ **MoneyInputGroup**(`props`, `context?`): `ReactNode`
4264
+
4265
+ Input group for inputting money.
4266
+
4267
+ #### Parameters
4268
+
4269
+ | Name | Type |
4270
+ | :------ | :------ |
4271
+ | `props` | [`MoneyInputGroupProps`](#interfacesmoneyinputgrouppropsmd) |
4272
+ | `context?` | `any` |
4273
+
4274
+ #### Returns
4275
+
4276
+ `ReactNode`
4277
+
4278
+ #### Defined in
4279
+
4280
+ common/temp/node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/index.d.ts:556
4281
+
4282
+ ___
4283
+
4284
+ ### MultiNumberSelectGroup
4285
+
4286
+ ▸ **MultiNumberSelectGroup**(`props`): `Element`
4287
+
4288
+ A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time.
4289
+
4290
+ #### Parameters
4291
+
4292
+ | Name | Type |
4293
+ | :------ | :------ |
4294
+ | `props` | [`MultiNumberSelectGroupProps`](#interfacesmultinumberselectgrouppropsmd) |
4295
+
4296
+ #### Returns
4297
+
4298
+ `Element`
4299
+
4300
+ #### Defined in
4301
+
4302
+ packages/envoc-form/src/Select/NumberSelectGroup.tsx:7
4303
+
4304
+ ___
4305
+
4306
+ ### MultiStringSelectGroup
4307
+
4308
+ ▸ **MultiStringSelectGroup**(`props`): `Element`
4309
+
4310
+ A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time.
4311
+
4312
+ #### Parameters
4313
+
4314
+ | Name | Type |
4315
+ | :------ | :------ |
4316
+ | `props` | [`MultiStringSelectGroupProps`](#interfacesmultistringselectgrouppropsmd) |
4317
+
4318
+ #### Returns
4319
+
4320
+ `Element`
4321
+
4322
+ #### Defined in
4323
+
4324
+ packages/envoc-form/src/Select/StringSelectGroup.tsx:7
4325
+
4326
+ ___
4327
+
4328
+ ### SelectGroup
4329
+
4330
+ ▸ **SelectGroup**<`TValue`\>(`«destructured»`): `Element`
4331
+
4332
+ Generic select dropdown. Uses [react-select](https://react-select.com/home).
4333
+
4334
+ #### Type parameters
4335
+
4336
+ | Name |
4337
+ | :------ |
4338
+ | `TValue` |
4339
+
4340
+ #### Parameters
4341
+
4342
+ | Name | Type |
4343
+ | :------ | :------ |
4344
+ | `«destructured»` | [`SelectGroupProps`](#interfacesselectgrouppropsmd)<`TValue`\> |
4345
+
4346
+ #### Returns
4347
+
4348
+ `Element`
4349
+
4350
+ #### Defined in
4351
+
4352
+ packages/envoc-form/src/Select/SelectGroup.tsx:43
4353
+
4354
+ ___
4355
+
4356
+ ### SingleNumberSelectGroup
4357
+
4358
+ ▸ **SingleNumberSelectGroup**(`props`): `Element`
4359
+
4360
+ A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time.
4361
+
4362
+ #### Parameters
4363
+
4364
+ | Name | Type |
4365
+ | :------ | :------ |
4366
+ | `props` | [`SingleNumberSelectGroupProps`](#interfacessinglenumberselectgrouppropsmd) |
4367
+
4368
+ #### Returns
4369
+
4370
+ `Element`
4371
+
4372
+ #### Defined in
4373
+
4374
+ packages/envoc-form/src/Select/NumberSelectGroup.tsx:14
4375
+
4376
+ ___
4377
+
4378
+ ### SingleStringSelectGroup
4379
+
4380
+ ▸ **SingleStringSelectGroup**(`props`): `Element`
4381
+
4382
+ A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time.
4383
+
4384
+ #### Parameters
4385
+
4386
+ | Name | Type |
4387
+ | :------ | :------ |
4388
+ | `props` | [`SingleStringSelectGroupProps`](#interfacessinglestringselectgrouppropsmd) |
4389
+
4390
+ #### Returns
4391
+
4392
+ `Element`
4393
+
4394
+ #### Defined in
4395
+
4396
+ packages/envoc-form/src/Select/StringSelectGroup.tsx:14
4397
+
4398
+ ___
4399
+
4400
+ ### StandAloneInput
4401
+
4402
+ ▸ **StandAloneInput**<`TValue`, `TComponent`\>(`props`): `Element`
4403
+
4404
+ The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`.
4405
+
4406
+ #### Type parameters
4407
+
4408
+ | Name | Type |
4409
+ | :------ | :------ |
4410
+ | `TValue` | `TValue` |
4411
+ | `TComponent` | extends `ElementType` |
4412
+
4413
+ #### Parameters
4414
+
4415
+ | Name | Type |
4416
+ | :------ | :------ |
4417
+ | `props` | [`StandAloneInputProps`](#standaloneinputprops)<`TValue`, `TComponent`\> |
4418
+
4419
+ #### Returns
4420
+
4421
+ `Element`
4422
+
4423
+ #### Defined in
4424
+
4425
+ packages/envoc-form/src/Field/StandAloneInput.tsx:28
4426
+
4427
+ ___
4428
+
4429
+ ### StandardFormActions
4430
+
4431
+ ▸ **StandardFormActions**(`«destructured»`): `Element`
4432
+
4433
+ Standard submit and cancel buttons.
4434
+
4435
+ #### Parameters
4436
+
4437
+ | Name | Type |
4438
+ | :------ | :------ |
4439
+ | `«destructured»` | [`StandardFormActionsProps`](#interfacesstandardformactionspropsmd) |
4440
+
4441
+ #### Returns
4442
+
4443
+ `Element`
4444
+
4445
+ #### Defined in
4446
+
4447
+ packages/envoc-form/src/StandardFormActions.tsx:17
4448
+
4449
+ ___
4450
+
4451
+ ### StringDateOnlyPickerGroup
4452
+
4453
+ ▸ **StringDateOnlyPickerGroup**(`props`): `Element`
4454
+
4455
+ Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`.
4456
+
4457
+ Default display to the user is in `MM/DD/YYYY` format.
4458
+
4459
+ #### Parameters
4460
+
4461
+ | Name | Type |
4462
+ | :------ | :------ |
4463
+ | `props` | [`StringDateOnlyPickerGroupProps`](#interfacesstringdateonlypickergrouppropsmd) |
4464
+
4465
+ #### Returns
4466
+
4467
+ `Element`
4468
+
4469
+ #### Defined in
4470
+
4471
+ packages/envoc-form/src/DatePicker/StringDateOnlyPickerGroup.tsx:12
4472
+
4473
+ ___
4474
+
4475
+ ### StringDatePickerGroup
4476
+
4477
+ ▸ **StringDatePickerGroup**(`props`): `Element`
4478
+
4479
+ Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
4480
+
4481
+ If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`.
4482
+
4483
+ #### Parameters
4484
+
4485
+ | Name | Type |
4486
+ | :------ | :------ |
4487
+ | `props` | [`StringDatePickerGroupProps`](#interfacesstringdatepickergrouppropsmd) |
4488
+
4489
+ #### Returns
4490
+
4491
+ `Element`
4492
+
4493
+ #### Defined in
4494
+
4495
+ packages/envoc-form/src/DatePicker/StringDatePickerGroup.tsx:12
4496
+
4497
+ ___
4498
+
4499
+ ### SubmitFormButton
4500
+
4501
+ ▸ **SubmitFormButton**(`props`, `context?`): `ReactNode`
4502
+
4503
+ Generic submit button for forms.
4504
+
4505
+ #### Parameters
4506
+
4507
+ | Name | Type |
4508
+ | :------ | :------ |
4509
+ | `props` | [`SubmitFormButtonProps`](#interfacessubmitformbuttonpropsmd) |
4510
+ | `context?` | `any` |
4511
+
4512
+ #### Returns
4513
+
4514
+ `ReactNode`
4515
+
4516
+ #### Defined in
4517
+
4518
+ common/temp/node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/index.d.ts:556
4519
+
4520
+ ___
4521
+
4522
+ ### convertToTimeZoneInsensitiveISOString
4523
+
4524
+ ▸ **convertToTimeZoneInsensitiveISOString**(`date`): `string`
4525
+
4526
+ #### Parameters
4527
+
4528
+ | Name | Type |
4529
+ | :------ | :------ |
4530
+ | `date` | `Date` |
4531
+
4532
+ #### Returns
4533
+
4534
+ `string`
4535
+
4536
+ #### Defined in
4537
+
4538
+ packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:106
4539
+
4540
+ ___
4541
+
4542
+ ### isArray
4543
+
4544
+ ▸ **isArray**(`value`): `boolean`
4545
+
4546
+ #### Parameters
4547
+
4548
+ | Name | Type |
4549
+ | :------ | :------ |
4550
+ | `value` | `any` |
4551
+
4552
+ #### Returns
4553
+
4554
+ `boolean`
4555
+
4556
+ #### Defined in
4557
+
4558
+ packages/envoc-form/src/utils/typeChecks.ts:5
4559
+
4560
+ ___
4561
+
4562
+ ### isBlob
4563
+
4564
+ ▸ **isBlob**(`value`): `any`
4565
+
4566
+ #### Parameters
4567
+
4568
+ | Name | Type |
4569
+ | :------ | :------ |
4570
+ | `value` | `any` |
4571
+
4572
+ #### Returns
4573
+
4574
+ `any`
4575
+
4576
+ #### Defined in
4577
+
4578
+ packages/envoc-form/src/utils/typeChecks.ts:8
4579
+
4580
+ ___
4581
+
4582
+ ### isBoolean
4583
+
4584
+ ▸ **isBoolean**(`value`): `boolean`
4585
+
4586
+ #### Parameters
4587
+
4588
+ | Name | Type |
4589
+ | :------ | :------ |
4590
+ | `value` | `any` |
4591
+
4592
+ #### Returns
4593
+
4594
+ `boolean`
4595
+
4596
+ #### Defined in
4597
+
4598
+ packages/envoc-form/src/utils/typeChecks.ts:3
4599
+
4600
+ ___
4601
+
4602
+ ### isDate
4603
+
4604
+ ▸ **isDate**(`value`): `boolean`
4605
+
4606
+ #### Parameters
4607
+
4608
+ | Name | Type |
4609
+ | :------ | :------ |
4610
+ | `value` | `any` |
4611
+
4612
+ #### Returns
4613
+
4614
+ `boolean`
4615
+
4616
+ #### Defined in
4617
+
4618
+ packages/envoc-form/src/utils/typeChecks.ts:6
4619
+
4620
+ ___
4621
+
4622
+ ### isFile
4623
+
4624
+ ▸ **isFile**(`value`): `any`
4625
+
4626
+ #### Parameters
4627
+
4628
+ | Name | Type |
4629
+ | :------ | :------ |
4630
+ | `value` | `any` |
4631
+
4632
+ #### Returns
4633
+
4634
+ `any`
4635
+
4636
+ #### Defined in
4637
+
4638
+ packages/envoc-form/src/utils/typeChecks.ts:14
4639
+
4640
+ ___
4641
+
4642
+ ### isNull
4643
+
4644
+ ▸ **isNull**(`value`): `boolean`
4645
+
4646
+ #### Parameters
4647
+
4648
+ | Name | Type |
4649
+ | :------ | :------ |
4650
+ | `value` | `any` |
4651
+
4652
+ #### Returns
4653
+
4654
+ `boolean`
4655
+
4656
+ #### Defined in
4657
+
4658
+ packages/envoc-form/src/utils/typeChecks.ts:2
4659
+
4660
+ ___
4661
+
4662
+ ### isObject
4663
+
4664
+ ▸ **isObject**(`value`): `boolean`
4665
+
4666
+ #### Parameters
4667
+
4668
+ | Name | Type |
4669
+ | :------ | :------ |
4670
+ | `value` | `any` |
4671
+
4672
+ #### Returns
4673
+
4674
+ `boolean`
4675
+
4676
+ #### Defined in
4677
+
4678
+ packages/envoc-form/src/utils/typeChecks.ts:4
4679
+
4680
+ ___
4681
+
4682
+ ### isUndefined
4683
+
4684
+ ▸ **isUndefined**(`value`): `boolean`
4685
+
4686
+ #### Parameters
4687
+
4688
+ | Name | Type |
4689
+ | :------ | :------ |
4690
+ | `value` | `any` |
4691
+
4692
+ #### Returns
4693
+
4694
+ `boolean`
4695
+
4696
+ #### Defined in
4697
+
4698
+ packages/envoc-form/src/utils/typeChecks.ts:1
4699
+
4700
+ ___
4701
+
4702
+ ### objectContainsNonSerializableProperty
4703
+
4704
+ ▸ **objectContainsNonSerializableProperty**(`object`): `boolean`
4705
+
4706
+ #### Parameters
4707
+
4708
+ | Name | Type |
4709
+ | :------ | :------ |
4710
+ | `object` | `any` |
4711
+
4712
+ #### Returns
4713
+
4714
+ `boolean`
4715
+
4716
+ #### Defined in
4717
+
4718
+ packages/envoc-form/src/utils/objectContainsNonSerializableProperty.ts:3
4719
+
4720
+ ___
4721
+
4722
+ ### serialize
4723
+
4724
+ ▸ **serialize**(`obj`, `cfg`, `fd?`, `pre?`): `FormData`
4725
+
4726
+ #### Parameters
4727
+
4728
+ | Name | Type |
4729
+ | :------ | :------ |
4730
+ | `obj` | `any` |
4731
+ | `cfg` | [`ObjectToFormDataCfgProps`](#interfacesobjecttoformdatacfgpropsmd) |
4732
+ | `fd?` | `FormData` |
4733
+ | `pre?` | `string` |
4734
+
4735
+ #### Returns
4736
+
4737
+ `FormData`
4738
+
4739
+ #### Defined in
4740
+
4741
+ packages/envoc-form/src/utils/objectToFormData.ts:25
4742
+
4743
+ ___
4744
+
4745
+ ### useStandardField
4746
+
4747
+ ▸ **useStandardField**<`TValue`\>(`«destructured»`): [`CustomFieldInputProps`<`TValue`\>, `CustomFieldMetaProps`<`TValue`\>]
4748
+
4749
+ Provides a consistent way to deal with all form fields (non array).
4750
+
4751
+ #### Type parameters
4752
+
4753
+ | Name |
4754
+ | :------ |
4755
+ | `TValue` |
4756
+
4757
+ #### Parameters
4758
+
4759
+ | Name | Type |
4760
+ | :------ | :------ |
4761
+ | `«destructured»` | [`useStandardFieldProps`](#interfacesusestandardfieldpropsmd)<`TValue`\> |
4762
+
4763
+ #### Returns
4764
+
4765
+ [`CustomFieldInputProps`<`TValue`\>, `CustomFieldMetaProps`<`TValue`\>]
4766
+
4767
+ #### Defined in
4768
+
4769
+ packages/envoc-form/src/Field/useStandardField.ts:24
4770
+
4771
+ # Modules
4772
+
4773
+
4774
+ <a name="modulesformmd"></a>
4775
+
4776
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / Form
4777
+
4778
+ ## Namespace: Form
4779
+
4780
+ ### Table of contents
4781
+
4782
+ #### Variables
4783
+
4784
+ - [DisplayFormState](#displayformstate)
4785
+
4786
+ ### Variables
4787
+
4788
+ #### DisplayFormState
4789
+
4790
+ • **DisplayFormState**: () => `Element`
4791
+
4792
+ ##### Type declaration
4793
+
4794
+ ▸ (): `Element`
4795
+
4796
+ ###### Returns
4797
+
4798
+ `Element`
4799
+
4800
+ ##### Defined in
4801
+
4802
+ packages/envoc-form/src/Form/Form.tsx:214
4803
+
4804
+
4805
+ <a name="modulesnormalizersmd"></a>
4806
+
4807
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / normalizers
4808
+
4809
+ ## Namespace: normalizers
4810
+
4811
+ ### Table of contents
4812
+
4813
+ #### Functions
4814
+
4815
+ - [phoneNumber](#phonenumber)
4816
+ - [zipCode](#zipcode)
4817
+
4818
+ ### Functions
4819
+
4820
+ #### phoneNumber
4821
+
4822
+ ▸ **phoneNumber**(`value`): `undefined` \| `string`
4823
+
4824
+ Normalizer for converting a string into a valid phone number.
4825
+
4826
+ ##### Parameters
4827
+
4828
+ | Name | Type |
4829
+ | :------ | :------ |
4830
+ | `value` | `undefined` \| ``null`` \| `string` |
4831
+
4832
+ ##### Returns
4833
+
4834
+ `undefined` \| `string`
4835
+
4836
+ ##### Defined in
4837
+
4838
+ packages/envoc-form/src/Normalization/normalizers.ts:2
4839
+
4840
+ ___
4841
+
4842
+ #### zipCode
4843
+
4844
+ ▸ **zipCode**(`value`): `undefined` \| `string`
4845
+
4846
+ Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format.
4847
+
4848
+ ##### Parameters
4849
+
4850
+ | Name | Type |
4851
+ | :------ | :------ |
4852
+ | `value` | `undefined` \| ``null`` \| `string` |
4853
+
4854
+ ##### Returns
4855
+
4856
+ `undefined` \| `string`
4857
+
4858
+ ##### Defined in
4859
+
4860
+ packages/envoc-form/src/Normalization/normalizers.ts:35
4861
+
4862
+
4863
+ <a name="modulesvalidatorsmd"></a>
4864
+
4865
+ [envoc-form](#readmemd) / [Exports](#modulesmd) / validators
4866
+
4867
+ ## Namespace: validators
4868
+
4869
+ ### Table of contents
4870
+
4871
+ #### Functions
4872
+
4873
+ - [any](#any)
4874
+ - [integer](#integer)
4875
+ - [length](#length)
4876
+ - [maxCount](#maxcount)
4877
+ - [maxLength](#maxlength)
4878
+ - [maxValue](#maxvalue)
4879
+ - [minCount](#mincount)
4880
+ - [minValue](#minvalue)
4881
+ - [required](#required)
4882
+ - [zipCode](#zipcode)
4883
+
4884
+ ### Functions
4885
+
4886
+ #### any
4887
+
4888
+ ▸ **any**<`TValue`\>(`validatorList`): (`value`: `TValue`) => `undefined` \| `string`
4889
+
4890
+ One of the validators provided must be true.
4891
+
4892
+ ##### Type parameters
4893
+
4894
+ | Name |
4895
+ | :------ |
4896
+ | `TValue` |
4897
+
4898
+ ##### Parameters
4899
+
4900
+ | Name | Type |
4901
+ | :------ | :------ |
4902
+ | `validatorList` | [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TValue`\>[] |
4903
+
4904
+ ##### Returns
4905
+
4906
+ `fn`
4907
+
4908
+ ▸ (`value`): `undefined` \| `string`
4909
+
4910
+ ###### Parameters
4911
+
4912
+ | Name | Type |
4913
+ | :------ | :------ |
4914
+ | `value` | `TValue` |
4915
+
4916
+ ###### Returns
4917
+
4918
+ `undefined` \| `string`
4919
+
4920
+ ##### Defined in
4921
+
4922
+ packages/envoc-form/src/Validation/validators.ts:66
4923
+
4924
+ ___
4925
+
4926
+ #### integer
4927
+
4928
+ ▸ **integer**(`val`): `undefined` \| ``"Must be a whole number"``
4929
+
4930
+ ##### Parameters
4931
+
4932
+ | Name | Type |
4933
+ | :------ | :------ |
4934
+ | `val` | `undefined` \| ``null`` \| `string` \| `number` |
4935
+
4936
+ ##### Returns
4937
+
4938
+ `undefined` \| ``"Must be a whole number"``
4939
+
4940
+ ##### Defined in
4941
+
4942
+ packages/envoc-form/src/Validation/validators.ts:19
4943
+
4944
+ ___
4945
+
4946
+ #### length
4947
+
4948
+ ▸ **length**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string`
4949
+
4950
+ Asserts that the value is a certain number of characters. numbers are coerced to a string
4951
+
4952
+ ##### Parameters
4953
+
4954
+ | Name | Type |
4955
+ | :------ | :------ |
4956
+ | `len` | `number` |
4957
+
4958
+ ##### Returns
4959
+
4960
+ `fn`
4961
+
4962
+ ▸ (`value`): `undefined` \| `string`
4963
+
4964
+ ###### Parameters
4965
+
4966
+ | Name | Type |
4967
+ | :------ | :------ |
4968
+ | `value` | `undefined` \| ``null`` \| `string` \| `number` |
4969
+
4970
+ ###### Returns
4971
+
4972
+ `undefined` \| `string`
4973
+
4974
+ ##### Defined in
4975
+
4976
+ packages/envoc-form/src/Validation/validators.ts:14
4977
+
4978
+ ___
4979
+
4980
+ #### maxCount
4981
+
4982
+ ▸ **maxCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string`
4983
+
4984
+ ##### Parameters
4985
+
4986
+ | Name | Type |
4987
+ | :------ | :------ |
4988
+ | `count` | `number` |
4989
+
4990
+ ##### Returns
4991
+
4992
+ `fn`
4993
+
4994
+ ▸ (`value`): `undefined` \| `string`
4995
+
4996
+ ###### Parameters
4997
+
4998
+ | Name | Type |
4999
+ | :------ | :------ |
5000
+ | `value` | `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[] |
5001
+
5002
+ ###### Returns
5003
+
5004
+ `undefined` \| `string`
5005
+
5006
+ ##### Defined in
5007
+
5008
+ packages/envoc-form/src/Validation/validators.ts:35
5009
+
5010
+ ___
5011
+
5012
+ #### maxLength
5013
+
5014
+ ▸ **maxLength**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string`
5015
+
5016
+ ##### Parameters
5017
+
5018
+ | Name | Type |
5019
+ | :------ | :------ |
5020
+ | `len` | `number` |
5021
+
5022
+ ##### Returns
5023
+
5024
+ `fn`
5025
+
5026
+ ▸ (`value`): `undefined` \| `string`
5027
+
5028
+ ###### Parameters
5029
+
5030
+ | Name | Type |
5031
+ | :------ | :------ |
5032
+ | `value` | `undefined` \| ``null`` \| `string` \| `number` |
5033
+
5034
+ ###### Returns
5035
+
5036
+ `undefined` \| `string`
5037
+
5038
+ ##### Defined in
5039
+
5040
+ packages/envoc-form/src/Validation/validators.ts:29
5041
+
5042
+ ___
5043
+
5044
+ #### maxValue
5045
+
5046
+ ▸ **maxValue**(`max`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string`
5047
+
5048
+ ##### Parameters
5049
+
5050
+ | Name | Type |
5051
+ | :------ | :------ |
5052
+ | `max` | `number` |
5053
+
5054
+ ##### Returns
5055
+
5056
+ `fn`
5057
+
5058
+ ▸ (`value`): `undefined` \| `string`
5059
+
5060
+ ###### Parameters
5061
+
5062
+ | Name | Type |
5063
+ | :------ | :------ |
5064
+ | `value` | `undefined` \| ``null`` \| `number` |
5065
+
5066
+ ###### Returns
5067
+
5068
+ `undefined` \| `string`
5069
+
5070
+ ##### Defined in
5071
+
5072
+ packages/envoc-form/src/Validation/validators.ts:47
5073
+
5074
+ ___
5075
+
5076
+ #### minCount
5077
+
5078
+ ▸ **minCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string`
5079
+
5080
+ ##### Parameters
5081
+
5082
+ | Name | Type |
5083
+ | :------ | :------ |
5084
+ | `count` | `number` |
5085
+
5086
+ ##### Returns
5087
+
5088
+ `fn`
5089
+
5090
+ ▸ (`value`): `undefined` \| `string`
5091
+
5092
+ ###### Parameters
5093
+
5094
+ | Name | Type |
5095
+ | :------ | :------ |
5096
+ | `value` | `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[] |
5097
+
5098
+ ###### Returns
5099
+
5100
+ `undefined` \| `string`
5101
+
5102
+ ##### Defined in
5103
+
5104
+ packages/envoc-form/src/Validation/validators.ts:42
5105
+
5106
+ ___
5107
+
5108
+ #### minValue
5109
+
5110
+ ▸ **minValue**(`min`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string`
5111
+
5112
+ ##### Parameters
5113
+
5114
+ | Name | Type |
5115
+ | :------ | :------ |
5116
+ | `min` | `number` |
5117
+
5118
+ ##### Returns
5119
+
5120
+ `fn`
5121
+
5122
+ ▸ (`value`): `undefined` \| `string`
5123
+
5124
+ ###### Parameters
5125
+
5126
+ | Name | Type |
5127
+ | :------ | :------ |
5128
+ | `value` | `undefined` \| ``null`` \| `number` |
5129
+
5130
+ ###### Returns
5131
+
5132
+ `undefined` \| `string`
5133
+
5134
+ ##### Defined in
5135
+
5136
+ packages/envoc-form/src/Validation/validators.ts:52
5137
+
5138
+ ___
5139
+
5140
+ #### required
5141
+
5142
+ ▸ **required**(`value`): `undefined` \| ``"Required"``
5143
+
5144
+ ##### Parameters
5145
+
5146
+ | Name | Type |
5147
+ | :------ | :------ |
5148
+ | `value` | `any` |
5149
+
5150
+ ##### Returns
5151
+
5152
+ `undefined` \| ``"Required"``
5153
+
5154
+ ##### Defined in
5155
+
5156
+ packages/envoc-form/src/Validation/validators.ts:3
5157
+
5158
+ ___
5159
+
5160
+ #### zipCode
5161
+
5162
+ ▸ **zipCode**(`value`): `undefined` \| ``"Invalid ZIP Code"``
5163
+
5164
+ Validate for a ZIP Code. Accepts formats: ##### and #####-####
5165
+
5166
+ ##### Parameters
5167
+
5168
+ | Name | Type |
5169
+ | :------ | :------ |
5170
+ | `value` | `undefined` \| ``null`` \| `string` |
5171
+
5172
+ ##### Returns
5173
+
5174
+ `undefined` \| ``"Invalid ZIP Code"``
5175
+
5176
+ ##### Defined in
5177
+
5178
+ packages/envoc-form/src/Validation/validators.ts:58