react-hook-form 7.44.0-rc.0 → 7.44.0-rc.3

package/dist/types/fieldArray.d.ts

@@ -1,195 +1,195 @@
-import { FieldValues } from './fields';
-import { Control } from './form';
-import { FieldArrayPath, FieldArrayPathValue } from './path';
-import { RegisterOptions, Validate } from './validator';
-export type UseFieldArrayProps<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
-    name: TFieldArrayName;
-    keyName?: TKeyName;
-    control?: Control<TFieldValues>;
-    rules?: {
-        validate?: Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues> | Record<string, Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues>>;
-    } & Pick<RegisterOptions<TFieldValues>, 'maxLength' | 'minLength' | 'required'>;
-    shouldUnregister?: boolean;
-};
-/**
- * `useFieldArray` returned `fields` with unique id
- */
-export type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = FieldArray<TFieldValues, TFieldArrayName> & Record<TKeyName, string>;
-export type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> | null | undefined ? U : never;
-/**
- * `useFieldArray` focus option, ability to toggle focus on and off with `shouldFocus` and setting focus by either field index or name.
- */
-export type FieldArrayMethodProps = {
-    shouldFocus?: boolean;
-    focusIndex?: number;
-    focusName?: string;
-};
-/**
- * Swap field array by supplying from and to index
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param indexA - from index
- * @param indexB - to index
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => swap(0, 1)}>swap</button>
- * ```
- */
-export type UseFieldArraySwap = (indexA: number, indexB: number) => void;
-/**
- * Move field array by supplying from and to index
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param indexA - from index
- * @param indexB - to index
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => move(0, 1)}>swap</button>
- * ```
- */
-export type UseFieldArrayMove = (indexA: number, indexB: number) => void;
-/**
- * Prepend field/fields to the start of the fields and optionally focus. The input value will be registered during this action.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param value - prepend items or items
- * @param options - focus options
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => prepend({ name: "data" })}>Prepend</button>
- * <button type="button" onClick={() => prepend({ name: "data" }, { shouldFocus: false })}>Prepend</button>
- * <button
- *   type="button"
- *   onClick={() => prepend([{ name: "data" }, { name: "data" }])}
- * >
- *   Prepend
- * </button>
- * ```
- */
-export type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
-/**
- * Append field/fields to the end of your fields and focus. The input value will be registered during this action.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param value - append items or items.
- * @param options - focus options
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => append({ name: "data" })}>Append</button>
- * <button type="button" onClick={() => append({ name: "data" }, { shouldFocus: false })}>Append</button>
- * <button
- *   type="button"
- *   onClick={() => append([{ name: "data" }, { name: "data" }])}
- * >
- *   Append
- * </button>
- * ```
- */
-export type UseFieldArrayAppend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
-/**
- * Remove field/fields at particular position.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param index - index to remove at, or remove all when no index provided.
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => remove(0)}>Remove</button>
- * <button
- *   type="button"
- *   onClick={() => remove()}
- * >
- *   Remove all
- * </button>
- * ```
- */
-export type UseFieldArrayRemove = (index?: number | number[]) => void;
-/**
- * Insert field/fields at particular position and focus.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param index - insert position
- * @param value - insert field or fields
- * @param options - focus options
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => insert(1, { name: "data" })}>Insert</button>
- * <button type="button" onClick={() => insert(1, { name: "data" }, { shouldFocus: false })}>Insert</button>
- * <button
- *   type="button"
- *   onClick={() => insert(1, [{ name: "data" }, { name: "data" }])}
- * >
- *   Insert
- * </button>
- * ```
- */
-export type UseFieldArrayInsert<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
-/**
- * Update field/fields at particular position.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param index - insert position
- * @param value - insert field or fields
- *
- * @example
- * ```tsx
- * <button type="button" onClick={() => update(1, { name: "data" })}>Update</button>
- * <button
- *   type="button"
- *   onClick={() => update(1, [{ name: "data" }, { name: "data" }])}
- * >
- *   Update
- * </button>
- * ```
- */
-export type UseFieldArrayUpdate<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName>) => void;
-/**
- * Replace the entire field array values.
- *
- * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
- *
- * @param value - the entire field values.
- *
- * @example
- * ```tsx
- * <button
- *   type="button"
- *   onClick={() => replace([{ name: "data" }, { name: "data" }])}
- * >
- *   Replace
- * </button>
- * ```
- */
-export type UseFieldArrayReplace<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[]) => void;
-export type UseFieldArrayReturn<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
-    swap: UseFieldArraySwap;
-    move: UseFieldArrayMove;
-    prepend: UseFieldArrayPrepend<TFieldValues, TFieldArrayName>;
-    append: UseFieldArrayAppend<TFieldValues, TFieldArrayName>;
-    remove: UseFieldArrayRemove;
-    insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>;
-    update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>;
-    replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>;
-    fields: FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>[];
-};
+import { FieldValues } from './fields';
+import { Control } from './form';
+import { FieldArrayPath, FieldArrayPathValue } from './path';
+import { RegisterOptions, Validate } from './validator';
+export type UseFieldArrayProps<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
+    name: TFieldArrayName;
+    keyName?: TKeyName;
+    control?: Control<TFieldValues>;
+    rules?: {
+        validate?: Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues> | Record<string, Validate<FieldArray<TFieldValues, TFieldArrayName>[], TFieldValues>>;
+    } & Pick<RegisterOptions<TFieldValues>, 'maxLength' | 'minLength' | 'required'>;
+    shouldUnregister?: boolean;
+};
+/**
+ * `useFieldArray` returned `fields` with unique id
+ */
+export type FieldArrayWithId<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = FieldArray<TFieldValues, TFieldArrayName> & Record<TKeyName, string>;
+export type FieldArray<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = FieldArrayPathValue<TFieldValues, TFieldArrayName> extends ReadonlyArray<infer U> | null | undefined ? U : never;
+/**
+ * `useFieldArray` focus option, ability to toggle focus on and off with `shouldFocus` and setting focus by either field index or name.
+ */
+export type FieldArrayMethodProps = {
+    shouldFocus?: boolean;
+    focusIndex?: number;
+    focusName?: string;
+};
+/**
+ * Swap field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param indexA - from index
+ * @param indexB - to index
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => swap(0, 1)}>swap</button>
+ * ```
+ */
+export type UseFieldArraySwap = (indexA: number, indexB: number) => void;
+/**
+ * Move field array by supplying from and to index
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param indexA - from index
+ * @param indexB - to index
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => move(0, 1)}>swap</button>
+ * ```
+ */
+export type UseFieldArrayMove = (indexA: number, indexB: number) => void;
+/**
+ * Prepend field/fields to the start of the fields and optionally focus. The input value will be registered during this action.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - prepend items or items
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => prepend({ name: "data" })}>Prepend</button>
+ * <button type="button" onClick={() => prepend({ name: "data" }, { shouldFocus: false })}>Prepend</button>
+ * <button
+ *   type="button"
+ *   onClick={() => prepend([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Prepend
+ * </button>
+ * ```
+ */
+export type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Append field/fields to the end of your fields and focus. The input value will be registered during this action.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - append items or items.
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => append({ name: "data" })}>Append</button>
+ * <button type="button" onClick={() => append({ name: "data" }, { shouldFocus: false })}>Append</button>
+ * <button
+ *   type="button"
+ *   onClick={() => append([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Append
+ * </button>
+ * ```
+ */
+export type UseFieldArrayAppend<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Remove field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - index to remove at, or remove all when no index provided.
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => remove(0)}>Remove</button>
+ * <button
+ *   type="button"
+ *   onClick={() => remove()}
+ * >
+ *   Remove all
+ * </button>
+ * ```
+ */
+export type UseFieldArrayRemove = (index?: number | number[]) => void;
+/**
+ * Insert field/fields at particular position and focus.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - insert position
+ * @param value - insert field or fields
+ * @param options - focus options
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => insert(1, { name: "data" })}>Insert</button>
+ * <button type="button" onClick={() => insert(1, { name: "data" }, { shouldFocus: false })}>Insert</button>
+ * <button
+ *   type="button"
+ *   onClick={() => insert(1, [{ name: "data" }, { name: "data" }])}
+ * >
+ *   Insert
+ * </button>
+ * ```
+ */
+export type UseFieldArrayInsert<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[], options?: FieldArrayMethodProps) => void;
+/**
+ * Update field/fields at particular position.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param index - insert position
+ * @param value - insert field or fields
+ *
+ * @example
+ * ```tsx
+ * <button type="button" onClick={() => update(1, { name: "data" })}>Update</button>
+ * <button
+ *   type="button"
+ *   onClick={() => update(1, [{ name: "data" }, { name: "data" }])}
+ * >
+ *   Update
+ * </button>
+ * ```
+ */
+export type UseFieldArrayUpdate<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (index: number, value: FieldArray<TFieldValues, TFieldArrayName>) => void;
+/**
+ * Replace the entire field array values.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ *
+ * @param value - the entire field values.
+ *
+ * @example
+ * ```tsx
+ * <button
+ *   type="button"
+ *   onClick={() => replace([{ name: "data" }, { name: "data" }])}
+ * >
+ *   Replace
+ * </button>
+ * ```
+ */
+export type UseFieldArrayReplace<TFieldValues extends FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>> = (value: FieldArray<TFieldValues, TFieldArrayName> | FieldArray<TFieldValues, TFieldArrayName>[]) => void;
+export type UseFieldArrayReturn<TFieldValues extends FieldValues = FieldValues, TFieldArrayName extends FieldArrayPath<TFieldValues> = FieldArrayPath<TFieldValues>, TKeyName extends string = 'id'> = {
+    swap: UseFieldArraySwap;
+    move: UseFieldArrayMove;
+    prepend: UseFieldArrayPrepend<TFieldValues, TFieldArrayName>;
+    append: UseFieldArrayAppend<TFieldValues, TFieldArrayName>;
+    remove: UseFieldArrayRemove;
+    insert: UseFieldArrayInsert<TFieldValues, TFieldArrayName>;
+    update: UseFieldArrayUpdate<TFieldValues, TFieldArrayName>;
+    replace: UseFieldArrayReplace<TFieldValues, TFieldArrayName>;
+    fields: FieldArrayWithId<TFieldValues, TFieldArrayName, TKeyName>[];
+};
 //# sourceMappingURL=fieldArray.d.ts.map

package/dist/types/fields.d.ts

@@ -1,29 +1,29 @@
-import { IsFlatObject, Noop } from './utils';
-import { RegisterOptions } from './validator';
-export type InternalFieldName = string;
-export type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
-export type CustomElement<TFieldValues extends FieldValues> = {
-    name: FieldName<TFieldValues>;
-    type?: string;
-    value?: any;
-    disabled?: boolean;
-    checked?: boolean;
-    options?: HTMLOptionsCollection;
-    files?: FileList | null;
-    focus?: Noop;
-};
-export type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
-export type FieldValues = Record<string, any>;
-export type NativeFieldValue = string | number | boolean | null | undefined | unknown[];
-export type FieldElement<TFieldValues extends FieldValues = FieldValues> = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | CustomElement<TFieldValues>;
-export type Ref = FieldElement;
-export type Field = {
-    _f: {
-        ref: Ref;
-        name: InternalFieldName;
-        refs?: HTMLInputElement[];
-        mount?: boolean;
-    } & RegisterOptions;
-};
-export type FieldRefs = Partial<Record<InternalFieldName, Field>>;
+import { IsFlatObject, Noop } from './utils';
+import { RegisterOptions } from './validator';
+export type InternalFieldName = string;
+export type FieldName<TFieldValues extends FieldValues> = IsFlatObject<TFieldValues> extends true ? Extract<keyof TFieldValues, string> : string;
+export type CustomElement<TFieldValues extends FieldValues> = {
+    name: FieldName<TFieldValues>;
+    type?: string;
+    value?: any;
+    disabled?: boolean;
+    checked?: boolean;
+    options?: HTMLOptionsCollection;
+    files?: FileList | null;
+    focus?: Noop;
+};
+export type FieldValue<TFieldValues extends FieldValues> = TFieldValues[InternalFieldName];
+export type FieldValues = Record<string, any>;
+export type NativeFieldValue = string | number | boolean | null | undefined | unknown[];
+export type FieldElement<TFieldValues extends FieldValues = FieldValues> = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement | CustomElement<TFieldValues>;
+export type Ref = FieldElement;
+export type Field = {
+    _f: {
+        ref: Ref;
+        name: InternalFieldName;
+        refs?: HTMLInputElement[];
+        mount?: boolean;
+    } & RegisterOptions;
+};
+export type FieldRefs = Partial<Record<InternalFieldName, Field>>;
 //# sourceMappingURL=fields.d.ts.map