From d39d73df162a2acc0eb476abdee24d936c4f4d4c Mon Sep 17 00:00:00 2001 From: Leonardo Montini Date: Sat, 10 Aug 2024 11:51:32 +0200 Subject: [PATCH] docs: sync reference to 0.29 (#896) --- .../reference/classes/tanstackfield.md | 26 ++--- .../angular/reference/functions/injectform.md | 2 +- .../reference/functions/injectstore.md | 2 +- .../classes/tanstackformcontroller.md | 10 +- .../react/reference/functions/field.md | 2 +- .../react/reference/functions/usefield.md | 2 +- .../react/reference/functions/useform.md | 4 +- .../react/reference/functions/usetransform.md | 26 +---- docs/framework/react/reference/index.md | 4 + .../reference/interfaces/reactformapi.md | 110 ++++++++++++++++++ .../reference/type-aliases/fieldcomponent.md | 2 +- .../react/reference/type-aliases/usefield.md | 2 +- .../solid/reference/functions/createfield.md | 2 +- .../solid/reference/functions/createform.md | 2 +- .../solid/reference/functions/field.md | 2 +- .../reference/type-aliases/createfield.md | 2 +- .../reference/type-aliases/fieldcomponent.md | 2 +- .../vue/reference/functions/field.md | 2 +- .../vue/reference/functions/usefield.md | 2 +- .../vue/reference/functions/useform.md | 2 +- .../reference/type-aliases/fieldcomponent.md | 2 +- .../vue/reference/type-aliases/usefield.md | 2 +- docs/reference/classes/fieldapi.md | 66 +++++++---- docs/reference/classes/formapi.md | 72 ++++++++---- docs/reference/functions/formoptions.md | 2 +- docs/reference/functions/mergeform.md | 2 +- docs/reference/interfaces/fieldapioptions.md | 16 +-- docs/reference/interfaces/fieldoptions.md | 14 +-- docs/reference/interfaces/fieldvalidators.md | 22 ++-- docs/reference/interfaces/formoptions.md | 18 +-- docs/reference/interfaces/formvalidators.md | 18 +-- docs/reference/type-aliases/deepkeys.md | 2 +- docs/reference/type-aliases/deepvalue.md | 2 +- docs/reference/type-aliases/fieldinfo.md | 2 +- docs/reference/type-aliases/fieldmeta.md | 2 +- docs/reference/type-aliases/fieldstate.md | 2 +- docs/reference/type-aliases/formstate.md | 2 +- docs/reference/type-aliases/updater.md | 2 +- docs/reference/type-aliases/updaterfn.md | 2 +- .../reference/type-aliases/validationerror.md | 2 +- docs/reference/type-aliases/validationmeta.md | 2 +- 41 files changed, 300 insertions(+), 162 deletions(-) create mode 100644 docs/framework/react/reference/interfaces/reactformapi.md diff --git a/docs/framework/angular/reference/classes/tanstackfield.md b/docs/framework/angular/reference/classes/tanstackfield.md index 2a8aa2149..1a0fc97c1 100644 --- a/docs/framework/angular/reference/classes/tanstackfield.md +++ b/docs/framework/angular/reference/classes/tanstackfield.md @@ -46,7 +46,7 @@ api: FieldApi; #### Defined in -[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L61) +[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L61) *** @@ -64,7 +64,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L50) +[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L50) *** @@ -82,7 +82,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L49) +[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L49) *** @@ -100,7 +100,7 @@ An optional object with default metadata for the field. #### Defined in -[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L59) +[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L59) *** @@ -118,7 +118,7 @@ An optional default value for the field. #### Defined in -[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L48) +[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L48) *** @@ -136,7 +136,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L44) +[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L44) *** @@ -148,7 +148,7 @@ tanstackField: FormApi; #### Defined in -[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L52) +[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L52) *** @@ -164,7 +164,7 @@ optional unmount: () => void; #### Defined in -[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L76) +[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L76) *** @@ -182,7 +182,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L51) +[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L51) *** @@ -200,7 +200,7 @@ A list of validators to pass to the field #### Defined in -[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L56) +[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L56) ## Methods @@ -225,7 +225,7 @@ children are checked. #### Defined in -[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L88) +[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L88) *** @@ -248,7 +248,7 @@ before a directive, pipe, or service instance is destroyed. #### Defined in -[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L84) +[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L84) *** @@ -274,4 +274,4 @@ It is invoked only once when the directive is instantiated. #### Defined in -[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L78) +[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/tanstack-field.directive.ts#L78) diff --git a/docs/framework/angular/reference/functions/injectform.md b/docs/framework/angular/reference/functions/injectform.md index 6b714cdf6..c1f5fb5df 100644 --- a/docs/framework/angular/reference/functions/injectform.md +++ b/docs/framework/angular/reference/functions/injectform.md @@ -25,4 +25,4 @@ function injectForm(opts?): FormApi(form, selector?): Sig ## Defined in -[inject-store.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/inject-store.ts#L4) +[inject-store.ts:4](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/angular-form/src/inject-store.ts#L4) diff --git a/docs/framework/lit/reference/classes/tanstackformcontroller.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md index 817d8d938..2dc8d2f6f 100644 --- a/docs/framework/lit/reference/classes/tanstackformcontroller.md +++ b/docs/framework/lit/reference/classes/tanstackformcontroller.md @@ -35,7 +35,7 @@ new TanStackFormController(host, config?): TanStack #### Defined in -[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/lit-form/src/tanstack-form-controller.ts#L93) +[tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/lit-form/src/tanstack-form-controller.ts#L93) ## Properties @@ -47,7 +47,7 @@ api: FormApi; #### Defined in -[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/lit-form/src/tanstack-form-controller.ts#L91) +[tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/lit-form/src/tanstack-form-controller.ts#L91) ## Methods @@ -101,7 +101,7 @@ render: renderCallback & `ReactFormApi`\<`TFormData`, `TFormValidator`\> +`FormApi`\<`TFormData`, `TFormValidator`\> & [`ReactFormApi`](../interfaces/reactformapi.md)\<`TFormData`, `TFormValidator`\> ## Defined in -[useForm.tsx:56](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useForm.tsx#L56) +[useForm.tsx:56](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useForm.tsx#L56) diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md index de885f556..25b1891c2 100644 --- a/docs/framework/react/reference/functions/usetransform.md +++ b/docs/framework/react/reference/functions/usetransform.md @@ -6,7 +6,7 @@ title: useTransform # Function: useTransform() ```ts -function useTransform(fn, deps): object +function useTransform(fn, deps): FormTransform ``` ## Type Parameters @@ -23,28 +23,8 @@ function useTransform(fn, deps): object ## Returns -`object` - -### deps - -```ts -deps: unknown[]; -``` - -### fn() - -```ts -fn: (formBase) => FormApi; -``` - -#### Parameters - -• **formBase**: `FormApi`\<`any`, `any`\> - -#### Returns - -`FormApi`\<`TFormData`, `TFormValidator`\> +`FormTransform`\<`TFormData`, `TFormValidator`\> ## Defined in -[useTransform.ts:3](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useTransform.ts#L3) +[useTransform.ts:3](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useTransform.ts#L3) diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 5c67153e1..9476d97f2 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -5,6 +5,10 @@ title: "@tanstack/react-form" # @tanstack/react-form +## Interfaces + +- [ReactFormApi](interfaces/reactformapi.md) + ## Type Aliases - [FieldComponent](type-aliases/fieldcomponent.md) diff --git a/docs/framework/react/reference/interfaces/reactformapi.md b/docs/framework/react/reference/interfaces/reactformapi.md new file mode 100644 index 000000000..e71ee8308 --- /dev/null +++ b/docs/framework/react/reference/interfaces/reactformapi.md @@ -0,0 +1,110 @@ +--- +id: ReactFormApi +title: ReactFormApi +--- + +# Interface: ReactFormApi\ + +Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm` + +## Type Parameters + +• **TFormData** + +• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` + +## Properties + +### Field + +```ts +Field: FieldComponent; +``` + +A React component to render form fields. With this, you can render and manage individual form fields. + +#### Defined in + +[useForm.tsx:20](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useForm.tsx#L20) + +*** + +### Subscribe() + +```ts +Subscribe: (props) => ReactNode; +``` + +A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates. + +#### Type Parameters + +• **TSelected** = `FormState`\<`TFormData`\> + +#### Parameters + +• **props** + +• **props.children**: `ReactNode` \| (`state`) => `ReactNode` + +• **props.selector?** + +TypeScript versions <=5.0.4 have a bug that prevents +the type of the `TSelected` generic from being inferred +from the return type of this method. + +In these versions, `TSelected` will fall back to the default +type (or `unknown` if that's not defined). + +**See** + + - [This discussion on GitHub for the details](https://github.com/TanStack/form/pull/606/files#r1506715714) + - [The bug report in `microsoft/TypeScript`](https://github.com/microsoft/TypeScript/issues/52786) + +#### Returns + +`ReactNode` + +#### Defined in + +[useForm.tsx:34](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useForm.tsx#L34) + +*** + +### useField + +```ts +useField: UseField; +``` + +A custom React hook that provides functionalities related to individual form fields. It gives you access to field values, errors, and allows you to set or update field values. + +#### Defined in + +[useForm.tsx:24](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useForm.tsx#L24) + +*** + +### useStore() + +```ts +useStore: (selector?) => TSelected; +``` + +A `useStore` hook that connects to the internal store of the form. It can be used to access the form's current state or any other related state information. You can optionally pass in a selector function to cherry-pick specific parts of the state + +#### Type Parameters + +• **TSelected** = `FormState`\<`TFormData`\> + +#### Parameters + +• **selector?** + +#### Returns + +`TSelected` + +#### Defined in + +[useForm.tsx:28](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useForm.tsx#L28) diff --git a/docs/framework/react/reference/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md index d76778e89..a7146a7a8 100644 --- a/docs/framework/react/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/react/reference/type-aliases/fieldcomponent.md @@ -41,4 +41,4 @@ A type alias representing a field component for a specific form data type. ## Defined in -[useField.tsx:133](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useField.tsx#L133) +[useField.tsx:133](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useField.tsx#L133) diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md index a4cf02e60..e339a4f6a 100644 --- a/docs/framework/react/reference/type-aliases/usefield.md +++ b/docs/framework/react/reference/type-aliases/usefield.md @@ -37,4 +37,4 @@ A function that takes an optional object with a `name` property and field option ## Defined in -[useField.tsx:25](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/react-form/src/useField.tsx#L25) +[useField.tsx:25](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/react-form/src/useField.tsx#L25) diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md index f1b7c58ce..44a69b9c5 100644 --- a/docs/framework/solid/reference/functions/createfield.md +++ b/docs/framework/solid/reference/functions/createfield.md @@ -35,4 +35,4 @@ function createField ## Defined in -[createField.tsx:87](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L87) +[createField.tsx:87](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/solid-form/src/createField.tsx#L87) diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md index 181f6a8a3..9d0898401 100644 --- a/docs/framework/solid/reference/functions/createform.md +++ b/docs/framework/solid/reference/functions/createform.md @@ -25,4 +25,4 @@ function createForm(opts?): FormApi(props ## Defined in -[createField.tsx:185](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L185) +[createField.tsx:185](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/solid-form/src/createField.tsx#L185) diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md index 3edb2b360..63efe46f9 100644 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -37,4 +37,4 @@ type CreateField: (o ## Defined in -[createField.tsx:29](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/solid-form/src/createField.tsx#L29) +[createField.tsx:29](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/solid-form/src/createField.tsx#L29) diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md index c349bf0c7..0c1cf516a 100644 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -39,4 +39,4 @@ type FieldComponent: (props ## Defined in -[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/vue-form/src/useField.tsx#L162) +[packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/vue-form/src/useField.tsx#L162) diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md index 43c82ee5c..3103672da 100644 --- a/docs/framework/vue/reference/functions/usefield.md +++ b/docs/framework/vue/reference/functions/usefield.md @@ -43,4 +43,4 @@ readonly state: Readonly>> = fieldState; ## Defined in -[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/vue-form/src/useField.tsx#L49) +[packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/vue-form/src/useField.tsx#L49) diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md index b9abe0ea8..4bfc6ad4e 100644 --- a/docs/framework/vue/reference/functions/useform.md +++ b/docs/framework/vue/reference/functions/useform.md @@ -25,4 +25,4 @@ function useForm(opts?): FormApi: (field): void #### Defined in -[packages/form-core/src/FormApi.ts:925](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L925) +[packages/form-core/src/FormApi.ts:927](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L927) *** @@ -147,7 +147,7 @@ Gets the field info of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:843](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L843) +[packages/form-core/src/FormApi.ts:845](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L845) *** @@ -173,7 +173,7 @@ Gets the metadata of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:834](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L834) +[packages/form-core/src/FormApi.ts:836](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L836) *** @@ -199,7 +199,7 @@ Gets the value of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:827](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L827) +[packages/form-core/src/FormApi.ts:829](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L829) *** @@ -217,7 +217,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu #### Defined in -[packages/form-core/src/FormApi.ts:767](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L767) +[packages/form-core/src/FormApi.ts:769](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L769) *** @@ -253,7 +253,7 @@ Inserts a value into an array field at the specified index, shifting the subsequ #### Defined in -[packages/form-core/src/FormApi.ts:957](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L957) +[packages/form-core/src/FormApi.ts:959](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L959) *** @@ -269,7 +269,7 @@ mount(): void #### Defined in -[packages/form-core/src/FormApi.ts:443](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L443) +[packages/form-core/src/FormApi.ts:445](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L445) *** @@ -305,7 +305,7 @@ Moves the value at the first specified index to the second specified index withi #### Defined in -[packages/form-core/src/FormApi.ts:1075](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1075) +[packages/form-core/src/FormApi.ts:1077](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L1077) *** @@ -338,7 +338,7 @@ Pushes a value into an array field. #### Defined in -[packages/form-core/src/FormApi.ts:939](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L939) +[packages/form-core/src/FormApi.ts:941](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L941) *** @@ -371,7 +371,7 @@ Removes a value from an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:1010](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1010) +[packages/form-core/src/FormApi.ts:1012](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L1012) *** @@ -407,7 +407,7 @@ Replaces a value into an array field at the specified index. #### Defined in -[packages/form-core/src/FormApi.ts:984](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L984) +[packages/form-core/src/FormApi.ts:986](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L986) *** @@ -425,7 +425,7 @@ Resets the form state to the default values. #### Defined in -[packages/form-core/src/FormApi.ts:505](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L505) +[packages/form-core/src/FormApi.ts:507](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L507) *** @@ -449,7 +449,29 @@ resetFieldMeta(fieldMeta): Record #### Defined in -[packages/form-core/src/FormApi.ts:877](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L877) +[packages/form-core/src/FormApi.ts:879](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L879) + +*** + +### setErrorMap() + +```ts +setErrorMap(errorMap): void +``` + +Updates the form's errorMap + +#### Parameters + +• **errorMap**: `ValidationErrorMap` + +#### Returns + +`void` + +#### Defined in + +[packages/form-core/src/FormApi.ts:1101](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L1101) *** @@ -477,7 +499,7 @@ Updates the metadata of the specified field. #### Defined in -[packages/form-core/src/FormApi.ts:862](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L862) +[packages/form-core/src/FormApi.ts:864](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L864) *** @@ -510,7 +532,7 @@ Sets the value of the specified field and optionally updates the touched state. #### Defined in -[packages/form-core/src/FormApi.ts:900](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L900) +[packages/form-core/src/FormApi.ts:902](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L902) *** @@ -546,7 +568,7 @@ Swaps the values at the specified indices within an array field. #### Defined in -[packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L1049) +[packages/form-core/src/FormApi.ts:1051](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L1051) *** @@ -568,7 +590,7 @@ Updates the form options and form state. #### Defined in -[packages/form-core/src/FormApi.ts:465](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L465) +[packages/form-core/src/FormApi.ts:467](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L467) *** @@ -590,7 +612,7 @@ Validates all fields in the form using the correct handlers for a given validati #### Defined in -[packages/form-core/src/FormApi.ts:520](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L520) +[packages/form-core/src/FormApi.ts:522](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L522) *** @@ -623,7 +645,7 @@ Validates the children of a specified array in the form starting from a given in #### Defined in -[packages/form-core/src/FormApi.ts:547](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L547) +[packages/form-core/src/FormApi.ts:549](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L549) *** @@ -651,4 +673,4 @@ Validates a specified field in the form using the correct handlers for a given v #### Defined in -[packages/form-core/src/FormApi.ts:586](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L586) +[packages/form-core/src/FormApi.ts:588](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L588) diff --git a/docs/reference/functions/formoptions.md b/docs/reference/functions/formoptions.md index 124dbee00..cf00224b8 100644 --- a/docs/reference/functions/formoptions.md +++ b/docs/reference/functions/formoptions.md @@ -25,4 +25,4 @@ function formOptions(defaultOpts?): undefined | FormO ## Defined in -[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/formOptions.ts#L4) +[packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/formOptions.ts#L4) diff --git a/docs/reference/functions/mergeform.md b/docs/reference/functions/mergeform.md index 3bc4ae86c..c3763b99a 100644 --- a/docs/reference/functions/mergeform.md +++ b/docs/reference/functions/mergeform.md @@ -27,4 +27,4 @@ function mergeForm(baseForm, state): FormApi; #### Defined in -[packages/form-core/src/FieldApi.ts:325](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L325) +[packages/form-core/src/FieldApi.ts:327](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L327) *** @@ -123,7 +123,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:274](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L274) *** @@ -141,7 +141,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:290](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L290) *** @@ -159,4 +159,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:294](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L294) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md index ad3fe3916..cd13e7c74 100644 --- a/docs/reference/interfaces/fieldoptions.md +++ b/docs/reference/interfaces/fieldoptions.md @@ -35,7 +35,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Defined in -[packages/form-core/src/FieldApi.ts:284](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L284) +[packages/form-core/src/FieldApi.ts:286](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L286) *** @@ -49,7 +49,7 @@ The default time to debounce async validation if there is not a more specific de #### Defined in -[packages/form-core/src/FieldApi.ts:280](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L280) +[packages/form-core/src/FieldApi.ts:282](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L282) *** @@ -63,7 +63,7 @@ An optional object with default metadata for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:302](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L302) +[packages/form-core/src/FieldApi.ts:304](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L304) *** @@ -77,7 +77,7 @@ An optional default value for the field. #### Defined in -[packages/form-core/src/FieldApi.ts:276](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L276) +[packages/form-core/src/FieldApi.ts:278](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L278) *** @@ -91,7 +91,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Defined in -[packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L272) +[packages/form-core/src/FieldApi.ts:274](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L274) *** @@ -105,7 +105,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo #### Defined in -[packages/form-core/src/FieldApi.ts:288](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L288) +[packages/form-core/src/FieldApi.ts:290](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L290) *** @@ -119,4 +119,4 @@ A list of validators to pass to the field #### Defined in -[packages/form-core/src/FieldApi.ts:292](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L292) +[packages/form-core/src/FieldApi.ts:294](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L294) diff --git a/docs/reference/interfaces/fieldvalidators.md b/docs/reference/interfaces/fieldvalidators.md index 7e6188403..92fcad086 100644 --- a/docs/reference/interfaces/fieldvalidators.md +++ b/docs/reference/interfaces/fieldvalidators.md @@ -36,7 +36,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:196](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L196) +[packages/form-core/src/FieldApi.ts:198](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L198) *** @@ -57,7 +57,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:209](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L209) +[packages/form-core/src/FieldApi.ts:211](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L211) *** @@ -73,7 +73,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:222](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L222) +[packages/form-core/src/FieldApi.ts:224](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L224) *** @@ -87,7 +87,7 @@ An optional list of field names that should trigger this field's `onBlur` and `o #### Defined in -[packages/form-core/src/FieldApi.ts:226](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L226) +[packages/form-core/src/FieldApi.ts:228](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L228) *** @@ -108,7 +108,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:160](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L160) +[packages/form-core/src/FieldApi.ts:162](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L162) *** @@ -129,7 +129,7 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:173](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L173) +[packages/form-core/src/FieldApi.ts:175](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L175) *** @@ -145,7 +145,7 @@ If set to a number larger than 0, will debounce the async validation event by th #### Defined in -[packages/form-core/src/FieldApi.ts:185](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L185) +[packages/form-core/src/FieldApi.ts:187](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L187) *** @@ -159,7 +159,7 @@ An optional list of field names that should trigger this field's `onChange` and #### Defined in -[packages/form-core/src/FieldApi.ts:189](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L189) +[packages/form-core/src/FieldApi.ts:191](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L191) *** @@ -173,7 +173,7 @@ An optional function that takes a param of `formApi` which is a generic type of #### Defined in -[packages/form-core/src/FieldApi.ts:147](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L147) +[packages/form-core/src/FieldApi.ts:149](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L149) *** @@ -194,7 +194,7 @@ If `validatorAdapter` is passed, this may also accept a property from the respec #### Defined in -[packages/form-core/src/FieldApi.ts:233](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L233) +[packages/form-core/src/FieldApi.ts:235](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L235) *** @@ -215,4 +215,4 @@ is passed, this may also accept a property from the respective adapter #### Defined in -[packages/form-core/src/FieldApi.ts:246](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L246) +[packages/form-core/src/FieldApi.ts:248](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L248) diff --git a/docs/reference/interfaces/formoptions.md b/docs/reference/interfaces/formoptions.md index acdb97717..8c93f3935 100644 --- a/docs/reference/interfaces/formoptions.md +++ b/docs/reference/interfaces/formoptions.md @@ -25,7 +25,7 @@ If true, always run async validation, even when sync validation has produced an #### Defined in -[packages/form-core/src/FormApi.ts:133](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L133) +[packages/form-core/src/FormApi.ts:135](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L135) *** @@ -39,7 +39,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off #### Defined in -[packages/form-core/src/FormApi.ts:137](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L137) +[packages/form-core/src/FormApi.ts:139](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L139) *** @@ -53,7 +53,7 @@ The default state for the form. #### Defined in -[packages/form-core/src/FormApi.ts:129](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L129) +[packages/form-core/src/FormApi.ts:131](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L131) *** @@ -67,7 +67,7 @@ Set initial values for your form. #### Defined in -[packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L125) +[packages/form-core/src/FormApi.ts:127](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L127) *** @@ -93,7 +93,7 @@ A function to be called when the form is submitted, what should happen once the #### Defined in -[packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L149) +[packages/form-core/src/FormApi.ts:151](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L151) *** @@ -119,7 +119,7 @@ Specify an action for scenarios where the user tries to submit an invalid form. #### Defined in -[packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L156) +[packages/form-core/src/FormApi.ts:158](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L158) *** @@ -131,7 +131,7 @@ optional transform: FormTransform; #### Defined in -[packages/form-core/src/FormApi.ts:160](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L160) +[packages/form-core/src/FormApi.ts:162](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L162) *** @@ -145,7 +145,7 @@ A validator adapter to support usage of extra validation types (IE: Zod, Yup, or #### Defined in -[packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L141) +[packages/form-core/src/FormApi.ts:143](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L143) *** @@ -159,4 +159,4 @@ A list of validators to pass to the form #### Defined in -[packages/form-core/src/FormApi.ts:145](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L145) +[packages/form-core/src/FormApi.ts:147](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L147) diff --git a/docs/reference/interfaces/formvalidators.md b/docs/reference/interfaces/formvalidators.md index fdda37c59..fedaca8a1 100644 --- a/docs/reference/interfaces/formvalidators.md +++ b/docs/reference/interfaces/formvalidators.md @@ -23,7 +23,7 @@ Optional function that validates the form data when a field loses focus, returns #### Defined in -[packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L89) +[packages/form-core/src/FormApi.ts:91](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L91) *** @@ -37,7 +37,7 @@ Optional onBlur asynchronous validation method for when a field loses focus retu #### Defined in -[packages/form-core/src/FormApi.ts:93](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L93) +[packages/form-core/src/FormApi.ts:95](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L95) *** @@ -51,7 +51,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:97](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L97) +[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L99) *** @@ -65,7 +65,7 @@ Optional function that checks the validity of your data whenever a value changes #### Defined in -[packages/form-core/src/FormApi.ts:77](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L77) +[packages/form-core/src/FormApi.ts:79](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L79) *** @@ -79,7 +79,7 @@ Optional onChange asynchronous counterpart to onChange. Useful for more complex #### Defined in -[packages/form-core/src/FormApi.ts:81](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L81) +[packages/form-core/src/FormApi.ts:83](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L83) *** @@ -93,7 +93,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb #### Defined in -[packages/form-core/src/FormApi.ts:85](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L85) +[packages/form-core/src/FormApi.ts:87](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L87) *** @@ -107,7 +107,7 @@ Optional function that fires as soon as the component mounts. #### Defined in -[packages/form-core/src/FormApi.ts:73](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L73) +[packages/form-core/src/FormApi.ts:75](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L75) *** @@ -119,7 +119,7 @@ optional onSubmit: FormValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L98) +[packages/form-core/src/FormApi.ts:100](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L100) *** @@ -131,4 +131,4 @@ optional onSubmitAsync: FormAsyncValidateOrFn; #### Defined in -[packages/form-core/src/FormApi.ts:99](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L99) +[packages/form-core/src/FormApi.ts:101](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L101) diff --git a/docs/reference/type-aliases/deepkeys.md b/docs/reference/type-aliases/deepkeys.md index dad50d909..9d90b5355 100644 --- a/docs/reference/type-aliases/deepkeys.md +++ b/docs/reference/type-aliases/deepkeys.md @@ -19,4 +19,4 @@ The keys of an object or array, deeply nested. ## Defined in -[packages/form-core/src/util-types.ts:85](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/util-types.ts#L85) +[packages/form-core/src/util-types.ts:85](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/util-types.ts#L85) diff --git a/docs/reference/type-aliases/deepvalue.md b/docs/reference/type-aliases/deepvalue.md index b45a42306..a7b52d03d 100644 --- a/docs/reference/type-aliases/deepvalue.md +++ b/docs/reference/type-aliases/deepvalue.md @@ -21,4 +21,4 @@ Infer the type of a deeply nested property within an object or an array. ## Defined in -[packages/form-core/src/util-types.ts:109](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/util-types.ts#L109) +[packages/form-core/src/util-types.ts:109](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/util-types.ts#L109) diff --git a/docs/reference/type-aliases/fieldinfo.md b/docs/reference/type-aliases/fieldinfo.md index 91c04fac2..2cfdf5657 100644 --- a/docs/reference/type-aliases/fieldinfo.md +++ b/docs/reference/type-aliases/fieldinfo.md @@ -37,4 +37,4 @@ A record of field validation internal handling. ## Defined in -[packages/form-core/src/FormApi.ts:176](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L176) +[packages/form-core/src/FormApi.ts:178](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L178) diff --git a/docs/reference/type-aliases/fieldmeta.md b/docs/reference/type-aliases/fieldmeta.md index 47498dd7a..8e1e89d34 100644 --- a/docs/reference/type-aliases/fieldmeta.md +++ b/docs/reference/type-aliases/fieldmeta.md @@ -63,4 +63,4 @@ A flag indicating whether the field is currently being validated. ## Defined in -[packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L331) +[packages/form-core/src/FieldApi.ts:333](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L333) diff --git a/docs/reference/type-aliases/fieldstate.md b/docs/reference/type-aliases/fieldstate.md index 0a013c9ef..0e45044e0 100644 --- a/docs/reference/type-aliases/fieldstate.md +++ b/docs/reference/type-aliases/fieldstate.md @@ -35,4 +35,4 @@ The current value of the field. ## Defined in -[packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FieldApi.ts#L361) +[packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FieldApi.ts#L363) diff --git a/docs/reference/type-aliases/formstate.md b/docs/reference/type-aliases/formstate.md index d1407bc95..3dcff3dcf 100644 --- a/docs/reference/type-aliases/formstate.md +++ b/docs/reference/type-aliases/formstate.md @@ -163,4 +163,4 @@ The current values of the form fields. ## Defined in -[packages/form-core/src/FormApi.ts:198](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L198) +[packages/form-core/src/FormApi.ts:200](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L200) diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md index 0e7a1211d..625622c50 100644 --- a/docs/reference/type-aliases/updater.md +++ b/docs/reference/type-aliases/updater.md @@ -17,4 +17,4 @@ type Updater: TOutput | UpdaterFn; ## Defined in -[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/utils.ts#L7) +[packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/utils.ts#L7) diff --git a/docs/reference/type-aliases/updaterfn.md b/docs/reference/type-aliases/updaterfn.md index 1444edf8b..14f10b728 100644 --- a/docs/reference/type-aliases/updaterfn.md +++ b/docs/reference/type-aliases/updaterfn.md @@ -25,4 +25,4 @@ type UpdaterFn: (input) => TOutput; ## Defined in -[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/utils.ts#L5) +[packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/utils.ts#L5) diff --git a/docs/reference/type-aliases/validationerror.md b/docs/reference/type-aliases/validationerror.md index 9688add73..a0ab74bd6 100644 --- a/docs/reference/type-aliases/validationerror.md +++ b/docs/reference/type-aliases/validationerror.md @@ -11,4 +11,4 @@ type ValidationError: undefined | false | null | string; ## Defined in -[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/types.ts#L1) +[packages/form-core/src/types.ts:1](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/types.ts#L1) diff --git a/docs/reference/type-aliases/validationmeta.md b/docs/reference/type-aliases/validationmeta.md index 77eb94590..fa15b386b 100644 --- a/docs/reference/type-aliases/validationmeta.md +++ b/docs/reference/type-aliases/validationmeta.md @@ -23,4 +23,4 @@ An abort controller stored in memory to cancel previous async validation attempt ## Defined in -[packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/form-core/src/FormApi.ts#L166) +[packages/form-core/src/FormApi.ts:168](https://github.com/TanStack/form/blob/782e82ea1fb36627b62d0f588484b4a9c3249fed/packages/form-core/src/FormApi.ts#L168)