react-hook-form 7.39.4 → 7.39.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/__typetest__/__fixtures__/pathString.d.ts +2 -2
- package/dist/__typetest__/__fixtures__/pathString.d.ts.map +1 -1
- package/dist/__typetest__/__fixtures__/traversable.d.ts +3 -3
- package/dist/__typetest__/__fixtures__/traversable.d.ts.map +1 -1
- package/dist/__typetest__/__fixtures__/tuple.d.ts +2 -2
- package/dist/__typetest__/__fixtures__/tuple.d.ts.map +1 -1
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.mjs +44 -45
- package/dist/index.esm.mjs.map +1 -1
- package/dist/index.umd.js +1 -1
- package/dist/index.umd.js.map +1 -1
- package/dist/logic/createFormControl.d.ts.map +1 -1
- package/dist/logic/generateWatchOutput.d.ts.map +1 -1
- package/dist/logic/getCheckboxValue.d.ts +1 -1
- package/dist/logic/getCheckboxValue.d.ts.map +1 -1
- package/dist/logic/getRadioValue.d.ts +1 -1
- package/dist/logic/getRadioValue.d.ts.map +1 -1
- package/dist/types/controller.d.ts +5 -5
- package/dist/types/controller.d.ts.map +1 -1
- package/dist/types/errors.d.ts +8 -8
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/events.d.ts +1 -1
- package/dist/types/events.d.ts.map +1 -1
- package/dist/types/fieldArray.d.ts +13 -13
- package/dist/types/fieldArray.d.ts.map +1 -1
- package/dist/types/fields.d.ts +10 -10
- package/dist/types/fields.d.ts.map +1 -1
- package/dist/types/form.d.ts +50 -50
- package/dist/types/form.d.ts.map +1 -1
- package/dist/types/path/common.d.ts +32 -32
- package/dist/types/path/common.d.ts.map +1 -1
- package/dist/types/path/eager.d.ts +11 -11
- package/dist/types/path/eager.d.ts.map +1 -1
- package/dist/types/resolvers.d.ts +4 -4
- package/dist/types/resolvers.d.ts.map +1 -1
- package/dist/types/utils.d.ts +13 -13
- package/dist/types/utils.d.ts.map +1 -1
- package/dist/types/validator.d.ts +6 -6
- package/dist/types/validator.d.ts.map +1 -1
- package/dist/useFormState.d.ts.map +1 -1
- package/dist/useSubscribe.d.ts +1 -1
- package/dist/useSubscribe.d.ts.map +1 -1
- package/dist/utils/createSubject.d.ts +3 -3
- package/dist/utils/createSubject.d.ts.map +1 -1
- package/package.json +2 -2
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"createFormControl.d.ts","sourceRoot":"","sources":["../../src/logic/createFormControl.ts"],"names":[],"mappings":"AACA,OAAO,EAWL,WAAW,EAeX,YAAY,EAIZ,aAAa,EASd,MAAM,UAAU,CAAC;AAiDlB,wBAAgB,iBAAiB,CAC/B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EAEd,KAAK,GAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,CAAM,GAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,
|
1
|
+
{"version":3,"file":"createFormControl.d.ts","sourceRoot":"","sources":["../../src/logic/createFormControl.ts"],"names":[],"mappings":"AACA,OAAO,EAWL,WAAW,EAeX,YAAY,EAIZ,aAAa,EASd,MAAM,UAAU,CAAC;AAiDlB,wBAAgB,iBAAiB,CAC/B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,QAAQ,GAAG,GAAG,EAEd,KAAK,GAAE,YAAY,CAAC,YAAY,EAAE,QAAQ,CAAM,GAC/C,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,CA8rC1D"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"generateWatchOutput.d.ts","sourceRoot":"","sources":["../../src/logic/generateWatchOutput.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,
|
1
|
+
{"version":3,"file":"generateWatchOutput.d.ts","sourceRoot":"","sources":["../../src/logic/generateWatchOutput.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;gCAKrC,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,UAC5B,KAAK,eACA,WAAW,aACb,OAAO;AAJpB,wBAsBE"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"getCheckboxValue.d.ts","sourceRoot":"","sources":["../../src/logic/getCheckboxValue.ts"],"names":[],"mappings":"AAEA,
|
1
|
+
{"version":3,"file":"getCheckboxValue.d.ts","sourceRoot":"","sources":["../../src/logic/getCheckboxValue.ts"],"names":[],"mappings":"AAEA,KAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,GAAG,SAAS,CAAC;CAChD,CAAC;mCASwB,gBAAgB,EAAE,KAAG,mBAAmB;AAAlE,wBAoBE"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"getRadioValue.d.ts","sourceRoot":"","sources":["../../src/logic/getRadioValue.ts"],"names":[],"mappings":"AAAA,
|
1
|
+
{"version":3,"file":"getRadioValue.d.ts","sourceRoot":"","sources":["../../src/logic/getRadioValue.ts"],"names":[],"mappings":"AAAA,KAAK,gBAAgB,GAAG;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;mCAOwB,gBAAgB,EAAE,KAAG,gBAAgB;AAA/D,wBAYoB"}
|
@@ -1,7 +1,7 @@
|
|
1
1
|
import React from 'react';
|
2
2
|
import { RegisterOptions } from './validator';
|
3
3
|
import { Control, FieldError, FieldPath, FieldPathValue, FieldValues, Noop, RefCallBack, UseFormStateReturn } from './';
|
4
|
-
export
|
4
|
+
export type ControllerFieldState = {
|
5
5
|
/**
|
6
6
|
* @deprecated check `fieldState.error` instead
|
7
7
|
* ```jsx
|
@@ -13,21 +13,21 @@ export declare type ControllerFieldState = {
|
|
13
13
|
isDirty: boolean;
|
14
14
|
error?: FieldError;
|
15
15
|
};
|
16
|
-
export
|
16
|
+
export type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
17
17
|
onChange: (...event: any[]) => void;
|
18
18
|
onBlur: Noop;
|
19
19
|
value: FieldPathValue<TFieldValues, TName>;
|
20
20
|
name: TName;
|
21
21
|
ref: RefCallBack;
|
22
22
|
};
|
23
|
-
export
|
23
|
+
export type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
24
24
|
name: TName;
|
25
25
|
rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'disabled'>;
|
26
26
|
shouldUnregister?: boolean;
|
27
27
|
defaultValue?: FieldPathValue<TFieldValues, TName>;
|
28
28
|
control?: Control<TFieldValues>;
|
29
29
|
};
|
30
|
-
export
|
30
|
+
export type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
31
31
|
field: ControllerRenderProps<TFieldValues, TName>;
|
32
32
|
formState: UseFormStateReturn<TFieldValues>;
|
33
33
|
fieldState: ControllerFieldState;
|
@@ -53,7 +53,7 @@ export declare type UseControllerReturn<TFieldValues extends FieldValues = Field
|
|
53
53
|
* />
|
54
54
|
* ```
|
55
55
|
*/
|
56
|
-
export
|
56
|
+
export type ControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
|
57
57
|
render: ({ field, fieldState, formState, }: {
|
58
58
|
field: ControllerRenderProps<TFieldValues, TName>;
|
59
59
|
fieldState: ControllerFieldState;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/types/controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,UAAU,EACV,SAAS,EACT,cAAc,EACd,WAAW,EACX,IAAI,EACJ,WAAW,EACX,kBAAkB,EACnB,MAAM,IAAI,CAAC;AAEZ,
|
1
|
+
{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/types/controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EACL,OAAO,EACP,UAAU,EACV,SAAS,EACT,cAAc,EACd,WAAW,EACX,IAAI,EACJ,WAAW,EACX,kBAAkB,EACnB,MAAM,IAAI,CAAC;AAEZ,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAC/B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,KAAK,SAAS,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAC7D;IACF,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IACpC,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC3C,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,WAAW,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,KAAK,SAAS,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAC7D;IACF,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,CAAC,EAAE,IAAI,CACV,eAAe,CAAC,YAAY,EAAE,KAAK,CAAC,EACpC,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,UAAU,CAC5D,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,YAAY,CAAC,EAAE,cAAc,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,KAAK,SAAS,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAC7D;IACF,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAClD,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAC5C,UAAU,EAAE,oBAAoB,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,eAAe,CACzB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,KAAK,SAAS,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,YAAY,CAAC,IAC7D;IACF,MAAM,EAAE,CAAC,EACP,KAAK,EACL,UAAU,EACV,SAAS,GACV,EAAE;QACD,KAAK,EAAE,qBAAqB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAClD,UAAU,EAAE,oBAAoB,CAAC;QACjC,SAAS,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC7C,KAAK,KAAK,CAAC,YAAY,CAAC;CAC1B,GAAG,kBAAkB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC"}
|
package/dist/types/errors.d.ts
CHANGED
@@ -1,30 +1,30 @@
|
|
1
1
|
import { FieldValues, InternalFieldName, Ref } from './fields';
|
2
2
|
import { BrowserNativeObject, IsAny, LiteralUnion, Merge } from './utils';
|
3
3
|
import { RegisterOptions, ValidateResult } from './validator';
|
4
|
-
export
|
5
|
-
export
|
4
|
+
export type Message = string;
|
5
|
+
export type MultipleFieldErrors = {
|
6
6
|
[K in keyof RegisterOptions]?: ValidateResult;
|
7
7
|
} & {
|
8
8
|
[key: string]: ValidateResult;
|
9
9
|
};
|
10
|
-
export
|
10
|
+
export type FieldError = {
|
11
11
|
type: LiteralUnion<keyof RegisterOptions, string>;
|
12
12
|
root?: FieldError;
|
13
13
|
ref?: Ref;
|
14
14
|
types?: MultipleFieldErrors;
|
15
15
|
message?: Message;
|
16
16
|
};
|
17
|
-
export
|
17
|
+
export type ErrorOption = {
|
18
18
|
message?: Message;
|
19
19
|
type?: LiteralUnion<keyof RegisterOptions, string>;
|
20
20
|
types?: MultipleFieldErrors;
|
21
21
|
};
|
22
|
-
export
|
22
|
+
export type DeepRequired<T> = T extends BrowserNativeObject | Blob ? T : {
|
23
23
|
[K in keyof T]-?: NonNullable<DeepRequired<T[K]>>;
|
24
24
|
};
|
25
|
-
export
|
25
|
+
export type FieldErrorsImpl<T extends FieldValues = FieldValues> = {
|
26
26
|
[K in keyof T]?: T[K] extends BrowserNativeObject | Blob ? FieldError : T[K] extends object ? Merge<FieldError, FieldErrorsImpl<T[K]>> : FieldError;
|
27
27
|
};
|
28
|
-
export
|
29
|
-
export
|
28
|
+
export type FieldErrors<T extends FieldValues = FieldValues> = Partial<FieldValues extends IsAny<FieldValues> ? any : FieldErrorsImpl<DeepRequired<T>>>;
|
29
|
+
export type InternalFieldErrors = Partial<Record<InternalFieldName, FieldError>>;
|
30
30
|
//# sourceMappingURL=errors.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE9D,
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE9D,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,eAAe,CAAC,CAAC,EAAE,cAAc;CAC9C,GAAG;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,YAAY,CAAC,MAAM,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,mBAAmB,GAAG,IAAI,GAC9D,CAAC,GACD;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClD,CAAC;AAEN,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI;KAChE,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,mBAAmB,GAAG,IAAI,GACpD,UAAU,GACV,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACnB,KAAK,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACxC,UAAU;CACf,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,IAAI,OAAO,CACpE,WAAW,SAAS,KAAK,CAAC,WAAW,CAAC,GAClC,GAAG,GACH,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CACrC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,OAAO,CACvC,MAAM,CAAC,iBAAiB,EAAE,UAAU,CAAC,CACtC,CAAC"}
|
package/dist/types/events.d.ts
CHANGED
@@ -1,2 +1,2 @@
|
|
1
|
-
export
|
1
|
+
export type EventType = 'focus' | 'blur' | 'change' | 'changeText' | 'valueChange' | 'contentSizeChange' | 'endEditing' | 'keyPress' | 'submitEditing' | 'layout' | 'selectionChange' | 'longPress' | 'press' | 'pressIn' | 'pressOut' | 'momentumScrollBegin' | 'momentumScrollEnd' | 'scroll' | 'scrollBeginDrag' | 'scrollEndDrag' | 'load' | 'error' | 'progress' | 'custom';
|
2
2
|
//# sourceMappingURL=events.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB,OAAO,GACP,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,aAAa,GACb,mBAAmB,GACnB,YAAY,GACZ,UAAU,GACV,eAAe,GACf,QAAQ,GACR,iBAAiB,GACjB,WAAW,GACX,OAAO,GACP,SAAS,GACT,UAAU,GACV,qBAAqB,GACrB,mBAAmB,GACnB,QAAQ,GACR,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,OAAO,GACP,UAAU,GACV,QAAQ,CAAC"}
|
@@ -2,7 +2,7 @@ import { FieldValues } from './fields';
|
|
2
2
|
import { Control } from './form';
|
3
3
|
import { FieldArrayPath, FieldArrayPathValue } from './path';
|
4
4
|
import { RegisterOptions, Validate } from './validator';
|
5
|
-
export
|
5
|
+
export type UseFieldArrayProps<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
|
6
6
|
name: TFieldArrayName;
|
7
7
|
keyName?: TKeyName;
|
8
8
|
control?: Control<TFieldValues>;
|
@@ -14,12 +14,12 @@ export declare type UseFieldArrayProps<TFieldValues extends FieldValues = FieldV
|
|
14
14
|
/**
|
15
15
|
* `useFieldArray` returned `fields` with unique id
|
16
16
|
*/
|
17
|
-
export
|
18
|
-
export
|
17
|
+
export type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = FieldArray<TFieldValues, TFieldArrayName> & Record<TKeyName, string>;
|
18
|
+
export type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> | null | undefined ? U : never;
|
19
19
|
/**
|
20
20
|
* `useFieldArray` focus option, ability to toggle focus on and off with `shouldFocus` and setting focus by either field index or name.
|
21
21
|
*/
|
22
|
-
export
|
22
|
+
export type FieldArrayMethodProps = {
|
23
23
|
shouldFocus?: boolean;
|
24
24
|
focusIndex?: number;
|
25
25
|
focusName?: string;
|
@@ -38,7 +38,7 @@ export declare type FieldArrayMethodProps = {
|
|
38
38
|
* <button type="button" onClick={() => swap(0, 1)}>swap</button>
|
39
39
|
* ```
|
40
40
|
*/
|
41
|
-
export
|
41
|
+
export type UseFieldArraySwap = (indexA: number, indexB: number) => void;
|
42
42
|
/**
|
43
43
|
* Move field array by supplying from and to index
|
44
44
|
*
|
@@ -53,7 +53,7 @@ export declare type UseFieldArraySwap = (indexA: number, indexB: number) => void
|
|
53
53
|
* <button type="button" onClick={() => move(0, 1)}>swap</button>
|
54
54
|
* ```
|
55
55
|
*/
|
56
|
-
export
|
56
|
+
export type UseFieldArrayMove = (indexA: number, indexB: number) => void;
|
57
57
|
/**
|
58
58
|
* Prepend field/fields to the start of the fields and optionally focus. The input value will be registered during this action.
|
59
59
|
*
|
@@ -75,7 +75,7 @@ export declare type UseFieldArrayMove = (indexA: number, indexB: number) => void
|
|
75
75
|
* </button>
|
76
76
|
* ```
|
77
77
|
*/
|
78
|
-
export
|
78
|
+
export type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
|
79
79
|
/**
|
80
80
|
* Append field/fields to the end of your fields and focus. The input value will be registered during this action.
|
81
81
|
*
|
@@ -97,7 +97,7 @@ export declare type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFiel
|
|
97
97
|
* </button>
|
98
98
|
* ```
|
99
99
|
*/
|
100
|
-
export
|
100
|
+
export type UseFieldArrayAppend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
|
101
101
|
/**
|
102
102
|
* Remove field/fields at particular position.
|
103
103
|
*
|
@@ -117,7 +117,7 @@ export declare type UseFieldArrayAppend<TFieldValues extends FieldValues, TField
|
|
117
117
|
* </button>
|
118
118
|
* ```
|
119
119
|
*/
|
120
|
-
export
|
120
|
+
export type UseFieldArrayRemove = (index?: number | number[]) => void;
|
121
121
|
/**
|
122
122
|
* Insert field/fields at particular position and focus.
|
123
123
|
*
|
@@ -140,7 +140,7 @@ export declare type UseFieldArrayRemove = (index?: number | number[]) => void;
|
|
140
140
|
* </button>
|
141
141
|
* ```
|
142
142
|
*/
|
143
|
-
export
|
143
|
+
export type UseFieldArrayInsert<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
|
144
144
|
/**
|
145
145
|
* Update field/fields at particular position.
|
146
146
|
*
|
@@ -161,7 +161,7 @@ export declare type UseFieldArrayInsert<TFieldValues extends FieldValues, TField
|
|
161
161
|
* </button>
|
162
162
|
* ```
|
163
163
|
*/
|
164
|
-
export
|
164
|
+
export type UseFieldArrayUpdate<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName>) => void;
|
165
165
|
/**
|
166
166
|
* Replace the entire field array values.
|
167
167
|
*
|
@@ -180,8 +180,8 @@ export declare type UseFieldArrayUpdate<TFieldValues extends FieldValues, TField
|
|
180
180
|
* </button>
|
181
181
|
* ```
|
182
182
|
*/
|
183
|
-
export
|
184
|
-
export
|
183
|
+
export type UseFieldArrayReplace<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[]) => void;
|
184
|
+
export type UseFieldArrayReturn<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
|
185
185
|
swap: UseFieldArraySwap;
|
186
186
|
move: UseFieldArrayMove;
|
187
187
|
prepend: UseFieldArrayPrepend<TFieldValues, TFieldArrayName>;
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"fieldArray.d.ts","sourceRoot":"","sources":["../../src/types/fieldArray.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAExD,
|
1
|
+
{"version":3,"file":"fieldArray.d.ts","sourceRoot":"","sources":["../../src/types/fieldArray.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAExD,MAAM,MAAM,kBAAkB,CAC5B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,EACnF,QAAQ,SAAS,MAAM,GAAG,IAAI,IAC5B;IACF,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;IAChC,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EACL,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC,GACrD,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;KAC3E,GAAG,IAAI,CACN,eAAe,CAAC,YAAY,CAAC,EAC7B,WAAW,GAAG,WAAW,GAAG,UAAU,CACvC,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAC1B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,EACnF,QAAQ,SAAS,MAAM,GAAG,IAAI,IAC5B,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAEzE,MAAM,MAAM,UAAU,CACpB,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,SAClD,aAAa,CAAC,MAAM,CAAC,CAAC,GACtB,IAAI,GACJ,SAAS,GACT,CAAC,GACD,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,oBAAoB,CAC9B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,CACF,KAAK,EAAE,MAAM,EACb,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,EAC/C,OAAO,CAAC,EAAE,qBAAqB,KAC5B,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,KAAK,IAAI,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,oBAAoB,CAC9B,YAAY,SAAS,WAAW,EAChC,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,IACjF,CACF,KAAK,EACD,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,GACzC,UAAU,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,KAC5C,IAAI,CAAC;AAEV,MAAM,MAAM,mBAAmB,CAC7B,YAAY,SAAS,WAAW,GAAG,WAAW,EAC9C,eAAe,SAAS,cAAc,CAAC,YAAY,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,EACnF,QAAQ,SAAS,MAAM,GAAG,IAAI,IAC5B;IACF,IAAI,EAAE,iBAAiB,CAAC;IACxB,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC7D,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,MAAM,EAAE,mBAAmB,CAAC;IAC5B,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,MAAM,EAAE,mBAAmB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC3D,OAAO,EAAE,oBAAoB,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;IAC7D,MAAM,EAAE,gBAAgB,CAAC,YAAY,EAAE,eAAe,EAAE,QAAQ,CAAC,EAAE,CAAC;CACrE,CAAC"}
|
package/dist/types/fields.d.ts
CHANGED
@@ -1,8 +1,8 @@
|
|
1
1
|
import { IsFlatObject, Noop } from './utils';
|
2
2
|
import { RegisterOptions } from './validator';
|
3
|
-
export
|
4
|
-
export
|
5
|
-
export
|
3
|
+
export type InternalFieldName = string;
|
4
|
+
export type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
|
5
|
+
export type CustomElement<TFieldValues extends FieldValues> = {
|
6
6
|
name: FieldName<TFieldValues>;
|
7
7
|
type?: string;
|
8
8
|
value?: any;
|
@@ -12,12 +12,12 @@ export declare type CustomElement<TFieldValues extends FieldValues> = {
|
|
12
12
|
files?: FileList | null;
|
13
13
|
focus?: Noop;
|
14
14
|
};
|
15
|
-
export
|
16
|
-
export
|
17
|
-
export
|
18
|
-
export
|
19
|
-
export
|
20
|
-
export
|
15
|
+
export type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
|
16
|
+
export type FieldValues = Record<string, any>;
|
17
|
+
export type NativeFieldValue = string | number | boolean | null | undefined | unknown[];
|
18
|
+
export type FieldElement<TFieldValues extends FieldValues = FieldValues> = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | CustomElement<TFieldValues>;
|
19
|
+
export type Ref = FieldElement;
|
20
|
+
export type Field = {
|
21
21
|
_f: {
|
22
22
|
ref: Ref;
|
23
23
|
name: InternalFieldName;
|
@@ -25,5 +25,5 @@ export declare type Field = {
|
|
25
25
|
mount?: boolean;
|
26
26
|
} & RegisterOptions;
|
27
27
|
};
|
28
|
-
export
|
28
|
+
export type FieldRefs = Partial<Record<InternalFieldName, Field>>;
|
29
29
|
//# sourceMappingURL=fields.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/types/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,
|
1
|
+
{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/types/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,MAAM,SAAS,CAAC,YAAY,SAAS,WAAW,IACpD,YAAY,CAAC,YAAY,CAAC,SAAS,IAAI,GACnC,OAAO,CAAC,MAAM,YAAY,EAAE,MAAM,CAAC,GACnC,MAAM,CAAC;AAEb,MAAM,MAAM,aAAa,CAAC,YAAY,SAAS,WAAW,IAAI;IAC5D,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,YAAY,SAAS,WAAW,IACrD,YAAY,CAAC,iBAAiB,CAAC,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAE9C,MAAM,MAAM,gBAAgB,GACxB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,OAAO,EAAE,CAAC;AAEd,MAAM,MAAM,YAAY,CAAC,YAAY,SAAS,WAAW,GAAG,WAAW,IACnE,gBAAgB,GAChB,iBAAiB,GACjB,mBAAmB,GACnB,aAAa,CAAC,YAAY,CAAC,CAAC;AAEhC,MAAM,MAAM,GAAG,GAAG,YAAY,CAAC;AAE/B,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,EAAE;QACF,GAAG,EAAE,GAAG,CAAC;QACT,IAAI,EAAE,iBAAiB,CAAC;QACxB,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;QAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB,GAAG,eAAe,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC,CAAC"}
|
package/dist/types/form.d.ts
CHANGED
@@ -12,42 +12,42 @@ declare const $NestedValue: unique symbol;
|
|
12
12
|
/**
|
13
13
|
* @deprecated to be removed in the next major version
|
14
14
|
*/
|
15
|
-
export
|
15
|
+
export type NestedValue<TValue extends object = object> = {
|
16
16
|
[$NestedValue]: never;
|
17
17
|
} & TValue;
|
18
18
|
/**
|
19
19
|
* @deprecated to be removed in the next major version
|
20
20
|
*/
|
21
|
-
export
|
21
|
+
export type UnpackNestedValue<T> = T extends NestedValue<infer U> ? U : T extends Date | FileList | File | Blob ? T : T extends object ? {
|
22
22
|
[K in keyof T]: UnpackNestedValue<T[K]>;
|
23
23
|
} : T;
|
24
|
-
export
|
25
|
-
export
|
26
|
-
export
|
24
|
+
export type DefaultValues<TFieldValues> = DeepPartial<TFieldValues>;
|
25
|
+
export type InternalNameSet = Set<InternalFieldName>;
|
26
|
+
export type ValidationMode = {
|
27
27
|
onBlur: 'onBlur';
|
28
28
|
onChange: 'onChange';
|
29
29
|
onSubmit: 'onSubmit';
|
30
30
|
onTouched: 'onTouched';
|
31
31
|
all: 'all';
|
32
32
|
};
|
33
|
-
export
|
34
|
-
export
|
35
|
-
export
|
36
|
-
export
|
37
|
-
export
|
33
|
+
export type Mode = keyof ValidationMode;
|
34
|
+
export type CriteriaMode = 'firstError' | 'all';
|
35
|
+
export type SubmitHandler<TFieldValues extends FieldValues> = (data: TFieldValues, event?: React.BaseSyntheticEvent) => any | Promise<any>;
|
36
|
+
export type SubmitErrorHandler<TFieldValues extends FieldValues> = (errors: FieldErrors<TFieldValues>, event?: React.BaseSyntheticEvent) => any | Promise<any>;
|
37
|
+
export type SetValueConfig = Partial<{
|
38
38
|
shouldValidate: boolean;
|
39
39
|
shouldDirty: boolean;
|
40
40
|
shouldTouch: boolean;
|
41
41
|
}>;
|
42
|
-
export
|
42
|
+
export type TriggerConfig = Partial<{
|
43
43
|
shouldFocus: boolean;
|
44
44
|
}>;
|
45
|
-
export
|
45
|
+
export type ChangeHandler = (event: {
|
46
46
|
target: any;
|
47
47
|
type?: any;
|
48
48
|
}) => Promise<void | boolean>;
|
49
|
-
export
|
50
|
-
export
|
49
|
+
export type DelayCallback = (wait: number) => void;
|
50
|
+
export type UseFormProps<TFieldValues extends FieldValues = FieldValues, TContext = any> = Partial<{
|
51
51
|
mode: Mode;
|
52
52
|
reValidateMode: Exclude<Mode, 'onTouched' | 'all'>;
|
53
53
|
defaultValues: DefaultValues<TFieldValues>;
|
@@ -59,8 +59,8 @@ export declare type UseFormProps<TFieldValues extends FieldValues = FieldValues,
|
|
59
59
|
criteriaMode: CriteriaMode;
|
60
60
|
delayError: number;
|
61
61
|
}>;
|
62
|
-
export
|
63
|
-
export
|
62
|
+
export type FieldNamesMarkedBoolean<TFieldValues extends FieldValues> = DeepMap<DeepPartial<TFieldValues>, boolean>;
|
63
|
+
export type FormStateProxy<TFieldValues extends FieldValues = FieldValues> = {
|
64
64
|
isDirty: boolean;
|
65
65
|
isValidating: boolean;
|
66
66
|
dirtyFields: FieldNamesMarkedBoolean<TFieldValues>;
|
@@ -68,10 +68,10 @@ export declare type FormStateProxy<TFieldValues extends FieldValues = FieldValue
|
|
68
68
|
errors: boolean;
|
69
69
|
isValid: boolean;
|
70
70
|
};
|
71
|
-
export
|
71
|
+
export type ReadFormState = {
|
72
72
|
[K in keyof FormStateProxy]: boolean | 'all';
|
73
73
|
};
|
74
|
-
export
|
74
|
+
export type FormState<TFieldValues extends FieldValues> = {
|
75
75
|
isDirty: boolean;
|
76
76
|
isSubmitted: boolean;
|
77
77
|
isSubmitSuccessful: boolean;
|
@@ -84,7 +84,7 @@ export declare type FormState<TFieldValues extends FieldValues> = {
|
|
84
84
|
touchedFields: Partial<Readonly<FieldNamesMarkedBoolean<TFieldValues>>>;
|
85
85
|
errors: FieldErrors<TFieldValues>;
|
86
86
|
};
|
87
|
-
export
|
87
|
+
export type KeepStateOptions = Partial<{
|
88
88
|
keepDirtyValues: boolean;
|
89
89
|
keepErrors: boolean;
|
90
90
|
keepDirty: boolean;
|
@@ -95,9 +95,9 @@ export declare type KeepStateOptions = Partial<{
|
|
95
95
|
keepIsValid: boolean;
|
96
96
|
keepSubmitCount: boolean;
|
97
97
|
}>;
|
98
|
-
export
|
99
|
-
export
|
100
|
-
export
|
98
|
+
export type SetFieldValue<TFieldValues extends FieldValues> = FieldValue<TFieldValues>;
|
99
|
+
export type RefCallBack = (instance: any) => void;
|
100
|
+
export type UseFormRegisterReturn<TFieldName extends InternalFieldName = InternalFieldName> = {
|
101
101
|
onChange: ChangeHandler;
|
102
102
|
onBlur: ChangeHandler;
|
103
103
|
ref: RefCallBack;
|
@@ -143,8 +143,8 @@ export declare type UseFormRegisterReturn<TFieldName extends InternalFieldName =
|
|
143
143
|
* <input onChange={onChange} onBlur={onBlur} name={name} />
|
144
144
|
* ```
|
145
145
|
*/
|
146
|
-
export
|
147
|
-
export
|
146
|
+
export type UseFormRegister<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, options?: RegisterOptions<TFieldValues, TFieldName>) => UseFormRegisterReturn<TFieldName>;
|
147
|
+
export type SetFocusOptions = Partial<{
|
148
148
|
shouldSelect: boolean;
|
149
149
|
}>;
|
150
150
|
/**
|
@@ -165,8 +165,8 @@ export declare type SetFocusOptions = Partial<{
|
|
165
165
|
* <button onClick={() => setFocus("name", { shouldSelect: true })}>Focus</button>
|
166
166
|
* ```
|
167
167
|
*/
|
168
|
-
export
|
169
|
-
export
|
168
|
+
export type UseFormSetFocus<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, options?: SetFocusOptions) => void;
|
169
|
+
export type UseFormGetValues<TFieldValues extends FieldValues> = {
|
170
170
|
/**
|
171
171
|
* Get the entire form values when no argument is supplied to this function.
|
172
172
|
*
|
@@ -250,7 +250,7 @@ export declare type UseFormGetValues<TFieldValues extends FieldValues> = {
|
|
250
250
|
* getFieldState('name', formState)
|
251
251
|
* ```
|
252
252
|
*/
|
253
|
-
export
|
253
|
+
export type UseFormGetFieldState<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues>>(name: TFieldName, formState?: FormState<TFieldValues>) => {
|
254
254
|
/**
|
255
255
|
* @deprecated check `fieldState.error` instead
|
256
256
|
* ```jsx
|
@@ -262,7 +262,7 @@ export declare type UseFormGetFieldState<TFieldValues extends FieldValues> = <TF
|
|
262
262
|
isTouched: boolean;
|
263
263
|
error?: FieldError;
|
264
264
|
};
|
265
|
-
export
|
265
|
+
export type UseFormWatch<TFieldValues extends FieldValues> = {
|
266
266
|
/**
|
267
267
|
* Watch and subscribe to the entire form update/change based on onChange and re-render at the useForm.
|
268
268
|
*
|
@@ -358,7 +358,7 @@ export declare type UseFormWatch<TFieldValues extends FieldValues> = {
|
|
358
358
|
* </button>
|
359
359
|
* ```
|
360
360
|
*/
|
361
|
-
export
|
361
|
+
export type UseFormTrigger<TFieldValues extends FieldValues> = (name?: FieldPath<TFieldValues> | FieldPath<TFieldValues>[] | readonly FieldPath<TFieldValues>[], options?: TriggerConfig) => Promise<boolean>;
|
362
362
|
/**
|
363
363
|
* Clear the entire form errors.
|
364
364
|
*
|
@@ -375,7 +375,7 @@ export declare type UseFormTrigger<TFieldValues extends FieldValues> = (name?: F
|
|
375
375
|
* clearErrors("name2"); // clear a single field error
|
376
376
|
* ```
|
377
377
|
*/
|
378
|
-
export
|
378
|
+
export type UseFormClearErrors<TFieldValues extends FieldValues> = (name?: FieldPath<TFieldValues> | FieldPath<TFieldValues>[] | readonly FieldPath<TFieldValues>[]) => void;
|
379
379
|
/**
|
380
380
|
* Set a single field value, or a group of fields value.
|
381
381
|
*
|
@@ -405,7 +405,7 @@ export declare type UseFormClearErrors<TFieldValues extends FieldValues> = (name
|
|
405
405
|
* setValue('select', { label: 'test', value: 'Test' });
|
406
406
|
* ```
|
407
407
|
*/
|
408
|
-
export
|
408
|
+
export type UseFormSetValue<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, value: FieldPathValue<TFieldValues, TFieldName>, options?: SetValueConfig) => void;
|
409
409
|
/**
|
410
410
|
* Set an error for the field. When set an error which is not associated to a field then manual `clearErrors` invoke is required.
|
411
411
|
*
|
@@ -427,7 +427,7 @@ export declare type UseFormSetValue<TFieldValues extends FieldValues> = <TFieldN
|
|
427
427
|
* <button onClick={() => setError("name", { type: "max" }, { shouldFocus: true })} />
|
428
428
|
* ```
|
429
429
|
*/
|
430
|
-
export
|
430
|
+
export type UseFormSetError<TFieldValues extends FieldValues> = (name: FieldPath<TFieldValues>, error: ErrorOption, options?: {
|
431
431
|
shouldFocus: boolean;
|
432
432
|
}) => void;
|
433
433
|
/**
|
@@ -448,7 +448,7 @@ export declare type UseFormSetError<TFieldValues extends FieldValues> = (name: F
|
|
448
448
|
* <button onClick={() => unregister("name", { keepErrors: true })} />
|
449
449
|
* ```
|
450
450
|
*/
|
451
|
-
export
|
451
|
+
export type UseFormUnregister<TFieldValues extends FieldValues> = (name?: FieldPath<TFieldValues> | FieldPath<TFieldValues>[] | readonly FieldPath<TFieldValues>[], options?: Omit<KeepStateOptions, 'keepIsSubmitted' | 'keepSubmitCount' | 'keepValues' | 'keepDefaultValues' | 'keepErrors'> & {
|
452
452
|
keepValue?: boolean;
|
453
453
|
keepDefaultValue?: boolean;
|
454
454
|
keepError?: boolean;
|
@@ -472,7 +472,7 @@ export declare type UseFormUnregister<TFieldValues extends FieldValues> = (name?
|
|
472
472
|
* <form onSubmit={handleSubmit(onSubmit, onError)} />
|
473
473
|
* ```
|
474
474
|
*/
|
475
|
-
export
|
475
|
+
export type UseFormHandleSubmit<TFieldValues extends FieldValues> = (onValid: SubmitHandler<TFieldValues>, onInvalid?: SubmitErrorHandler<TFieldValues>) => (e?: React.BaseSyntheticEvent) => Promise<void>;
|
476
476
|
/**
|
477
477
|
* Reset a field state and reference.
|
478
478
|
*
|
@@ -488,13 +488,13 @@ export declare type UseFormHandleSubmit<TFieldValues extends FieldValues> = (onV
|
|
488
488
|
* <button type="button" onClick={() => resetField("firstName"))}>Reset</button>
|
489
489
|
* ```
|
490
490
|
*/
|
491
|
-
export
|
491
|
+
export type UseFormResetField<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, options?: Partial<{
|
492
492
|
keepDirty: boolean;
|
493
493
|
keepTouched: boolean;
|
494
494
|
keepError: boolean;
|
495
495
|
defaultValue: any;
|
496
496
|
}>) => void;
|
497
|
-
|
497
|
+
type ResetAction<TFieldValues> = (formValues: TFieldValues) => TFieldValues;
|
498
498
|
/**
|
499
499
|
* Reset at the entire form state.
|
500
500
|
*
|
@@ -529,13 +529,13 @@ declare type ResetAction<TFieldValues> = (formValues: TFieldValues) => TFieldVal
|
|
529
529
|
*});
|
530
530
|
* ```
|
531
531
|
*/
|
532
|
-
export
|
533
|
-
export
|
534
|
-
export
|
535
|
-
export
|
532
|
+
export type UseFormReset<TFieldValues extends FieldValues> = (values?: DefaultValues<TFieldValues> | TFieldValues | ResetAction<TFieldValues>, keepStateOptions?: KeepStateOptions) => void;
|
533
|
+
export type WatchInternal<TFieldValues> = (fieldNames?: InternalFieldName | InternalFieldName[], defaultValue?: DeepPartial<TFieldValues>, isMounted?: boolean, isGlobal?: boolean) => FieldPathValue<FieldValues, InternalFieldName> | FieldPathValues<FieldValues, InternalFieldName[]>;
|
534
|
+
export type GetIsDirty = <TName extends InternalFieldName, TData>(name?: TName, data?: TData) => boolean;
|
535
|
+
export type FormStateSubjectRef<TFieldValues extends FieldValues> = Subject<Partial<FormState<TFieldValues>> & {
|
536
536
|
name?: InternalFieldName;
|
537
537
|
}>;
|
538
|
-
export
|
538
|
+
export type Subjects<TFieldValues extends FieldValues = FieldValues> = {
|
539
539
|
watch: Subject<{
|
540
540
|
name?: InternalFieldName;
|
541
541
|
type?: EventType;
|
@@ -547,7 +547,7 @@ export declare type Subjects<TFieldValues extends FieldValues = FieldValues> = {
|
|
547
547
|
}>;
|
548
548
|
state: FormStateSubjectRef<TFieldValues>;
|
549
549
|
};
|
550
|
-
export
|
550
|
+
export type Names = {
|
551
551
|
mount: InternalNameSet;
|
552
552
|
unMount: InternalNameSet;
|
553
553
|
array: InternalNameSet;
|
@@ -555,11 +555,11 @@ export declare type Names = {
|
|
555
555
|
focus: InternalFieldName;
|
556
556
|
watchAll: boolean;
|
557
557
|
};
|
558
|
-
export
|
558
|
+
export type BatchFieldArrayUpdate = <T extends Function, TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>>(name: InternalFieldName, updatedFieldArrayValues?: Partial<FieldArray<TFieldValues, TFieldArrayName>>[], method?: T, args?: Partial<{
|
559
559
|
argA: unknown;
|
560
560
|
argB: unknown;
|
561
561
|
}>, shouldSetValue?: boolean, shouldUpdateFieldsAndErrors?: boolean) => void;
|
562
|
-
export
|
562
|
+
export type Control<TFieldValues extends FieldValues = FieldValues, TContext = any> = {
|
563
563
|
_subjects: Subjects<TFieldValues>;
|
564
564
|
_removeUnmounted: Noop;
|
565
565
|
_focusError: Noop;
|
@@ -587,12 +587,12 @@ export declare type Control<TFieldValues extends FieldValues = FieldValues, TCon
|
|
587
587
|
unregister: UseFormUnregister<TFieldValues>;
|
588
588
|
getFieldState: UseFormGetFieldState<TFieldValues>;
|
589
589
|
};
|
590
|
-
export
|
590
|
+
export type WatchObserver<TFieldValues extends FieldValues> = (value: DeepPartial<TFieldValues>, info: {
|
591
591
|
name?: FieldPath<TFieldValues>;
|
592
592
|
type?: EventType;
|
593
593
|
value?: unknown;
|
594
594
|
}) => void;
|
595
|
-
export
|
595
|
+
export type UseFormReturn<TFieldValues extends FieldValues = FieldValues, TContext = any> = {
|
596
596
|
watch: UseFormWatch<TFieldValues>;
|
597
597
|
getValues: UseFormGetValues<TFieldValues>;
|
598
598
|
getFieldState: UseFormGetFieldState<TFieldValues>;
|
@@ -609,21 +609,21 @@ export declare type UseFormReturn<TFieldValues extends FieldValues = FieldValues
|
|
609
609
|
register: UseFormRegister<TFieldValues>;
|
610
610
|
setFocus: UseFormSetFocus<TFieldValues>;
|
611
611
|
};
|
612
|
-
export
|
612
|
+
export type UseFormStateProps<TFieldValues extends FieldValues> = Partial<{
|
613
613
|
control?: Control<TFieldValues>;
|
614
614
|
disabled?: boolean;
|
615
615
|
name?: FieldPath<TFieldValues> | FieldPath<TFieldValues>[] | readonly FieldPath<TFieldValues>[];
|
616
616
|
exact?: boolean;
|
617
617
|
}>;
|
618
|
-
export
|
619
|
-
export
|
618
|
+
export type UseFormStateReturn<TFieldValues extends FieldValues> = FormState<TFieldValues>;
|
619
|
+
export type UseWatchProps<TFieldValues extends FieldValues = FieldValues> = {
|
620
620
|
defaultValue?: unknown;
|
621
621
|
disabled?: boolean;
|
622
622
|
name?: FieldPath<TFieldValues> | FieldPath<TFieldValues>[] | readonly FieldPath<TFieldValues>[];
|
623
623
|
control?: Control<TFieldValues>;
|
624
624
|
exact?: boolean;
|
625
625
|
};
|
626
|
-
export
|
626
|
+
export type FormProviderProps<TFieldValues extends FieldValues = FieldValues, TContext = any> = {
|
627
627
|
children: React.ReactNode | React.ReactNode[];
|
628
628
|
} & UseFormReturn<TFieldValues, TContext>;
|
629
629
|
export {};
|