envoc-form 4.1.0 → 5.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +367 -176
- package/es/AddressInput/AddressInput.d.ts +24 -25
- package/es/AddressInput/AddressInput.js +20 -31
- package/es/AddressInput/UsStates.d.ts +3 -3
- package/es/AddressInput/UsStates.js +53 -53
- package/es/ConfirmBaseForm/ConfirmBaseForm.d.ts +26 -26
- package/es/ConfirmBaseForm/ConfirmBaseForm.js +42 -42
- package/es/ConfirmDeleteForm/ConfirmDeleteForm.d.ts +24 -24
- package/es/ConfirmDeleteForm/ConfirmDeleteForm.js +60 -60
- package/es/DatePicker/DatePickerGroup.d.ts +13 -14
- package/es/DatePicker/DatePickerGroup.js +87 -87
- package/es/DatePicker/DatePickerHelper.d.ts +3 -3
- package/es/DatePicker/DatePickerHelper.js +1 -1
- package/es/DatePicker/StringDateOnlyPickerGroup.d.ts +9 -10
- package/es/DatePicker/StringDateOnlyPickerGroup.js +29 -29
- package/es/DatePicker/StringDatePickerGroup.d.ts +9 -10
- package/es/DatePicker/StringDatePickerGroup.js +24 -24
- package/es/Field/CustomFieldInputProps.d.ts +7 -7
- package/es/Field/CustomFieldInputProps.js +1 -1
- package/es/Field/CustomFieldMetaProps.d.ts +4 -4
- package/es/Field/CustomFieldMetaProps.js +1 -1
- package/es/Field/Field.d.ts +28 -28
- package/es/Field/Field.js +51 -51
- package/es/Field/FieldErrorScrollTarget.d.ts +2 -3
- package/es/Field/FieldErrorScrollTarget.js +12 -12
- package/es/Field/FieldNameContext.d.ts +3 -3
- package/es/Field/FieldNameContext.js +3 -3
- package/es/Field/FieldSection.d.ts +7 -7
- package/es/Field/FieldSection.js +9 -20
- package/es/Field/InjectedFieldProps.d.ts +7 -7
- package/es/Field/InjectedFieldProps.js +1 -1
- package/es/Field/StandAloneInput.d.ts +13 -13
- package/es/Field/StandAloneInput.js +50 -50
- package/es/Field/useStandardField.d.ts +21 -21
- package/es/Field/useStandardField.js +92 -92
- package/es/FieldArray/FieldArray.d.ts +24 -24
- package/es/FieldArray/FieldArray.js +77 -88
- package/es/File/FileGroup.d.ts +10 -10
- package/es/File/FileGroup.js +53 -53
- package/es/File/FileList.d.ts +5 -6
- package/es/File/FileList.js +10 -21
- package/es/File/humanFileSize.d.ts +1 -1
- package/es/File/humanFileSize.js +6 -6
- package/es/Form/FocusError.d.ts +7 -7
- package/es/Form/FocusError.js +42 -42
- package/es/Form/Form.d.ts +33 -33
- package/es/Form/Form.js +141 -141
- package/es/Form/FormBasedPreventNavigation.d.ts +6 -7
- package/es/Form/FormBasedPreventNavigation.js +20 -20
- package/es/Form/LegacyFormBasedPreventNavigation.d.ts +17 -17
- package/es/Form/LegacyFormBasedPreventNavigation.js +69 -69
- package/es/Form/NewFormBasedPreventNavigation.d.ts +14 -14
- package/es/Form/NewFormBasedPreventNavigation.js +39 -39
- package/es/Form/ServerErrorContext.d.ts +11 -11
- package/es/Form/ServerErrorContext.js +9 -9
- package/es/FormActions.d.ts +12 -13
- package/es/FormActions.js +16 -27
- package/es/FormDefaults.d.ts +4 -4
- package/es/FormDefaults.js +2 -2
- package/es/Group.d.ts +16 -16
- package/es/Group.js +14 -25
- package/es/Input/IconInputGroup.d.ts +12 -12
- package/es/Input/IconInputGroup.js +43 -43
- package/es/Input/InputGroup.d.ts +12 -12
- package/es/Input/InputGroup.js +34 -34
- package/es/Input/MoneyInputGroup.d.ts +9 -9
- package/es/Input/MoneyInputGroup.js +43 -43
- package/es/Input/NumberInputGroup.d.ts +9 -9
- package/es/Input/NumberInputGroup.js +43 -43
- package/es/Input/PhoneNumberInputGroup.d.ts +10 -0
- package/es/Input/PhoneNumberInputGroup.js +47 -0
- package/es/Input/StringInputGroup.d.ts +8 -8
- package/es/Input/StringInputGroup.js +43 -43
- package/es/Normalization/NormalizationFunction.d.ts +4 -4
- package/es/Normalization/NormalizationFunction.js +1 -1
- package/es/Normalization/normalizers.d.ts +4 -4
- package/es/Normalization/normalizers.js +32 -32
- package/es/Select/BooleanSelectGroup.d.ts +7 -8
- package/es/Select/BooleanSelectGroup.js +28 -28
- package/es/Select/NumberSelectGroup.d.ts +9 -10
- package/es/Select/NumberSelectGroup.js +21 -21
- package/es/Select/SelectGroup.d.ts +27 -28
- package/es/Select/SelectGroup.js +65 -65
- package/es/Select/SelectGroupPropsHelper.d.ts +3 -3
- package/es/Select/SelectGroupPropsHelper.js +1 -1
- package/es/Select/StringSelectGroup.d.ts +9 -10
- package/es/Select/StringSelectGroup.js +21 -21
- package/es/StandardFormActions.d.ts +11 -11
- package/es/StandardFormActions.js +14 -25
- package/es/SubmitFormButton.d.ts +10 -10
- package/es/SubmitFormButton.js +40 -40
- package/es/TextArea/TextAreaGroup.d.ts +9 -9
- package/es/TextArea/TextAreaGroup.js +35 -35
- package/es/Validation/ValidatedApiResult.d.ts +6 -6
- package/es/Validation/ValidatedApiResult.js +1 -1
- package/es/Validation/ValidationError.d.ts +5 -5
- package/es/Validation/ValidationError.js +1 -1
- package/es/Validation/ValidationFunction.d.ts +4 -4
- package/es/Validation/ValidationFunction.js +1 -1
- package/es/Validation/validators.d.ts +18 -18
- package/es/Validation/validators.js +77 -77
- package/es/index.d.ts +75 -73
- package/es/index.js +51 -50
- package/es/setupTests.d.ts +1 -1
- package/es/setupTests.js +1 -1
- package/es/utils/objectContainsNonSerializableProperty.d.ts +1 -1
- package/es/utils/objectContainsNonSerializableProperty.js +14 -14
- package/es/utils/objectToFormData.d.ts +10 -10
- package/es/utils/objectToFormData.js +77 -77
- package/es/utils/typeChecks.d.ts +8 -8
- package/es/utils/typeChecks.js +18 -18
- package/lib/AddressInput/AddressInput.d.ts +24 -25
- package/lib/AddressInput/AddressInput.js +26 -37
- package/lib/AddressInput/UsStates.d.ts +3 -3
- package/lib/AddressInput/UsStates.js +55 -55
- package/lib/ConfirmBaseForm/ConfirmBaseForm.d.ts +26 -26
- package/lib/ConfirmBaseForm/ConfirmBaseForm.js +48 -48
- package/lib/ConfirmDeleteForm/ConfirmDeleteForm.d.ts +24 -24
- package/lib/ConfirmDeleteForm/ConfirmDeleteForm.js +66 -66
- package/lib/DatePicker/DatePickerGroup.d.ts +13 -14
- package/lib/DatePicker/DatePickerGroup.js +95 -95
- package/lib/DatePicker/DatePickerHelper.d.ts +3 -3
- package/lib/DatePicker/DatePickerHelper.js +2 -2
- package/lib/DatePicker/StringDateOnlyPickerGroup.d.ts +9 -10
- package/lib/DatePicker/StringDateOnlyPickerGroup.js +35 -35
- package/lib/DatePicker/StringDatePickerGroup.d.ts +9 -10
- package/lib/DatePicker/StringDatePickerGroup.js +30 -30
- package/lib/Field/CustomFieldInputProps.d.ts +7 -7
- package/lib/Field/CustomFieldInputProps.js +2 -2
- package/lib/Field/CustomFieldMetaProps.d.ts +4 -4
- package/lib/Field/CustomFieldMetaProps.js +2 -2
- package/lib/Field/Field.d.ts +28 -28
- package/lib/Field/Field.js +56 -56
- package/lib/Field/FieldErrorScrollTarget.d.ts +2 -3
- package/lib/Field/FieldErrorScrollTarget.js +15 -15
- package/lib/Field/FieldNameContext.d.ts +3 -3
- package/lib/Field/FieldNameContext.js +9 -9
- package/lib/Field/FieldSection.d.ts +7 -7
- package/lib/Field/FieldSection.js +12 -23
- package/lib/Field/InjectedFieldProps.d.ts +7 -7
- package/lib/Field/InjectedFieldProps.js +2 -2
- package/lib/Field/StandAloneInput.d.ts +13 -13
- package/lib/Field/StandAloneInput.js +76 -76
- package/lib/Field/useStandardField.d.ts +21 -21
- package/lib/Field/useStandardField.js +95 -95
- package/lib/FieldArray/FieldArray.d.ts +24 -24
- package/lib/FieldArray/FieldArray.js +83 -94
- package/lib/File/FileGroup.d.ts +10 -10
- package/lib/File/FileGroup.js +58 -58
- package/lib/File/FileList.d.ts +5 -6
- package/lib/File/FileList.js +13 -24
- package/lib/File/humanFileSize.d.ts +1 -1
- package/lib/File/humanFileSize.js +10 -10
- package/lib/Form/FocusError.d.ts +7 -7
- package/lib/Form/FocusError.js +48 -48
- package/lib/Form/Form.d.ts +33 -33
- package/lib/Form/Form.js +147 -147
- package/lib/Form/FormBasedPreventNavigation.d.ts +6 -7
- package/lib/Form/FormBasedPreventNavigation.js +26 -26
- package/lib/Form/LegacyFormBasedPreventNavigation.d.ts +17 -17
- package/lib/Form/LegacyFormBasedPreventNavigation.js +72 -72
- package/lib/Form/NewFormBasedPreventNavigation.d.ts +14 -14
- package/lib/Form/NewFormBasedPreventNavigation.js +42 -42
- package/lib/Form/ServerErrorContext.d.ts +11 -11
- package/lib/Form/ServerErrorContext.js +15 -15
- package/lib/FormActions.d.ts +12 -13
- package/lib/FormActions.js +22 -33
- package/lib/FormDefaults.d.ts +4 -4
- package/lib/FormDefaults.js +5 -5
- package/lib/Group.d.ts +16 -16
- package/lib/Group.js +20 -31
- package/lib/Input/IconInputGroup.d.ts +12 -12
- package/lib/Input/IconInputGroup.js +48 -48
- package/lib/Input/InputGroup.d.ts +12 -12
- package/lib/Input/InputGroup.js +39 -39
- package/lib/Input/MoneyInputGroup.d.ts +9 -9
- package/lib/Input/MoneyInputGroup.js +48 -48
- package/lib/Input/NumberInputGroup.d.ts +9 -9
- package/lib/Input/NumberInputGroup.js +48 -48
- package/lib/Input/PhoneNumberInputGroup.d.ts +10 -0
- package/lib/Input/PhoneNumberInputGroup.js +52 -0
- package/lib/Input/StringInputGroup.d.ts +8 -8
- package/lib/Input/StringInputGroup.js +48 -48
- package/lib/Normalization/NormalizationFunction.d.ts +4 -4
- package/lib/Normalization/NormalizationFunction.js +2 -2
- package/lib/Normalization/normalizers.d.ts +4 -4
- package/lib/Normalization/normalizers.js +37 -37
- package/lib/Select/BooleanSelectGroup.d.ts +7 -8
- package/lib/Select/BooleanSelectGroup.js +35 -35
- package/lib/Select/NumberSelectGroup.d.ts +9 -10
- package/lib/Select/NumberSelectGroup.js +29 -29
- package/lib/Select/SelectGroup.d.ts +27 -28
- package/lib/Select/SelectGroup.js +71 -71
- package/lib/Select/SelectGroupPropsHelper.d.ts +3 -3
- package/lib/Select/SelectGroupPropsHelper.js +2 -2
- package/lib/Select/StringSelectGroup.d.ts +9 -10
- package/lib/Select/StringSelectGroup.js +29 -29
- package/lib/StandardFormActions.d.ts +11 -11
- package/lib/StandardFormActions.js +20 -31
- package/lib/SubmitFormButton.d.ts +10 -10
- package/lib/SubmitFormButton.js +45 -45
- package/lib/TextArea/TextAreaGroup.d.ts +9 -9
- package/lib/TextArea/TextAreaGroup.js +40 -40
- package/lib/Validation/ValidatedApiResult.d.ts +6 -6
- package/lib/Validation/ValidatedApiResult.js +2 -2
- package/lib/Validation/ValidationError.d.ts +5 -5
- package/lib/Validation/ValidationError.js +2 -2
- package/lib/Validation/ValidationFunction.d.ts +4 -4
- package/lib/Validation/ValidationFunction.js +2 -2
- package/lib/Validation/validators.d.ts +18 -18
- package/lib/Validation/validators.js +90 -90
- package/lib/index.d.ts +75 -73
- package/lib/index.js +119 -117
- package/lib/setupTests.d.ts +1 -1
- package/lib/setupTests.js +3 -3
- package/lib/utils/objectContainsNonSerializableProperty.d.ts +1 -1
- package/lib/utils/objectContainsNonSerializableProperty.js +17 -17
- package/lib/utils/objectToFormData.d.ts +10 -10
- package/lib/utils/objectToFormData.js +79 -79
- package/lib/utils/typeChecks.d.ts +8 -8
- package/lib/utils/typeChecks.js +29 -29
- package/package.json +12 -12
- package/src/AddressInput/__snapshots__/AddressInput.test.tsx.snap +6 -8
- package/src/Input/PhoneNumberInputGroup.tsx +45 -0
- package/src/Input/__Tests__/PhoneNumberInputGroup.test.tsx +36 -0
- package/src/Input/__Tests__/__snapshots__/PhoneNumberInputGroup.test.tsx.snap +33 -0
- package/src/Select/__tests__/__snapshots__/BooleanSelectGroup.test.tsx.snap +6 -8
- package/src/Select/__tests__/__snapshots__/NumberSelectGroup.test.tsx.snap +12 -16
- package/src/Select/__tests__/__snapshots__/StringSelectGroup.test.tsx.snap +12 -16
- package/src/index.ts +3 -0
- package/src/utils/objectToFormData.test.tsx +1 -1
package/README.md
CHANGED
@@ -266,7 +266,9 @@ ___
|
|
266
266
|
|
267
267
|
Custom confirm button text.
|
268
268
|
|
269
|
-
**`
|
269
|
+
**`Default Value`**
|
270
|
+
|
271
|
+
`Confirm`
|
270
272
|
|
271
273
|
##### Defined in
|
272
274
|
|
@@ -425,7 +427,9 @@ ___
|
|
425
427
|
|
426
428
|
Custom message to display.
|
427
429
|
|
428
|
-
**`
|
430
|
+
**`Default Value`**
|
431
|
+
|
432
|
+
`Are you sure you want to delete this?`
|
429
433
|
|
430
434
|
##### Defined in
|
431
435
|
|
@@ -438,6 +442,8 @@ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:19
|
|
438
442
|
|
439
443
|
## Interface: DatePickerGroupProps<T\>
|
440
444
|
|
445
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
446
|
+
|
441
447
|
### Type parameters
|
442
448
|
|
443
449
|
| Name |
|
@@ -459,15 +465,12 @@ packages/envoc-form/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx:19
|
|
459
465
|
#### Properties
|
460
466
|
|
461
467
|
- [className](#classname)
|
468
|
+
- [convert](#convert)
|
462
469
|
- [helpText](#helptext)
|
463
470
|
- [input](#input)
|
464
471
|
- [label](#label)
|
465
472
|
- [meta](#meta)
|
466
473
|
|
467
|
-
#### Methods
|
468
|
-
|
469
|
-
- [convert](#convert)
|
470
|
-
|
471
474
|
### Properties
|
472
475
|
|
473
476
|
#### className
|
@@ -486,6 +489,30 @@ packages/envoc-form/src/Group.tsx:8
|
|
486
489
|
|
487
490
|
___
|
488
491
|
|
492
|
+
#### convert
|
493
|
+
|
494
|
+
• **convert**: (`arg`: `Date`) => `T`
|
495
|
+
|
496
|
+
##### Type declaration
|
497
|
+
|
498
|
+
▸ (`arg`): `T`
|
499
|
+
|
500
|
+
###### Parameters
|
501
|
+
|
502
|
+
| Name | Type |
|
503
|
+
| :------ | :------ |
|
504
|
+
| `arg` | `Date` |
|
505
|
+
|
506
|
+
###### Returns
|
507
|
+
|
508
|
+
`T`
|
509
|
+
|
510
|
+
##### Defined in
|
511
|
+
|
512
|
+
packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:18
|
513
|
+
|
514
|
+
___
|
515
|
+
|
489
516
|
#### helpText
|
490
517
|
|
491
518
|
• `Optional` **helpText**: `ReactNode`
|
@@ -544,26 +571,6 @@ ___
|
|
544
571
|
|
545
572
|
packages/envoc-form/src/Field/InjectedFieldProps.ts:7
|
546
573
|
|
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
574
|
|
568
575
|
<a name="interfacesdatepickerhelpermd"></a>
|
569
576
|
|
@@ -680,6 +687,8 @@ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
|
|
680
687
|
|
681
688
|
## Interface: FileGroupProps
|
682
689
|
|
690
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
691
|
+
|
683
692
|
### Hierarchy
|
684
693
|
|
685
694
|
- [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any` \| `undefined` \| ``null``\>
|
@@ -838,9 +847,6 @@ packages/envoc-form/src/Group.tsx:21
|
|
838
847
|
|
839
848
|
- [allowPristineSubmit](#allowpristinesubmit)
|
840
849
|
- [disabled](#disabled)
|
841
|
-
|
842
|
-
#### Methods
|
843
|
-
|
844
850
|
- [handleCancel](#handlecancel)
|
845
851
|
|
846
852
|
### Properties
|
@@ -867,17 +873,23 @@ Whether both buttons should be disabled.
|
|
867
873
|
|
868
874
|
packages/envoc-form/src/FormActions.tsx:13
|
869
875
|
|
870
|
-
|
876
|
+
___
|
871
877
|
|
872
878
|
#### handleCancel
|
873
879
|
|
874
|
-
|
880
|
+
• `Optional` **handleCancel**: () => `void`
|
881
|
+
|
882
|
+
##### Type declaration
|
883
|
+
|
884
|
+
▸ (): `void`
|
875
885
|
|
876
886
|
The cancel button's `onClick`.
|
877
887
|
|
878
|
-
**`
|
888
|
+
**`Default Value`**
|
879
889
|
|
880
|
-
|
890
|
+
`window.history.back()`
|
891
|
+
|
892
|
+
###### Returns
|
881
893
|
|
882
894
|
`void`
|
883
895
|
|
@@ -892,6 +904,8 @@ packages/envoc-form/src/FormActions.tsx:11
|
|
892
904
|
|
893
905
|
## Interface: GroupProps
|
894
906
|
|
907
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
908
|
+
|
895
909
|
### Hierarchy
|
896
910
|
|
897
911
|
- [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`any`\>
|
@@ -1128,7 +1142,7 @@ ___
|
|
1128
1142
|
|
1129
1143
|
#### type
|
1130
1144
|
|
1131
|
-
• `Optional` **type**: ``"
|
1145
|
+
• `Optional` **type**: ``"color"`` \| ``"search"`` \| ``"text"`` \| ``"tel"`` \| ``"url"`` \| ``"email"``
|
1132
1146
|
|
1133
1147
|
##### Defined in
|
1134
1148
|
|
@@ -1199,6 +1213,8 @@ packages/envoc-form/src/Field/InjectedFieldProps.ts:7
|
|
1199
1213
|
|
1200
1214
|
## Interface: InputGroupProps<TValue\>
|
1201
1215
|
|
1216
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
1217
|
+
|
1202
1218
|
### Type parameters
|
1203
1219
|
|
1204
1220
|
| Name |
|
@@ -1457,7 +1473,7 @@ ___
|
|
1457
1473
|
|
1458
1474
|
#### parseFunc
|
1459
1475
|
|
1460
|
-
• `Optional` **parseFunc**: (`string`: `string
|
1476
|
+
• `Optional` **parseFunc**: (`string`: `string`) => `number` \| (`string`: `string`, `radix?`: `number`) => `number`
|
1461
1477
|
|
1462
1478
|
Custom parsing function when the value changes.
|
1463
1479
|
|
@@ -1588,7 +1604,7 @@ ___
|
|
1588
1604
|
|
1589
1605
|
#### options
|
1590
1606
|
|
1591
|
-
• **options**:
|
1607
|
+
• **options**: `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`[]\> \| [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`[]\>[]
|
1592
1608
|
|
1593
1609
|
Options for the dropdown. Includes the label and value.
|
1594
1610
|
|
@@ -1753,7 +1769,7 @@ ___
|
|
1753
1769
|
|
1754
1770
|
#### options
|
1755
1771
|
|
1756
|
-
• **options**: [`SelectOption`](#interfacesselectoptionmd)<`string`[]\>[]
|
1772
|
+
• **options**: `OptionsUseServiceResult`<`string`[]\> \| [`SelectOption`](#interfacesselectoptionmd)<`string`[]\>[]
|
1757
1773
|
|
1758
1774
|
Options for the dropdown. Includes the label and value.
|
1759
1775
|
|
@@ -1802,6 +1818,8 @@ packages/envoc-form/src/Group.tsx:21
|
|
1802
1818
|
|
1803
1819
|
## Interface: NormalizationFunction<TValue\>
|
1804
1820
|
|
1821
|
+
Normalization of values
|
1822
|
+
|
1805
1823
|
### Type parameters
|
1806
1824
|
|
1807
1825
|
| Name |
|
@@ -1814,8 +1832,6 @@ packages/envoc-form/src/Group.tsx:21
|
|
1814
1832
|
|
1815
1833
|
▸ **NormalizationFunction**(`value`): `TValue`
|
1816
1834
|
|
1817
|
-
Normalization of values
|
1818
|
-
|
1819
1835
|
##### Parameters
|
1820
1836
|
|
1821
1837
|
| Name | Type |
|
@@ -1949,7 +1965,7 @@ ___
|
|
1949
1965
|
|
1950
1966
|
#### parseFunc
|
1951
1967
|
|
1952
|
-
• `Optional` **parseFunc**: (`string`: `string
|
1968
|
+
• `Optional` **parseFunc**: (`string`: `string`) => `number` \| (`string`: `string`, `radix?`: `number`) => `number`
|
1953
1969
|
|
1954
1970
|
Custom parsing function when the value changes.
|
1955
1971
|
|
@@ -2036,12 +2052,128 @@ ___
|
|
2036
2052
|
packages/envoc-form/src/utils/objectToFormData.ts:20
|
2037
2053
|
|
2038
2054
|
|
2055
|
+
<a name="interfacesphonenumberinputgrouppropsmd"></a>
|
2056
|
+
|
2057
|
+
[envoc-form](#readmemd) / [Exports](#modulesmd) / PhoneNumberInputGroupProps
|
2058
|
+
|
2059
|
+
## Interface: PhoneNumberInputGroupProps
|
2060
|
+
|
2061
|
+
### Hierarchy
|
2062
|
+
|
2063
|
+
- `Omit`<[`InputGroupProps`](#interfacesinputgrouppropsmd)<`string` \| `undefined` \| ``null``\>, ``"onChange"`` \| ``"type"`` \| ``"value"``\>
|
2064
|
+
|
2065
|
+
↳ **`PhoneNumberInputGroupProps`**
|
2066
|
+
|
2067
|
+
### Table of contents
|
2068
|
+
|
2069
|
+
#### Properties
|
2070
|
+
|
2071
|
+
- [className](#classname)
|
2072
|
+
- [helpText](#helptext)
|
2073
|
+
- [icon](#icon)
|
2074
|
+
- [input](#input)
|
2075
|
+
- [label](#label)
|
2076
|
+
- [meta](#meta)
|
2077
|
+
|
2078
|
+
### Properties
|
2079
|
+
|
2080
|
+
#### className
|
2081
|
+
|
2082
|
+
• `Optional` **className**: `string`
|
2083
|
+
|
2084
|
+
Extra class names to apply.
|
2085
|
+
|
2086
|
+
##### Inherited from
|
2087
|
+
|
2088
|
+
Omit.className
|
2089
|
+
|
2090
|
+
##### Defined in
|
2091
|
+
|
2092
|
+
packages/envoc-form/src/Group.tsx:8
|
2093
|
+
|
2094
|
+
___
|
2095
|
+
|
2096
|
+
#### helpText
|
2097
|
+
|
2098
|
+
• `Optional` **helpText**: `ReactNode`
|
2099
|
+
|
2100
|
+
Simple helper text after the input.
|
2101
|
+
|
2102
|
+
##### Inherited from
|
2103
|
+
|
2104
|
+
Omit.helpText
|
2105
|
+
|
2106
|
+
##### Defined in
|
2107
|
+
|
2108
|
+
packages/envoc-form/src/Group.tsx:16
|
2109
|
+
|
2110
|
+
___
|
2111
|
+
|
2112
|
+
#### icon
|
2113
|
+
|
2114
|
+
• `Optional` **icon**: `ReactNode`
|
2115
|
+
|
2116
|
+
##### Inherited from
|
2117
|
+
|
2118
|
+
Omit.icon
|
2119
|
+
|
2120
|
+
##### Defined in
|
2121
|
+
|
2122
|
+
packages/envoc-form/src/Input/InputGroup.tsx:20
|
2123
|
+
|
2124
|
+
___
|
2125
|
+
|
2126
|
+
#### input
|
2127
|
+
|
2128
|
+
• **input**: `CustomFieldInputProps`<`undefined` \| ``null`` \| `string`\>
|
2129
|
+
|
2130
|
+
##### Inherited from
|
2131
|
+
|
2132
|
+
Omit.input
|
2133
|
+
|
2134
|
+
##### Defined in
|
2135
|
+
|
2136
|
+
packages/envoc-form/src/Field/InjectedFieldProps.ts:6
|
2137
|
+
|
2138
|
+
___
|
2139
|
+
|
2140
|
+
#### label
|
2141
|
+
|
2142
|
+
• `Optional` **label**: `string`
|
2143
|
+
|
2144
|
+
Simple text label before the input.
|
2145
|
+
|
2146
|
+
##### Inherited from
|
2147
|
+
|
2148
|
+
Omit.label
|
2149
|
+
|
2150
|
+
##### Defined in
|
2151
|
+
|
2152
|
+
packages/envoc-form/src/Group.tsx:13
|
2153
|
+
|
2154
|
+
___
|
2155
|
+
|
2156
|
+
#### meta
|
2157
|
+
|
2158
|
+
• **meta**: `CustomFieldMetaProps`<`undefined` \| ``null`` \| `string`\>
|
2159
|
+
|
2160
|
+
##### Inherited from
|
2161
|
+
|
2162
|
+
Omit.meta
|
2163
|
+
|
2164
|
+
##### Defined in
|
2165
|
+
|
2166
|
+
packages/envoc-form/src/Field/InjectedFieldProps.ts:7
|
2167
|
+
|
2168
|
+
|
2039
2169
|
<a name="interfacesselectgrouppropsmd"></a>
|
2040
2170
|
|
2041
2171
|
[envoc-form](#readmemd) / [Exports](#modulesmd) / SelectGroupProps
|
2042
2172
|
|
2043
2173
|
## Interface: SelectGroupProps<TValue\>
|
2044
2174
|
|
2175
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
2176
|
+
|
2045
2177
|
### Type parameters
|
2046
2178
|
|
2047
2179
|
| Name |
|
@@ -2179,7 +2311,7 @@ ___
|
|
2179
2311
|
|
2180
2312
|
#### options
|
2181
2313
|
|
2182
|
-
• **options**: [`SelectOption`](#interfacesselectoptionmd)<`TValue`\>[]
|
2314
|
+
• **options**: `OptionsUseServiceResult`<`TValue`\> \| [`SelectOption`](#interfacesselectoptionmd)<`TValue`\>[]
|
2183
2315
|
|
2184
2316
|
Options for the dropdown. Includes the label and value.
|
2185
2317
|
|
@@ -2350,7 +2482,7 @@ ___
|
|
2350
2482
|
|
2351
2483
|
#### options
|
2352
2484
|
|
2353
|
-
• **options**: [`SelectOption`](#interfacesselectoptionmd)<`T`\>[]
|
2485
|
+
• **options**: `OptionsUseServiceResult`<`T`\> \| [`SelectOption`](#interfacesselectoptionmd)<`T`\>[]
|
2354
2486
|
|
2355
2487
|
Options for the dropdown. Includes the label and value.
|
2356
2488
|
|
@@ -2448,9 +2580,6 @@ packages/envoc-form/src/Select/SelectGroup.tsx:9
|
|
2448
2580
|
#### Properties
|
2449
2581
|
|
2450
2582
|
- [errors](#errors)
|
2451
|
-
|
2452
|
-
#### Methods
|
2453
|
-
|
2454
2583
|
- [getError](#geterror)
|
2455
2584
|
- [setError](#seterror)
|
2456
2585
|
|
@@ -2464,19 +2593,23 @@ packages/envoc-form/src/Select/SelectGroup.tsx:9
|
|
2464
2593
|
|
2465
2594
|
packages/envoc-form/src/Form/ServerErrorContext.ts:7
|
2466
2595
|
|
2467
|
-
|
2596
|
+
___
|
2468
2597
|
|
2469
2598
|
#### getError
|
2470
2599
|
|
2471
|
-
|
2600
|
+
• **getError**: (`path`: `string`) => `undefined` \| `string`
|
2472
2601
|
|
2473
|
-
#####
|
2602
|
+
##### Type declaration
|
2603
|
+
|
2604
|
+
▸ (`path`): `undefined` \| `string`
|
2605
|
+
|
2606
|
+
###### Parameters
|
2474
2607
|
|
2475
2608
|
| Name | Type |
|
2476
2609
|
| :------ | :------ |
|
2477
2610
|
| `path` | `string` |
|
2478
2611
|
|
2479
|
-
|
2612
|
+
###### Returns
|
2480
2613
|
|
2481
2614
|
`undefined` \| `string`
|
2482
2615
|
|
@@ -2488,16 +2621,20 @@ ___
|
|
2488
2621
|
|
2489
2622
|
#### setError
|
2490
2623
|
|
2491
|
-
|
2624
|
+
• **setError**: (`path`: `string`, `errorMessage`: `undefined` \| `string`) => `void`
|
2492
2625
|
|
2493
|
-
#####
|
2626
|
+
##### Type declaration
|
2627
|
+
|
2628
|
+
▸ (`path`, `errorMessage`): `void`
|
2629
|
+
|
2630
|
+
###### Parameters
|
2494
2631
|
|
2495
2632
|
| Name | Type |
|
2496
2633
|
| :------ | :------ |
|
2497
2634
|
| `path` | `string` |
|
2498
2635
|
| `errorMessage` | `undefined` \| `string` |
|
2499
2636
|
|
2500
|
-
|
2637
|
+
###### Returns
|
2501
2638
|
|
2502
2639
|
`void`
|
2503
2640
|
|
@@ -2639,7 +2776,7 @@ ___
|
|
2639
2776
|
|
2640
2777
|
#### options
|
2641
2778
|
|
2642
|
-
• **options**:
|
2779
|
+
• **options**: `OptionsUseServiceResult`<`undefined` \| ``null`` \| `number`\> \| [`SelectOption`](#interfacesselectoptionmd)<`undefined` \| ``null`` \| `number`\>[]
|
2643
2780
|
|
2644
2781
|
Options for the dropdown. Includes the label and value.
|
2645
2782
|
|
@@ -2880,7 +3017,9 @@ ___
|
|
2880
3017
|
|
2881
3018
|
The cancel button's `onClick`.
|
2882
3019
|
|
2883
|
-
**`
|
3020
|
+
**`Default Value`**
|
3021
|
+
|
3022
|
+
`window.history.back()`
|
2884
3023
|
|
2885
3024
|
##### Defined in
|
2886
3025
|
|
@@ -3203,7 +3342,7 @@ ___
|
|
3203
3342
|
|
3204
3343
|
#### type
|
3205
3344
|
|
3206
|
-
• `Optional` **type**: ``"
|
3345
|
+
• `Optional` **type**: ``"color"`` \| ``"search"`` \| ``"textarea"`` \| ``"text"`` \| ``"tel"`` \| ``"url"`` \| ``"email"`` \| ``"password"``
|
3207
3346
|
|
3208
3347
|
##### Defined in
|
3209
3348
|
|
@@ -3264,6 +3403,8 @@ packages/envoc-form/src/SubmitFormButton.tsx:11
|
|
3264
3403
|
|
3265
3404
|
## Interface: TextAreaGroupProps
|
3266
3405
|
|
3406
|
+
Defines what is injected by a Field wrapper of some TRenderComponent
|
3407
|
+
|
3267
3408
|
### Hierarchy
|
3268
3409
|
|
3269
3410
|
- [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`string` \| `undefined` \| ``null``\>
|
@@ -3450,6 +3591,8 @@ packages/envoc-form/src/Validation/ValidationError.ts:4
|
|
3450
3591
|
|
3451
3592
|
## Interface: ValidationFunction<TValue\>
|
3452
3593
|
|
3594
|
+
Client side validation function
|
3595
|
+
|
3453
3596
|
### Type parameters
|
3454
3597
|
|
3455
3598
|
| Name |
|
@@ -3462,8 +3605,6 @@ packages/envoc-form/src/Validation/ValidationError.ts:4
|
|
3462
3605
|
|
3463
3606
|
▸ **ValidationFunction**(`value`): `undefined` \| `string`
|
3464
3607
|
|
3465
|
-
Client side validation function
|
3466
|
-
|
3467
3608
|
##### Parameters
|
3468
3609
|
|
3469
3610
|
| Name | Type |
|
@@ -3596,6 +3737,7 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3596
3737
|
- [NormalizationFunction](#interfacesnormalizationfunctionmd)
|
3597
3738
|
- [NumberInputGroupProps](#interfacesnumberinputgrouppropsmd)
|
3598
3739
|
- [ObjectToFormDataCfgProps](#interfacesobjecttoformdatacfgpropsmd)
|
3740
|
+
- [PhoneNumberInputGroupProps](#interfacesphonenumberinputgrouppropsmd)
|
3599
3741
|
- [SelectGroupProps](#interfacesselectgrouppropsmd)
|
3600
3742
|
- [SelectGroupPropsHelper](#interfacesselectgrouppropshelpermd)
|
3601
3743
|
- [SelectOption](#interfacesselectoptionmd)
|
@@ -3614,7 +3756,7 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3614
3756
|
- [ValidationFunction](#interfacesvalidationfunctionmd)
|
3615
3757
|
- [useStandardFieldProps](#interfacesusestandardfieldpropsmd)
|
3616
3758
|
|
3617
|
-
### Type
|
3759
|
+
### Type Aliases
|
3618
3760
|
|
3619
3761
|
- [ArrayFormBuilderProp](#arrayformbuilderprop)
|
3620
3762
|
- [FieldArrayProps](#fieldarrayprops)
|
@@ -3625,19 +3767,14 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3625
3767
|
- [RenderComponentProps](#rendercomponentprops)
|
3626
3768
|
- [StandAloneInputProps](#standaloneinputprops)
|
3627
3769
|
|
3628
|
-
### Properties
|
3629
|
-
|
3630
|
-
- [Field](#field)
|
3631
|
-
- [SubmitFormButton](#submitformbutton)
|
3632
|
-
|
3633
3770
|
### Variables
|
3634
3771
|
|
3635
3772
|
- [FieldNameContext](#fieldnamecontext)
|
3636
3773
|
- [FileGroup](#filegroup)
|
3637
3774
|
- [FormDefaults](#formdefaults)
|
3638
3775
|
- [IconInputGroup](#iconinputgroup)
|
3639
|
-
- [MoneyInputGroup](#moneyinputgroup)
|
3640
3776
|
- [NumberInputGroup](#numberinputgroup)
|
3777
|
+
- [PhoneNumberInputGroup](#phonenumberinputgroup)
|
3641
3778
|
- [ServerErrorContext](#servererrorcontext)
|
3642
3779
|
- [StringInputGroup](#stringinputgroup)
|
3643
3780
|
- [TextAreaGroup](#textareagroup)
|
@@ -3649,12 +3786,14 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3649
3786
|
- [ConfirmBaseForm](#confirmbaseform)
|
3650
3787
|
- [ConfirmDeleteForm](#confirmdeleteform)
|
3651
3788
|
- [DatePickerGroup](#datepickergroup)
|
3789
|
+
- [Field](#field)
|
3652
3790
|
- [FieldArray](#fieldarray)
|
3653
3791
|
- [FieldErrorScrollTarget](#fielderrorscrolltarget)
|
3654
3792
|
- [Form](#form)
|
3655
3793
|
- [FormActions](#formactions)
|
3656
3794
|
- [Group](#group)
|
3657
3795
|
- [InputGroup](#inputgroup)
|
3796
|
+
- [MoneyInputGroup](#moneyinputgroup)
|
3658
3797
|
- [MultiNumberSelectGroup](#multinumberselectgroup)
|
3659
3798
|
- [MultiStringSelectGroup](#multistringselectgroup)
|
3660
3799
|
- [SelectGroup](#selectgroup)
|
@@ -3664,6 +3803,7 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3664
3803
|
- [StandardFormActions](#standardformactions)
|
3665
3804
|
- [StringDateOnlyPickerGroup](#stringdateonlypickergroup)
|
3666
3805
|
- [StringDatePickerGroup](#stringdatepickergroup)
|
3806
|
+
- [SubmitFormButton](#submitformbutton)
|
3667
3807
|
- [convertToTimeZoneInsensitiveISOString](#converttotimezoneinsensitiveisostring)
|
3668
3808
|
- [isArray](#isarray)
|
3669
3809
|
- [isBlob](#isblob)
|
@@ -3677,11 +3817,11 @@ packages/envoc-form/src/Field/useStandardField.ts:18
|
|
3677
3817
|
- [serialize](#serialize)
|
3678
3818
|
- [useStandardField](#usestandardfield)
|
3679
3819
|
|
3680
|
-
## Type
|
3820
|
+
## Type Aliases
|
3681
3821
|
|
3682
3822
|
### ArrayFormBuilderProp
|
3683
3823
|
|
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`
|
3824
|
+
Ƭ **ArrayFormBuilderProp**<`TValue`\>: `TValue` extends infer TForm[] \| `undefined` \| ``null`` ? `TForm` extends `object` ? { `Field`: <TProp, TRenderComponent\>(`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `JSX.Element` ; `FieldArray`: <TProp\>(`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `JSX.Element` } : `never` : `never`
|
3685
3825
|
|
3686
3826
|
#### Type parameters
|
3687
3827
|
|
@@ -3697,7 +3837,7 @@ ___
|
|
3697
3837
|
|
3698
3838
|
### FieldArrayProps
|
3699
3839
|
|
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`]\>[]
|
3840
|
+
Ƭ **FieldArrayProps**<`TForm`, `TProp`\>: `TForm`[`TProp`] extends `any`[] \| `undefined` \| ``null`` ? { `children`: (`formBuilder`: [`ArrayFormBuilderProp`](#arrayformbuilderprop)<`TForm`[`TProp`]\>) => `JSX.Element` ; `disabled?`: `boolean` ; `label?`: `string` ; `name`: `TProp` ; `validate?`: [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\> \| [`ValidationFunction`](#interfacesvalidationfunctionmd)<`TForm`[`TProp`]\>[] } : `never`
|
3701
3841
|
|
3702
3842
|
#### Type parameters
|
3703
3843
|
|
@@ -3746,8 +3886,8 @@ ___
|
|
3746
3886
|
|
3747
3887
|
| Name | Type |
|
3748
3888
|
| :------ | :------ |
|
3749
|
-
| `Field` | <TProp, TRenderComponent\>(`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `Element` |
|
3750
|
-
| `FieldArray` | <TProp\>(`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `Element` |
|
3889
|
+
| `Field` | <TProp, TRenderComponent\>(`props`: [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\>) => `JSX.Element` |
|
3890
|
+
| `FieldArray` | <TProp\>(`props`: [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\>) => `JSX.Element` |
|
3751
3891
|
|
3752
3892
|
#### Defined in
|
3753
3893
|
|
@@ -3807,7 +3947,7 @@ ___
|
|
3807
3947
|
|
3808
3948
|
### StandAloneInputProps
|
3809
3949
|
|
3810
|
-
Ƭ **StandAloneInputProps**<`TValue`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TValue`, `TRenderComponent`\> ; `
|
3950
|
+
Ƭ **StandAloneInputProps**<`TValue`, `TRenderComponent`\>: { `Component`: [`RenderComponent`](#rendercomponent)<`TValue`, `TRenderComponent`\> ; `onChange`: (`arg`: `TValue`) => `void` ; `value`: `TValue` } & `Omit`<[`RenderComponentProps`](#rendercomponentprops)<`TValue`, `TRenderComponent`\>, keyof [`InjectedFieldProps`](#interfacesinjectedfieldpropsmd)<`TValue`\> \| ``"value"`` \| ``"onChange"`` \| ``"normalize"`` \| ``"validate"``\>
|
3811
3951
|
|
3812
3952
|
#### Type parameters
|
3813
3953
|
|
@@ -3820,44 +3960,6 @@ ___
|
|
3820
3960
|
|
3821
3961
|
packages/envoc-form/src/Field/StandAloneInput.tsx:8
|
3822
3962
|
|
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
3963
|
## Variables
|
3862
3964
|
|
3863
3965
|
### FieldNameContext
|
@@ -3914,27 +4016,34 @@ packages/envoc-form/src/Input/IconInputGroup.tsx:50
|
|
3914
4016
|
|
3915
4017
|
___
|
3916
4018
|
|
3917
|
-
###
|
4019
|
+
### NumberInputGroup
|
3918
4020
|
|
3919
|
-
• `Const` **
|
4021
|
+
• `Const` **NumberInputGroup**: `ComponentType`<[`NumberInputGroupProps`](#interfacesnumberinputgrouppropsmd)\>
|
3920
4022
|
|
3921
|
-
|
4023
|
+
Standard number input group. By default allows for float values.
|
3922
4024
|
|
3923
4025
|
#### Defined in
|
3924
4026
|
|
3925
|
-
packages/envoc-form/src/Input/
|
4027
|
+
packages/envoc-form/src/Input/NumberInputGroup.tsx:44
|
3926
4028
|
|
3927
4029
|
___
|
3928
4030
|
|
3929
|
-
###
|
4031
|
+
### PhoneNumberInputGroup
|
3930
4032
|
|
3931
|
-
• `Const` **
|
4033
|
+
• `Const` **PhoneNumberInputGroup**: `ComponentType`<[`PhoneNumberInputGroupProps`](#interfacesphonenumberinputgrouppropsmd)\>
|
3932
4034
|
|
3933
|
-
|
4035
|
+
A standard phone number input. Will display to the user in `+XXX XXX-XXX-XXXX` format as the number is being inputted.
|
4036
|
+
The data will get sent in the same format as displayed. Uses `normalizers.phoneNumber`.
|
4037
|
+
|
4038
|
+
**`Default`**
|
4039
|
+
|
4040
|
+
```ts
|
4041
|
+
autoComplete="tel-national"
|
4042
|
+
```
|
3934
4043
|
|
3935
4044
|
#### Defined in
|
3936
4045
|
|
3937
|
-
packages/envoc-form/src/Input/
|
4046
|
+
packages/envoc-form/src/Input/PhoneNumberInputGroup.tsx:42
|
3938
4047
|
|
3939
4048
|
___
|
3940
4049
|
|
@@ -3976,22 +4085,22 @@ packages/envoc-form/src/TextArea/TextAreaGroup.tsx:60
|
|
3976
4085
|
|
3977
4086
|
### AddressInput
|
3978
4087
|
|
3979
|
-
▸ **AddressInput**(
|
4088
|
+
▸ **AddressInput**(`«destructured»`): `Element`
|
3980
4089
|
|
3981
|
-
Collection of `<Field/>`s for inputting an address. Includes:
|
3982
|
-
```txt
|
3983
|
-
Address 1
|
3984
|
-
Address 2
|
3985
|
-
City
|
3986
|
-
State
|
3987
|
-
Zip
|
4090
|
+
Collection of `<Field/>`s for inputting an address. Includes:
|
4091
|
+
```txt
|
4092
|
+
Address 1
|
4093
|
+
Address 2
|
4094
|
+
City
|
4095
|
+
State
|
4096
|
+
Zip
|
3988
4097
|
```
|
3989
4098
|
|
3990
4099
|
#### Parameters
|
3991
4100
|
|
3992
4101
|
| Name | Type |
|
3993
4102
|
| :------ | :------ |
|
3994
|
-
|
|
4103
|
+
| `«destructured»` | [`AddressInputProps`](#interfacesaddressinputpropsmd) |
|
3995
4104
|
|
3996
4105
|
#### Returns
|
3997
4106
|
|
@@ -4027,9 +4136,9 @@ ___
|
|
4027
4136
|
|
4028
4137
|
### ConfirmBaseForm
|
4029
4138
|
|
4030
|
-
▸ **ConfirmBaseForm**(
|
4139
|
+
▸ **ConfirmBaseForm**(`«destructured»`): `Element`
|
4031
4140
|
|
4032
|
-
Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
|
4141
|
+
Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
|
4033
4142
|
Commonly used for confirming delete and archive.
|
4034
4143
|
|
4035
4144
|
See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
|
@@ -4038,7 +4147,7 @@ See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
|
|
4038
4147
|
|
4039
4148
|
| Name | Type |
|
4040
4149
|
| :------ | :------ |
|
4041
|
-
|
|
4150
|
+
| `«destructured»` | [`ConfirmBaseFormProps`](#interfacesconfirmbaseformpropsmd) |
|
4042
4151
|
|
4043
4152
|
#### Returns
|
4044
4153
|
|
@@ -4052,7 +4161,7 @@ ___
|
|
4052
4161
|
|
4053
4162
|
### ConfirmDeleteForm
|
4054
4163
|
|
4055
|
-
▸ **ConfirmDeleteForm**(
|
4164
|
+
▸ **ConfirmDeleteForm**(`«destructured»`): `Element`
|
4056
4165
|
|
4057
4166
|
Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
|
4058
4167
|
|
@@ -4062,7 +4171,7 @@ Wraps `<ConfirmBaseForm/>`.
|
|
4062
4171
|
|
4063
4172
|
| Name | Type |
|
4064
4173
|
| :------ | :------ |
|
4065
|
-
|
|
4174
|
+
| `«destructured»` | [`ConfirmDeleteFormProps`](#interfacesconfirmdeleteformpropsmd) |
|
4066
4175
|
|
4067
4176
|
#### Returns
|
4068
4177
|
|
@@ -4076,7 +4185,7 @@ ___
|
|
4076
4185
|
|
4077
4186
|
### DatePickerGroup
|
4078
4187
|
|
4079
|
-
▸ **DatePickerGroup**<`T`\>(
|
4188
|
+
▸ **DatePickerGroup**<`T`\>(`«destructured»`): `Element`
|
4080
4189
|
|
4081
4190
|
Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
|
4082
4191
|
|
@@ -4092,7 +4201,7 @@ Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
|
|
4092
4201
|
|
4093
4202
|
| Name | Type |
|
4094
4203
|
| :------ | :------ |
|
4095
|
-
|
|
4204
|
+
| `«destructured»` | [`DatePickerGroupProps`](#interfacesdatepickergrouppropsmd)<`T`\> |
|
4096
4205
|
|
4097
4206
|
#### Returns
|
4098
4207
|
|
@@ -4104,9 +4213,41 @@ packages/envoc-form/src/DatePicker/DatePickerGroup.tsx:26
|
|
4104
4213
|
|
4105
4214
|
___
|
4106
4215
|
|
4216
|
+
### Field
|
4217
|
+
|
4218
|
+
▸ **Field**<`TForm`, `TProp`, `TRenderComponent`\>(`«destructured»`, `ref`): `Element`
|
4219
|
+
|
4220
|
+
Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field.
|
4221
|
+
Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])
|
4222
|
+
|
4223
|
+
#### Type parameters
|
4224
|
+
|
4225
|
+
| Name | Type |
|
4226
|
+
| :------ | :------ |
|
4227
|
+
| `TForm` | extends `object` |
|
4228
|
+
| `TProp` | extends `string` \| `number` \| `symbol` |
|
4229
|
+
| `TRenderComponent` | extends `ElementType` |
|
4230
|
+
|
4231
|
+
#### Parameters
|
4232
|
+
|
4233
|
+
| Name | Type |
|
4234
|
+
| :------ | :------ |
|
4235
|
+
| `«destructured»` | [`FieldProps`](#fieldprops)<`TForm`, `TProp`, `TRenderComponent`\> |
|
4236
|
+
| `ref` | `LegacyRef`<`any`\> |
|
4237
|
+
|
4238
|
+
#### Returns
|
4239
|
+
|
4240
|
+
`Element`
|
4241
|
+
|
4242
|
+
#### Defined in
|
4243
|
+
|
4244
|
+
packages/envoc-form/src/Field/Field.tsx:60
|
4245
|
+
|
4246
|
+
___
|
4247
|
+
|
4107
4248
|
### FieldArray
|
4108
4249
|
|
4109
|
-
▸ **FieldArray**<`TForm`, `TProp`\>(
|
4250
|
+
▸ **FieldArray**<`TForm`, `TProp`\>(`«destructured»`): `Element`
|
4110
4251
|
|
4111
4252
|
An array of fields that allows the user to add multiple instances of the same field.
|
4112
4253
|
|
@@ -4123,7 +4264,7 @@ Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the
|
|
4123
4264
|
|
4124
4265
|
| Name | Type |
|
4125
4266
|
| :------ | :------ |
|
4126
|
-
|
|
4267
|
+
| `«destructured»` | [`FieldArrayProps`](#fieldarrayprops)<`TForm`, `TProp`\> |
|
4127
4268
|
|
4128
4269
|
#### Returns
|
4129
4270
|
|
@@ -4153,7 +4294,7 @@ ___
|
|
4153
4294
|
|
4154
4295
|
### Form
|
4155
4296
|
|
4156
|
-
▸ **Form**<`TForm`\>(
|
4297
|
+
▸ **Form**<`TForm`\>(`«destructured»`): `Element`
|
4157
4298
|
|
4158
4299
|
Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components.
|
4159
4300
|
|
@@ -4167,7 +4308,7 @@ Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains
|
|
4167
4308
|
|
4168
4309
|
| Name | Type |
|
4169
4310
|
| :------ | :------ |
|
4170
|
-
|
|
4311
|
+
| `«destructured»` | [`FormProps`](#formprops)<`TForm`\> |
|
4171
4312
|
|
4172
4313
|
#### Returns
|
4173
4314
|
|
@@ -4181,7 +4322,7 @@ ___
|
|
4181
4322
|
|
4182
4323
|
### FormActions
|
4183
4324
|
|
4184
|
-
▸ **FormActions**(
|
4325
|
+
▸ **FormActions**(`«destructured»`): `Element`
|
4185
4326
|
|
4186
4327
|
Standard cancel and submit buttons.
|
4187
4328
|
|
@@ -4189,7 +4330,7 @@ Standard cancel and submit buttons.
|
|
4189
4330
|
|
4190
4331
|
| Name | Type |
|
4191
4332
|
| :------ | :------ |
|
4192
|
-
|
|
4333
|
+
| `«destructured»` | [`FormActionsProps`](#interfacesformactionspropsmd) |
|
4193
4334
|
|
4194
4335
|
#### Returns
|
4195
4336
|
|
@@ -4203,7 +4344,7 @@ ___
|
|
4203
4344
|
|
4204
4345
|
### Group
|
4205
4346
|
|
4206
|
-
▸ **Group**(
|
4347
|
+
▸ **Group**(`«destructured»`): `Element`
|
4207
4348
|
|
4208
4349
|
Contains standard field bits like a label, helper text, error scroll target, validation message container, etc.
|
4209
4350
|
|
@@ -4211,7 +4352,7 @@ Contains standard field bits like a label, helper text, error scroll target, val
|
|
4211
4352
|
|
4212
4353
|
| Name | Type |
|
4213
4354
|
| :------ | :------ |
|
4214
|
-
|
|
4355
|
+
| `«destructured»` | [`GroupProps`](#interfacesgrouppropsmd) |
|
4215
4356
|
|
4216
4357
|
#### Returns
|
4217
4358
|
|
@@ -4225,7 +4366,7 @@ ___
|
|
4225
4366
|
|
4226
4367
|
### InputGroup
|
4227
4368
|
|
4228
|
-
▸
|
4369
|
+
▸ **InputGroup**<`TValue`\>(`«destructured»`, `ref`): `Element`
|
4229
4370
|
|
4230
4371
|
Generic controlled `<input/>` wrapped by a `<Group/>`
|
4231
4372
|
|
@@ -4239,7 +4380,7 @@ Generic controlled `<input/>` wrapped by a `<Group/>`
|
|
4239
4380
|
|
4240
4381
|
| Name | Type |
|
4241
4382
|
| :------ | :------ |
|
4242
|
-
|
|
4383
|
+
| `«destructured»` | [`InputGroupProps`](#interfacesinputgrouppropsmd)<`TValue`\> |
|
4243
4384
|
| `ref` | `LegacyRef`<`HTMLInputElement`\> |
|
4244
4385
|
|
4245
4386
|
#### Returns
|
@@ -4248,7 +4389,30 @@ Generic controlled `<input/>` wrapped by a `<Group/>`
|
|
4248
4389
|
|
4249
4390
|
#### Defined in
|
4250
4391
|
|
4251
|
-
packages/envoc-form/src/Input/InputGroup.tsx:
|
4392
|
+
packages/envoc-form/src/Input/InputGroup.tsx:23
|
4393
|
+
|
4394
|
+
___
|
4395
|
+
|
4396
|
+
### MoneyInputGroup
|
4397
|
+
|
4398
|
+
▸ **MoneyInputGroup**(`props`, `context?`): `ReactNode`
|
4399
|
+
|
4400
|
+
Input group for inputting money.
|
4401
|
+
|
4402
|
+
#### Parameters
|
4403
|
+
|
4404
|
+
| Name | Type |
|
4405
|
+
| :------ | :------ |
|
4406
|
+
| `props` | [`MoneyInputGroupProps`](#interfacesmoneyinputgrouppropsmd) |
|
4407
|
+
| `context?` | `any` |
|
4408
|
+
|
4409
|
+
#### Returns
|
4410
|
+
|
4411
|
+
`ReactNode`
|
4412
|
+
|
4413
|
+
#### Defined in
|
4414
|
+
|
4415
|
+
common/temp/node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/index.d.ts:556
|
4252
4416
|
|
4253
4417
|
___
|
4254
4418
|
|
@@ -4298,7 +4462,7 @@ ___
|
|
4298
4462
|
|
4299
4463
|
### SelectGroup
|
4300
4464
|
|
4301
|
-
▸ **SelectGroup**<`TValue`\>(
|
4465
|
+
▸ **SelectGroup**<`TValue`\>(`«destructured»`): `Element`
|
4302
4466
|
|
4303
4467
|
Generic select dropdown. Uses [react-select](https://react-select.com/home).
|
4304
4468
|
|
@@ -4312,7 +4476,7 @@ Generic select dropdown. Uses [react-select](https://react-select.com/home).
|
|
4312
4476
|
|
4313
4477
|
| Name | Type |
|
4314
4478
|
| :------ | :------ |
|
4315
|
-
|
|
4479
|
+
| `«destructured»` | [`SelectGroupProps`](#interfacesselectgrouppropsmd)<`TValue`\> |
|
4316
4480
|
|
4317
4481
|
#### Returns
|
4318
4482
|
|
@@ -4379,7 +4543,7 @@ The stand alone version of `<Field/>`. Can use a type of input component outside
|
|
4379
4543
|
| Name | Type |
|
4380
4544
|
| :------ | :------ |
|
4381
4545
|
| `TValue` | `TValue` |
|
4382
|
-
| `TComponent` | extends `ElementType
|
4546
|
+
| `TComponent` | extends `ElementType` |
|
4383
4547
|
|
4384
4548
|
#### Parameters
|
4385
4549
|
|
@@ -4399,7 +4563,7 @@ ___
|
|
4399
4563
|
|
4400
4564
|
### StandardFormActions
|
4401
4565
|
|
4402
|
-
▸ **StandardFormActions**(
|
4566
|
+
▸ **StandardFormActions**(`«destructured»`): `Element`
|
4403
4567
|
|
4404
4568
|
Standard submit and cancel buttons.
|
4405
4569
|
|
@@ -4407,7 +4571,7 @@ Standard submit and cancel buttons.
|
|
4407
4571
|
|
4408
4572
|
| Name | Type |
|
4409
4573
|
| :------ | :------ |
|
4410
|
-
|
|
4574
|
+
| `«destructured»` | [`StandardFormActionsProps`](#interfacesstandardformactionspropsmd) |
|
4411
4575
|
|
4412
4576
|
#### Returns
|
4413
4577
|
|
@@ -4467,6 +4631,29 @@ packages/envoc-form/src/DatePicker/StringDatePickerGroup.tsx:12
|
|
4467
4631
|
|
4468
4632
|
___
|
4469
4633
|
|
4634
|
+
### SubmitFormButton
|
4635
|
+
|
4636
|
+
▸ **SubmitFormButton**(`props`, `context?`): `ReactNode`
|
4637
|
+
|
4638
|
+
Generic submit button for forms.
|
4639
|
+
|
4640
|
+
#### Parameters
|
4641
|
+
|
4642
|
+
| Name | Type |
|
4643
|
+
| :------ | :------ |
|
4644
|
+
| `props` | [`SubmitFormButtonProps`](#interfacessubmitformbuttonpropsmd) |
|
4645
|
+
| `context?` | `any` |
|
4646
|
+
|
4647
|
+
#### Returns
|
4648
|
+
|
4649
|
+
`ReactNode`
|
4650
|
+
|
4651
|
+
#### Defined in
|
4652
|
+
|
4653
|
+
common/temp/node_modules/.pnpm/@types+react@18.2.14/node_modules/@types/react/index.d.ts:556
|
4654
|
+
|
4655
|
+
___
|
4656
|
+
|
4470
4657
|
### convertToTimeZoneInsensitiveISOString
|
4471
4658
|
|
4472
4659
|
▸ **convertToTimeZoneInsensitiveISOString**(`date`): `string`
|
@@ -4489,7 +4676,7 @@ ___
|
|
4489
4676
|
|
4490
4677
|
### isArray
|
4491
4678
|
|
4492
|
-
▸
|
4679
|
+
▸ **isArray**(`value`): `boolean`
|
4493
4680
|
|
4494
4681
|
#### Parameters
|
4495
4682
|
|
@@ -4509,7 +4696,7 @@ ___
|
|
4509
4696
|
|
4510
4697
|
### isBlob
|
4511
4698
|
|
4512
|
-
▸
|
4699
|
+
▸ **isBlob**(`value`): `any`
|
4513
4700
|
|
4514
4701
|
#### Parameters
|
4515
4702
|
|
@@ -4529,7 +4716,7 @@ ___
|
|
4529
4716
|
|
4530
4717
|
### isBoolean
|
4531
4718
|
|
4532
|
-
▸
|
4719
|
+
▸ **isBoolean**(`value`): `boolean`
|
4533
4720
|
|
4534
4721
|
#### Parameters
|
4535
4722
|
|
@@ -4549,7 +4736,7 @@ ___
|
|
4549
4736
|
|
4550
4737
|
### isDate
|
4551
4738
|
|
4552
|
-
▸
|
4739
|
+
▸ **isDate**(`value`): `boolean`
|
4553
4740
|
|
4554
4741
|
#### Parameters
|
4555
4742
|
|
@@ -4569,7 +4756,7 @@ ___
|
|
4569
4756
|
|
4570
4757
|
### isFile
|
4571
4758
|
|
4572
|
-
▸
|
4759
|
+
▸ **isFile**(`value`): `any`
|
4573
4760
|
|
4574
4761
|
#### Parameters
|
4575
4762
|
|
@@ -4589,7 +4776,7 @@ ___
|
|
4589
4776
|
|
4590
4777
|
### isNull
|
4591
4778
|
|
4592
|
-
▸
|
4779
|
+
▸ **isNull**(`value`): `boolean`
|
4593
4780
|
|
4594
4781
|
#### Parameters
|
4595
4782
|
|
@@ -4609,7 +4796,7 @@ ___
|
|
4609
4796
|
|
4610
4797
|
### isObject
|
4611
4798
|
|
4612
|
-
▸
|
4799
|
+
▸ **isObject**(`value`): `boolean`
|
4613
4800
|
|
4614
4801
|
#### Parameters
|
4615
4802
|
|
@@ -4629,7 +4816,7 @@ ___
|
|
4629
4816
|
|
4630
4817
|
### isUndefined
|
4631
4818
|
|
4632
|
-
▸
|
4819
|
+
▸ **isUndefined**(`value`): `boolean`
|
4633
4820
|
|
4634
4821
|
#### Parameters
|
4635
4822
|
|
@@ -4669,7 +4856,7 @@ ___
|
|
4669
4856
|
|
4670
4857
|
### serialize
|
4671
4858
|
|
4672
|
-
▸
|
4859
|
+
▸ **serialize**(`obj`, `cfg`, `fd?`, `pre?`): `FormData`
|
4673
4860
|
|
4674
4861
|
#### Parameters
|
4675
4862
|
|
@@ -4692,7 +4879,7 @@ ___
|
|
4692
4879
|
|
4693
4880
|
### useStandardField
|
4694
4881
|
|
4695
|
-
▸ **useStandardField**<`TValue`\>(
|
4882
|
+
▸ **useStandardField**<`TValue`\>(`«destructured»`): [`CustomFieldInputProps`<`TValue`\>, `CustomFieldMetaProps`<`TValue`\>]
|
4696
4883
|
|
4697
4884
|
Provides a consistent way to deal with all form fields (non array).
|
4698
4885
|
|
@@ -4706,7 +4893,7 @@ Provides a consistent way to deal with all form fields (non array).
|
|
4706
4893
|
|
4707
4894
|
| Name | Type |
|
4708
4895
|
| :------ | :------ |
|
4709
|
-
|
|
4896
|
+
| `«destructured»` | [`useStandardFieldProps`](#interfacesusestandardfieldpropsmd)<`TValue`\> |
|
4710
4897
|
|
4711
4898
|
#### Returns
|
4712
4899
|
|
@@ -4745,6 +4932,10 @@ packages/envoc-form/src/Field/useStandardField.ts:24
|
|
4745
4932
|
|
4746
4933
|
`Element`
|
4747
4934
|
|
4935
|
+
##### Defined in
|
4936
|
+
|
4937
|
+
packages/envoc-form/src/Form/Form.tsx:214
|
4938
|
+
|
4748
4939
|
|
4749
4940
|
<a name="modulesnormalizersmd"></a>
|
4750
4941
|
|
@@ -4763,7 +4954,7 @@ packages/envoc-form/src/Field/useStandardField.ts:24
|
|
4763
4954
|
|
4764
4955
|
#### phoneNumber
|
4765
4956
|
|
4766
|
-
▸
|
4957
|
+
▸ **phoneNumber**(`value`): `undefined` \| `string`
|
4767
4958
|
|
4768
4959
|
Normalizer for converting a string into a valid phone number.
|
4769
4960
|
|
@@ -4785,7 +4976,7 @@ ___
|
|
4785
4976
|
|
4786
4977
|
#### zipCode
|
4787
4978
|
|
4788
|
-
▸
|
4979
|
+
▸ **zipCode**(`value`): `undefined` \| `string`
|
4789
4980
|
|
4790
4981
|
Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format.
|
4791
4982
|
|
@@ -4829,7 +5020,7 @@ packages/envoc-form/src/Normalization/normalizers.ts:35
|
|
4829
5020
|
|
4830
5021
|
#### any
|
4831
5022
|
|
4832
|
-
▸
|
5023
|
+
▸ **any**<`TValue`\>(`validatorList`): (`value`: `TValue`) => `undefined` \| `string`
|
4833
5024
|
|
4834
5025
|
One of the validators provided must be true.
|
4835
5026
|
|
@@ -4863,13 +5054,13 @@ One of the validators provided must be true.
|
|
4863
5054
|
|
4864
5055
|
##### Defined in
|
4865
5056
|
|
4866
|
-
packages/envoc-form/src/Validation/validators.ts:
|
5057
|
+
packages/envoc-form/src/Validation/validators.ts:66
|
4867
5058
|
|
4868
5059
|
___
|
4869
5060
|
|
4870
5061
|
#### integer
|
4871
5062
|
|
4872
|
-
▸
|
5063
|
+
▸ **integer**(`val`): `undefined` \| ``"Must be a whole number"``
|
4873
5064
|
|
4874
5065
|
##### Parameters
|
4875
5066
|
|
@@ -4889,7 +5080,7 @@ ___
|
|
4889
5080
|
|
4890
5081
|
#### length
|
4891
5082
|
|
4892
|
-
▸
|
5083
|
+
▸ **length**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string`
|
4893
5084
|
|
4894
5085
|
Asserts that the value is a certain number of characters. numbers are coerced to a string
|
4895
5086
|
|
@@ -4917,13 +5108,13 @@ Asserts that the value is a certain number of characters. numbers are coerced to
|
|
4917
5108
|
|
4918
5109
|
##### Defined in
|
4919
5110
|
|
4920
|
-
packages/envoc-form/src/Validation/validators.ts:
|
5111
|
+
packages/envoc-form/src/Validation/validators.ts:14
|
4921
5112
|
|
4922
5113
|
___
|
4923
5114
|
|
4924
5115
|
#### maxCount
|
4925
5116
|
|
4926
|
-
▸
|
5117
|
+
▸ **maxCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string`
|
4927
5118
|
|
4928
5119
|
##### Parameters
|
4929
5120
|
|
@@ -4949,13 +5140,13 @@ ___
|
|
4949
5140
|
|
4950
5141
|
##### Defined in
|
4951
5142
|
|
4952
|
-
packages/envoc-form/src/Validation/validators.ts:
|
5143
|
+
packages/envoc-form/src/Validation/validators.ts:35
|
4953
5144
|
|
4954
5145
|
___
|
4955
5146
|
|
4956
5147
|
#### maxLength
|
4957
5148
|
|
4958
|
-
▸
|
5149
|
+
▸ **maxLength**(`len`): (`value`: `undefined` \| ``null`` \| `string` \| `number`) => `undefined` \| `string`
|
4959
5150
|
|
4960
5151
|
##### Parameters
|
4961
5152
|
|
@@ -4981,13 +5172,13 @@ ___
|
|
4981
5172
|
|
4982
5173
|
##### Defined in
|
4983
5174
|
|
4984
|
-
packages/envoc-form/src/Validation/validators.ts:
|
5175
|
+
packages/envoc-form/src/Validation/validators.ts:29
|
4985
5176
|
|
4986
5177
|
___
|
4987
5178
|
|
4988
5179
|
#### maxValue
|
4989
5180
|
|
4990
|
-
▸
|
5181
|
+
▸ **maxValue**(`max`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string`
|
4991
5182
|
|
4992
5183
|
##### Parameters
|
4993
5184
|
|
@@ -5019,7 +5210,7 @@ ___
|
|
5019
5210
|
|
5020
5211
|
#### minCount
|
5021
5212
|
|
5022
|
-
▸
|
5213
|
+
▸ **minCount**(`count`): (`value`: `undefined` \| ``null`` \| { `isDeleted?`: `boolean` }[]) => `undefined` \| `string`
|
5023
5214
|
|
5024
5215
|
##### Parameters
|
5025
5216
|
|
@@ -5045,13 +5236,13 @@ ___
|
|
5045
5236
|
|
5046
5237
|
##### Defined in
|
5047
5238
|
|
5048
|
-
packages/envoc-form/src/Validation/validators.ts:
|
5239
|
+
packages/envoc-form/src/Validation/validators.ts:42
|
5049
5240
|
|
5050
5241
|
___
|
5051
5242
|
|
5052
5243
|
#### minValue
|
5053
5244
|
|
5054
|
-
▸
|
5245
|
+
▸ **minValue**(`min`): (`value`: `undefined` \| ``null`` \| `number`) => `undefined` \| `string`
|
5055
5246
|
|
5056
5247
|
##### Parameters
|
5057
5248
|
|
@@ -5083,7 +5274,7 @@ ___
|
|
5083
5274
|
|
5084
5275
|
#### required
|
5085
5276
|
|
5086
|
-
▸
|
5277
|
+
▸ **required**(`value`): `undefined` \| ``"Required"``
|
5087
5278
|
|
5088
5279
|
##### Parameters
|
5089
5280
|
|
@@ -5103,7 +5294,7 @@ ___
|
|
5103
5294
|
|
5104
5295
|
#### zipCode
|
5105
5296
|
|
5106
|
-
▸
|
5297
|
+
▸ **zipCode**(`value`): `undefined` \| ``"Invalid ZIP Code"``
|
5107
5298
|
|
5108
5299
|
Validate for a ZIP Code. Accepts formats: ##### and #####-####
|
5109
5300
|
|