diff --git a/docs/framework/angular/guides/basic-concepts.md b/docs/framework/angular/guides/basic-concepts.md index 3774692a1..4d777ded3 100644 --- a/docs/framework/angular/guides/basic-concepts.md +++ b/docs/framework/angular/guides/basic-concepts.md @@ -259,7 +259,7 @@ onCountryChange: FieldListenerFn = ({ } ``` -More information can be found at [Listeners](../listeners.md) +More information can be found at [Listeners](./listeners.md) ## Array Fields diff --git a/docs/framework/angular/guides/submission-handling.md b/docs/framework/angular/guides/submission-handling.md index 4f503f0cd..e5fae2477 100644 --- a/docs/framework/angular/guides/submission-handling.md +++ b/docs/framework/angular/guides/submission-handling.md @@ -65,7 +65,7 @@ export class AppComponent { ## Transforming data with Standard Schemas -While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data. +While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data. The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function: diff --git a/docs/framework/angular/guides/validation.md b/docs/framework/angular/guides/validation.md index 9e9ee6afa..85e676587 100644 --- a/docs/framework/angular/guides/validation.md +++ b/docs/framework/angular/guides/validation.md @@ -554,7 +554,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe _Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet. -> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information. +> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information. To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function: diff --git a/docs/framework/angular/reference/classes/TanStackAppField.md b/docs/framework/angular/reference/classes/TanStackAppField.md index bb731eadc..0569bd1bc 100644 --- a/docs/framework/angular/reference/classes/TanStackAppField.md +++ b/docs/framework/angular/reference/classes/TanStackAppField.md @@ -9,7 +9,7 @@ Defined in: [app-field.ts:20](https://github.com/TanStack/form/blob/main/package ## Extends -- [`TanStackField`](../TanStackField.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> +- [`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> ## Type Parameters @@ -121,7 +121,7 @@ Defined in: [app-field.ts:79](https://github.com/TanStack/form/blob/main/package #### Overrides -[`TanStackField`](../TanStackField.md).[`constructor`](../TanStackField.md#constructor) +[`TanStackField`](TanStackField.md).[`constructor`](TanStackField.md#constructor) ## Properties @@ -135,7 +135,7 @@ Defined in: [tanstack-field.ts:151](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`_api`](../TanStackField.md#_api) +[`TanStackField`](TanStackField.md).[`_api`](TanStackField.md#_api) *** @@ -149,7 +149,7 @@ Defined in: [tanstack-field.ts:76](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`asyncAlways`](../TanStackField.md#asyncalways) +[`TanStackField`](TanStackField.md).[`asyncAlways`](TanStackField.md#asyncalways) *** @@ -163,7 +163,7 @@ Defined in: [tanstack-field.ts:73](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`asyncDebounceMs`](../TanStackField.md#asyncdebouncems) +[`TanStackField`](TanStackField.md).[`asyncDebounceMs`](TanStackField.md#asyncdebouncems) *** @@ -187,7 +187,7 @@ Defined in: [tanstack-field.ts:238](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`cd`](../TanStackField.md#cd) +[`TanStackField`](TanStackField.md).[`cd`](TanStackField.md#cd) *** @@ -203,7 +203,7 @@ Defined in: [tanstack-field.ts:118](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`defaultMeta`](../TanStackField.md#defaultmeta) +[`TanStackField`](TanStackField.md).[`defaultMeta`](TanStackField.md#defaultmeta) *** @@ -217,7 +217,7 @@ Defined in: [tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`defaultValue`](../TanStackField.md#defaultvalue) +[`TanStackField`](TanStackField.md).[`defaultValue`](TanStackField.md#defaultvalue) *** @@ -231,7 +231,7 @@ Defined in: [tanstack-field.ts:149](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`disableErrorFlat`](../TanStackField.md#disableerrorflat) +[`TanStackField`](TanStackField.md).[`disableErrorFlat`](TanStackField.md#disableerrorflat) *** @@ -245,7 +245,7 @@ Defined in: [tanstack-field.ts:222](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`injector`](../TanStackField.md#injector) +[`TanStackField`](TanStackField.md).[`injector`](TanStackField.md#injector) *** @@ -261,7 +261,7 @@ Defined in: [tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`listeners`](../TanStackField.md#listeners) +[`TanStackField`](TanStackField.md).[`listeners`](TanStackField.md#listeners) *** @@ -275,7 +275,7 @@ Defined in: [tanstack-field.ts:147](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`mode`](../TanStackField.md#mode) +[`TanStackField`](TanStackField.md).[`mode`](TanStackField.md#mode) *** @@ -289,7 +289,7 @@ Defined in: [tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`name`](../TanStackField.md#name) +[`TanStackField`](TanStackField.md).[`name`](TanStackField.md#name) *** @@ -303,7 +303,7 @@ Defined in: [tanstack-field.ts:183](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`options`](../TanStackField.md#options) +[`TanStackField`](TanStackField.md).[`options`](TanStackField.md#options) *** @@ -317,7 +317,7 @@ Defined in: [tanstack-field.ts:79](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`tanstackField`](../TanStackField.md#tanstackfield) +[`TanStackField`](TanStackField.md).[`tanstackField`](TanStackField.md#tanstackfield) *** @@ -333,7 +333,7 @@ Defined in: [tanstack-field.ts:97](https://github.com/TanStack/form/blob/main/pa #### Inherited from -[`TanStackField`](../TanStackField.md).[`validators`](../TanStackField.md#validators) +[`TanStackField`](TanStackField.md).[`validators`](TanStackField.md#validators) ## Accessors @@ -353,7 +353,7 @@ Defined in: [tanstack-field.ts:155](https://github.com/TanStack/form/blob/main/p #### Inherited from -[`TanStackField`](../TanStackField.md).[`api`](../TanStackField.md#api) +[`TanStackField`](TanStackField.md).[`api`](TanStackField.md#api) ## Methods @@ -377,4 +377,4 @@ It is invoked only once when the directive is instantiated. #### Inherited from -[`TanStackField`](../TanStackField.md).[`ngOnInit`](../TanStackField.md#ngoninit) +[`TanStackField`](TanStackField.md).[`ngOnInit`](TanStackField.md#ngoninit) diff --git a/docs/framework/angular/reference/classes/TanStackField.md b/docs/framework/angular/reference/classes/TanStackField.md index 8a7532c93..86d0e7e72 100644 --- a/docs/framework/angular/reference/classes/TanStackField.md +++ b/docs/framework/angular/reference/classes/TanStackField.md @@ -9,7 +9,7 @@ Defined in: [tanstack-field.ts:37](https://github.com/TanStack/form/blob/main/pa ## Extended by -- [`TanStackAppField`](../TanStackAppField.md) +- [`TanStackAppField`](TanStackAppField.md) ## Type Parameters diff --git a/docs/framework/angular/reference/functions/injectField.md b/docs/framework/angular/reference/functions/injectField.md index 8999b428b..5fa3aadf5 100644 --- a/docs/framework/angular/reference/functions/injectField.md +++ b/docs/framework/angular/reference/functions/injectField.md @@ -19,4 +19,4 @@ Defined in: [injectable.ts:39](https://github.com/TanStack/form/blob/main/packag ## Returns -[`TanStackFieldInjectable`](../../classes/TanStackFieldInjectable.md)\<`T`\> +[`TanStackFieldInjectable`](../classes/TanStackFieldInjectable.md)\<`T`\> diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index c56b414cc..c439082a3 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -7,12 +7,12 @@ title: "@tanstack/angular-form" ## Classes -- [TanStackAppField](../classes/TanStackAppField.md) -- [TanStackField](../classes/TanStackField.md) -- [TanStackFieldInjectable](../classes/TanStackFieldInjectable.md) +- [TanStackAppField](classes/TanStackAppField.md) +- [TanStackField](classes/TanStackField.md) +- [TanStackFieldInjectable](classes/TanStackFieldInjectable.md) ## Functions -- [injectField](../functions/injectField.md) -- [injectForm](../functions/injectForm.md) -- [injectStore](../functions/injectStore.md) +- [injectField](functions/injectField.md) +- [injectForm](functions/injectForm.md) +- [injectStore](functions/injectStore.md) diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md index 81a403174..2d1f38948 100644 --- a/docs/framework/lit/reference/index.md +++ b/docs/framework/lit/reference/index.md @@ -7,4 +7,4 @@ title: "@tanstack/lit-form" ## Classes -- [TanStackFormController](../classes/TanStackFormController.md) +- [TanStackFormController](classes/TanStackFormController.md) diff --git a/docs/framework/react/guides/basic-concepts.md b/docs/framework/react/guides/basic-concepts.md index 1992a3586..9e343aded 100644 --- a/docs/framework/react/guides/basic-concepts.md +++ b/docs/framework/react/guides/basic-concepts.md @@ -284,7 +284,7 @@ Example: /> ``` -More information can be found at [Listeners](../listeners.md) +More information can be found at [Listeners](./listeners.md) ## Array Fields diff --git a/docs/framework/react/guides/focus-management.md b/docs/framework/react/guides/focus-management.md index 78319bf1b..6e1a26196 100644 --- a/docs/framework/react/guides/focus-management.md +++ b/docs/framework/react/guides/focus-management.md @@ -5,7 +5,7 @@ title: Focus Management In some instances, you may want to focus the first input with an error. -[Because TanStack Form intentionally does not have insights into your markup](../../../../philosophy.md), we cannot add a built-in focus management feature. +[Because TanStack Form intentionally does not have insights into your markup](../../../philosophy.md), we cannot add a built-in focus management feature. However, you can easily add this feature into your application without this hypothetical built-in feature. diff --git a/docs/framework/react/guides/form-composition.md b/docs/framework/react/guides/form-composition.md index 593b11d3c..f30102237 100644 --- a/docs/framework/react/guides/form-composition.md +++ b/docs/framework/react/guides/form-composition.md @@ -250,7 +250,7 @@ const ChildForm = withForm({ ## Reusing groups of fields in multiple forms -Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](../linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component. +Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](./linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component. > Unlike `withForm`, validators cannot be specified and could be any value. > Ensure that your fields can accept unknown error types. diff --git a/docs/framework/react/guides/reactivity.md b/docs/framework/react/guides/reactivity.md index fd3b21441..479facf44 100644 --- a/docs/framework/react/guides/reactivity.md +++ b/docs/framework/react/guides/reactivity.md @@ -9,7 +9,7 @@ If you would like to access reactive values, you will need to subscribe to them Some uses for these subscriptions are rendering up-to-date field values, determining what to render based on a condition, or using field values inside the logic of your component. -> For situations where you want to "react" to triggers, check out the [listener](../listeners.md) API. +> For situations where you want to "react" to triggers, check out the [listener](./listeners.md) API. ## useStore diff --git a/docs/framework/react/guides/ssr.md b/docs/framework/react/guides/ssr.md index 16e831439..a48cb4188 100644 --- a/docs/framework/react/guides/ssr.md +++ b/docs/framework/react/guides/ssr.md @@ -183,7 +183,7 @@ This section focuses on integrating TanStack Form with `Next.js`, particularly u - Start a new `Next.js` project, following the steps in the [Next.js Documentation](https://nextjs.org/docs/getting-started/installation). Ensure you select `yes` for `Would you like to use App Router?` during the setup to access all new features provided by Next.js. - Install `@tanstack/react-form` -- Install any [form validator](../validation#validation-through-schema-libraries) of your choice. [Optional] +- Install any [form validator](./validation#validation-through-schema-libraries) of your choice. [Optional] ## App Router integration @@ -338,7 +338,7 @@ Here, we're using [React's `useActionState` hook](https://playfulprogramming.com - Start a new `Remix` project, following the steps in the [Remix Documentation](https://remix.run/docs/en/main/start/quickstart). - Install `@tanstack/react-form` -- Install any [form validator](../validation#validation-through-schema-libraries) of your choice. [Optional] +- Install any [form validator](./validation#validation-through-schema-libraries) of your choice. [Optional] ## Remix integration diff --git a/docs/framework/react/guides/submission-handling.md b/docs/framework/react/guides/submission-handling.md index 65b9c197d..a7fe65ca7 100644 --- a/docs/framework/react/guides/submission-handling.md +++ b/docs/framework/react/guides/submission-handling.md @@ -64,7 +64,7 @@ function App() { ## Transforming data with Standard Schemas -While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data. +While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data. The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function: diff --git a/docs/framework/react/guides/validation.md b/docs/framework/react/guides/validation.md index 4444f37d7..9ae0f061a 100644 --- a/docs/framework/react/guides/validation.md +++ b/docs/framework/react/guides/validation.md @@ -458,7 +458,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe _Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet. -> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information. +> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information. To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function: diff --git a/docs/framework/react/quick-start.md b/docs/framework/react/quick-start.md index c63af1ec4..6fc27e6c7 100644 --- a/docs/framework/react/quick-start.md +++ b/docs/framework/react/quick-start.md @@ -5,7 +5,7 @@ title: Quick Start TanStack Form is unlike most form libraries you've used before. It's designed for large-scale production usage, with a focus on type safety, performance and composition for an unmatched developer experience. -As a result, we've developed [a philosophy around the library's usage](../../../philosophy.md) that values scalability and long-term developer experience over short and sharable code snippets. +As a result, we've developed [a philosophy around the library's usage](../../philosophy.md) that values scalability and long-term developer experience over short and sharable code snippets. Here's an example of a form following many of our best practices, which will allow you to rapidly develop even high-complexity forms after a short onboarding experience: diff --git a/docs/framework/react/reference/functions/createFormHook.md b/docs/framework/react/reference/functions/createFormHook.md index 46ca02f39..abe54aaf2 100644 --- a/docs/framework/react/reference/functions/createFormHook.md +++ b/docs/framework/react/reference/functions/createFormHook.md @@ -122,7 +122,7 @@ withFieldGroup: (__namedParameters) ##### \_\_namedParameters -[`WithFieldGroupProps`](../../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\> +[`WithFieldGroupProps`](../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\> #### Returns @@ -261,7 +261,7 @@ withForm: +[`WithFormProps`](../interfaces/WithFormProps.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\> #### Returns diff --git a/docs/framework/react/reference/functions/createFormHookContexts.md b/docs/framework/react/reference/functions/createFormHookContexts.md index e20f60017..41b38bb24 100644 --- a/docs/framework/react/reference/functions/createFormHookContexts.md +++ b/docs/framework/react/reference/functions/createFormHookContexts.md @@ -51,4 +51,4 @@ useFormContext: () => ReactFormExtendedApi, any, any, any, #### Returns -[`ReactFormExtendedApi`](../../type-aliases/ReactFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> +[`ReactFormExtendedApi`](../type-aliases/ReactFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/framework/react/reference/functions/useField.md b/docs/framework/react/reference/functions/useField.md index b1c7797bb..e16a37a4b 100644 --- a/docs/framework/react/reference/functions/useField.md +++ b/docs/framework/react/reference/functions/useField.md @@ -111,7 +111,7 @@ A hook for managing a field in a form. ### opts -[`UseFieldOptions`](../../interfaces/UseFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> +[`UseFieldOptions`](../interfaces/UseFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> An object with field options. diff --git a/docs/framework/react/reference/functions/useForm.md b/docs/framework/react/reference/functions/useForm.md index 5ca88a168..ad3c54912 100644 --- a/docs/framework/react/reference/functions/useForm.md +++ b/docs/framework/react/reference/functions/useForm.md @@ -73,4 +73,4 @@ This API encapsulates all the necessary functionalities related to the form. It ## Returns -[`ReactFormExtendedApi`](../../type-aliases/ReactFormExtendedApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`ReactFormExtendedApi`](../type-aliases/ReactFormExtendedApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 43ee975b4..ce3022f37 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -7,29 +7,29 @@ title: "@tanstack/react-form" ## Interfaces -- [ReactFormApi](../interfaces/ReactFormApi.md) -- [UseFieldOptions](../interfaces/UseFieldOptions.md) -- [UseFieldOptionsBound](../interfaces/UseFieldOptionsBound.md) -- [WithFieldGroupProps](../interfaces/WithFieldGroupProps.md) -- [WithFormProps](../interfaces/WithFormProps.md) +- [ReactFormApi](interfaces/ReactFormApi.md) +- [UseFieldOptions](interfaces/UseFieldOptions.md) +- [UseFieldOptionsBound](interfaces/UseFieldOptionsBound.md) +- [WithFieldGroupProps](interfaces/WithFieldGroupProps.md) +- [WithFormProps](interfaces/WithFormProps.md) ## Type Aliases -- [FieldComponent](../type-aliases/FieldComponent.md) -- [LensFieldComponent](../type-aliases/LensFieldComponent.md) -- [ReactFormExtendedApi](../type-aliases/ReactFormExtendedApi.md) -- [ServerFormState](../type-aliases/ServerFormState.md) -- [UseField](../type-aliases/UseField.md) +- [FieldComponent](type-aliases/FieldComponent.md) +- [LensFieldComponent](type-aliases/LensFieldComponent.md) +- [ReactFormExtendedApi](type-aliases/ReactFormExtendedApi.md) +- [ServerFormState](type-aliases/ServerFormState.md) +- [UseField](type-aliases/UseField.md) ## Variables -- [Field](../variables/Field.md) +- [Field](variables/Field.md) ## Functions -- [createFormHook](../functions/createFormHook.md) -- [createFormHookContexts](../functions/createFormHookContexts.md) -- [useField](../functions/useField.md) -- [useFieldGroup](../functions/useFieldGroup.md) -- [useForm](../functions/useForm.md) -- [useStore](../functions/useStore.md) +- [createFormHook](functions/createFormHook.md) +- [createFormHookContexts](functions/createFormHookContexts.md) +- [useField](functions/useField.md) +- [useFieldGroup](functions/useFieldGroup.md) +- [useForm](functions/useForm.md) +- [useStore](functions/useStore.md) diff --git a/docs/framework/react/reference/type-aliases/UseField.md b/docs/framework/react/reference/type-aliases/UseField.md index cfdc62dca..879c4d7a2 100644 --- a/docs/framework/react/reference/type-aliases/UseField.md +++ b/docs/framework/react/reference/type-aliases/UseField.md @@ -115,7 +115,7 @@ A function that takes an optional object with a `name` property and field option ### opts -[`UseFieldOptionsBound`](../../interfaces/UseFieldOptionsBound.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> +[`UseFieldOptionsBound`](../interfaces/UseFieldOptionsBound.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> ## Returns diff --git a/docs/framework/solid/guides/form-composition.md b/docs/framework/solid/guides/form-composition.md index fe36134e8..053aa0831 100644 --- a/docs/framework/solid/guides/form-composition.md +++ b/docs/framework/solid/guides/form-composition.md @@ -218,7 +218,7 @@ function App() { ## Reusing groups of fields in multiple forms -Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](../linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component. +Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](./linked-fields.md). Instead of repeating this logic across multiple forms, you can utilize the `withFieldGroup` higher-order component. > Unlike `withForm`, validators cannot be specified and could be any value. > Ensure that your fields can accept unknown error types. diff --git a/docs/framework/solid/guides/submission-handling.md b/docs/framework/solid/guides/submission-handling.md index 1cbc8b251..0ff523e1c 100644 --- a/docs/framework/solid/guides/submission-handling.md +++ b/docs/framework/solid/guides/submission-handling.md @@ -64,7 +64,7 @@ export default function App() { ## Transforming data with Standard Schemas -While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data. +While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data. The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function: diff --git a/docs/framework/solid/guides/validation.md b/docs/framework/solid/guides/validation.md index 856d71a8b..31af7cbc0 100644 --- a/docs/framework/solid/guides/validation.md +++ b/docs/framework/solid/guides/validation.md @@ -464,7 +464,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe _Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet. -> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information. +> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information. To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function: diff --git a/docs/framework/solid/reference/functions/createField.md b/docs/framework/solid/reference/functions/createField.md index 3607b7a6b..a82672fe9 100644 --- a/docs/framework/solid/reference/functions/createField.md +++ b/docs/framework/solid/reference/functions/createField.md @@ -109,7 +109,7 @@ Defined in: [packages/solid-form/src/createField.tsx:259](https://github.com/Tan ### opts -() => [`CreateFieldOptions`](../../interfaces/CreateFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> +() => [`CreateFieldOptions`](../interfaces/CreateFieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> ## Returns diff --git a/docs/framework/solid/reference/functions/createForm.md b/docs/framework/solid/reference/functions/createForm.md index de8aa1017..fcf67900d 100644 --- a/docs/framework/solid/reference/functions/createForm.md +++ b/docs/framework/solid/reference/functions/createForm.md @@ -69,4 +69,4 @@ Defined in: [packages/solid-form/src/createForm.tsx:173](https://github.com/TanS ## Returns -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`SolidFormApi`](../../interfaces/SolidFormApi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> +`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`SolidFormApi`](../interfaces/SolidFormApi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/solid/reference/functions/createFormHook.md b/docs/framework/solid/reference/functions/createFormHook.md index fb7012f09..db586fc64 100644 --- a/docs/framework/solid/reference/functions/createFormHook.md +++ b/docs/framework/solid/reference/functions/createFormHook.md @@ -122,7 +122,7 @@ withFieldGroup: (__namedParameters) ##### \_\_namedParameters -[`WithFieldGroupProps`](../../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\> +[`WithFieldGroupProps`](../interfaces/WithFieldGroupProps.md)\<`TFieldGroupData`, `TComponents`, `TFormComponents`, `TSubmitMeta`, `TRenderProps`\> #### Returns @@ -261,7 +261,7 @@ withForm: +[`WithFormProps`](../interfaces/WithFormProps.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\> #### Returns diff --git a/docs/framework/solid/reference/functions/createFormHookContexts.md b/docs/framework/solid/reference/functions/createFormHookContexts.md index 59f930b40..857ea8d2d 100644 --- a/docs/framework/solid/reference/functions/createFormHookContexts.md +++ b/docs/framework/solid/reference/functions/createFormHookContexts.md @@ -51,4 +51,4 @@ useFormContext: () => SolidFormExtendedApi, any, any, any, #### Returns -[`SolidFormExtendedApi`](../../type-aliases/SolidFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> +[`SolidFormExtendedApi`](../type-aliases/SolidFormExtendedApi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 79d9679a3..7824e8e51 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -7,25 +7,25 @@ title: "@tanstack/solid-form" ## Interfaces -- [CreateFieldOptions](../interfaces/CreateFieldOptions.md) -- [CreateFieldOptionsBound](../interfaces/CreateFieldOptionsBound.md) -- [SolidFormApi](../interfaces/SolidFormApi.md) -- [WithFieldGroupProps](../interfaces/WithFieldGroupProps.md) -- [WithFormProps](../interfaces/WithFormProps.md) +- [CreateFieldOptions](interfaces/CreateFieldOptions.md) +- [CreateFieldOptionsBound](interfaces/CreateFieldOptionsBound.md) +- [SolidFormApi](interfaces/SolidFormApi.md) +- [WithFieldGroupProps](interfaces/WithFieldGroupProps.md) +- [WithFormProps](interfaces/WithFormProps.md) ## Type Aliases -- [CreateField](../type-aliases/CreateField.md) -- [FieldComponent](../type-aliases/FieldComponent.md) -- [LensFieldComponent](../type-aliases/LensFieldComponent.md) -- [SolidFormExtendedApi](../type-aliases/SolidFormExtendedApi.md) +- [CreateField](type-aliases/CreateField.md) +- [FieldComponent](type-aliases/FieldComponent.md) +- [LensFieldComponent](type-aliases/LensFieldComponent.md) +- [SolidFormExtendedApi](type-aliases/SolidFormExtendedApi.md) ## Functions -- [createField](../functions/createField.md) -- [createFieldGroup](../functions/createFieldGroup.md) -- [createForm](../functions/createForm.md) -- [createFormHook](../functions/createFormHook.md) -- [createFormHookContexts](../functions/createFormHookContexts.md) -- [Field](../functions/Field.md) -- [useStore](../functions/useStore.md) +- [createField](functions/createField.md) +- [createFieldGroup](functions/createFieldGroup.md) +- [createForm](functions/createForm.md) +- [createFormHook](functions/createFormHook.md) +- [createFormHookContexts](functions/createFormHookContexts.md) +- [Field](functions/Field.md) +- [useStore](functions/useStore.md) diff --git a/docs/framework/solid/reference/type-aliases/CreateField.md b/docs/framework/solid/reference/type-aliases/CreateField.md index b3491b9c8..b3f4d2404 100644 --- a/docs/framework/solid/reference/type-aliases/CreateField.md +++ b/docs/framework/solid/reference/type-aliases/CreateField.md @@ -111,7 +111,7 @@ Defined in: [packages/solid-form/src/createField.tsx:53](https://github.com/TanS ### opts -() => `object` & [`CreateFieldOptionsBound`](../../interfaces/CreateFieldOptionsBound.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> +() => `object` & [`CreateFieldOptionsBound`](../interfaces/CreateFieldOptionsBound.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> ## Returns diff --git a/docs/framework/svelte/guides/form-composition.md b/docs/framework/svelte/guides/form-composition.md index da55ec10e..e289057c1 100644 --- a/docs/framework/svelte/guides/form-composition.md +++ b/docs/framework/svelte/guides/form-composition.md @@ -240,7 +240,7 @@ export const peopleFormOpts = formOptions({ ## Reusing groups of fields in multiple forms -Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](../linked-fields.md). Instead of repeating this logic across multiple forms, you can create reusable field group components. +Sometimes, a pair of fields are so closely related that it makes sense to group and reuse them — like the password example listed in the [linked fields guide](./linked-fields.md). Instead of repeating this logic across multiple forms, you can create reusable field group components. > Unlike form-level components, validators in field groups cannot be strictly typed and could be any value. > Ensure that your fields can accept unknown error types. diff --git a/docs/framework/vue/guides/basic-concepts.md b/docs/framework/vue/guides/basic-concepts.md index 1a58fd7e0..0691323c7 100644 --- a/docs/framework/vue/guides/basic-concepts.md +++ b/docs/framework/vue/guides/basic-concepts.md @@ -290,7 +290,7 @@ Example: ``` -More information can be found at [Listeners](../listeners.md) +More information can be found at [Listeners](./listeners.md) Note: The usage of the `form.useField` method to achieve reactivity is discouraged since it is designed to be used thoughtfully within the `form.Field` component. You might want to use `form.useStore` instead. diff --git a/docs/framework/vue/guides/submission-handling.md b/docs/framework/vue/guides/submission-handling.md index 6ed8e9819..2976e0b85 100644 --- a/docs/framework/vue/guides/submission-handling.md +++ b/docs/framework/vue/guides/submission-handling.md @@ -62,7 +62,7 @@ const form = useForm({ ## Transforming data with Standard Schemas -While Tanstack Form provides [Standard Schema support](../validation.md) for validation, it does not preserve the Schema's output data. +While Tanstack Form provides [Standard Schema support](./validation.md) for validation, it does not preserve the Schema's output data. The value passed to the `onSubmit` function will always be the input data. To receive the output data of a Standard Schema, parse it in the `onSubmit` function: diff --git a/docs/framework/vue/guides/validation.md b/docs/framework/vue/guides/validation.md index 04c1d19c0..83bb9c3e6 100644 --- a/docs/framework/vue/guides/validation.md +++ b/docs/framework/vue/guides/validation.md @@ -470,7 +470,7 @@ TanStack Form natively supports all libraries following the [Standard Schema spe _Note:_ make sure to use the latest version of the schema libraries as older versions might not support Standard Schema yet. -> Validation will not provide you with transformed values. See [submission handling](../submission-handling.md) for more information. +> Validation will not provide you with transformed values. See [submission handling](./submission-handling.md) for more information. To use schemas from these libraries you can pass them to the `validators` props as you would do with a custom function: diff --git a/docs/framework/vue/reference/functions/useForm.md b/docs/framework/vue/reference/functions/useForm.md index 01c9ee79d..0ee7112cf 100644 --- a/docs/framework/vue/reference/functions/useForm.md +++ b/docs/framework/vue/reference/functions/useForm.md @@ -69,4 +69,4 @@ Defined in: [packages/vue-form/src/useForm.tsx:217](https://github.com/TanStack/ ## Returns -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`VueFormApi`](../../interfaces/VueFormApi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> +`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`VueFormApi`](../interfaces/VueFormApi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 739a3dd58..5a51c6ac8 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -7,22 +7,22 @@ title: "@tanstack/vue-form" ## Interfaces -- [VueFieldApi](../interfaces/VueFieldApi.md) -- [VueFormApi](../interfaces/VueFormApi.md) +- [VueFieldApi](interfaces/VueFieldApi.md) +- [VueFormApi](interfaces/VueFormApi.md) ## Type Aliases -- [FieldComponent](../type-aliases/FieldComponent.md) -- [FieldComponentBoundProps](../type-aliases/FieldComponentBoundProps.md) -- [FieldComponentProps](../type-aliases/FieldComponentProps.md) -- [UseField](../type-aliases/UseField.md) +- [FieldComponent](type-aliases/FieldComponent.md) +- [FieldComponentBoundProps](type-aliases/FieldComponentBoundProps.md) +- [FieldComponentProps](type-aliases/FieldComponentProps.md) +- [UseField](type-aliases/UseField.md) ## Variables -- [Field](../variables/Field.md) +- [Field](variables/Field.md) ## Functions -- [useField](../functions/useField.md) -- [useForm](../functions/useForm.md) -- [useStore](../functions/useStore.md) +- [useField](functions/useField.md) +- [useForm](functions/useForm.md) +- [useStore](functions/useStore.md) diff --git a/docs/framework/vue/reference/type-aliases/FieldComponent.md b/docs/framework/vue/reference/type-aliases/FieldComponent.md index 6fa10513b..e7c3c7dbc 100644 --- a/docs/framework/vue/reference/type-aliases/FieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/FieldComponent.md @@ -76,11 +76,11 @@ Defined in: [packages/vue-form/src/useField.tsx:24](https://github.com/TanStack/ ### props -[`FieldComponentBoundProps`](../FieldComponentBoundProps.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> & `EmitsToProps`\<`EmitsOptions`\> & `PublicProps` +[`FieldComponentBoundProps`](FieldComponentBoundProps.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> & `EmitsToProps`\<`EmitsOptions`\> & `PublicProps` ## Returns -`CreateComponentPublicInstanceWithMixins`\<[`FieldComponentBoundProps`](../FieldComponentBoundProps.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>, \{ +`CreateComponentPublicInstanceWithMixins`\<[`FieldComponentBoundProps`](FieldComponentBoundProps.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\>, \{ \}, \{ \}, \{ \}, \{ diff --git a/docs/overview.md b/docs/overview.md index 8a774f563..7274886f6 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -139,4 +139,4 @@ createRoot(rootElement).render() ## You talked me into it, so what now? -- Learn TanStack Form at your own pace with our thorough [Walkthrough Guide](../installation) and [API Reference](../reference/classes/FormApi) +- Learn TanStack Form at your own pace with our thorough [Walkthrough Guide](./installation) and [API Reference](./reference/classes/FormApi) diff --git a/docs/reference/classes/FieldApi.md b/docs/reference/classes/FieldApi.md index db9796783..c3edabd4e 100644 --- a/docs/reference/classes/FieldApi.md +++ b/docs/reference/classes/FieldApi.md @@ -23,11 +23,11 @@ the `new FieldApi` constructor. ### TName -`TName` *extends* [`DeepKeys`](../../type-aliases/DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount @@ -125,7 +125,7 @@ Initializes a new `FieldApi` instance. ##### opts -[`FieldApiOptions`](../../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> +[`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> #### Returns @@ -223,7 +223,7 @@ The current field state. ##### Returns -[`FieldState`](../../type-aliases/FieldState.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> +[`FieldState`](../type-aliases/FieldState.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> ## Methods @@ -261,7 +261,7 @@ Gets the field information object. #### Returns -[`FieldInfo`](../../type-aliases/FieldInfo.md)\<`TParentData`\> +[`FieldInfo`](../type-aliases/FieldInfo.md)\<`TParentData`\> *** @@ -275,7 +275,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1374](https://github.com/TanStac #### Returns -[`FieldMeta`](../../type-aliases/FieldMeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> +[`FieldMeta`](../type-aliases/FieldMeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\> *** @@ -329,7 +329,7 @@ Handles the change event. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<`TData`\> +[`Updater`](../type-aliases/Updater.md)\<`TData`\> #### Returns @@ -442,13 +442,13 @@ issues (if any). This method does NOT set any internal errors. ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> The standard schema to parse this field's value with. #### Returns - \| [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[] + \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[] \| `undefined` *** @@ -470,14 +470,14 @@ issues (if any). This method does NOT set any internal errors. ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TData`, `unknown`\> The standard schema to parse this field's value with. #### Returns `Promise`\< - \| [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[] + \| [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[] \| `undefined`\> *** @@ -581,7 +581,7 @@ Updates the field's errorMap ##### errorMap -`ValidationErrorMap`\<[`UnwrapFieldValidateOrFn`](../../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnMount`, `TFormOnMount`\>, [`UnwrapFieldValidateOrFn`](../../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnChange`, `TFormOnChange`\>, [`UnwrapFieldAsyncValidateOrFn`](../../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnChangeAsync`, `TFormOnChangeAsync`\>, [`UnwrapFieldValidateOrFn`](../../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnBlur`, `TFormOnBlur`\>, [`UnwrapFieldAsyncValidateOrFn`](../../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnBlurAsync`, `TFormOnBlurAsync`\>, [`UnwrapFieldValidateOrFn`](../../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnSubmit`, `TFormOnSubmit`\>, [`UnwrapFieldAsyncValidateOrFn`](../../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnSubmitAsync`, `TFormOnSubmitAsync`\>, [`UnwrapFieldValidateOrFn`](../../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnDynamic`, `TFormOnDynamic`\>, [`UnwrapFieldAsyncValidateOrFn`](../../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnDynamicAsync`, `TFormOnDynamicAsync`\>\> +`ValidationErrorMap`\<[`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnMount`, `TFormOnMount`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnChange`, `TFormOnChange`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnChangeAsync`, `TFormOnChangeAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnBlur`, `TFormOnBlur`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnBlurAsync`, `TFormOnBlurAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnSubmit`, `TFormOnSubmit`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnSubmitAsync`, `TFormOnSubmitAsync`\>, [`UnwrapFieldValidateOrFn`](../type-aliases/UnwrapFieldValidateOrFn.md)\<`TName`, `TOnDynamic`, `TFormOnDynamic`\>, [`UnwrapFieldAsyncValidateOrFn`](../type-aliases/UnwrapFieldAsyncValidateOrFn.md)\<`TName`, `TOnDynamicAsync`, `TFormOnDynamicAsync`\>\> #### Returns @@ -603,7 +603,7 @@ Sets the field metadata. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<[`FieldMetaBase`](../../type-aliases/FieldMetaBase.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>\> +[`Updater`](../type-aliases/Updater.md)\<[`FieldMetaBase`](../type-aliases/FieldMetaBase.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`\>\> #### Returns @@ -625,7 +625,7 @@ Sets the field value and run the `change` validator. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<`TData`\> +[`Updater`](../type-aliases/Updater.md)\<`TData`\> ##### options? @@ -684,7 +684,7 @@ Updates the field instance with new options. ##### opts -[`FieldApiOptions`](../../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> +[`FieldApiOptions`](../interfaces/FieldApiOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnDynamic`, `TFormOnDynamicAsync`, `TFormOnServer`, `TParentSubmitMeta`\> #### Returns diff --git a/docs/reference/classes/FieldGroupApi.md b/docs/reference/classes/FieldGroupApi.md index ce3cd231d..9413fc04e 100644 --- a/docs/reference/classes/FieldGroupApi.md +++ b/docs/reference/classes/FieldGroupApi.md @@ -20,8 +20,8 @@ Defined in: [packages/form-core/src/FieldGroupApi.ts:112](https://github.com/Tan ### TFields `TFields` *extends* - \| [`DeepKeysOfType`](../../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\> - \| [`FieldsMap`](../../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\> + \| [`DeepKeysOfType`](../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\> + \| [`FieldsMap`](../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\> ### TOnMount @@ -83,7 +83,7 @@ Constructs a new `FieldGroupApi` instance with the given form options. ##### opts -[`FieldGroupOptions`](../../interfaces/FieldGroupOptions.md)\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FieldGroupOptions`](../interfaces/FieldGroupOptions.md)\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns @@ -135,7 +135,7 @@ Defined in: [packages/form-core/src/FieldGroupApi.ts:231](https://github.com/Tan ##### Returns -[`FieldGroupState`](../../interfaces/FieldGroupState.md)\<`TFieldGroupData`\> +[`FieldGroupState`](../interfaces/FieldGroupState.md)\<`TFieldGroupData`\> ## Methods @@ -233,7 +233,7 @@ Gets the metadata of the specified field. #### Returns -[`AnyFieldMeta`](../../type-aliases/AnyFieldMeta.md) \| `undefined` +[`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md) \| `undefined` #### Implementation of @@ -267,7 +267,7 @@ Gets the value of the specified field. #### Returns -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> #### Implementation of @@ -359,7 +359,7 @@ Insert a value into an array field at the specified index. ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` ##### opts? @@ -476,7 +476,7 @@ Pushes a value into an array field. ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` ##### opts? @@ -571,7 +571,7 @@ Replaces a value into an array field at the specified index. ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\[`number`\] : `never` ##### opts? @@ -647,7 +647,7 @@ Updates the metadata of the specified field. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../../type-aliases/AnyFieldMetaBase.md)\> +[`Updater`](../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../type-aliases/AnyFieldMetaBase.md)\> #### Returns @@ -688,7 +688,7 @@ Sets the value of the specified field and optionally updates the touched state. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\> +[`Updater`](../type-aliases/Updater.md)\<[`DeepValue`](../type-aliases/DeepValue.md)\<`TFieldGroupData`, `TField`\>\> ##### opts? diff --git a/docs/reference/classes/FormApi.md b/docs/reference/classes/FormApi.md index 1d4fec331..07aa197a6 100644 --- a/docs/reference/classes/FormApi.md +++ b/docs/reference/classes/FormApi.md @@ -79,7 +79,7 @@ Constructs a new `FormApi` instance with the given form options. ##### opts? -[`FormOptions`](../../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns @@ -169,7 +169,7 @@ Defined in: [packages/form-core/src/FormApi.ts:967](https://github.com/TanStack/ ##### Returns -[`FormState`](../../interfaces/FormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\> +[`FormState`](../interfaces/FormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\> ## Methods @@ -342,7 +342,7 @@ Gets the field info of the specified field. #### Returns -[`FieldInfo`](../../type-aliases/FieldInfo.md)\<`TFormData`\> +[`FieldInfo`](../type-aliases/FieldInfo.md)\<`TFormData`\> *** @@ -370,7 +370,7 @@ Gets the metadata of the specified field. #### Returns -[`AnyFieldMeta`](../../type-aliases/AnyFieldMeta.md) \| `undefined` +[`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md) \| `undefined` #### Implementation of @@ -404,7 +404,7 @@ Gets the value of the specified field. #### Returns -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> #### Implementation of @@ -492,7 +492,7 @@ Defined in: [packages/form-core/src/FormApi.ts:2331](https://github.com/TanStack ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` ##### options? @@ -600,15 +600,15 @@ issues (if any). This method does NOT set any internal errors. ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\> +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\> The standard schema to parse the form values with. #### Returns \| \{ - `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[]\>; - `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[]\>; + `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>; + `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>; \} \| `undefined` @@ -634,7 +634,7 @@ issues (if any). This method does NOT set any internal errors. ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\> +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md)\<`TFormData`, `unknown`\> The standard schema to parse the form values with. @@ -642,8 +642,8 @@ The standard schema to parse the form values with. `Promise`\< \| \{ - `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[]\>; - `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../../interfaces/StandardSchemaV1Issue.md)[]\>; + `fields`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>; + `form`: `Record`\<`string`, [`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)[]\>; \} \| `undefined`\> @@ -676,7 +676,7 @@ Pushes a value into an array field. ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` ##### options? @@ -771,7 +771,7 @@ Replaces a value into an array field at the specified index. ##### value -[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` +[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\[`number`\] : `never` ##### options? @@ -876,11 +876,11 @@ resets every field's meta ##### fieldMeta -`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/AnyFieldMeta.md)\>\> +`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md)\>\> #### Returns -`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../../type-aliases/AnyFieldMeta.md)\>\> +`Partial`\<`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/AnyFieldMeta.md)\>\> *** @@ -898,7 +898,7 @@ Updates the form's errorMap ##### errorMap -`FormValidationErrorMap`\<`TFormData`, [`UnwrapFormValidateOrFn`](../../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnMount`\>, [`UnwrapFormValidateOrFn`](../../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnChange`\>, [`UnwrapFormAsyncValidateOrFn`](../../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnChangeAsync`\>, [`UnwrapFormValidateOrFn`](../../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnBlur`\>, [`UnwrapFormAsyncValidateOrFn`](../../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnBlurAsync`\>, [`UnwrapFormValidateOrFn`](../../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnSubmit`\>, [`UnwrapFormAsyncValidateOrFn`](../../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnSubmitAsync`\>, [`UnwrapFormValidateOrFn`](../../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnDynamic`\>, [`UnwrapFormAsyncValidateOrFn`](../../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnDynamicAsync`\>, [`UnwrapFormAsyncValidateOrFn`](../../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnServer`\>\> +`FormValidationErrorMap`\<`TFormData`, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnMount`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnChange`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnChangeAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnBlur`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnBlurAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnSubmit`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnSubmitAsync`\>, [`UnwrapFormValidateOrFn`](../type-aliases/UnwrapFormValidateOrFn.md)\<`TOnDynamic`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnDynamicAsync`\>, [`UnwrapFormAsyncValidateOrFn`](../type-aliases/UnwrapFormAsyncValidateOrFn.md)\<`TOnServer`\>\> #### Returns @@ -930,7 +930,7 @@ Updates the metadata of the specified field. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../../type-aliases/AnyFieldMetaBase.md)\> +[`Updater`](../type-aliases/Updater.md)\<[`AnyFieldMetaBase`](../type-aliases/AnyFieldMetaBase.md)\> #### Returns @@ -971,7 +971,7 @@ Sets the value of the specified field and optionally updates the touched state. ##### updater -[`Updater`](../../type-aliases/Updater.md)\<[`DeepValue`](../../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\> +[`Updater`](../type-aliases/Updater.md)\<[`DeepValue`](../type-aliases/DeepValue.md)\<`TFormData`, `TField`\>\> ##### opts? @@ -1053,7 +1053,7 @@ Updates the form options and form state. ##### options? -[`FormOptions`](../../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns diff --git a/docs/reference/functions/formOptions.md b/docs/reference/functions/formOptions.md index 3dd7c4bc5..d3e98f0ea 100644 --- a/docs/reference/functions/formOptions.md +++ b/docs/reference/functions/formOptions.md @@ -15,7 +15,7 @@ Defined in: [packages/form-core/src/formOptions.ts:23](https://github.com/TanSta ### TOptions -`TOptions` *extends* `Partial`\<[`FormOptions`](../../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\> +`TOptions` *extends* `Partial`\<[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\> ### TFormData @@ -69,7 +69,7 @@ Defined in: [packages/form-core/src/formOptions.ts:23](https://github.com/TanSta ### defaultOpts -`Partial`\<[`FormOptions`](../../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\> & `TOptions` +`Partial`\<[`FormOptions`](../interfaces/FormOptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>\> & `TOptions` ## Returns diff --git a/docs/reference/functions/mergeForm.md b/docs/reference/functions/mergeForm.md index 08fb3f1d4..169aff39f 100644 --- a/docs/reference/functions/mergeForm.md +++ b/docs/reference/functions/mergeForm.md @@ -21,12 +21,12 @@ Defined in: [packages/form-core/src/mergeForm.ts:73](https://github.com/TanStack ### baseForm -[`FormApi`](../../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> +[`FormApi`](../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> ### state -`Partial`\<[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\[`"state"`\]\> +`Partial`\<[`FormApi`](../classes/FormApi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\[`"state"`\]\> ## Returns -[`FormApi`](../../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> +[`FormApi`](../classes/FormApi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/reference/functions/revalidateLogic.md b/docs/reference/functions/revalidateLogic.md index e6615a614..b0355ea4b 100644 --- a/docs/reference/functions/revalidateLogic.md +++ b/docs/reference/functions/revalidateLogic.md @@ -27,4 +27,4 @@ When the form is submitted, it will run the validation logic on `change` ## Returns -[`ValidationLogicFn`](../../type-aliases/ValidationLogicFn.md) +[`ValidationLogicFn`](../type-aliases/ValidationLogicFn.md) diff --git a/docs/reference/index.md b/docs/reference/index.md index 37e038121..41a1c8be2 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -7,103 +7,103 @@ title: "@tanstack/form-core" ## Classes -- [FieldApi](../classes/FieldApi.md) -- [FieldGroupApi](../classes/FieldGroupApi.md) -- [FormApi](../classes/FormApi.md) +- [FieldApi](classes/FieldApi.md) +- [FieldGroupApi](classes/FieldGroupApi.md) +- [FormApi](classes/FormApi.md) ## Interfaces -- [AnyDeepKeyAndValue](../interfaces/AnyDeepKeyAndValue.md) -- [ArrayDeepKeyAndValue](../interfaces/ArrayDeepKeyAndValue.md) -- [BaseFormOptions](../interfaces/BaseFormOptions.md) -- [FieldApiOptions](../interfaces/FieldApiOptions.md) -- [FieldGroupOptions](../interfaces/FieldGroupOptions.md) -- [FieldGroupState](../interfaces/FieldGroupState.md) -- [FieldListeners](../interfaces/FieldListeners.md) -- [FieldOptions](../interfaces/FieldOptions.md) -- [FieldValidators](../interfaces/FieldValidators.md) -- [FormListeners](../interfaces/FormListeners.md) -- [FormOptions](../interfaces/FormOptions.md) -- [FormState](../interfaces/FormState.md) -- [FormValidators](../interfaces/FormValidators.md) -- [ObjectDeepKeyAndValue](../interfaces/ObjectDeepKeyAndValue.md) -- [StandardSchemaV1Issue](../interfaces/StandardSchemaV1Issue.md) -- [TupleDeepKeyAndValue](../interfaces/TupleDeepKeyAndValue.md) -- [UnknownDeepKeyAndValue](../interfaces/UnknownDeepKeyAndValue.md) -- [ValidationLogicProps](../interfaces/ValidationLogicProps.md) +- [AnyDeepKeyAndValue](interfaces/AnyDeepKeyAndValue.md) +- [ArrayDeepKeyAndValue](interfaces/ArrayDeepKeyAndValue.md) +- [BaseFormOptions](interfaces/BaseFormOptions.md) +- [FieldApiOptions](interfaces/FieldApiOptions.md) +- [FieldGroupOptions](interfaces/FieldGroupOptions.md) +- [FieldGroupState](interfaces/FieldGroupState.md) +- [FieldListeners](interfaces/FieldListeners.md) +- [FieldOptions](interfaces/FieldOptions.md) +- [FieldValidators](interfaces/FieldValidators.md) +- [FormListeners](interfaces/FormListeners.md) +- [FormOptions](interfaces/FormOptions.md) +- [FormState](interfaces/FormState.md) +- [FormValidators](interfaces/FormValidators.md) +- [ObjectDeepKeyAndValue](interfaces/ObjectDeepKeyAndValue.md) +- [StandardSchemaV1Issue](interfaces/StandardSchemaV1Issue.md) +- [TupleDeepKeyAndValue](interfaces/TupleDeepKeyAndValue.md) +- [UnknownDeepKeyAndValue](interfaces/UnknownDeepKeyAndValue.md) +- [ValidationLogicProps](interfaces/ValidationLogicProps.md) ## Type Aliases -- [AllObjectKeys](../type-aliases/AllObjectKeys.md) -- [AllTupleKeys](../type-aliases/AllTupleKeys.md) -- [AnyFieldApi](../type-aliases/AnyFieldApi.md) -- [AnyFieldGroupApi](../type-aliases/AnyFieldGroupApi.md) -- [AnyFieldMeta](../type-aliases/AnyFieldMeta.md) -- [AnyFieldMetaBase](../type-aliases/AnyFieldMetaBase.md) -- [AnyFieldMetaDerived](../type-aliases/AnyFieldMetaDerived.md) -- [AnyFormApi](../type-aliases/AnyFormApi.md) -- [AnyFormOptions](../type-aliases/AnyFormOptions.md) -- [AnyFormState](../type-aliases/AnyFormState.md) -- [ArrayAccessor](../type-aliases/ArrayAccessor.md) -- [BaseFormState](../type-aliases/BaseFormState.md) -- [BroadcastFormApi](../type-aliases/BroadcastFormApi.md) -- [BroadcastFormId](../type-aliases/BroadcastFormId.md) -- [BroadcastFormState](../type-aliases/BroadcastFormState.md) -- [BroadcastFormSubmissionState](../type-aliases/BroadcastFormSubmissionState.md) -- [DeepKeyAndValueArray](../type-aliases/DeepKeyAndValueArray.md) -- [DeepKeyAndValueObject](../type-aliases/DeepKeyAndValueObject.md) -- [DeepKeyAndValueTuple](../type-aliases/DeepKeyAndValueTuple.md) -- [DeepKeys](../type-aliases/DeepKeys.md) -- [DeepKeysAndValues](../type-aliases/DeepKeysAndValues.md) -- [DeepKeysAndValuesImpl](../type-aliases/DeepKeysAndValuesImpl.md) -- [DeepKeysOfType](../type-aliases/DeepKeysOfType.md) -- [DeepRecord](../type-aliases/DeepRecord.md) -- [DeepValue](../type-aliases/DeepValue.md) -- [DerivedFormState](../type-aliases/DerivedFormState.md) -- [EventClientEventMap](../type-aliases/EventClientEventMap.md) -- [EventClientEventNames](../type-aliases/EventClientEventNames.md) -- [ExtractGlobalFormError](../type-aliases/ExtractGlobalFormError.md) -- [FieldInfo](../type-aliases/FieldInfo.md) -- [FieldMeta](../type-aliases/FieldMeta.md) -- [FieldMetaBase](../type-aliases/FieldMetaBase.md) -- [FieldMetaDerived](../type-aliases/FieldMetaDerived.md) -- [FieldsMap](../type-aliases/FieldsMap.md) -- [FieldState](../type-aliases/FieldState.md) -- [FormValidateFn](../type-aliases/FormValidateFn.md) -- [FormValidationError](../type-aliases/FormValidationError.md) -- [FormValidator](../type-aliases/FormValidator.md) -- [Nullable](../type-aliases/Nullable.md) -- [ObjectAccessor](../type-aliases/ObjectAccessor.md) -- [ObjectValue](../type-aliases/ObjectValue.md) -- [StandardSchemaV1](../type-aliases/StandardSchemaV1.md) -- [TStandardSchemaValidatorIssue](../type-aliases/TStandardSchemaValidatorIssue.md) -- [TStandardSchemaValidatorValue](../type-aliases/TStandardSchemaValidatorValue.md) -- [TupleAccessor](../type-aliases/TupleAccessor.md) -- [UnknownAccessor](../type-aliases/UnknownAccessor.md) -- [UnwrapFieldAsyncValidateOrFn](../type-aliases/UnwrapFieldAsyncValidateOrFn.md) -- [UnwrapFieldValidateOrFn](../type-aliases/UnwrapFieldValidateOrFn.md) -- [UnwrapFormAsyncValidateOrFn](../type-aliases/UnwrapFormAsyncValidateOrFn.md) -- [UnwrapFormValidateOrFn](../type-aliases/UnwrapFormValidateOrFn.md) -- [Updater](../type-aliases/Updater.md) -- [UpdaterFn](../type-aliases/UpdaterFn.md) -- [ValidationError](../type-aliases/ValidationError.md) -- [ValidationLogicFn](../type-aliases/ValidationLogicFn.md) -- [ValidationMeta](../type-aliases/ValidationMeta.md) -- [ValidationSource](../type-aliases/ValidationSource.md) +- [AllObjectKeys](type-aliases/AllObjectKeys.md) +- [AllTupleKeys](type-aliases/AllTupleKeys.md) +- [AnyFieldApi](type-aliases/AnyFieldApi.md) +- [AnyFieldGroupApi](type-aliases/AnyFieldGroupApi.md) +- [AnyFieldMeta](type-aliases/AnyFieldMeta.md) +- [AnyFieldMetaBase](type-aliases/AnyFieldMetaBase.md) +- [AnyFieldMetaDerived](type-aliases/AnyFieldMetaDerived.md) +- [AnyFormApi](type-aliases/AnyFormApi.md) +- [AnyFormOptions](type-aliases/AnyFormOptions.md) +- [AnyFormState](type-aliases/AnyFormState.md) +- [ArrayAccessor](type-aliases/ArrayAccessor.md) +- [BaseFormState](type-aliases/BaseFormState.md) +- [BroadcastFormApi](type-aliases/BroadcastFormApi.md) +- [BroadcastFormId](type-aliases/BroadcastFormId.md) +- [BroadcastFormState](type-aliases/BroadcastFormState.md) +- [BroadcastFormSubmissionState](type-aliases/BroadcastFormSubmissionState.md) +- [DeepKeyAndValueArray](type-aliases/DeepKeyAndValueArray.md) +- [DeepKeyAndValueObject](type-aliases/DeepKeyAndValueObject.md) +- [DeepKeyAndValueTuple](type-aliases/DeepKeyAndValueTuple.md) +- [DeepKeys](type-aliases/DeepKeys.md) +- [DeepKeysAndValues](type-aliases/DeepKeysAndValues.md) +- [DeepKeysAndValuesImpl](type-aliases/DeepKeysAndValuesImpl.md) +- [DeepKeysOfType](type-aliases/DeepKeysOfType.md) +- [DeepRecord](type-aliases/DeepRecord.md) +- [DeepValue](type-aliases/DeepValue.md) +- [DerivedFormState](type-aliases/DerivedFormState.md) +- [EventClientEventMap](type-aliases/EventClientEventMap.md) +- [EventClientEventNames](type-aliases/EventClientEventNames.md) +- [ExtractGlobalFormError](type-aliases/ExtractGlobalFormError.md) +- [FieldInfo](type-aliases/FieldInfo.md) +- [FieldMeta](type-aliases/FieldMeta.md) +- [FieldMetaBase](type-aliases/FieldMetaBase.md) +- [FieldMetaDerived](type-aliases/FieldMetaDerived.md) +- [FieldsMap](type-aliases/FieldsMap.md) +- [FieldState](type-aliases/FieldState.md) +- [FormValidateFn](type-aliases/FormValidateFn.md) +- [FormValidationError](type-aliases/FormValidationError.md) +- [FormValidator](type-aliases/FormValidator.md) +- [Nullable](type-aliases/Nullable.md) +- [ObjectAccessor](type-aliases/ObjectAccessor.md) +- [ObjectValue](type-aliases/ObjectValue.md) +- [StandardSchemaV1](type-aliases/StandardSchemaV1.md) +- [TStandardSchemaValidatorIssue](type-aliases/TStandardSchemaValidatorIssue.md) +- [TStandardSchemaValidatorValue](type-aliases/TStandardSchemaValidatorValue.md) +- [TupleAccessor](type-aliases/TupleAccessor.md) +- [UnknownAccessor](type-aliases/UnknownAccessor.md) +- [UnwrapFieldAsyncValidateOrFn](type-aliases/UnwrapFieldAsyncValidateOrFn.md) +- [UnwrapFieldValidateOrFn](type-aliases/UnwrapFieldValidateOrFn.md) +- [UnwrapFormAsyncValidateOrFn](type-aliases/UnwrapFormAsyncValidateOrFn.md) +- [UnwrapFormValidateOrFn](type-aliases/UnwrapFormValidateOrFn.md) +- [Updater](type-aliases/Updater.md) +- [UpdaterFn](type-aliases/UpdaterFn.md) +- [ValidationError](type-aliases/ValidationError.md) +- [ValidationLogicFn](type-aliases/ValidationLogicFn.md) +- [ValidationMeta](type-aliases/ValidationMeta.md) +- [ValidationSource](type-aliases/ValidationSource.md) ## Variables -- [defaultValidationLogic](../variables/defaultValidationLogic.md) -- [formEventClient](../variables/formEventClient.md) -- [standardSchemaValidators](../variables/standardSchemaValidators.md) +- [defaultValidationLogic](variables/defaultValidationLogic.md) +- [formEventClient](variables/formEventClient.md) +- [standardSchemaValidators](variables/standardSchemaValidators.md) ## Functions -- [createFieldMap](../functions/createFieldMap.md) -- [evaluate](../functions/evaluate.md) -- [formOptions](../functions/formOptions.md) -- [isGlobalFormValidationError](../functions/isGlobalFormValidationError.md) -- [isStandardSchemaValidator](../functions/isStandardSchemaValidator.md) -- [mergeForm](../functions/mergeForm.md) -- [revalidateLogic](../functions/revalidateLogic.md) -- [uuid](../functions/uuid.md) +- [createFieldMap](functions/createFieldMap.md) +- [evaluate](functions/evaluate.md) +- [formOptions](functions/formOptions.md) +- [isGlobalFormValidationError](functions/isGlobalFormValidationError.md) +- [isStandardSchemaValidator](functions/isStandardSchemaValidator.md) +- [mergeForm](functions/mergeForm.md) +- [revalidateLogic](functions/revalidateLogic.md) +- [uuid](functions/uuid.md) diff --git a/docs/reference/interfaces/AnyDeepKeyAndValue.md b/docs/reference/interfaces/AnyDeepKeyAndValue.md index 04557075b..e92bf5be3 100644 --- a/docs/reference/interfaces/AnyDeepKeyAndValue.md +++ b/docs/reference/interfaces/AnyDeepKeyAndValue.md @@ -9,10 +9,10 @@ Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/TanStac ## Extended by -- [`ArrayDeepKeyAndValue`](../ArrayDeepKeyAndValue.md) -- [`TupleDeepKeyAndValue`](../TupleDeepKeyAndValue.md) -- [`ObjectDeepKeyAndValue`](../ObjectDeepKeyAndValue.md) -- [`UnknownDeepKeyAndValue`](../UnknownDeepKeyAndValue.md) +- [`ArrayDeepKeyAndValue`](ArrayDeepKeyAndValue.md) +- [`TupleDeepKeyAndValue`](TupleDeepKeyAndValue.md) +- [`ObjectDeepKeyAndValue`](ObjectDeepKeyAndValue.md) +- [`UnknownDeepKeyAndValue`](UnknownDeepKeyAndValue.md) ## Type Parameters diff --git a/docs/reference/interfaces/ArrayDeepKeyAndValue.md b/docs/reference/interfaces/ArrayDeepKeyAndValue.md index 0bc8f0356..e549b0a82 100644 --- a/docs/reference/interfaces/ArrayDeepKeyAndValue.md +++ b/docs/reference/interfaces/ArrayDeepKeyAndValue.md @@ -9,13 +9,13 @@ Defined in: [packages/form-core/src/util-types.ts:33](https://github.com/TanStac ## Extends -- [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +- [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ## Type Parameters ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ### T @@ -33,7 +33,7 @@ Defined in: [packages/form-core/src/util-types.ts:37](https://github.com/TanStac #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`key`](../AnyDeepKeyAndValue.md#key) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`key`](AnyDeepKeyAndValue.md#key) *** @@ -49,4 +49,4 @@ Defined in: [packages/form-core/src/util-types.ts:38](https://github.com/TanStac #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`value`](../AnyDeepKeyAndValue.md#value) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`value`](AnyDeepKeyAndValue.md#value) diff --git a/docs/reference/interfaces/BaseFormOptions.md b/docs/reference/interfaces/BaseFormOptions.md index 135758ea7..c08609d1a 100644 --- a/docs/reference/interfaces/BaseFormOptions.md +++ b/docs/reference/interfaces/BaseFormOptions.md @@ -11,7 +11,7 @@ An object representing the base properties of a form, unrelated to any validator ## Extended by -- [`FormOptions`](../FormOptions.md) +- [`FormOptions`](FormOptions.md) ## Type Parameters diff --git a/docs/reference/interfaces/FieldApiOptions.md b/docs/reference/interfaces/FieldApiOptions.md index 77666d23b..f06efd807 100644 --- a/docs/reference/interfaces/FieldApiOptions.md +++ b/docs/reference/interfaces/FieldApiOptions.md @@ -11,7 +11,7 @@ An object type representing the required options for the FieldApi class. ## Extends -- [`FieldOptions`](../FieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> +- [`FieldOptions`](FieldOptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`\> ## Type Parameters @@ -21,11 +21,11 @@ An object type representing the required options for the FieldApi class. ### TName -`TName` *extends* [`DeepKeys`](../../type-aliases/DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount @@ -121,7 +121,7 @@ If `true`, always run async validation, even if there are errors emitted during #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`asyncAlways`](../FieldOptions.md#asyncalways) +[`FieldOptions`](FieldOptions.md).[`asyncAlways`](FieldOptions.md#asyncalways) *** @@ -137,7 +137,7 @@ The default time to debounce async validation if there is not a more specific de #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`asyncDebounceMs`](../FieldOptions.md#asyncdebouncems) +[`FieldOptions`](FieldOptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems) *** @@ -153,7 +153,7 @@ An optional object with default metadata for the field. #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`defaultMeta`](../FieldOptions.md#defaultmeta) +[`FieldOptions`](FieldOptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta) *** @@ -169,7 +169,7 @@ An optional default value for the field. #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`defaultValue`](../FieldOptions.md#defaultvalue) +[`FieldOptions`](FieldOptions.md).[`defaultValue`](FieldOptions.md#defaultvalue) *** @@ -185,7 +185,7 @@ Disable the `flat(1)` operation on `field.errors`. This is useful if you want to #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`disableErrorFlat`](../FieldOptions.md#disableerrorflat) +[`FieldOptions`](FieldOptions.md).[`disableErrorFlat`](FieldOptions.md#disableerrorflat) *** @@ -211,7 +211,7 @@ A list of listeners which attach to the corresponding events #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`listeners`](../FieldOptions.md#listeners) +[`FieldOptions`](FieldOptions.md).[`listeners`](FieldOptions.md#listeners) *** @@ -227,7 +227,7 @@ The field name. The type will be `DeepKeys` to ensure your name is #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`name`](../FieldOptions.md#name) +[`FieldOptions`](FieldOptions.md).[`name`](FieldOptions.md#name) *** @@ -243,4 +243,4 @@ A list of validators to pass to the field #### Inherited from -[`FieldOptions`](../FieldOptions.md).[`validators`](../FieldOptions.md#validators) +[`FieldOptions`](FieldOptions.md).[`validators`](FieldOptions.md#validators) diff --git a/docs/reference/interfaces/FieldGroupOptions.md b/docs/reference/interfaces/FieldGroupOptions.md index 3c48ca34d..091abc73d 100644 --- a/docs/reference/interfaces/FieldGroupOptions.md +++ b/docs/reference/interfaces/FieldGroupOptions.md @@ -22,8 +22,8 @@ An object representing the options for a field group. ### TFields `TFields` *extends* - \| [`DeepKeysOfType`](../../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\> - \| [`FieldsMap`](../../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\> + \| [`DeepKeysOfType`](../type-aliases/DeepKeysOfType.md)\<`TFormData`, `TFieldGroupData` \| `null` \| `undefined`\> + \| [`FieldsMap`](../type-aliases/FieldsMap.md)\<`TFormData`, `TFieldGroupData`\> ### TOnMount diff --git a/docs/reference/interfaces/FieldListeners.md b/docs/reference/interfaces/FieldListeners.md index 1a28a2c28..2ef19f9e8 100644 --- a/docs/reference/interfaces/FieldListeners.md +++ b/docs/reference/interfaces/FieldListeners.md @@ -15,11 +15,11 @@ Defined in: [packages/form-core/src/FieldApi.ts:375](https://github.com/TanStack ### TName -`TName` *extends* [`DeepKeys`](../../type-aliases/DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ## Properties diff --git a/docs/reference/interfaces/FieldOptions.md b/docs/reference/interfaces/FieldOptions.md index 86cc5ec05..b035b6762 100644 --- a/docs/reference/interfaces/FieldOptions.md +++ b/docs/reference/interfaces/FieldOptions.md @@ -11,7 +11,7 @@ An object type representing the options for a field in a form. ## Extended by -- [`FieldApiOptions`](../FieldApiOptions.md) +- [`FieldApiOptions`](FieldApiOptions.md) ## Type Parameters @@ -21,11 +21,11 @@ An object type representing the options for a field in a form. ### TName -`TName` *extends* [`DeepKeys`](../../type-aliases/DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/interfaces/FieldValidators.md b/docs/reference/interfaces/FieldValidators.md index d7d9d2487..84d56ab82 100644 --- a/docs/reference/interfaces/FieldValidators.md +++ b/docs/reference/interfaces/FieldValidators.md @@ -15,11 +15,11 @@ Defined in: [packages/form-core/src/FieldApi.ts:287](https://github.com/TanStack ### TName -`TName` *extends* [`DeepKeys`](../../type-aliases/DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](../type-aliases/DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](../type-aliases/DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/interfaces/FormListeners.md b/docs/reference/interfaces/FormListeners.md index 33491b054..3e2b3044f 100644 --- a/docs/reference/interfaces/FormListeners.md +++ b/docs/reference/interfaces/FormListeners.md @@ -73,11 +73,11 @@ Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/TanStack/ ###### fieldApi -[`AnyFieldApi`](../../type-aliases/AnyFieldApi.md) +[`AnyFieldApi`](../type-aliases/AnyFieldApi.md) ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns @@ -109,11 +109,11 @@ Defined in: [packages/form-core/src/FormApi.ts:283](https://github.com/TanStack/ ###### fieldApi -[`AnyFieldApi`](../../type-aliases/AnyFieldApi.md) +[`AnyFieldApi`](../type-aliases/AnyFieldApi.md) ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns @@ -145,7 +145,7 @@ Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/ ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> #### Returns @@ -167,7 +167,7 @@ Defined in: [packages/form-core/src/FormApi.ts:338](https://github.com/TanStack/ ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> ###### meta diff --git a/docs/reference/interfaces/FormOptions.md b/docs/reference/interfaces/FormOptions.md index 00cfa655a..1cb04e862 100644 --- a/docs/reference/interfaces/FormOptions.md +++ b/docs/reference/interfaces/FormOptions.md @@ -11,7 +11,7 @@ An object representing the options for a form. ## Extends -- [`BaseFormOptions`](../BaseFormOptions.md)\<`TFormData`, `TSubmitMeta`\> +- [`BaseFormOptions`](BaseFormOptions.md)\<`TFormData`, `TSubmitMeta`\> ## Type Parameters @@ -125,7 +125,7 @@ Set initial values for your form. #### Inherited from -[`BaseFormOptions`](../BaseFormOptions.md).[`defaultValues`](../BaseFormOptions.md#defaultvalues) +[`BaseFormOptions`](BaseFormOptions.md).[`defaultValues`](BaseFormOptions.md#defaultvalues) *** @@ -169,7 +169,7 @@ A function to be called when the form is submitted, what should happen once the ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> ###### meta @@ -201,7 +201,7 @@ Specify an action for scenarios where the user tries to submit an invalid form. ###### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\> ###### meta @@ -229,7 +229,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun #### Inherited from -[`BaseFormOptions`](../BaseFormOptions.md).[`onSubmitMeta`](../BaseFormOptions.md#onsubmitmeta) +[`BaseFormOptions`](BaseFormOptions.md).[`onSubmitMeta`](BaseFormOptions.md#onsubmitmeta) *** diff --git a/docs/reference/interfaces/FormState.md b/docs/reference/interfaces/FormState.md index 8b7a41816..70e722571 100644 --- a/docs/reference/interfaces/FormState.md +++ b/docs/reference/interfaces/FormState.md @@ -11,7 +11,7 @@ An object representing the current state of the form. ## Extends -- [`BaseFormState`](../../type-aliases/BaseFormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\>.[`DerivedFormState`](../../type-aliases/DerivedFormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\> +- [`BaseFormState`](../type-aliases/BaseFormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\>.[`DerivedFormState`](../type-aliases/DerivedFormState.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`\> ## Type Parameters diff --git a/docs/reference/interfaces/ObjectDeepKeyAndValue.md b/docs/reference/interfaces/ObjectDeepKeyAndValue.md index db66d0328..9ebc1c169 100644 --- a/docs/reference/interfaces/ObjectDeepKeyAndValue.md +++ b/docs/reference/interfaces/ObjectDeepKeyAndValue.md @@ -9,13 +9,13 @@ Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/TanStac ## Extends -- [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +- [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ## Type Parameters ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ### T @@ -23,7 +23,7 @@ Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/TanStac ### TKey -`TKey` *extends* [`AllObjectKeys`](../../type-aliases/AllObjectKeys.md)\<`T`\> +`TKey` *extends* [`AllObjectKeys`](../type-aliases/AllObjectKeys.md)\<`T`\> ## Properties @@ -37,7 +37,7 @@ Defined in: [packages/form-core/src/util-types.ts:102](https://github.com/TanSta #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`key`](../AnyDeepKeyAndValue.md#key) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`key`](AnyDeepKeyAndValue.md#key) *** @@ -51,4 +51,4 @@ Defined in: [packages/form-core/src/util-types.ts:103](https://github.com/TanSta #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`value`](../AnyDeepKeyAndValue.md#value) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`value`](AnyDeepKeyAndValue.md#value) diff --git a/docs/reference/interfaces/TupleDeepKeyAndValue.md b/docs/reference/interfaces/TupleDeepKeyAndValue.md index dd58fd79c..e10b6fca3 100644 --- a/docs/reference/interfaces/TupleDeepKeyAndValue.md +++ b/docs/reference/interfaces/TupleDeepKeyAndValue.md @@ -9,13 +9,13 @@ Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/TanStac ## Extends -- [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +- [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ## Type Parameters ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ### T @@ -23,7 +23,7 @@ Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/TanStac ### TKey -`TKey` *extends* [`AllTupleKeys`](../../type-aliases/AllTupleKeys.md)\<`T`\> +`TKey` *extends* [`AllTupleKeys`](../type-aliases/AllTupleKeys.md)\<`T`\> ## Properties @@ -37,7 +37,7 @@ Defined in: [packages/form-core/src/util-types.ts:61](https://github.com/TanStac #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`key`](../AnyDeepKeyAndValue.md#key) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`key`](AnyDeepKeyAndValue.md#key) *** @@ -53,4 +53,4 @@ Defined in: [packages/form-core/src/util-types.ts:62](https://github.com/TanStac #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`value`](../AnyDeepKeyAndValue.md#value) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`value`](AnyDeepKeyAndValue.md#value) diff --git a/docs/reference/interfaces/UnknownDeepKeyAndValue.md b/docs/reference/interfaces/UnknownDeepKeyAndValue.md index 044a3705a..dfcd0e6bb 100644 --- a/docs/reference/interfaces/UnknownDeepKeyAndValue.md +++ b/docs/reference/interfaces/UnknownDeepKeyAndValue.md @@ -9,13 +9,13 @@ Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/TanSta ## Extends -- [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +- [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ## Type Parameters ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md) ## Properties @@ -29,7 +29,7 @@ Defined in: [packages/form-core/src/util-types.ts:124](https://github.com/TanSta #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`key`](../AnyDeepKeyAndValue.md#key) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`key`](AnyDeepKeyAndValue.md#key) *** @@ -43,4 +43,4 @@ Defined in: [packages/form-core/src/util-types.ts:125](https://github.com/TanSta #### Overrides -[`AnyDeepKeyAndValue`](../AnyDeepKeyAndValue.md).[`value`](../AnyDeepKeyAndValue.md#value) +[`AnyDeepKeyAndValue`](AnyDeepKeyAndValue.md).[`value`](AnyDeepKeyAndValue.md#value) diff --git a/docs/reference/interfaces/ValidationLogicProps.md b/docs/reference/interfaces/ValidationLogicProps.md index 5e48570de..0a76b5010 100644 --- a/docs/reference/interfaces/ValidationLogicProps.md +++ b/docs/reference/interfaces/ValidationLogicProps.md @@ -61,7 +61,7 @@ Defined in: [packages/form-core/src/ValidationLogic.ts:33](https://github.com/Ta ###### form -[`AnyFormApi`](../../type-aliases/AnyFormApi.md) +[`AnyFormApi`](../type-aliases/AnyFormApi.md) ###### validators diff --git a/docs/reference/type-aliases/ArrayAccessor.md b/docs/reference/type-aliases/ArrayAccessor.md index fc9d63929..731a9334c 100644 --- a/docs/reference/type-aliases/ArrayAccessor.md +++ b/docs/reference/type-aliases/ArrayAccessor.md @@ -15,4 +15,4 @@ Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) diff --git a/docs/reference/type-aliases/BaseFormState.md b/docs/reference/type-aliases/BaseFormState.md index a0818befc..98b5a867e 100644 --- a/docs/reference/type-aliases/BaseFormState.md +++ b/docs/reference/type-aliases/BaseFormState.md @@ -15,7 +15,7 @@ An object representing the current state of the form. ## Extended by -- [`FormState`](../../interfaces/FormState.md) +- [`FormState`](../interfaces/FormState.md) ## Type Parameters diff --git a/docs/reference/type-aliases/DeepKeyAndValueArray.md b/docs/reference/type-aliases/DeepKeyAndValueArray.md index e1a5a3959..6e7fc646c 100644 --- a/docs/reference/type-aliases/DeepKeyAndValueArray.md +++ b/docs/reference/type-aliases/DeepKeyAndValueArray.md @@ -17,7 +17,7 @@ Defined in: [packages/form-core/src/util-types.ts:41](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### T diff --git a/docs/reference/type-aliases/DeepKeyAndValueObject.md b/docs/reference/type-aliases/DeepKeyAndValueObject.md index 3614e50bc..b7d99ad3d 100644 --- a/docs/reference/type-aliases/DeepKeyAndValueObject.md +++ b/docs/reference/type-aliases/DeepKeyAndValueObject.md @@ -17,7 +17,7 @@ Defined in: [packages/form-core/src/util-types.ts:106](https://github.com/TanSta ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### T @@ -29,4 +29,4 @@ Defined in: [packages/form-core/src/util-types.ts:106](https://github.com/TanSta ### TAllKeys -`TAllKeys` *extends* [`AllObjectKeys`](../AllObjectKeys.md)\<`T`\> = [`AllObjectKeys`](../AllObjectKeys.md)\<`T`\> +`TAllKeys` *extends* [`AllObjectKeys`](AllObjectKeys.md)\<`T`\> = [`AllObjectKeys`](AllObjectKeys.md)\<`T`\> diff --git a/docs/reference/type-aliases/DeepKeyAndValueTuple.md b/docs/reference/type-aliases/DeepKeyAndValueTuple.md index 6d99e8e28..117ee74d1 100644 --- a/docs/reference/type-aliases/DeepKeyAndValueTuple.md +++ b/docs/reference/type-aliases/DeepKeyAndValueTuple.md @@ -17,7 +17,7 @@ Defined in: [packages/form-core/src/util-types.ts:67](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### T @@ -29,4 +29,4 @@ Defined in: [packages/form-core/src/util-types.ts:67](https://github.com/TanStac ### TAllKeys -`TAllKeys` *extends* [`AllTupleKeys`](../AllTupleKeys.md)\<`T`\> = [`AllTupleKeys`](../AllTupleKeys.md)\<`T`\> +`TAllKeys` *extends* [`AllTupleKeys`](AllTupleKeys.md)\<`T`\> = [`AllTupleKeys`](AllTupleKeys.md)\<`T`\> diff --git a/docs/reference/type-aliases/DeepKeysAndValuesImpl.md b/docs/reference/type-aliases/DeepKeysAndValuesImpl.md index 70723bb3f..3e9432752 100644 --- a/docs/reference/type-aliases/DeepKeysAndValuesImpl.md +++ b/docs/reference/type-aliases/DeepKeysAndValuesImpl.md @@ -23,7 +23,7 @@ Defined in: [packages/form-core/src/util-types.ts:133](https://github.com/TanSta ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) = `never` +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) = `never` ### TAcc diff --git a/docs/reference/type-aliases/DerivedFormState.md b/docs/reference/type-aliases/DerivedFormState.md index b06c0c330..c7982163a 100644 --- a/docs/reference/type-aliases/DerivedFormState.md +++ b/docs/reference/type-aliases/DerivedFormState.md @@ -13,7 +13,7 @@ Defined in: [packages/form-core/src/FormApi.ts:661](https://github.com/TanStack/ ## Extended by -- [`FormState`](../../interfaces/FormState.md) +- [`FormState`](../interfaces/FormState.md) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldMeta.md b/docs/reference/type-aliases/FieldMeta.md index 767eaef71..a61eadfde 100644 --- a/docs/reference/type-aliases/FieldMeta.md +++ b/docs/reference/type-aliases/FieldMeta.md @@ -21,11 +21,11 @@ An object type representing the metadata of a field in a form. ### TName -`TName` *extends* [`DeepKeys`](../DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/type-aliases/FieldMetaBase.md b/docs/reference/type-aliases/FieldMetaBase.md index decc3b5a9..ccc3a856e 100644 --- a/docs/reference/type-aliases/FieldMetaBase.md +++ b/docs/reference/type-aliases/FieldMetaBase.md @@ -19,11 +19,11 @@ Defined in: [packages/form-core/src/FieldApi.ts:567](https://github.com/TanStack ### TName -`TName` *extends* [`DeepKeys`](../DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/type-aliases/FieldMetaDerived.md b/docs/reference/type-aliases/FieldMetaDerived.md index 46e9298ec..91f274a57 100644 --- a/docs/reference/type-aliases/FieldMetaDerived.md +++ b/docs/reference/type-aliases/FieldMetaDerived.md @@ -19,11 +19,11 @@ Defined in: [packages/form-core/src/FieldApi.ts:659](https://github.com/TanStack ### TName -`TName` *extends* [`DeepKeys`](../DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/type-aliases/FieldState.md b/docs/reference/type-aliases/FieldState.md index 5cf7d5846..b38e63d5e 100644 --- a/docs/reference/type-aliases/FieldState.md +++ b/docs/reference/type-aliases/FieldState.md @@ -21,11 +21,11 @@ An object type representing the state of a field. ### TName -`TName` *extends* [`DeepKeys`](../DeepKeys.md)\<`TParentData`\> +`TName` *extends* [`DeepKeys`](DeepKeys.md)\<`TParentData`\> ### TData -`TData` *extends* [`DeepValue`](../DeepValue.md)\<`TParentData`, `TName`\> +`TData` *extends* [`DeepValue`](DeepValue.md)\<`TParentData`, `TName`\> ### TOnMount diff --git a/docs/reference/type-aliases/FormValidateFn.md b/docs/reference/type-aliases/FormValidateFn.md index ac1656c22..52f7322bf 100644 --- a/docs/reference/type-aliases/FormValidateFn.md +++ b/docs/reference/type-aliases/FormValidateFn.md @@ -23,7 +23,7 @@ Defined in: [packages/form-core/src/FormApi.ts:84](https://github.com/TanStack/f #### formApi -[`FormApi`](../../classes/FormApi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> +[`FormApi`](../classes/FormApi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> #### value diff --git a/docs/reference/type-aliases/ObjectAccessor.md b/docs/reference/type-aliases/ObjectAccessor.md index b704054c2..5a28cbc5b 100644 --- a/docs/reference/type-aliases/ObjectAccessor.md +++ b/docs/reference/type-aliases/ObjectAccessor.md @@ -15,7 +15,7 @@ Defined in: [packages/form-core/src/util-types.ts:84](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### TKey diff --git a/docs/reference/type-aliases/ObjectValue.md b/docs/reference/type-aliases/ObjectValue.md index 9be9caf1b..4508fa84a 100644 --- a/docs/reference/type-aliases/ObjectValue.md +++ b/docs/reference/type-aliases/ObjectValue.md @@ -15,7 +15,7 @@ Defined in: [packages/form-core/src/util-types.ts:91](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### T @@ -23,4 +23,4 @@ Defined in: [packages/form-core/src/util-types.ts:91](https://github.com/TanStac ### TKey -`TKey` *extends* [`AllObjectKeys`](../AllObjectKeys.md)\<`T`\> +`TKey` *extends* [`AllObjectKeys`](AllObjectKeys.md)\<`T`\> diff --git a/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md b/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md index 55d5c9a17..482890eae 100644 --- a/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md +++ b/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md @@ -15,4 +15,4 @@ Defined in: [packages/form-core/src/standardSchemaValidator.ts:11](https://githu ### TSource -`TSource` *extends* [`ValidationSource`](../ValidationSource.md) = [`ValidationSource`](../ValidationSource.md) +`TSource` *extends* [`ValidationSource`](ValidationSource.md) = [`ValidationSource`](ValidationSource.md) diff --git a/docs/reference/type-aliases/TStandardSchemaValidatorValue.md b/docs/reference/type-aliases/TStandardSchemaValidatorValue.md index 3d3d81617..d21caacae 100644 --- a/docs/reference/type-aliases/TStandardSchemaValidatorValue.md +++ b/docs/reference/type-aliases/TStandardSchemaValidatorValue.md @@ -19,7 +19,7 @@ Defined in: [packages/form-core/src/standardSchemaValidator.ts:3](https://github ### TSource -`TSource` *extends* [`ValidationSource`](../ValidationSource.md) = [`ValidationSource`](../ValidationSource.md) +`TSource` *extends* [`ValidationSource`](ValidationSource.md) = [`ValidationSource`](ValidationSource.md) ## Properties diff --git a/docs/reference/type-aliases/TupleAccessor.md b/docs/reference/type-aliases/TupleAccessor.md index eb6745ea2..15602e4ff 100644 --- a/docs/reference/type-aliases/TupleAccessor.md +++ b/docs/reference/type-aliases/TupleAccessor.md @@ -15,7 +15,7 @@ Defined in: [packages/form-core/src/util-types.ts:51](https://github.com/TanStac ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) ### TKey diff --git a/docs/reference/type-aliases/UnknownAccessor.md b/docs/reference/type-aliases/UnknownAccessor.md index 259aa2617..9eb9b9c07 100644 --- a/docs/reference/type-aliases/UnknownAccessor.md +++ b/docs/reference/type-aliases/UnknownAccessor.md @@ -15,4 +15,4 @@ Defined in: [packages/form-core/src/util-types.ts:119](https://github.com/TanSta ### TParent -`TParent` *extends* [`AnyDeepKeyAndValue`](../../interfaces/AnyDeepKeyAndValue.md) +`TParent` *extends* [`AnyDeepKeyAndValue`](../interfaces/AnyDeepKeyAndValue.md) diff --git a/docs/reference/type-aliases/ValidationLogicFn.md b/docs/reference/type-aliases/ValidationLogicFn.md index 484121c8e..3728c093b 100644 --- a/docs/reference/type-aliases/ValidationLogicFn.md +++ b/docs/reference/type-aliases/ValidationLogicFn.md @@ -15,7 +15,7 @@ Defined in: [packages/form-core/src/ValidationLogic.ts:56](https://github.com/Ta ### props -[`ValidationLogicProps`](../../interfaces/ValidationLogicProps.md) +[`ValidationLogicProps`](../interfaces/ValidationLogicProps.md) ## Returns diff --git a/docs/reference/variables/standardSchemaValidators.md b/docs/reference/variables/standardSchemaValidators.md index ee515920c..70e371f6a 100644 --- a/docs/reference/variables/standardSchemaValidators.md +++ b/docs/reference/variables/standardSchemaValidators.md @@ -25,21 +25,21 @@ validate(__namedParameters, schema): ##### TSource -`TSource` *extends* [`ValidationSource`](../../type-aliases/ValidationSource.md) = [`ValidationSource`](../../type-aliases/ValidationSource.md) +`TSource` *extends* [`ValidationSource`](../type-aliases/ValidationSource.md) = [`ValidationSource`](../type-aliases/ValidationSource.md) #### Parameters ##### \_\_namedParameters -[`TStandardSchemaValidatorValue`](../../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\> +[`TStandardSchemaValidatorValue`](../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\> ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md) +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md) #### Returns - \| [`TStandardSchemaValidatorIssue`](../../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\> + \| [`TStandardSchemaValidatorIssue`](../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\> \| `undefined` ### validateAsync() @@ -54,20 +54,20 @@ validateAsync(__namedParameters, schema): Promise< ##### TSource -`TSource` *extends* [`ValidationSource`](../../type-aliases/ValidationSource.md) +`TSource` *extends* [`ValidationSource`](../type-aliases/ValidationSource.md) #### Parameters ##### \_\_namedParameters -[`TStandardSchemaValidatorValue`](../../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\> +[`TStandardSchemaValidatorValue`](../type-aliases/TStandardSchemaValidatorValue.md)\<`unknown`, `TSource`\> ##### schema -[`StandardSchemaV1`](../../type-aliases/StandardSchemaV1.md) +[`StandardSchemaV1`](../type-aliases/StandardSchemaV1.md) #### Returns `Promise`\< - \| [`TStandardSchemaValidatorIssue`](../../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\> + \| [`TStandardSchemaValidatorIssue`](../type-aliases/TStandardSchemaValidatorIssue.md)\<`TSource`\> \| `undefined`\> diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index f2d54bac8..b41c52dbf 100644 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -1,8 +1,6 @@ import { resolve } from 'node:path' import { fileURLToPath } from 'node:url' -import { readFileSync, writeFileSync } from 'node:fs' import { generateReferenceDocs } from '@tanstack/typedoc-config' -import { glob } from 'tinyglobby' const __dirname = fileURLToPath(new URL('.', import.meta.url)) @@ -57,33 +55,6 @@ await generateReferenceDocs({ ], }) -// Find all markdown files matching the pattern -const markdownFiles = [ - ...(await glob('docs/reference/**/*.md')), - ...(await glob('docs/framework/*/reference/**/*.md')), -] - -console.log(`Found ${markdownFiles.length} markdown files to process\n`) - -// Process each markdown file -markdownFiles.forEach((file) => { - const content = readFileSync(file, 'utf-8') - let updatedContent = content - updatedContent = updatedContent.replaceAll(/\]\(\.\.\//gm, '](../../') - // updatedContent = content.replaceAll(/\]\(\.\//gm, '](../') - updatedContent = updatedContent.replaceAll( - /\]\((?!https?:\/\/|\/\/|\/|\.\/|\.\.\/|#)([^)]+)\)/gm, - // @ts-expect-error - (match, p1) => `](../${p1})`, - ) - - // Write the updated content back to the file - if (updatedContent !== content) { - writeFileSync(file, updatedContent, 'utf-8') - console.log(`Processed file: ${file}`) - } -}) - console.log('\n✅ All markdown files have been processed!') process.exit(0) diff --git a/scripts/verify-links.ts b/scripts/verify-links.ts index 268a0ac90..8a1c40ddc 100644 --- a/scripts/verify-links.ts +++ b/scripts/verify-links.ts @@ -1,12 +1,19 @@ import { existsSync, readFileSync, statSync } from 'node:fs' -import path, { resolve } from 'node:path' +import { extname, resolve } from 'node:path' import { glob } from 'tinyglobby' // @ts-ignore Could not find a declaration file for module 'markdown-link-extractor'. import markdownLinkExtractor from 'markdown-link-extractor' +const errors: Array<{ + file: string + link: string + resolvedPath: string + reason: string +}> = [] + function isRelativeLink(link: string) { return ( - link && + !link.startsWith('/') && !link.startsWith('http://') && !link.startsWith('https://') && !link.startsWith('//') && @@ -15,39 +22,33 @@ function isRelativeLink(link: string) { ) } -function normalizePath(p: string): string { - // Remove any trailing .md - p = p.replace(`${path.extname(p)}`, '') - return p +/** Remove any trailing .md */ +function stripExtension(p: string): string { + return p.replace(`${extname(p)}`, '') } -function fileExistsForLink( - link: string, - markdownFile: string, - errors: Array, -): boolean { +function relativeLinkExists(link: string, file: string): boolean { // Remove hash if present - const filePart = link.split('#')[0] + const linkWithoutHash = link.split('#')[0] // If the link is empty after removing hash, it's not a file - if (!filePart) return false - - // Normalize the markdown file path - markdownFile = normalizePath(markdownFile) + if (!linkWithoutHash) return false - // Normalize the path - const normalizedPath = normalizePath(filePart) + // Strip the file/link extensions + const filePath = stripExtension(file) + const linkPath = stripExtension(linkWithoutHash) // Resolve the path relative to the markdown file's directory - let absPath = resolve(markdownFile, normalizedPath) + // Nav up a level to simulate how links are resolved on the web + let absPath = resolve(filePath, '..', linkPath) // Ensure the resolved path is within /docs const docsRoot = resolve('docs') if (!absPath.startsWith(docsRoot)) { errors.push({ link, - markdownFile, + file, resolvedPath: absPath, - reason: 'navigates above /docs, invalid', + reason: 'Path outside /docs', }) return false } @@ -76,15 +77,15 @@ function fileExistsForLink( if (!exists) { errors.push({ link, - markdownFile, + file, resolvedPath: absPath, - reason: 'not found', + reason: 'Not found', }) } return exists } -async function findMarkdownLinks() { +async function verifyMarkdownLinks() { // Find all markdown files in docs directory const markdownFiles = await glob('docs/**/*.md', { ignore: ['**/node_modules/**'], @@ -92,26 +93,18 @@ async function findMarkdownLinks() { console.log(`Found ${markdownFiles.length} markdown files\n`) - const errors: Array = [] - // Process each file for (const file of markdownFiles) { const content = readFileSync(file, 'utf-8') - const links: Array = markdownLinkExtractor(content) - - const filteredLinks = links.filter((link: any) => { - if (typeof link === 'string') { - return isRelativeLink(link) - } else if (link && typeof link.href === 'string') { - return isRelativeLink(link.href) - } - return false + const links: Array = markdownLinkExtractor(content) + + const relativeLinks = links.filter((link: string) => { + return isRelativeLink(link) }) - if (filteredLinks.length > 0) { - filteredLinks.forEach((link) => { - const href = typeof link === 'string' ? link : link.href - fileExistsForLink(href, file, errors) + if (relativeLinks.length > 0) { + relativeLinks.forEach((link) => { + relativeLinkExists(link, file) }) } } @@ -120,7 +113,7 @@ async function findMarkdownLinks() { console.log(`\n❌ Found ${errors.length} broken links:`) errors.forEach((err) => { console.log( - `${err.link}\n in: ${err.markdownFile}\n path: ${err.resolvedPath}\n why: ${err.reason}\n`, + `${err.file}\n link: ${err.link}\n resolved: ${err.resolvedPath}\n why: ${err.reason}\n`, ) }) process.exit(1) @@ -129,4 +122,4 @@ async function findMarkdownLinks() { } } -findMarkdownLinks().catch(console.error) +verifyMarkdownLinks().catch(console.error)