react-hook-form 7.44.0-next.1 → 7.44.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (166) hide show
  1. package/README.md +14 -32
  2. package/dist/__tests__/controller.server.test.d.ts +1 -1
  3. package/dist/__tests__/controller.test.d.ts +1 -1
  4. package/dist/__tests__/form.test.d.ts +1 -1
  5. package/dist/__tests__/logic/validateField.test.d.ts +1 -1
  6. package/dist/__tests__/type.test.d.ts +1 -1
  7. package/dist/__tests__/useController.test.d.ts +1 -1
  8. package/dist/__tests__/useFieldArray/append.test.d.ts +1 -1
  9. package/dist/__tests__/useFieldArray/focus.test.d.ts +1 -1
  10. package/dist/__tests__/useFieldArray/insert.test.d.ts +1 -1
  11. package/dist/__tests__/useFieldArray/move.test.d.ts +1 -1
  12. package/dist/__tests__/useFieldArray/prepend.test.d.ts +1 -1
  13. package/dist/__tests__/useFieldArray/remove.test.d.ts +1 -1
  14. package/dist/__tests__/useFieldArray/replace.test.d.ts +1 -1
  15. package/dist/__tests__/useFieldArray/swap.test.d.ts +1 -1
  16. package/dist/__tests__/useFieldArray/update.test.d.ts +1 -1
  17. package/dist/__tests__/useFieldArray.test.d.ts +1 -1
  18. package/dist/__tests__/useForm/clearErrors.test.d.ts +1 -1
  19. package/dist/__tests__/useForm/formState.test.d.ts +1 -1
  20. package/dist/__tests__/useForm/getFieldState.test.d.ts +1 -1
  21. package/dist/__tests__/useForm/getValues.test.d.ts +1 -1
  22. package/dist/__tests__/useForm/handleSubmit.test.d.ts +1 -1
  23. package/dist/__tests__/useForm/register.test.d.ts +1 -1
  24. package/dist/__tests__/useForm/reset.test.d.ts +1 -1
  25. package/dist/__tests__/useForm/resetField.test.d.ts +1 -1
  26. package/dist/__tests__/useForm/resolver.test.d.ts +1 -1
  27. package/dist/__tests__/useForm/setError.test.d.ts +1 -1
  28. package/dist/__tests__/useForm/setValue.test.d.ts +1 -1
  29. package/dist/__tests__/useForm/trigger.test.d.ts +1 -1
  30. package/dist/__tests__/useForm/unregister.test.d.ts +1 -1
  31. package/dist/__tests__/useForm/watch.test.d.ts +1 -1
  32. package/dist/__tests__/useForm.server.test.d.ts +1 -1
  33. package/dist/__tests__/useForm.test.d.ts +1 -1
  34. package/dist/__tests__/useFormContext.server.test.d.ts +1 -1
  35. package/dist/__tests__/useFormContext.test.d.ts +1 -1
  36. package/dist/__tests__/useFormState.test.d.ts +1 -1
  37. package/dist/__tests__/useWatch.test.d.ts +1 -1
  38. package/dist/__typetest__/__fixtures__/index.d.ts +4 -4
  39. package/dist/__typetest__/__fixtures__/pathString.d.ts +3 -3
  40. package/dist/__typetest__/__fixtures__/traversable.d.ts +13 -13
  41. package/dist/__typetest__/__fixtures__/tuple.d.ts +14 -14
  42. package/dist/__typetest__/__fixtures__/type.d.ts +11 -11
  43. package/dist/__typetest__/errors.test-d.d.ts +1 -1
  44. package/dist/__typetest__/form.test-d.d.ts +1 -1
  45. package/dist/__typetest__/path/common.test-d.d.ts +1 -1
  46. package/dist/__typetest__/path/eager.test-d.d.ts +1 -1
  47. package/dist/__typetest__/util.test-d.d.ts +1 -1
  48. package/dist/constants.d.ts +16 -16
  49. package/dist/controller.d.ts +46 -46
  50. package/dist/controller.d.ts.map +1 -1
  51. package/dist/form.d.ts +59 -57
  52. package/dist/form.d.ts.map +1 -1
  53. package/dist/index.cjs.js +1 -1
  54. package/dist/index.cjs.js.map +1 -1
  55. package/dist/index.d.ts +11 -11
  56. package/dist/index.esm.mjs +2276 -2264
  57. package/dist/index.esm.mjs.map +1 -1
  58. package/dist/index.umd.js +1 -1
  59. package/dist/index.umd.js.map +1 -1
  60. package/dist/logic/appendErrors.d.ts +3 -3
  61. package/dist/logic/createFormControl.d.ts +26 -26
  62. package/dist/logic/createFormControl.d.ts.map +1 -1
  63. package/dist/logic/focusFieldBy.d.ts +3 -3
  64. package/dist/logic/generateId.d.ts +2 -2
  65. package/dist/logic/generateWatchOutput.d.ts +3 -3
  66. package/dist/logic/getCheckboxValue.d.ts +6 -6
  67. package/dist/logic/getDirtyFields.d.ts +2 -2
  68. package/dist/logic/getDirtyFields.d.ts.map +1 -1
  69. package/dist/logic/getEventValue.d.ts +2 -2
  70. package/dist/logic/getFieldValue.d.ts +2 -2
  71. package/dist/logic/getFieldValueAs.d.ts +3 -3
  72. package/dist/logic/getFocusFieldName.d.ts +3 -3
  73. package/dist/logic/getNodeParentName.d.ts +2 -2
  74. package/dist/logic/getProxyFormState.d.ts +3 -3
  75. package/dist/logic/getRadioValue.d.ts +6 -6
  76. package/dist/logic/getResolverOptions.d.ts +13 -13
  77. package/dist/logic/getRuleValue.d.ts +3 -3
  78. package/dist/logic/getValidateError.d.ts +2 -2
  79. package/dist/logic/getValidationModes.d.ts +9 -9
  80. package/dist/logic/getValueAndMessage.d.ts +6 -6
  81. package/dist/logic/hasValidation.d.ts +3 -3
  82. package/dist/logic/index.d.ts +2 -2
  83. package/dist/logic/isNameInFieldArray.d.ts +3 -3
  84. package/dist/logic/isWatched.d.ts +3 -3
  85. package/dist/logic/schemaErrorLookup.d.ts +5 -5
  86. package/dist/logic/shouldRenderFormState.d.ts +5 -5
  87. package/dist/logic/shouldSubscribeByName.d.ts +2 -2
  88. package/dist/logic/skipValidation.d.ts +11 -11
  89. package/dist/logic/unsetEmptyArray.d.ts +2 -2
  90. package/dist/logic/updateFieldArrayRootError.d.ts +3 -3
  91. package/dist/logic/validateField.d.ts +3 -3
  92. package/dist/types/controller.d.ts +56 -56
  93. package/dist/types/errors.d.ts +35 -35
  94. package/dist/types/events.d.ts +1 -1
  95. package/dist/types/fieldArray.d.ts +194 -194
  96. package/dist/types/fields.d.ts +28 -28
  97. package/dist/types/form.d.ts +631 -631
  98. package/dist/types/form.d.ts.map +1 -1
  99. package/dist/types/index.d.ts +10 -10
  100. package/dist/types/path/common.d.ts +315 -315
  101. package/dist/types/path/eager.d.ts +120 -120
  102. package/dist/types/path/index.d.ts +3 -3
  103. package/dist/types/resolvers.d.ts +19 -19
  104. package/dist/types/utils.d.ts +70 -70
  105. package/dist/types/validator.d.ts +38 -38
  106. package/dist/types/validator.d.ts.map +1 -1
  107. package/dist/useController.d.ts +26 -26
  108. package/dist/useController.d.ts.map +1 -1
  109. package/dist/useFieldArray.d.ts +39 -39
  110. package/dist/useFieldArray.d.ts.map +1 -1
  111. package/dist/useForm.d.ts +31 -31
  112. package/dist/useForm.d.ts.map +1 -1
  113. package/dist/useFormContext.d.ts +64 -64
  114. package/dist/useFormContext.d.ts.map +1 -1
  115. package/dist/useFormState.d.ts +33 -33
  116. package/dist/useFormState.d.ts.map +1 -1
  117. package/dist/useSubscribe.d.ts +8 -8
  118. package/dist/useSubscribe.d.ts.map +1 -1
  119. package/dist/useWatch.d.ts +99 -99
  120. package/dist/utils/append.d.ts +1 -1
  121. package/dist/utils/cloneObject.d.ts +1 -1
  122. package/dist/utils/compact.d.ts +2 -2
  123. package/dist/utils/convertToArrayPayload.d.ts +2 -2
  124. package/dist/utils/createSubject.d.ts +13 -13
  125. package/dist/utils/deepEqual.d.ts +1 -1
  126. package/dist/utils/deepMerge.d.ts +1 -1
  127. package/dist/utils/fillBooleanArray.d.ts +2 -2
  128. package/dist/utils/fillEmptyArray.d.ts +2 -2
  129. package/dist/utils/get.d.ts +2 -2
  130. package/dist/utils/get.d.ts.map +1 -1
  131. package/dist/utils/index.d.ts +3 -3
  132. package/dist/utils/insert.d.ts +2 -2
  133. package/dist/utils/isBoolean.d.ts +2 -2
  134. package/dist/utils/isCheckBoxInput.d.ts +3 -3
  135. package/dist/utils/isDateObject.d.ts +2 -2
  136. package/dist/utils/isEmptyObject.d.ts +3 -3
  137. package/dist/utils/isFileInput.d.ts +3 -3
  138. package/dist/utils/isFunction.d.ts +2 -2
  139. package/dist/utils/isHTMLElement.d.ts +2 -2
  140. package/dist/utils/isKey.d.ts +2 -2
  141. package/dist/utils/isMessage.d.ts +2 -2
  142. package/dist/utils/isMultipleSelect.d.ts +3 -3
  143. package/dist/utils/isNullOrUndefined.d.ts +2 -2
  144. package/dist/utils/isObject.d.ts +3 -3
  145. package/dist/utils/isPlainObject.d.ts +2 -2
  146. package/dist/utils/isPrimitive.d.ts +3 -3
  147. package/dist/utils/isRadioInput.d.ts +3 -3
  148. package/dist/utils/isRadioOrCheckbox.d.ts +3 -3
  149. package/dist/utils/isRegex.d.ts +2 -2
  150. package/dist/utils/isSelectInput.d.ts +3 -3
  151. package/dist/utils/isString.d.ts +2 -2
  152. package/dist/utils/isUndefined.d.ts +2 -2
  153. package/dist/utils/isWeb.d.ts +2 -2
  154. package/dist/utils/live.d.ts +3 -3
  155. package/dist/utils/move.d.ts +2 -2
  156. package/dist/utils/objectHasFunction.d.ts +2 -2
  157. package/dist/utils/omit.d.ts +2 -2
  158. package/dist/utils/prepend.d.ts +1 -1
  159. package/dist/utils/remove.d.ts +2 -2
  160. package/dist/utils/set.d.ts +2 -2
  161. package/dist/utils/sleep.d.ts +1 -1
  162. package/dist/utils/stringToPath.d.ts +2 -2
  163. package/dist/utils/swap.d.ts +2 -2
  164. package/dist/utils/unset.d.ts +1 -1
  165. package/dist/utils/update.d.ts +2 -2
  166. package/package.json +9 -10
