react-hook-form 7.44.2 → 7.44.3-beta.0

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.33.7"
+    }
+  ]
+}

package/dist/types/fieldArray.d.ts

@@ -28,7 +28,7 @@ export type FieldArrayMethodProps = {
  * 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)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param indexA - from index
  * @param indexB - to index
@@ -43,7 +43,7 @@ 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)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param indexA - from index
  * @param indexB - to index
@@ -58,7 +58,7 @@ 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)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param value - prepend items or items
  * @param options - focus options
@@ -80,7 +80,7 @@ export type UseFieldArrayPrepend<TFieldValues extends FieldValues, TFieldArrayNa
  * 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)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param value - append items or items.
  * @param options - focus options
@@ -102,7 +102,7 @@ export type UseFieldArrayAppend<TFieldValues extends FieldValues, TFieldArrayNam
  * Remove field/fields at particular position.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param index - index to remove at, or remove all when no index provided.
  *
@@ -122,7 +122,7 @@ 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)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param index - insert position
  * @param value - insert field or fields
@@ -145,7 +145,7 @@ export type UseFieldArrayInsert<TFieldValues extends FieldValues, TFieldArrayNam
  * Update field/fields at particular position.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param index - insert position
  * @param value - insert field or fields
@@ -166,7 +166,7 @@ export type UseFieldArrayUpdate<TFieldValues extends FieldValues, TFieldArrayNam
  * Replace the entire field array values.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/calc-i231d)
  *
  * @param value - the entire field values.
  *

package/dist/types/form.d.ts

