envoc-form 4.0.1-11 → 4.0.1-12

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