package/README.md CHANGED
@@ -66,41 +66,23 @@ function App() {
66
66
 
67
67
  Thanks go to these kind and lovely sponsors!
68
68
 
69
- <a
70
- target = _blank
71
- href = 'https://wantedlyinc.com'
72
- />
73
- <img
74
- width = 94
75
- src = 'https://images.opencollective.com/wantedly/d94e44e/logo/256.png'
76
- />
69
+ <a target="_blank" href='https://wantedlyinc.com'>
70
+ <img width="94" src="https://images.opencollective.com/wantedly/d94e44e/logo/256.png" />
77
71
  </a>
78
- <a
79
- target = _blank
80
- href = 'https://graphcms.com'
81
- />
82
- <img
83
- width = 94
84
- src = 'https://avatars.githubusercontent.com/u/31031438'
85
- />
72
+ <a target="_blank" href='https://toss.im'>
73
+ <img width="94" src="https://images.opencollective.com/toss/3ed69b3/logo/256.png" />
86
74
  </a>
87
- <a
88
- target = _blank
89
- href = 'https://kanamekey.com'
90
- />
91
- <img
92
- width = 94
93
- src = 'https://images.opencollective.com/kaname/d15fd98/logo/256.png'
94
- />
75
+ <a target="_blank" href="https://graphcms.com">
76
+ <img width="94" src="https://avatars.githubusercontent.com/u/31031438" />
95
77
  </a>
96
- <a
97
- target = _blank
98
- href = 'https://formcarry.com/'
99
- />
100
- <img
101
- width = 94
102
- src = 'https://images.opencollective.com/formcarry/a40a4ea/logo/256.png'
103
- />
78
+ <a target="_blank" href="https://www.beekai.com/">
79
+ <img width="94" src="https://www.beekai.com/marketing/logo/logo.svg" />
80
+ </a>
81
+ <a target="_blank" href="https://kanamekey.com">
82
+ <img width="94" src="https://images.opencollective.com/kaname/d15fd98/logo/256.png" />
83
+ </a>
84
+ <a target="_blank" href="https://formcarry.com/">
85
+ <img width="94" src="https://images.opencollective.com/formcarry/a40a4ea/logo/256.png" />
104
86
  </a>
105
87
 
106
88
  ### Backers
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=controller.server.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=controller.test.d.ts.map
@@ -1,2 +1,2 @@
1
- import 'whatwg-fetch';
1
+ import 'whatwg-fetch';
2
2
  //# sourceMappingURL=form.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=validateField.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=type.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useController.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=append.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=focus.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=insert.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=move.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=prepend.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=remove.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=replace.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=swap.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=update.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useFieldArray.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=clearErrors.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=formState.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=getFieldState.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=getValues.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=handleSubmit.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=register.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=reset.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=resetField.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=resolver.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=setError.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=setValue.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=trigger.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=unregister.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=watch.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useForm.server.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useForm.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useFormContext.server.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useFormContext.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useFormState.test.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=useWatch.test.d.ts.map
@@ -1,5 +1,5 @@
1
- export * from './pathString';
2
- export * from './traversable';
3
- export * from './tuple';
4
- export * from './type';
1
+ export * from './pathString';
2
+ export * from './traversable';
3
+ export * from './tuple';
4
+ export * from './type';
5
5
  //# sourceMappingURL=index.d.ts.map
@@ -1,4 +1,4 @@
1
- type ConcatTenTimes<T extends string> = `${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}`;
2
- export type HundredPathString<T extends string> = ConcatTenTimes<ConcatTenTimes<T>>;
3
- export {};
1
+ type ConcatTenTimes<T extends string> = `${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}.${T}`;
2
+ export type HundredPathString<T extends string> = ConcatTenTimes<ConcatTenTimes<T>>;
3
+ export {};
4
4
  //# sourceMappingURL=pathString.d.ts.map
@@ -1,14 +1,14 @@
1
- interface Base<T, V> {
2
- foo: T;
3
- bar: [T];
4
- baz: Array<T>;
5
- value: V;
6
- }
7
- export type InfiniteType<T> = Base<InfiniteType<T>, T>;
8
- export type NullableInfiniteType<T> = null | undefined | Partial<Base<NullableInfiniteType<T>, T>>;
9
- export type Depth3Type<T> = Base<Base<Base<never, T>, T>, T>;
10
- export interface Nested<T> {
11
- nested: T;
12
- }
13
- export {};
1
+ interface Base<T, V> {
2
+ foo: T;
3
+ bar: [T];
4
+ baz: Array<T>;
5
+ value: V;
6
+ }
7
+ export type InfiniteType<T> = Base<InfiniteType<T>, T>;
8
+ export type NullableInfiniteType<T> = null | undefined | Partial<Base<NullableInfiniteType<T>, T>>;
9
+ export type Depth3Type<T> = Base<Base<Base<never, T>, T>, T>;
10
+ export interface Nested<T> {
11
+ nested: T;
12
+ }
13
+ export {};
14
14
  //# sourceMappingURL=traversable.d.ts.map
@@ -1,15 +1,15 @@
1
- type ConcatTupleTenTimes<T extends unknown[]> = [
2
- ...T,
3
- ...T,
4
- ...T,
5
- ...T,
6
- ...T,
7
- ...T,
8
- ...T,
9
- ...T,
10
- ...T,
11
- ...T
12
- ];
13
- export type HundredTuple<T> = ConcatTupleTenTimes<ConcatTupleTenTimes<[T]>>;
14
- export {};
1
+ type ConcatTupleTenTimes<T extends unknown[]> = [
2
+ ...T,
3
+ ...T,
4
+ ...T,
5
+ ...T,
6
+ ...T,
7
+ ...T,
8
+ ...T,
9
+ ...T,
10
+ ...T,
11
+ ...T
12
+ ];
13
+ export type HundredTuple<T> = ConcatTupleTenTimes<ConcatTupleTenTimes<[T]>>;
14
+ export {};
15
15
  //# sourceMappingURL=tuple.d.ts.map
@@ -1,12 +1,12 @@
1
- /**
2
- * tsd expects a value when calling expectType.
3
- * We're mostly dealing with types though. Therefore,
4
- * simply export this const and cast it to the expected type.
5
- * @example
6
- * ```
7
- * type Actual = DropLastElement<[0, 1, 2]>;
8
- * expectType<[0, 1]>(_ as Actual);
9
- * ```
10
- */
11
- export declare const _: never;
1
+ /**
2
+ * tsd expects a value when calling expectType.
3
+ * We're mostly dealing with types though. Therefore,
4
+ * simply export this const and cast it to the expected type.
5
+ * @example
6
+ * ```
7
+ * type Actual = DropLastElement<[0, 1, 2]>;
8
+ * expectType<[0, 1]>(_ as Actual);
9
+ * ```
10
+ */
11
+ export declare const _: never;
12
12
  //# sourceMappingURL=type.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=errors.test-d.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=form.test-d.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=common.test-d.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=eager.test-d.d.ts.map
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=util.test-d.d.ts.map
@@ -1,17 +1,17 @@
1
- import { ValidationMode } from './types';
2
- export declare const EVENTS: {
3
- BLUR: string;
4
- FOCUS_OUT: string;
5
- CHANGE: string;
6
- };
7
- export declare const VALIDATION_MODE: ValidationMode;
8
- export declare const INPUT_VALIDATION_RULES: {
9
- max: string;
10
- min: string;
11
- maxLength: string;
12
- minLength: string;
13
- pattern: string;
14
- required: string;
15
- validate: string;
16
- };
1
+ import { ValidationMode } from './types';
2
+ export declare const EVENTS: {
3
+ BLUR: string;
4
+ FOCUS_OUT: string;
5
+ CHANGE: string;
6
+ };
7
+ export declare const VALIDATION_MODE: ValidationMode;
8
+ export declare const INPUT_VALIDATION_RULES: {
9
+ max: string;
10
+ min: string;
11
+ maxLength: string;
12
+ minLength: string;
13
+ pattern: string;
14
+ required: string;
15
+ validate: string;
16
+ };
17
17
  //# sourceMappingURL=constants.d.ts.map
@@ -1,47 +1,47 @@
1
- /// <reference types="react" />
2
- import { ControllerProps, FieldValues } from './types';
3
- /**
4
- * Component based on `useController` hook to work with controlled component.
5
- *
6
- * @remarks
7
- * [API](https://react-hook-form.com/api/usecontroller/controller) • [Demo](https://codesandbox.io/s/react-hook-form-v6-controller-ts-jwyzw) • [Video](https://www.youtube.com/watch?v=N2UNk_UCVyA)
8
- *
9
- * @param props - the path name to the form field value, and validation rules.
10
- *
11
- * @returns provide field handler functions, field and form state.
12
- *
13
- * @example
14
- * ```tsx
15
- * function App() {
16
- * const { control } = useForm<FormValues>({
17
- * defaultValues: {
18
- * test: ""
19
- * }
20
- * });
21
- *
22
- * return (
23
- * <form>
24
- * <Controller
25
- * control={control}
26
- * name="test"
27
- * render={({ field: { onChange, onBlur, value, ref }, formState, fieldState }) => (
28
- * <>
29
- * <input
30
- * onChange={onChange} // send value to hook form
31
- * onBlur={onBlur} // notify when input is touched
32
- * value={value} // return updated value
33
- * ref={ref} // set ref for focus management
34
- * />
35
- * <p>{formState.isSubmitted ? "submitted" : ""}</p>
36
- * <p>{fieldState.isTouched ? "touched" : ""}</p>
37
- * </>
38
- * )}
39
- * />
40
- * </form>
41
- * );
42
- * }
43
- * ```
44
- */
45
- declare const Controller: <TFieldValues extends FieldValues = FieldValues, TName extends import("./types").Path<TFieldValues> = import("./types").Path<TFieldValues>>(props: ControllerProps<TFieldValues, TName>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
46
- export { Controller };
1
+ /// <reference types="react" />
2
+ import { ControllerProps, FieldPath, FieldValues } from './types';
3
+ /**
4
+ * Component based on `useController` hook to work with controlled component.
5
+ *
6
+ * @remarks
7
+ * [API](https://react-hook-form.com/api/usecontroller/controller) • [Demo](https://codesandbox.io/s/react-hook-form-v6-controller-ts-jwyzw) • [Video](https://www.youtube.com/watch?v=N2UNk_UCVyA)
8
+ *
9
+ * @param props - the path name to the form field value, and validation rules.
10
+ *
11
+ * @returns provide field handler functions, field and form state.
12
+ *
13
+ * @example
14
+ * ```tsx
15
+ * function App() {
16
+ * const { control } = useForm<FormValues>({
17
+ * defaultValues: {
18
+ * test: ""
19
+ * }
20
+ * });
21
+ *
22
+ * return (
23
+ * <form>
24
+ * <Controller
25
+ * control={control}
26
+ * name="test"
27
+ * render={({ field: { onChange, onBlur, value, ref }, formState, fieldState }) => (
28
+ * <>
29
+ * <input
30
+ * onChange={onChange} // send value to hook form
31
+ * onBlur={onBlur} // notify when input is touched
32
+ * value={value} // return updated value
33
+ * ref={ref} // set ref for focus management
34
+ * />
35
+ * <p>{formState.isSubmitted ? "submitted" : ""}</p>
36
+ * <p>{fieldState.isTouched ? "touched" : ""}</p>
37
+ * </>
38
+ * )}
39
+ * />
40
+ * </form>
41
+ * );
42
+ * }
43
+ * ```
44
+ */
45
+ declare const Controller: <TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: ControllerProps<TFieldValues, TName>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
46
+ export { Controller };
47
47
  //# sourceMappingURL=controller.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../src/controller.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAa,WAAW,EAAE,MAAM,SAAS,CAAC;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,QAAA,MAAM,UAAU,oRAK4C,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,CAAC"}
1
+ {"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../src/controller.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,QAAA,MAAM,UAAU,0PAK4C,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,CAAC"}
package/dist/form.d.ts CHANGED
@@ -1,58 +1,60 @@
1
- import * as React from 'react';
2
- import { Control, FieldValues, SubmitHandler } from './types';
3
- export type FormProps<T extends FieldValues, U extends FieldValues | undefined = undefined> = Partial<{
4
- control: Control<T>;
5
- children?: React.ReactNode | React.ReactNode[];
6
- render?: (props: {
7
- submit: (e?: React.FormEvent) => void;
8
- }) => React.ReactNode | React.ReactNode[];
9
- onSubmit: U extends FieldValues ? SubmitHandler<U> : SubmitHandler<T>;
10
- }> & Omit<React.FormHTMLAttributes<HTMLFormElement>, 'onError'> & (Partial<{
11
- onSuccess: ({ response }: {
12
- response: Response;
13
- }) => void;
14
- onError: ({ response, error, }: {
15
- response: Response;
16
- error?: undefined;
17
- } | {
18
- response?: undefined;
19
- error: unknown;
20
- }) => void;
21
- headers: Record<string, string>;
22
- validateStatus: (status: number) => boolean;
23
- fetcher: undefined;
24
- }> | Partial<{
25
- onSuccess: undefined;
26
- onError: undefined;
27
- validateStatus: undefined;
28
- headers: undefined;
29
- fetcher: (action: string, payload: {
30
- values?: T;
31
- method: string;
32
- event?: React.BaseSyntheticEvent;
33
- }) => Promise<void> | void;
34
- }>);
35
- /**
36
- * Form component to manage submission.
37
- *
38
- * @param props - to setup submission detail. {@link FormProps}
39
- *
40
- * @returns form component or headless render prop.
41
- *
42
- * @example
43
- * ```tsx
44
- * function App() {
45
- * const { control, formState: { errors } } = useForm();
46
- *
47
- * return (
48
- * <Form action="/api" control={control}>
49
- * <input {...register("name")} />
50
- * <p>{errors?.root?.server && 'Server error'}</p>
51
- * <button>Submit</button>
52
- * </form>
53
- * );
54
- * }
55
- * ```
56
- */
57
- export declare function Form<T extends FieldValues, U extends FieldValues | undefined = undefined>(props: FormProps<T, U>): JSX.Element;
1
+ import * as React from 'react';
2
+ import { Control, FieldValues, SubmitHandler } from './types';
3
+ export type FormProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues | undefined = undefined> = Partial<{
4
+ control: Control<TFieldValues>;
5
+ children?: React.ReactNode | React.ReactNode[];
6
+ render?: (props: {
7
+ submit: (e?: React.FormEvent) => void;
8
+ }) => React.ReactNode | React.ReactNode[];
9
+ onSubmit: TTransformedValues extends FieldValues ? SubmitHandler<TTransformedValues> : SubmitHandler<TFieldValues>;
10
+ }> & Omit<React.FormHTMLAttributes<HTMLFormElement>, 'onError'> & (Partial<{
11
+ onSuccess: ({ response }: {
12
+ response: Response;
13
+ }) => void;
14
+ onError: ({ response, error, }: {
15
+ response: Response;
16
+ error?: undefined;
17
+ } | {
18
+ response?: undefined;
19
+ error: unknown;
20
+ }) => void;
21
+ headers: Record<string, string>;
22
+ validateStatus: (status: number) => boolean;
23
+ fetcher: undefined;
24
+ }> | Partial<{
25
+ onSuccess: undefined;
26
+ onError: undefined;
27
+ validateStatus: undefined;
28
+ headers: undefined;
29
+ fetcher: (action: string, payload: {
30
+ values?: TFieldValues;
31
+ method: string;
32
+ event?: React.BaseSyntheticEvent;
33
+ formData: FormData;
34
+ formDataJson: string;
35
+ }) => Promise<void> | void;
36
+ }>);
37
+ /**
38
+ * Form component to manage submission.
39
+ *
40
+ * @param props - to setup submission detail. {@link FormProps}
41
+ *
42
+ * @returns form component or headless render prop.
43
+ *
44
+ * @example
45
+ * ```tsx
46
+ * function App() {
47
+ * const { control, formState: { errors } } = useForm();
48
+ *
49
+ * return (
50
+ * <Form action="/api" control={control}>
51
+ * <input {...register("name")} />
52
+ * <p>{errors?.root?.server && 'Server error'}</p>
53
+ * <button>Submit</button>
54
+ * </form>
55
+ * );
56
+ * }
57
+ * ```
58
+ */
59
+ export declare function Form<T extends FieldValues, U extends FieldValues | undefined = undefined>(props: FormProps<T, U>): JSX.Element;
58
60
  //# sourceMappingURL=form.d.ts.map