@@ -126,7 +126,7 @@ export type UseFormRegisterReturn<TFieldName extends InternalFieldName = Interna
  * Register field into hook form with or without the actual DOM ref. You can invoke register anywhere in the component including at `useEffect`.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/register) • [Demo](https://codesandbox.io/s/react-hook-form-register-ts-ip2j3) • [Video](https://www.youtube.com/watch?v=JFIpCoajYkA)
+ * [API](https://react-hook-form.com/docs/useform/register) • [Demo](https://codesandbox.io/s/react-hook-form-register-ts-ip2j3) • [Video](https://www.youtube.com/watch?v=JFIpCoajYkA)
  *
  * @param name - the path name to the form field value, name is required and unique
  * @param options - register options include validation, disabled, unregister, value as and dependent validation
@@ -163,7 +163,7 @@ export type SetFocusOptions = Partial<{
  * Set focus on a registered field. You can start to invoke this method after all fields are mounted to the DOM.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/setfocus) • [Demo](https://codesandbox.io/s/setfocus-rolus)
+ * [API](https://react-hook-form.com/docs/useform/setfocus) • [Demo](https://codesandbox.io/s/setfocus-rolus)
  *
  * @param name - the path name to the form field value.
  * @param options - input focus behavior options
@@ -183,7 +183,7 @@ export type UseFormGetValues<TFieldValues extends FieldValues> = {
      * Get the entire form values when no argument is supplied to this function.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
+     * [API](https://react-hook-form.com/docs/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
      *
      * @returns form values
      *
@@ -201,7 +201,7 @@ export type UseFormGetValues<TFieldValues extends FieldValues> = {
      * Get a single field value.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
+     * [API](https://react-hook-form.com/docs/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
      *
      * @param name - the path name to the form field value.
      *
@@ -221,7 +221,7 @@ export type UseFormGetValues<TFieldValues extends FieldValues> = {
      * Get an array of field values.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
+     * [API](https://react-hook-form.com/docs/useform/getvalues) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-getvalues-txsfg)
      *
      * @param names - an array of field names
      *
@@ -242,7 +242,7 @@ export type UseFormGetValues<TFieldValues extends FieldValues> = {
  * This method will return individual field states. It will be useful when you are trying to retrieve the nested value field state in a typesafe approach.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/getfieldstate) • [Demo](https://codesandbox.io/s/getfieldstate-jvekk)
+ * [API](https://react-hook-form.com/docs/useform/getfieldstate) • [Demo](https://codesandbox.io/s/getfieldstate-jvekk)
  *
  * @param name - the path name to the form field value.
  *
@@ -273,7 +273,7 @@ export type UseFormWatch<TFieldValues extends FieldValues> = {
      * Watch and subscribe to the entire form update/change based on onChange and re-render at the useForm.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
+     * [API](https://react-hook-form.com/docs/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
      *
      * @returns return the entire form values
      *
@@ -287,7 +287,7 @@ export type UseFormWatch<TFieldValues extends FieldValues> = {
      * Watch and subscribe to an array of fields used outside of render.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
+     * [API](https://react-hook-form.com/docs/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
      *
      * @param names - an array of field names
      * @param defaultValue - defaultValues for the entire form
@@ -304,7 +304,7 @@ export type UseFormWatch<TFieldValues extends FieldValues> = {
      * Watch and subscribe to a single field used outside of render.
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
+     * [API](https://react-hook-form.com/docs/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
      *
      * @param name - the path name to the form field value.
      * @param defaultValue - defaultValues for the entire form
@@ -321,7 +321,7 @@ export type UseFormWatch<TFieldValues extends FieldValues> = {
      * Subscribe to field update/change without trigger re-render
      *
      * @remarks
-     * [API](https://react-hook-form.com/api/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
+     * [API](https://react-hook-form.com/docs/useform/watch) • [Demo](https://codesandbox.io/s/react-hook-form-watch-v7-ts-8et1d) • [Video](https://www.youtube.com/watch?v=3qLd69WMqKk)
      *
      * @param callback - call back function to subscribe all fields change and return unsubscribe function
      * @param defaultValues - defaultValues for the entire form
@@ -344,7 +344,7 @@ export type UseFormWatch<TFieldValues extends FieldValues> = {
  * Trigger field or form validation
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/trigger) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-triggervalidation-forked-xs7hl) • [Video](https://www.youtube.com/watch?v=-bcyJCDjksE)
+ * [API](https://react-hook-form.com/docs/useform/trigger) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-triggervalidation-forked-xs7hl) • [Video](https://www.youtube.com/watch?v=-bcyJCDjksE)
  *
  * @param name - provide empty argument will trigger the entire form validation, an array of field names will validate an arrange of fields, and a single field name will only trigger that field's validation.
  * @param options - should focus on the error field
@@ -369,7 +369,7 @@ export type UseFormTrigger<TFieldValues extends FieldValues> = (name?: FieldPath
  * Clear the entire form errors.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/clearerrors) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-clearerrors-w3ymx)
+ * [API](https://react-hook-form.com/docs/useform/clearerrors) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-clearerrors-w3ymx)
  *
  * @param name - the path name to the form field value.
  *
@@ -386,7 +386,7 @@ export type UseFormClearErrors<TFieldValues extends FieldValues> = (name?: Field
  * Set a single field value, or a group of fields value.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/setvalue) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-setvalue-8z9hx) • [Video](https://www.youtube.com/watch?v=qpv51sCH3fI)
+ * [API](https://react-hook-form.com/docs/useform/setvalue) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-setvalue-8z9hx) • [Video](https://www.youtube.com/watch?v=qpv51sCH3fI)
  *
  * @param name - the path name to the form field value.
  * @param value - field value
@@ -416,7 +416,7 @@ export type UseFormSetValue<TFieldValues extends FieldValues> = <TFieldName exte
  * Set an error for the field. When set an error which is not associated to a field then manual `clearErrors` invoke is required.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/seterror) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-seterror-nfxxu) • [Video](https://www.youtube.com/watch?v=raMqvE0YyIY)
+ * [API](https://react-hook-form.com/docs/useform/seterror) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-seterror-nfxxu) • [Video](https://www.youtube.com/watch?v=raMqvE0YyIY)
  *
  * @param name - the path name to the form field value.
  * @param error - an error object which contains type and optional message
@@ -440,7 +440,7 @@ export type UseFormSetError<TFieldValues extends FieldValues> = (name: FieldPath
  * Unregister a field reference and remove its value.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/unregister) • [Demo](https://codesandbox.io/s/react-hook-form-unregister-4k2ey) • [Video](https://www.youtube.com/watch?v=TM99g_NW5Gk&feature=emb_imp_woyt)
+ * [API](https://react-hook-form.com/docs/useform/unregister) • [Demo](https://codesandbox.io/s/react-hook-form-unregister-4k2ey) • [Video](https://www.youtube.com/watch?v=TM99g_NW5Gk&feature=emb_imp_woyt)
  *
  * @param name - the path name to the form field value.
  * @param options - keep form state options
@@ -463,7 +463,7 @@ export type UseFormUnregister<TFieldValues extends FieldValues> = (name?: FieldP
  * Validate the entire form. Handle submit and error callback.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/handlesubmit) • [Demo](https://codesandbox.io/s/react-hook-form-handlesubmit-ts-v7-lcrtu) • [Video](https://www.youtube.com/watch?v=KzcPKB9SOEk)
+ * [API](https://react-hook-form.com/docs/useform/handlesubmit) • [Demo](https://codesandbox.io/s/react-hook-form-handlesubmit-ts-v7-lcrtu) • [Video](https://www.youtube.com/watch?v=KzcPKB9SOEk)
  *
  * @param onValid - callback function invoked after form pass validation
  * @param onInvalid - callback function invoked when form failed validation
@@ -483,7 +483,7 @@ export type UseFormHandleSubmit<TFieldValues extends FieldValues, TTransformedVa
  * Reset a field state and reference.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/resetfield) • [Demo](https://codesandbox.io/s/priceless-firefly-d0kuv) • [Video](https://www.youtube.com/watch?v=IdLFcNaEFEo)
+ * [API](https://react-hook-form.com/docs/useform/resetfield) • [Demo](https://codesandbox.io/s/priceless-firefly-d0kuv) • [Video](https://www.youtube.com/watch?v=IdLFcNaEFEo)
  *
  * @param name - the path name to the form field value.
  * @param options - keep form state options
@@ -505,7 +505,7 @@ type ResetAction<TFieldValues> = (formValues: TFieldValues) => TFieldValues;
  * Reset at the entire form state.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform/reset) • [Demo](https://codesandbox.io/s/react-hook-form-reset-v7-ts-pu901) • [Video](https://www.youtube.com/watch?v=qmCLBjyPwVk)
+ * [API](https://react-hook-form.com/docs/useform/reset) • [Demo](https://codesandbox.io/s/react-hook-form-reset-v7-ts-pu901) • [Video](https://www.youtube.com/watch?v=qmCLBjyPwVk)
  *
  * @param values - the entire form values to be reset
  * @param keepStateOptions - keep form state options

package/dist/useController.d.ts

@@ -3,7 +3,7 @@ import { FieldPath, FieldValues, UseControllerProps, UseControllerReturn } from
  * Custom hook to work with controlled component, this function provide you with both form and field level state. Re-render is isolated at the hook level.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/usecontroller) • [Demo](https://codesandbox.io/s/usecontroller-0o8px)
+ * [API](https://react-hook-form.com/docs/usecontroller) • [Demo](https://codesandbox.io/s/usecontroller-0o8px)
  *
  * @param props - the path name to the form field value, and validation rules.
  *

package/dist/useFieldArray.d.ts

@@ -3,7 +3,7 @@ import { FieldArrayPath, FieldValues, UseFieldArrayProps, UseFieldArrayReturn }
  * A custom hook that exposes convenient methods to perform operations with a list of dynamic inputs that need to be appended, updated, removed etc. • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn) • [Video](https://youtu.be/4MrbfGSFY2A)
  *
  * @remarks
- * [API](https://react-hook-form.com/api/usefieldarray) • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn)
+ * [API](https://react-hook-form.com/docs/usefieldarray) • [Demo](https://codesandbox.io/s/react-hook-form-usefieldarray-ssugn)
  *
  * @param props - useFieldArray props
  *

package/dist/useForm.d.ts

@@ -3,7 +3,7 @@ import { FieldValues, UseFormProps, UseFormReturn } from './types';
  * Custom hook to manage the entire form.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useform) • [Demo](https://codesandbox.io/s/react-hook-form-get-started-ts-5ksmm) • [Video](https://www.youtube.com/watch?v=RkXv4AXXC_4)
+ * [API](https://react-hook-form.com/docs/useform) • [Demo](https://codesandbox.io/s/react-hook-form-get-started-ts-5ksmm) • [Video](https://www.youtube.com/watch?v=RkXv4AXXC_4)
  *
  * @param props - form configuration and validation parameters.
  *

package/dist/useFormContext.d.ts

@@ -4,7 +4,7 @@ import { FieldValues, FormProviderProps, UseFormReturn } from './types';
  * This custom hook allows you to access the form context. useFormContext is intended to be used in deeply nested structures, where it would become inconvenient to pass the context as a prop. To be used with {@link FormProvider}.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
+ * [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
  *
  * @returns return all useForm methods
  *
@@ -35,7 +35,7 @@ export declare const useFormContext: <TFieldValues extends FieldValues, Transfor
  * A provider component that propagates the `useForm` methods to all children components via [React Context](https://reactjs.org/docs/context.html) API. To be used with {@link useFormContext}.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
+ * [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
  *
  * @param props - all useFrom methods
  *

package/dist/useFormState.d.ts

@@ -3,7 +3,7 @@ import { FieldValues, UseFormStateProps, UseFormStateReturn } from './types';
  * This custom hook allows you to subscribe to each form state, and isolate the re-render at the custom hook level. It has its scope in terms of form state subscription, so it would not affect other useFormState and useForm. Using this hook can reduce the re-render impact on large and complex form application.
  *
  * @remarks
- * [API](https://react-hook-form.com/api/useformstate) • [Demo](https://codesandbox.io/s/useformstate-75xly)
+ * [API](https://react-hook-form.com/docs/useformstate) • [Demo](https://codesandbox.io/s/useformstate-75xly)
  *
  * @param props - include options on specify fields to subscribe. {@link UseFormStateReturn}
  *

package/dist/useWatch.d.ts

@@ -4,7 +4,7 @@ import { Control, DeepPartialSkipArrayKey, FieldPath, FieldPathValue, FieldPathV
  *
  * @remarks
  *
- * [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
+ * [API](https://react-hook-form.com/docs/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
  *
  * @param props - defaultValue, disable subscription and match exact name.
  *
@@ -31,7 +31,7 @@ export declare function useWatch<TFieldValues extends FieldValues = FieldValues>
  *
  * @remarks
  *
- * [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
+ * [API](https://react-hook-form.com/docs/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
  *
  * @param props - defaultValue, disable subscription and match exact name.
  *
@@ -58,7 +58,7 @@ export declare function useWatch<TFieldValues extends FieldValues = FieldValues,
  *
  * @remarks
  *
- * [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
+ * [API](https://react-hook-form.com/docs/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
  *
  * @param props - defaultValue, disable subscription and match exact name.
  *
@@ -88,7 +88,7 @@ export declare function useWatch<TFieldValues extends FieldValues = FieldValues,
  *
  * @remarks
  *
- * [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
+ * [API](https://react-hook-form.com/docs/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e)
  *
  * @example
  * ```tsx

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-hook-form",
   "description": "Performant, flexible and extensible forms library for React Hooks",
-  "version": "7.44.2",
+  "version": "7.44.3-beta.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.mjs",
   "umd:main": "dist/index.umd.js",