diff --git a/docs/framework/angular/reference/classes/tanstackfield.md b/docs/framework/angular/reference/classes/tanstackfield.md index c15d5b235..321bf69cd 100644 --- a/docs/framework/angular/reference/classes/tanstackfield.md +++ b/docs/framework/angular/reference/classes/tanstackfield.md @@ -7,7 +7,7 @@ title: TanStackField # Class: TanStackField\ -Defined in: [tanstack-field.directive.ts:31](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L31) +Defined in: [tanstack-field.directive.ts:31](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L31) ## Type Parameters @@ -76,7 +76,7 @@ new TanStackField; ``` -Defined in: [tanstack-field.directive.ts:129](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129) +Defined in: [tanstack-field.directive.ts:129](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129) *** @@ -86,7 +86,7 @@ Defined in: [tanstack-field.directive.ts:129](https://github.com/TanStack/form/b optional asyncAlways: boolean; ``` -Defined in: [tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78) +Defined in: [tanstack-field.directive.ts:78](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78) If `true`, always run async validation, even if there are errors emitted during synchronous validation. @@ -104,7 +104,7 @@ FieldOptions.asyncAlways optional asyncDebounceMs: number; ``` -Defined in: [tanstack-field.directive.ts:77](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L77) +Defined in: [tanstack-field.directive.ts:77](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L77) The default time to debounce async validation if there is not a more specific debounce time passed. @@ -122,7 +122,7 @@ FieldOptions.asyncDebounceMs optional defaultMeta: Partial>; ``` -Defined in: [tanstack-field.directive.ts:106](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L106) +Defined in: [tanstack-field.directive.ts:106](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L106) An optional object with default metadata for the field. @@ -140,7 +140,7 @@ FieldOptions.defaultMeta optional defaultValue: NoInfer; ``` -Defined in: [tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L76) +Defined in: [tanstack-field.directive.ts:76](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L76) An optional default value for the field. @@ -158,7 +158,7 @@ FieldOptions.defaultValue optional disableErrorFlat: boolean; ``` -Defined in: [tanstack-field.directive.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L127) +Defined in: [tanstack-field.directive.ts:127](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L127) Disable the `flat(1)` operation on `field.errors`. This is useful if you want to keep the error structure as is. Not suggested for most use-cases. @@ -176,7 +176,7 @@ FieldOptions.disableErrorFlat optional listeners: NoInfer>; ``` -Defined in: [tanstack-field.directive.ts:105](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L105) +Defined in: [tanstack-field.directive.ts:105](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L105) A list of listeners which attach to the corresponding events @@ -194,7 +194,7 @@ FieldOptions.listeners name: TName; ``` -Defined in: [tanstack-field.directive.ts:75](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L75) +Defined in: [tanstack-field.directive.ts:75](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L75) The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. @@ -212,7 +212,7 @@ FieldOptions.name tanstackField: FormApi; ``` -Defined in: [tanstack-field.directive.ts:79](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L79) +Defined in: [tanstack-field.directive.ts:79](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L79) *** @@ -222,7 +222,7 @@ Defined in: [tanstack-field.directive.ts:79](https://github.com/TanStack/form/bl optional unmount: () => void; ``` -Defined in: [tanstack-field.directive.ts:185](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L185) +Defined in: [tanstack-field.directive.ts:185](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L185) #### Returns @@ -236,7 +236,7 @@ Defined in: [tanstack-field.directive.ts:185](https://github.com/TanStack/form/b optional validators: NoInfer>; ``` -Defined in: [tanstack-field.directive.ts:91](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L91) +Defined in: [tanstack-field.directive.ts:91](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L91) A list of validators to pass to the field @@ -254,7 +254,7 @@ FieldOptions.validators ngOnChanges(): void ``` -Defined in: [tanstack-field.directive.ts:197](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L197) +Defined in: [tanstack-field.directive.ts:197](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L197) A callback method that is invoked immediately after the default change detector has checked data-bound properties @@ -279,7 +279,7 @@ OnChanges.ngOnChanges ngOnDestroy(): void ``` -Defined in: [tanstack-field.directive.ts:193](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L193) +Defined in: [tanstack-field.directive.ts:193](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L193) A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed. @@ -302,7 +302,7 @@ OnDestroy.ngOnDestroy ngOnInit(): void ``` -Defined in: [tanstack-field.directive.ts:187](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L187) +Defined in: [tanstack-field.directive.ts:187](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L187) A callback method that is invoked immediately after the default change detector has checked the directive's diff --git a/docs/framework/angular/reference/functions/injectform.md b/docs/framework/angular/reference/functions/injectform.md index 08bdeed3c..828bf5a62 100644 --- a/docs/framework/angular/reference/functions/injectform.md +++ b/docs/framework/angular/reference/functions/injectform.md @@ -11,7 +11,7 @@ title: injectForm function injectForm(opts?): FormApi ``` -Defined in: [inject-form.ts:9](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-form.ts#L9) +Defined in: [inject-form.ts:9](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/inject-form.ts#L9) ## Type Parameters diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md index fad9e10ed..8bc51b62c 100644 --- a/docs/framework/angular/reference/functions/injectstore.md +++ b/docs/framework/angular/reference/functions/injectstore.md @@ -11,7 +11,7 @@ title: injectStore function injectStore(form, selector?): Signal ``` -Defined in: [inject-store.ts:9](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-store.ts#L9) +Defined in: [inject-store.ts:9](https://github.com/Pascalmh/tanstack-form/blob/main/packages/angular-form/src/inject-store.ts#L9) ## Type Parameters diff --git a/docs/framework/lit/reference/classes/tanstackformcontroller.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md index 30f5e3e7b..b232201db 100644 --- a/docs/framework/lit/reference/classes/tanstackformcontroller.md +++ b/docs/framework/lit/reference/classes/tanstackformcontroller.md @@ -7,7 +7,7 @@ title: TanStackFormController # Class: TanStackFormController\ -Defined in: [tanstack-form-controller.ts:190](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L190) +Defined in: [tanstack-form-controller.ts:190](https://github.com/Pascalmh/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L190) ## Type Parameters @@ -43,7 +43,7 @@ Defined in: [tanstack-form-controller.ts:190](https://github.com/TanStack/form/b new TanStackFormController(host, config?): TanStackFormController ``` -Defined in: [tanstack-form-controller.ts:219](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L219) +Defined in: [tanstack-form-controller.ts:219](https://github.com/Pascalmh/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L219) #### Parameters @@ -67,7 +67,7 @@ Defined in: [tanstack-form-controller.ts:219](https://github.com/TanStack/form/b api: FormApi; ``` -Defined in: [tanstack-form-controller.ts:206](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L206) +Defined in: [tanstack-form-controller.ts:206](https://github.com/Pascalmh/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L206) ## Methods @@ -77,7 +77,7 @@ Defined in: [tanstack-form-controller.ts:206](https://github.com/TanStack/form/b field(fieldConfig, render): object ``` -Defined in: [tanstack-form-controller.ts:259](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L259) +Defined in: [tanstack-form-controller.ts:259](https://github.com/Pascalmh/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L259) #### Type Parameters @@ -145,7 +145,7 @@ render: renderCallback(__namedParameters): object ``` -Defined in: [packages/react-form/src/createFormHook.tsx:223](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L223) +Defined in: [packages/react-form/src/createFormHook.tsx:223](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/createFormHook.tsx#L223) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createformhookcontexts.md b/docs/framework/react/reference/functions/createformhookcontexts.md index a01aba533..0af28cd00 100644 --- a/docs/framework/react/reference/functions/createformhookcontexts.md +++ b/docs/framework/react/reference/functions/createformhookcontexts.md @@ -11,7 +11,7 @@ title: createFormHookContexts function createFormHookContexts(): object ``` -Defined in: [packages/react-form/src/createFormHook.tsx:53](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L53) +Defined in: [packages/react-form/src/createFormHook.tsx:53](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/createFormHook.tsx#L53) ## Returns diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md index 37f707ca2..45fb89bee 100644 --- a/docs/framework/react/reference/functions/field.md +++ b/docs/framework/react/reference/functions/field.md @@ -11,7 +11,7 @@ title: Field function Field(__namedParameters): ReactNode ``` -Defined in: [packages/react-form/src/useField.tsx:428](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L428) +Defined in: [packages/react-form/src/useField.tsx:428](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useField.tsx#L428) A function component that takes field options and a render function as children and returns a React component. diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md index 7d26acf7d..8b9cac9f1 100644 --- a/docs/framework/react/reference/functions/usefield.md +++ b/docs/framework/react/reference/functions/usefield.md @@ -11,7 +11,7 @@ title: useField function useField(opts): FieldApi & ReactFieldApi ``` -Defined in: [packages/react-form/src/useField.tsx:118](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L118) +Defined in: [packages/react-form/src/useField.tsx:118](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useField.tsx#L118) A hook for managing a field in a form. diff --git a/docs/framework/react/reference/functions/useform.md b/docs/framework/react/reference/functions/useform.md index cc3de3c7a..d62b66e49 100644 --- a/docs/framework/react/reference/functions/useform.md +++ b/docs/framework/react/reference/functions/useform.md @@ -11,7 +11,7 @@ title: useForm function useForm(opts?): ReactFormExtendedApi ``` -Defined in: [packages/react-form/src/useForm.tsx:142](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L142) +Defined in: [packages/react-form/src/useForm.tsx:142](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useForm.tsx#L142) A custom React Hook that returns an extended instance of the `FormApi` class. diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md index 6545c00a1..da2d87aa2 100644 --- a/docs/framework/react/reference/functions/usetransform.md +++ b/docs/framework/react/reference/functions/usetransform.md @@ -11,7 +11,7 @@ title: useTransform function useTransform(fn, deps): FormTransform ``` -Defined in: [packages/react-form/src/useTransform.ts:9](https://github.com/TanStack/form/blob/main/packages/react-form/src/useTransform.ts#L9) +Defined in: [packages/react-form/src/useTransform.ts:9](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useTransform.ts#L9) ## Parameters diff --git a/docs/framework/react/reference/interfaces/reactformapi.md b/docs/framework/react/reference/interfaces/reactformapi.md index 96896a2f2..4136e2b57 100644 --- a/docs/framework/react/reference/interfaces/reactformapi.md +++ b/docs/framework/react/reference/interfaces/reactformapi.md @@ -7,7 +7,7 @@ title: ReactFormApi # Interface: ReactFormApi\ -Defined in: [packages/react-form/src/useForm.tsx:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L21) +Defined in: [packages/react-form/src/useForm.tsx:21](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useForm.tsx#L21) Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm` @@ -41,7 +41,7 @@ Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned Field: FieldComponent; ``` -Defined in: [packages/react-form/src/useForm.tsx:36](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L36) +Defined in: [packages/react-form/src/useForm.tsx:36](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useForm.tsx#L36) A React component to render form fields. With this, you can render and manage individual form fields. @@ -53,7 +53,7 @@ A React component to render form fields. With this, you can render and manage in Subscribe: (props) => ReactNode; ``` -Defined in: [packages/react-form/src/useForm.tsx:51](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L51) +Defined in: [packages/react-form/src/useForm.tsx:51](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useForm.tsx#L51) A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates. diff --git a/docs/framework/react/reference/interfaces/withformprops.md b/docs/framework/react/reference/interfaces/withformprops.md index fc40a17dc..580675d78 100644 --- a/docs/framework/react/reference/interfaces/withformprops.md +++ b/docs/framework/react/reference/interfaces/withformprops.md @@ -7,7 +7,7 @@ title: WithFormProps # Interface: WithFormProps\ -Defined in: [packages/react-form/src/createFormHook.tsx:173](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L173) +Defined in: [packages/react-form/src/createFormHook.tsx:173](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/createFormHook.tsx#L173) ## Extends @@ -49,7 +49,7 @@ Defined in: [packages/react-form/src/createFormHook.tsx:173](https://github.com/ optional props: TRenderProps; ``` -Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L200) +Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/createFormHook.tsx#L200) *** @@ -59,7 +59,7 @@ Defined in: [packages/react-form/src/createFormHook.tsx:200](https://github.com/ render: (props) => Element; ``` -Defined in: [packages/react-form/src/createFormHook.tsx:201](https://github.com/TanStack/form/blob/main/packages/react-form/src/createFormHook.tsx#L201) +Defined in: [packages/react-form/src/createFormHook.tsx:201](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/createFormHook.tsx#L201) #### Parameters diff --git a/docs/framework/react/reference/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md index b368dda79..39200c31b 100644 --- a/docs/framework/react/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/react/reference/type-aliases/fieldcomponent.md @@ -14,7 +14,7 @@ type FieldComponent ReactNode; ``` -Defined in: [packages/react-form/src/useField.tsx:363](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L363) +Defined in: [packages/react-form/src/useField.tsx:363](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useField.tsx#L363) A type alias representing a field component for a specific form data type. diff --git a/docs/framework/react/reference/type-aliases/reactformextendedapi.md b/docs/framework/react/reference/type-aliases/reactformextendedapi.md index 64961b7c8..ea4a833ee 100644 --- a/docs/framework/react/reference/type-aliases/reactformextendedapi.md +++ b/docs/framework/react/reference/type-aliases/reactformextendedapi.md @@ -11,7 +11,7 @@ title: ReactFormExtendedApi type ReactFormExtendedApi = FormApi & ReactFormApi; ``` -Defined in: [packages/react-form/src/useForm.tsx:88](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L88) +Defined in: [packages/react-form/src/useForm.tsx:88](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useForm.tsx#L88) An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi` diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md index aaebb1fe2..fb202b2bb 100644 --- a/docs/framework/react/reference/type-aliases/usefield.md +++ b/docs/framework/react/reference/type-aliases/usefield.md @@ -11,7 +11,7 @@ title: UseField type UseField = (opts) => FieldApi; ``` -Defined in: [packages/react-form/src/useField.tsx:50](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L50) +Defined in: [packages/react-form/src/useField.tsx:50](https://github.com/Pascalmh/tanstack-form/blob/main/packages/react-form/src/useField.tsx#L50) A type representing a hook for using a field in a form with the given form data type. diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md index 55ad9bca4..d8f39d027 100644 --- a/docs/framework/solid/reference/functions/createfield.md +++ b/docs/framework/solid/reference/functions/createfield.md @@ -11,7 +11,7 @@ title: createField function createField(opts): () => FieldApi & SolidFieldApi ``` -Defined in: [packages/solid-form/src/createField.tsx:223](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L223) +Defined in: [packages/solid-form/src/createField.tsx:223](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createField.tsx#L223) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md index 0be913e98..ec521bf6f 100644 --- a/docs/framework/solid/reference/functions/createform.md +++ b/docs/framework/solid/reference/functions/createform.md @@ -11,7 +11,7 @@ title: createForm function createForm(opts?): FormApi & SolidFormApi ``` -Defined in: [packages/solid-form/src/createForm.tsx:115](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L115) +Defined in: [packages/solid-form/src/createForm.tsx:115](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L115) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md index 35ccb37a1..651e08138 100644 --- a/docs/framework/solid/reference/functions/field.md +++ b/docs/framework/solid/reference/functions/field.md @@ -11,7 +11,7 @@ title: Field function Field(props): Element ``` -Defined in: [packages/solid-form/src/createField.tsx:524](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L524) +Defined in: [packages/solid-form/src/createField.tsx:524](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createField.tsx#L524) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md index f8a9c5951..c7166cf7a 100644 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ b/docs/framework/solid/reference/interfaces/solidformapi.md @@ -7,7 +7,7 @@ title: SolidFormApi # Interface: SolidFormApi\ -Defined in: [packages/solid-form/src/createForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L14) +Defined in: [packages/solid-form/src/createForm.tsx:14](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L14) ## Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/solid-form/src/createForm.tsx:14](https://github.com/TanSt createField: CreateField; ``` -Defined in: [packages/solid-form/src/createForm.tsx:38](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L38) +Defined in: [packages/solid-form/src/createForm.tsx:38](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L38) *** @@ -49,7 +49,7 @@ Defined in: [packages/solid-form/src/createForm.tsx:38](https://github.com/TanSt Field: FieldComponent; ``` -Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L26) +Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L26) *** @@ -59,7 +59,7 @@ Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/TanSt Subscribe: (props) => Element; ``` -Defined in: [packages/solid-form/src/createForm.tsx:81](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L81) +Defined in: [packages/solid-form/src/createForm.tsx:81](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L81) #### Type Parameters @@ -89,7 +89,7 @@ Defined in: [packages/solid-form/src/createForm.tsx:81](https://github.com/TanSt useStore: (selector?) => () => TSelected; ``` -Defined in: [packages/solid-form/src/createForm.tsx:50](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L50) +Defined in: [packages/solid-form/src/createForm.tsx:50](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createForm.tsx#L50) #### Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md index c45efcc8e..e8e5c57ae 100644 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -11,7 +11,7 @@ title: CreateField type CreateField = (opts) => () => FieldApi & SolidFieldApi; ``` -Defined in: [packages/solid-form/src/createField.tsx:49](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L49) +Defined in: [packages/solid-form/src/createField.tsx:49](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createField.tsx#L49) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md index f61dc4803..b11cce206 100644 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -14,7 +14,7 @@ type FieldComponent JSXElement; ``` -Defined in: [packages/solid-form/src/createField.tsx:400](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L400) +Defined in: [packages/solid-form/src/createField.tsx:400](https://github.com/Pascalmh/tanstack-form/blob/main/packages/solid-form/src/createField.tsx#L400) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md index f2ddae3d1..b11048ba4 100644 --- a/docs/framework/vue/reference/functions/usefield.md +++ b/docs/framework/vue/reference/functions/usefield.md @@ -11,7 +11,7 @@ title: useField function useField(opts): object ``` -Defined in: [packages/vue-form/src/useField.tsx:267](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L267) +Defined in: [packages/vue-form/src/useField.tsx:267](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L267) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md index 3feb93bbf..7b5262760 100644 --- a/docs/framework/vue/reference/functions/useform.md +++ b/docs/framework/vue/reference/functions/useform.md @@ -11,7 +11,7 @@ title: useForm function useForm(opts?): FormApi & VueFormApi ``` -Defined in: [packages/vue-form/src/useForm.tsx:195](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L195) +Defined in: [packages/vue-form/src/useForm.tsx:195](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L195) ## Type Parameters diff --git a/docs/framework/vue/reference/interfaces/vuefieldapi.md b/docs/framework/vue/reference/interfaces/vuefieldapi.md index 6359b1c13..46cd6a121 100644 --- a/docs/framework/vue/reference/interfaces/vuefieldapi.md +++ b/docs/framework/vue/reference/interfaces/vuefieldapi.md @@ -7,7 +7,7 @@ title: VueFieldApi # Interface: VueFieldApi\ -Defined in: [packages/vue-form/src/useField.tsx:140](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L140) +Defined in: [packages/vue-form/src/useField.tsx:140](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L140) ## Type Parameters @@ -39,4 +39,4 @@ Defined in: [packages/vue-form/src/useField.tsx:140](https://github.com/TanStack Field: FieldComponent; ``` -Defined in: [packages/vue-form/src/useField.tsx:152](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L152) +Defined in: [packages/vue-form/src/useField.tsx:152](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L152) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md index 7055de265..223250d46 100644 --- a/docs/framework/vue/reference/interfaces/vueformapi.md +++ b/docs/framework/vue/reference/interfaces/vueformapi.md @@ -7,7 +7,7 @@ title: VueFormApi # Interface: VueFormApi\ -Defined in: [packages/vue-form/src/useForm.tsx:115](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L115) +Defined in: [packages/vue-form/src/useForm.tsx:115](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L115) ## Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/vue-form/src/useForm.tsx:115](https://github.com/TanStack/ Field: FieldComponent; ``` -Defined in: [packages/vue-form/src/useForm.tsx:127](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L127) +Defined in: [packages/vue-form/src/useForm.tsx:127](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L127) *** @@ -49,7 +49,7 @@ Defined in: [packages/vue-form/src/useForm.tsx:127](https://github.com/TanStack/ Subscribe: SubscribeComponent; ``` -Defined in: [packages/vue-form/src/useForm.tsx:182](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L182) +Defined in: [packages/vue-form/src/useForm.tsx:182](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L182) *** @@ -59,7 +59,7 @@ Defined in: [packages/vue-form/src/useForm.tsx:182](https://github.com/TanStack/ useField: UseField; ``` -Defined in: [packages/vue-form/src/useForm.tsx:139](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L139) +Defined in: [packages/vue-form/src/useForm.tsx:139](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L139) *** @@ -69,7 +69,7 @@ Defined in: [packages/vue-form/src/useForm.tsx:139](https://github.com/TanStack/ useStore: (selector?) => Readonly>; ``` -Defined in: [packages/vue-form/src/useForm.tsx:151](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L151) +Defined in: [packages/vue-form/src/useForm.tsx:151](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useForm.tsx#L151) #### Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponent.md b/docs/framework/vue/reference/type-aliases/fieldcomponent.md index b2e6c559a..d024e42d0 100644 --- a/docs/framework/vue/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/vue/reference/type-aliases/fieldcomponent.md @@ -16,7 +16,7 @@ type FieldComponent>; ``` -Defined in: [packages/vue-form/src/useField.tsx:24](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L24) +Defined in: [packages/vue-form/src/useField.tsx:24](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L24) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentboundprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentboundprops.md index 2a01e5c68..fc1dcdbdf 100644 --- a/docs/framework/vue/reference/type-aliases/fieldcomponentboundprops.md +++ b/docs/framework/vue/reference/type-aliases/fieldcomponentboundprops.md @@ -11,7 +11,7 @@ title: FieldComponentBoundProps type FieldComponentBoundProps = UseFieldOptionsBound; ``` -Defined in: [packages/vue-form/src/useField.tsx:412](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L412) +Defined in: [packages/vue-form/src/useField.tsx:412](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L412) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md index 890321467..6d4571de4 100644 --- a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md +++ b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md @@ -11,7 +11,7 @@ title: FieldComponentProps type FieldComponentProps = UseFieldOptions; ``` -Defined in: [packages/vue-form/src/useField.tsx:364](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L364) +Defined in: [packages/vue-form/src/useField.tsx:364](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L364) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md index 6a8e8ba5e..3e324f1d2 100644 --- a/docs/framework/vue/reference/type-aliases/usefield.md +++ b/docs/framework/vue/reference/type-aliases/usefield.md @@ -11,7 +11,7 @@ title: UseField type UseField = (opts) => object; ``` -Defined in: [packages/vue-form/src/useField.tsx:166](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L166) +Defined in: [packages/vue-form/src/useField.tsx:166](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L166) ## Type Parameters diff --git a/docs/framework/vue/reference/variables/field.md b/docs/framework/vue/reference/variables/field.md index fef910c9d..6225fcc5a 100644 --- a/docs/framework/vue/reference/variables/field.md +++ b/docs/framework/vue/reference/variables/field.md @@ -11,7 +11,7 @@ title: Field const Field: (props) => CreateComponentPublicInstanceWithMixins & {} | {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {}, false, {}, {}>; ``` -Defined in: [packages/vue-form/src/useField.tsx:442](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L442) +Defined in: [packages/vue-form/src/useField.tsx:442](https://github.com/Pascalmh/tanstack-form/blob/main/packages/vue-form/src/useField.tsx#L442) ## Parameters diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md index e03e15236..0ed257e9b 100644 --- a/docs/reference/classes/fieldapi.md +++ b/docs/reference/classes/fieldapi.md @@ -7,7 +7,7 @@ title: FieldApi # Class: FieldApi\ -Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L863) +Defined in: [packages/form-core/src/FieldApi.ts:863](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L863) A class representing the API for managing a form field. @@ -65,7 +65,7 @@ the `new FieldApi` constructor. new FieldApi(opts): FieldApi ``` -Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L995) +Defined in: [packages/form-core/src/FieldApi.ts:995](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L995) Initializes a new `FieldApi` instance. @@ -87,7 +87,7 @@ Initializes a new `FieldApi` instance. form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L907) +Defined in: [packages/form-core/src/FieldApi.ts:907](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L907) A reference to the form API instance. @@ -99,7 +99,7 @@ A reference to the form API instance. name: DeepKeys; ``` -Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L931) +Defined in: [packages/form-core/src/FieldApi.ts:931](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L931) The field name. @@ -111,7 +111,7 @@ The field name. options: FieldApiOptions; ``` -Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L935) The field options. @@ -123,7 +123,7 @@ The field options. store: Derived>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L959) +Defined in: [packages/form-core/src/FieldApi.ts:959](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L959) The field state store. @@ -135,7 +135,7 @@ The field state store. timeoutIds: object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L986) +Defined in: [packages/form-core/src/FieldApi.ts:986](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L986) #### formListeners @@ -165,7 +165,7 @@ validations: Record; get state(): FieldState ``` -Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L983) +Defined in: [packages/form-core/src/FieldApi.ts:983](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L983) The current field state. @@ -181,7 +181,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1249) +Defined in: [packages/form-core/src/FieldApi.ts:1249](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1249) Gets the field information object. @@ -197,7 +197,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1217) +Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1217) #### Returns @@ -211,7 +211,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:1217](https://github.com/TanStac getValue(): TData ``` -Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1202) Gets the current field value. @@ -231,7 +231,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1661) +Defined in: [packages/form-core/src/FieldApi.ts:1661](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1661) Handles the blur event. @@ -247,7 +247,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1654) +Defined in: [packages/form-core/src/FieldApi.ts:1654](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1654) Handles the change event. @@ -272,7 +272,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1266) +Defined in: [packages/form-core/src/FieldApi.ts:1266](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1266) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -302,7 +302,7 @@ Inserts a value at the specified index, shifting the subsequent values to the ri mount(): () => void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1092) +Defined in: [packages/form-core/src/FieldApi.ts:1092](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1092) Mounts the field instance to the form. @@ -325,7 +325,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1310) +Defined in: [packages/form-core/src/FieldApi.ts:1310](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1310) Moves the value at the first specified index to the second specified index. @@ -357,7 +357,7 @@ parseValueWithSchema(schema): | StandardSchemaV1Issue[] ``` -Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1703) +Defined in: [packages/form-core/src/FieldApi.ts:1703](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1703) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -385,7 +385,7 @@ parseValueWithSchemaAsync(schema): Promise< | StandardSchemaV1Issue[]> ``` -Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1715) +Defined in: [packages/form-core/src/FieldApi.ts:1715](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1715) Parses the field's value with the given schema and returns issues (if any). This method does NOT set any internal errors. @@ -412,7 +412,7 @@ The standard schema to parse this field's value with. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1254) +Defined in: [packages/form-core/src/FieldApi.ts:1254](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1254) Pushes a new value to the field. @@ -438,7 +438,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1292) +Defined in: [packages/form-core/src/FieldApi.ts:1292](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1292) Removes a value at the specified index. @@ -467,7 +467,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1279) +Defined in: [packages/form-core/src/FieldApi.ts:1279](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1279) Replaces a value at the specified index. @@ -497,7 +497,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1678) +Defined in: [packages/form-core/src/FieldApi.ts:1678](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1678) Updates the field's errorMap @@ -519,7 +519,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1222) +Defined in: [packages/form-core/src/FieldApi.ts:1222](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1222) Sets the field metadata. @@ -541,7 +541,7 @@ Sets the field metadata. setValue(updater, options?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1209) +Defined in: [packages/form-core/src/FieldApi.ts:1209](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1209) Sets the field value and run the `change` validator. @@ -570,7 +570,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1301) +Defined in: [packages/form-core/src/FieldApi.ts:1301](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1301) Swaps the values at the specified indices. @@ -600,7 +600,7 @@ Swaps the values at the specified indices. update(opts): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1145) +Defined in: [packages/form-core/src/FieldApi.ts:1145](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1145) Updates the field instance with new options. @@ -622,7 +622,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1621) +Defined in: [packages/form-core/src/FieldApi.ts:1621](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L1621) Validates the field value. diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md index 116a76590..1ac965df3 100644 --- a/docs/reference/classes/formapi.md +++ b/docs/reference/classes/formapi.md @@ -7,7 +7,7 @@ title: FormApi # Class: FormApi\ -Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L771) +Defined in: [packages/form-core/src/FormApi.ts:771](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L771) A class representing the Form API. It handles the logic and interactions with the form state. @@ -45,7 +45,7 @@ However, if you need to create a new instance manually, you can do so by calling new FormApi(opts?): FormApi ``` -Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L842) +Defined in: [packages/form-core/src/FormApi.ts:842](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L842) Constructs a new `FormApi` instance with the given form options. @@ -67,7 +67,7 @@ Constructs a new `FormApi` instance with the given form options. baseStore: Store>; ``` -Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L798) +Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L798) *** @@ -77,7 +77,7 @@ Defined in: [packages/form-core/src/FormApi.ts:798](https://github.com/TanStack/ fieldInfo: Record, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L828) +Defined in: [packages/form-core/src/FormApi.ts:828](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L828) A record of field information for each field in the form. @@ -89,7 +89,7 @@ A record of field information for each field in the form. fieldMetaDerived: Derived, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L811) +Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L811) *** @@ -99,7 +99,7 @@ Defined in: [packages/form-core/src/FormApi.ts:811](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L786) +Defined in: [packages/form-core/src/FormApi.ts:786](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L786) The options for the form. @@ -111,7 +111,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L812) +Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L812) ## Accessors @@ -123,7 +123,7 @@ Defined in: [packages/form-core/src/FormApi.ts:812](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L830) +Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L830) ##### Returns @@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:830](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940) +Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1940) #### Type Parameters @@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:2214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2214) +Defined in: [packages/form-core/src/FormApi.ts:2214](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2214) Returns form and field level errors @@ -212,7 +212,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1854](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1854) +Defined in: [packages/form-core/src/FormApi.ts:1854](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1854) Gets the field info of the specified field. @@ -238,7 +238,7 @@ Gets the field info of the specified field. getFieldMeta(field): undefined | AnyFieldMeta ``` -Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1845) +Defined in: [packages/form-core/src/FormApi.ts:1845](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1845) Gets the metadata of the specified field. @@ -264,7 +264,7 @@ Gets the metadata of the specified field. getFieldValue(field): DeepValue ``` -Defined in: [packages/form-core/src/FormApi.ts:1838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1838) +Defined in: [packages/form-core/src/FormApi.ts:1838](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1838) Gets the value of the specified field. @@ -292,7 +292,7 @@ Gets the value of the specified field. handleSubmit(): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1740](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1740) +Defined in: [packages/form-core/src/FormApi.ts:1740](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1740) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -306,7 +306,7 @@ Handles the form submission, performs validation, and calls the appropriate onSu handleSubmit(submitMeta): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1741](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1741) +Defined in: [packages/form-core/src/FormApi.ts:1741](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1741) Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks. @@ -332,7 +332,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1979](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1979) +Defined in: [packages/form-core/src/FormApi.ts:1979](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1979) #### Type Parameters @@ -368,7 +368,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1979](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) +Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1168) #### Returns @@ -390,7 +390,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2103) +Defined in: [packages/form-core/src/FormApi.ts:2103](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2103) Moves the value at the first specified index to the second specified index within an array field. @@ -433,7 +433,7 @@ parseValuesWithSchema(schema): } ``` -Defined in: [packages/form-core/src/FormApi.ts:2274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2274) +Defined in: [packages/form-core/src/FormApi.ts:2274](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2274) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -467,7 +467,7 @@ parseValuesWithSchemaAsync(schema): Promise< }> ``` -Defined in: [packages/form-core/src/FormApi.ts:2286](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2286) +Defined in: [packages/form-core/src/FormApi.ts:2286](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2286) Parses the form's values with a given standard schema and returns issues (if any). This method does NOT set any internal errors. @@ -500,7 +500,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1964](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1964) +Defined in: [packages/form-core/src/FormApi.ts:1964](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1964) Pushes a value into an array field. @@ -537,7 +537,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2037](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2037) +Defined in: [packages/form-core/src/FormApi.ts:2037](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2037) Removes a value from an array field at the specified index. @@ -575,7 +575,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:2011](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2011) +Defined in: [packages/form-core/src/FormApi.ts:2011](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2011) Replaces a value into an array field at the specified index. @@ -613,7 +613,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1256) +Defined in: [packages/form-core/src/FormApi.ts:1256](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1256) Resets the form state to the default values. If values are provided, the form will be reset to those values instead and the default values will be updated. @@ -646,7 +646,7 @@ Optional options to control the reset behavior. resetField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2131](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2131) +Defined in: [packages/form-core/src/FormApi.ts:2131](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2131) Resets the field value and meta to default state @@ -672,7 +672,7 @@ Resets the field value and meta to default state resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1894](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1894) +Defined in: [packages/form-core/src/FormApi.ts:1894](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1894) resets every field's meta @@ -698,7 +698,7 @@ resets every field's meta setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2152](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2152) +Defined in: [packages/form-core/src/FormApi.ts:2152](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2152) Updates the form's errorMap @@ -720,7 +720,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1873](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1873) +Defined in: [packages/form-core/src/FormApi.ts:1873](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1873) Updates the metadata of the specified field. @@ -753,7 +753,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1910](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1910) +Defined in: [packages/form-core/src/FormApi.ts:1910](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1910) Sets the value of the specified field and optionally updates the touched state. @@ -791,7 +791,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:2074](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2074) +Defined in: [packages/form-core/src/FormApi.ts:2074](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L2074) Swaps the values at the specified indices within an array field. @@ -829,7 +829,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1188) +Defined in: [packages/form-core/src/FormApi.ts:1188](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1188) Updates the form options and form state. @@ -851,7 +851,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1282) +Defined in: [packages/form-core/src/FormApi.ts:1282](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1282) Validates all fields using the correct handlers for a given validation cause. @@ -876,7 +876,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1312) +Defined in: [packages/form-core/src/FormApi.ts:1312](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1312) Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type. @@ -910,7 +910,7 @@ Validates the children of a specified array in the form starting from a given in validateField(field, cause): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1353) +Defined in: [packages/form-core/src/FormApi.ts:1353](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L1353) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/reference/functions/evaluate.md b/docs/reference/functions/evaluate.md index d91ae8f64..7c68b6dc7 100644 --- a/docs/reference/functions/evaluate.md +++ b/docs/reference/functions/evaluate.md @@ -11,7 +11,7 @@ title: evaluate function evaluate(objA, objB): boolean ``` -Defined in: [packages/form-core/src/utils.ts:339](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L339) +Defined in: [packages/form-core/src/utils.ts:339](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/utils.ts#L339) ## Type Parameters diff --git a/docs/reference/functions/formoptions.md b/docs/reference/functions/formoptions.md index 7fa483b5b..85f02909b 100644 --- a/docs/reference/functions/formoptions.md +++ b/docs/reference/functions/formoptions.md @@ -11,7 +11,7 @@ title: formOptions function formOptions(defaultOpts): T ``` -Defined in: [packages/form-core/src/formOptions.ts:3](https://github.com/TanStack/form/blob/main/packages/form-core/src/formOptions.ts#L3) +Defined in: [packages/form-core/src/formOptions.ts:3](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/formOptions.ts#L3) ## Type Parameters diff --git a/docs/reference/functions/isglobalformvalidationerror.md b/docs/reference/functions/isglobalformvalidationerror.md index e4bc8b904..8a94d586b 100644 --- a/docs/reference/functions/isglobalformvalidationerror.md +++ b/docs/reference/functions/isglobalformvalidationerror.md @@ -11,7 +11,7 @@ title: isGlobalFormValidationError function isGlobalFormValidationError(error): error is GlobalFormValidationError ``` -Defined in: [packages/form-core/src/utils.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L333) +Defined in: [packages/form-core/src/utils.ts:333](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/utils.ts#L333) ## Parameters diff --git a/docs/reference/functions/isstandardschemavalidator.md b/docs/reference/functions/isstandardschemavalidator.md index 8f9dacc46..793fa2dde 100644 --- a/docs/reference/functions/isstandardschemavalidator.md +++ b/docs/reference/functions/isstandardschemavalidator.md @@ -11,7 +11,7 @@ title: isStandardSchemaValidator function isStandardSchemaValidator(validator): validator is StandardSchemaV1 ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:90](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L90) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:90](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L90) ## Parameters diff --git a/docs/reference/functions/mergeform.md b/docs/reference/functions/mergeform.md index 25d3a54e3..163c2e852 100644 --- a/docs/reference/functions/mergeform.md +++ b/docs/reference/functions/mergeform.md @@ -11,7 +11,7 @@ title: mergeForm function mergeForm(baseForm, state): FormApi, any, any, any, any, any, any, any, any, any> ``` -Defined in: [packages/form-core/src/mergeForm.ts:73](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L73) +Defined in: [packages/form-core/src/mergeForm.ts:73](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/mergeForm.ts#L73) ## Type Parameters diff --git a/docs/reference/interfaces/anydeepkeyandvalue.md b/docs/reference/interfaces/anydeepkeyandvalue.md index 3ff87227d..865ae139b 100644 --- a/docs/reference/interfaces/anydeepkeyandvalue.md +++ b/docs/reference/interfaces/anydeepkeyandvalue.md @@ -7,7 +7,7 @@ title: AnyDeepKeyAndValue # Interface: AnyDeepKeyAndValue\ -Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L22) +Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L22) ## Extended by @@ -30,7 +30,7 @@ Defined in: [packages/form-core/src/util-types.ts:22](https://github.com/TanStac key: K; ``` -Defined in: [packages/form-core/src/util-types.ts:26](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L26) +Defined in: [packages/form-core/src/util-types.ts:26](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L26) *** @@ -40,4 +40,4 @@ Defined in: [packages/form-core/src/util-types.ts:26](https://github.com/TanStac value: V; ``` -Defined in: [packages/form-core/src/util-types.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L27) +Defined in: [packages/form-core/src/util-types.ts:27](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L27) diff --git a/docs/reference/interfaces/arraydeepkeyandvalue.md b/docs/reference/interfaces/arraydeepkeyandvalue.md index 2ca3c8ae4..9b001809f 100644 --- a/docs/reference/interfaces/arraydeepkeyandvalue.md +++ b/docs/reference/interfaces/arraydeepkeyandvalue.md @@ -7,7 +7,7 @@ title: ArrayDeepKeyAndValue # Interface: ArrayDeepKeyAndValue\ -Defined in: [packages/form-core/src/util-types.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L33) +Defined in: [packages/form-core/src/util-types.ts:33](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L33) ## Extends @@ -27,7 +27,7 @@ Defined in: [packages/form-core/src/util-types.ts:33](https://github.com/TanStac key: `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`; ``` -Defined in: [packages/form-core/src/util-types.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L37) +Defined in: [packages/form-core/src/util-types.ts:37](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L37) #### Overrides @@ -43,7 +43,7 @@ value: | Nullable; ``` -Defined in: [packages/form-core/src/util-types.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L38) +Defined in: [packages/form-core/src/util-types.ts:38](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L38) #### Overrides diff --git a/docs/reference/interfaces/fieldapioptions.md b/docs/reference/interfaces/fieldapioptions.md index 5cc79ab24..0ceaf4657 100644 --- a/docs/reference/interfaces/fieldapioptions.md +++ b/docs/reference/interfaces/fieldapioptions.md @@ -7,7 +7,7 @@ title: FieldApiOptions # Interface: FieldApiOptions\ -Defined in: [packages/form-core/src/FieldApi.ts:455](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L455) +Defined in: [packages/form-core/src/FieldApi.ts:455](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L455) An object type representing the required options for the FieldApi class. @@ -63,7 +63,7 @@ An object type representing the required options for the FieldApi class. optional asyncAlways: boolean; ``` -Defined in: [packages/form-core/src/FieldApi.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L402) +Defined in: [packages/form-core/src/FieldApi.ts:402](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L402) If `true`, always run async validation, even if there are errors emitted during synchronous validation. @@ -79,7 +79,7 @@ If `true`, always run async validation, even if there are errors emitted during optional asyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L398) +Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L398) The default time to debounce async validation if there is not a more specific debounce time passed. @@ -95,7 +95,7 @@ The default time to debounce async validation if there is not a more specific de optional defaultMeta: Partial>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L421) +Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L421) An optional object with default metadata for the field. @@ -111,7 +111,7 @@ An optional object with default metadata for the field. optional defaultValue: NoInfer; ``` -Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L394) +Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L394) An optional default value for the field. @@ -127,7 +127,7 @@ An optional default value for the field. optional disableErrorFlat: boolean; ``` -Defined in: [packages/form-core/src/FieldApi.ts:449](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L449) +Defined in: [packages/form-core/src/FieldApi.ts:449](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L449) Disable the `flat(1)` operation on `field.errors`. This is useful if you want to keep the error structure as is. Not suggested for most use-cases. @@ -143,7 +143,7 @@ Disable the `flat(1)` operation on `field.errors`. This is useful if you want to form: FormApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:507](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L507) +Defined in: [packages/form-core/src/FieldApi.ts:507](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L507) *** @@ -153,7 +153,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:507](https://github.com/TanStack optional listeners: FieldListeners; ``` -Defined in: [packages/form-core/src/FieldApi.ts:445](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L445) +Defined in: [packages/form-core/src/FieldApi.ts:445](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L445) A list of listeners which attach to the corresponding events @@ -169,7 +169,7 @@ A list of listeners which attach to the corresponding events name: TName; ``` -Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L390) +Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L390) The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. @@ -185,7 +185,7 @@ The field name. The type will be `DeepKeys` to ensure your name is optional validators: FieldValidators; ``` -Defined in: [packages/form-core/src/FieldApi.ts:406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L406) +Defined in: [packages/form-core/src/FieldApi.ts:406](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L406) A list of validators to pass to the field diff --git a/docs/reference/interfaces/fieldlisteners.md b/docs/reference/interfaces/fieldlisteners.md index 73588ed61..dfc44104e 100644 --- a/docs/reference/interfaces/fieldlisteners.md +++ b/docs/reference/interfaces/fieldlisteners.md @@ -7,7 +7,7 @@ title: FieldListeners # Interface: FieldListeners\ -Defined in: [packages/form-core/src/FieldApi.ts:353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L353) +Defined in: [packages/form-core/src/FieldApi.ts:353](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L353) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:353](https://github.com/TanStack optional onBlur: FieldListenerFn; ``` -Defined in: [packages/form-core/src/FieldApi.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L360) +Defined in: [packages/form-core/src/FieldApi.ts:360](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L360) *** @@ -35,7 +35,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:360](https://github.com/TanStack optional onBlurDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L361) +Defined in: [packages/form-core/src/FieldApi.ts:361](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L361) *** @@ -45,7 +45,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack optional onChange: FieldListenerFn; ``` -Defined in: [packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) +Defined in: [packages/form-core/src/FieldApi.ts:358](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L358) *** @@ -55,7 +55,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack optional onChangeDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L359) +Defined in: [packages/form-core/src/FieldApi.ts:359](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L359) *** @@ -65,7 +65,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:359](https://github.com/TanStack optional onMount: FieldListenerFn; ``` -Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) +Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L362) *** @@ -75,4 +75,4 @@ Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/TanStack optional onSubmit: FieldListenerFn; ``` -Defined in: [packages/form-core/src/FieldApi.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L363) +Defined in: [packages/form-core/src/FieldApi.ts:363](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L363) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md index d850a48a8..1cf5b5e41 100644 --- a/docs/reference/interfaces/fieldoptions.md +++ b/docs/reference/interfaces/fieldoptions.md @@ -7,7 +7,7 @@ title: FieldOptions # Interface: FieldOptions\ -Defined in: [packages/form-core/src/FieldApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L369) +Defined in: [packages/form-core/src/FieldApi.ts:369](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L369) An object type representing the options for a field in a form. @@ -45,7 +45,7 @@ An object type representing the options for a field in a form. optional asyncAlways: boolean; ``` -Defined in: [packages/form-core/src/FieldApi.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L402) +Defined in: [packages/form-core/src/FieldApi.ts:402](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L402) If `true`, always run async validation, even if there are errors emitted during synchronous validation. @@ -57,7 +57,7 @@ If `true`, always run async validation, even if there are errors emitted during optional asyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L398) +Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L398) The default time to debounce async validation if there is not a more specific debounce time passed. @@ -69,7 +69,7 @@ The default time to debounce async validation if there is not a more specific de optional defaultMeta: Partial>; ``` -Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L421) +Defined in: [packages/form-core/src/FieldApi.ts:421](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L421) An optional object with default metadata for the field. @@ -81,7 +81,7 @@ An optional object with default metadata for the field. optional defaultValue: NoInfer; ``` -Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L394) +Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L394) An optional default value for the field. @@ -93,7 +93,7 @@ An optional default value for the field. optional disableErrorFlat: boolean; ``` -Defined in: [packages/form-core/src/FieldApi.ts:449](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L449) +Defined in: [packages/form-core/src/FieldApi.ts:449](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L449) Disable the `flat(1)` operation on `field.errors`. This is useful if you want to keep the error structure as is. Not suggested for most use-cases. @@ -105,7 +105,7 @@ Disable the `flat(1)` operation on `field.errors`. This is useful if you want to optional listeners: FieldListeners; ``` -Defined in: [packages/form-core/src/FieldApi.ts:445](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L445) +Defined in: [packages/form-core/src/FieldApi.ts:445](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L445) A list of listeners which attach to the corresponding events @@ -117,7 +117,7 @@ A list of listeners which attach to the corresponding events name: TName; ``` -Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L390) +Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L390) The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. @@ -129,6 +129,6 @@ The field name. The type will be `DeepKeys` to ensure your name is optional validators: FieldValidators; ``` -Defined in: [packages/form-core/src/FieldApi.ts:406](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L406) +Defined in: [packages/form-core/src/FieldApi.ts:406](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L406) A list of validators to pass to the field diff --git a/docs/reference/interfaces/fieldvalidators.md b/docs/reference/interfaces/fieldvalidators.md index e3158aa91..0ffb165dc 100644 --- a/docs/reference/interfaces/fieldvalidators.md +++ b/docs/reference/interfaces/fieldvalidators.md @@ -7,7 +7,7 @@ title: FieldValidators # Interface: FieldValidators\ -Defined in: [packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L272) +Defined in: [packages/form-core/src/FieldApi.ts:272](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L272) ## Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/form-core/src/FieldApi.ts:272](https://github.com/TanStack optional onBlur: TOnBlur; ``` -Defined in: [packages/form-core/src/FieldApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L321) +Defined in: [packages/form-core/src/FieldApi.ts:321](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L321) An optional function, that runs on the blur event of input. @@ -57,7 +57,7 @@ z.string().min(1) optional onBlurAsync: TOnBlurAsync; ``` -Defined in: [packages/form-core/src/FieldApi.ts:327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L327) +Defined in: [packages/form-core/src/FieldApi.ts:327](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L327) An optional property similar to `onBlur` but async validation. @@ -75,7 +75,7 @@ z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) optional onBlurAsyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:334](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L334) +Defined in: [packages/form-core/src/FieldApi.ts:334](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L334) An optional number to represent how long the `onBlurAsync` should wait before running @@ -89,7 +89,7 @@ If set to a number larger than 0, will debounce the async validation event by th optional onBlurListenTo: DeepKeys[]; ``` -Defined in: [packages/form-core/src/FieldApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L338) +Defined in: [packages/form-core/src/FieldApi.ts:338](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L338) An optional list of field names that should trigger this field's `onBlur` and `onBlurAsync` events when its value changes @@ -101,7 +101,7 @@ An optional list of field names that should trigger this field's `onBlur` and `o optional onChange: TOnChange; ``` -Defined in: [packages/form-core/src/FieldApi.ts:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L299) +Defined in: [packages/form-core/src/FieldApi.ts:299](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L299) An optional function, that runs on the change event of input. @@ -119,7 +119,7 @@ z.string().min(1) optional onChangeAsync: TOnChangeAsync; ``` -Defined in: [packages/form-core/src/FieldApi.ts:305](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L305) +Defined in: [packages/form-core/src/FieldApi.ts:305](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L305) An optional property similar to `onChange` but async validation @@ -137,7 +137,7 @@ z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) optional onChangeAsyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FieldApi.ts:311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L311) +Defined in: [packages/form-core/src/FieldApi.ts:311](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L311) An optional number to represent how long the `onChangeAsync` should wait before running @@ -151,7 +151,7 @@ If set to a number larger than 0, will debounce the async validation event by th optional onChangeListenTo: DeepKeys[]; ``` -Defined in: [packages/form-core/src/FieldApi.ts:315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L315) +Defined in: [packages/form-core/src/FieldApi.ts:315](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L315) An optional list of field names that should trigger this field's `onChange` and `onChangeAsync` events when its value changes @@ -163,7 +163,7 @@ An optional list of field names that should trigger this field's `onChange` and optional onMount: TOnMount; ``` -Defined in: [packages/form-core/src/FieldApi.ts:293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L293) +Defined in: [packages/form-core/src/FieldApi.ts:293](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L293) An optional function, that runs on the mount event of input. @@ -175,7 +175,7 @@ An optional function, that runs on the mount event of input. optional onSubmit: TOnSubmit; ``` -Defined in: [packages/form-core/src/FieldApi.ts:344](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L344) +Defined in: [packages/form-core/src/FieldApi.ts:344](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L344) An optional function, that runs on the submit event of form. @@ -193,7 +193,7 @@ z.string().min(1) optional onSubmitAsync: TOnSubmitAsync; ``` -Defined in: [packages/form-core/src/FieldApi.ts:350](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L350) +Defined in: [packages/form-core/src/FieldApi.ts:350](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L350) An optional property similar to `onSubmit` but async validation. diff --git a/docs/reference/interfaces/formlisteners.md b/docs/reference/interfaces/formlisteners.md index 2f05b1d47..1f68977ca 100644 --- a/docs/reference/interfaces/formlisteners.md +++ b/docs/reference/interfaces/formlisteners.md @@ -7,7 +7,7 @@ title: FormListeners # Interface: FormListeners\ -Defined in: [packages/form-core/src/FormApi.ts:241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L241) +Defined in: [packages/form-core/src/FormApi.ts:241](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L241) ## Type Parameters @@ -39,7 +39,7 @@ Defined in: [packages/form-core/src/FormApi.ts:241](https://github.com/TanStack/ optional onBlur: (props) => void; ``` -Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270) +Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L270) #### Parameters @@ -65,7 +65,7 @@ Defined in: [packages/form-core/src/FormApi.ts:270](https://github.com/TanStack/ optional onBlurDebounceMs: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L285) +Defined in: [packages/form-core/src/FormApi.ts:285](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L285) *** @@ -75,7 +75,7 @@ Defined in: [packages/form-core/src/FormApi.ts:285](https://github.com/TanStack/ optional onChange: (props) => void; ``` -Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L253) +Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L253) #### Parameters @@ -101,7 +101,7 @@ Defined in: [packages/form-core/src/FormApi.ts:253](https://github.com/TanStack/ optional onChangeDebounceMs: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:268](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L268) +Defined in: [packages/form-core/src/FormApi.ts:268](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L268) *** @@ -111,7 +111,7 @@ Defined in: [packages/form-core/src/FormApi.ts:268](https://github.com/TanStack/ optional onMount: (props) => void; ``` -Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L287) +Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L287) #### Parameters @@ -133,7 +133,7 @@ Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/ optional onSubmit: (props) => void; ``` -Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L302) +Defined in: [packages/form-core/src/FormApi.ts:302](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L302) #### Parameters diff --git a/docs/reference/interfaces/formoptions.md b/docs/reference/interfaces/formoptions.md index 9777960f9..d092506c8 100644 --- a/docs/reference/interfaces/formoptions.md +++ b/docs/reference/interfaces/formoptions.md @@ -7,7 +7,7 @@ title: FormOptions # Interface: FormOptions\ -Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L321) +Defined in: [packages/form-core/src/FormApi.ts:321](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L321) An object representing the options for a form. @@ -41,7 +41,7 @@ An object representing the options for a form. optional asyncAlways: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:356](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L356) +Defined in: [packages/form-core/src/FormApi.ts:356](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L356) If true, always run async validation, even when sync validation has produced an error. Defaults to undefined. @@ -53,7 +53,7 @@ If true, always run async validation, even when sync validation has produced an optional asyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360) +Defined in: [packages/form-core/src/FormApi.ts:360](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L360) Optional time in milliseconds if you want to introduce a delay before firing off an async action. @@ -65,7 +65,7 @@ Optional time in milliseconds if you want to introduce a delay before firing off optional canSubmitWhenInvalid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:364](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L364) +Defined in: [packages/form-core/src/FormApi.ts:364](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L364) If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined. @@ -77,7 +77,7 @@ If true, allows the form to be submitted in an invalid state i.e. canSubmit will optional defaultState: Partial>; ``` -Defined in: [packages/form-core/src/FormApi.ts:340](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L340) +Defined in: [packages/form-core/src/FormApi.ts:340](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L340) The default state for the form. @@ -89,7 +89,7 @@ The default state for the form. optional defaultValues: TFormData; ``` -Defined in: [packages/form-core/src/FormApi.ts:336](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L336) +Defined in: [packages/form-core/src/FormApi.ts:336](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L336) Set initial values for your form. @@ -101,7 +101,7 @@ Set initial values for your form. optional listeners: FormListeners; ``` -Defined in: [packages/form-core/src/FormApi.ts:387](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L387) +Defined in: [packages/form-core/src/FormApi.ts:387](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L387) form level listeners @@ -113,7 +113,7 @@ form level listeners optional onSubmit: (props) => any; ``` -Defined in: [packages/form-core/src/FormApi.ts:403](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L403) +Defined in: [packages/form-core/src/FormApi.ts:403](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L403) A function to be called when the form is submitted, what should happen once the user submits a valid form returns `any` or a promise `Promise` @@ -145,7 +145,7 @@ A function to be called when the form is submitted, what should happen once the optional onSubmitInvalid: (props) => void; ``` -Defined in: [packages/form-core/src/FormApi.ts:422](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L422) +Defined in: [packages/form-core/src/FormApi.ts:422](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L422) Specify an action for scenarios where the user tries to submit an invalid form. @@ -173,7 +173,7 @@ Specify an action for scenarios where the user tries to submit an invalid form. optional onSubmitMeta: TSubmitMeta; ``` -Defined in: [packages/form-core/src/FormApi.ts:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L382) +Defined in: [packages/form-core/src/FormApi.ts:382](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L382) onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props @@ -185,7 +185,7 @@ onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit fun optional transform: FormTransform, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer>; ``` -Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L437) +Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L437) *** @@ -195,6 +195,6 @@ Defined in: [packages/form-core/src/FormApi.ts:437](https://github.com/TanStack/ optional validators: FormValidators; ``` -Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L368) +Defined in: [packages/form-core/src/FormApi.ts:368](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L368) A list of validators to pass to the form diff --git a/docs/reference/interfaces/formstate.md b/docs/reference/interfaces/formstate.md index 99c9a7a56..6e483416a 100644 --- a/docs/reference/interfaces/formstate.md +++ b/docs/reference/interfaces/formstate.md @@ -7,7 +7,7 @@ title: FormState # Interface: FormState\ -Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L647) An object representing the current state of the form. @@ -43,7 +43,7 @@ An object representing the current state of the form. optional _force_re_eval: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:570](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L570) +Defined in: [packages/form-core/src/FormApi.ts:570](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L570) @private, used to force a re-evaluation of the form state when options change @@ -61,7 +61,7 @@ BaseFormState._force_re_eval canSubmit: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L640) +Defined in: [packages/form-core/src/FormApi.ts:640](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L640) A boolean indicating if the form can be submitted based on its current state. @@ -79,7 +79,7 @@ DerivedFormState.canSubmit errorMap: ValidationErrorMap, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormAsyncValidateOrFn>; ``` -Defined in: [packages/form-core/src/FormApi.ts:516](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L516) +Defined in: [packages/form-core/src/FormApi.ts:516](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L516) The error map for the form itself. @@ -105,7 +105,7 @@ errors: ( | UnwrapFormAsyncValidateOrFn)[]; ``` -Defined in: [packages/form-core/src/FormApi.ts:595](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L595) +Defined in: [packages/form-core/src/FormApi.ts:595](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L595) The error array for the form itself. @@ -123,7 +123,7 @@ DerivedFormState.errors fieldMeta: Record, AnyFieldMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L644) +Defined in: [packages/form-core/src/FormApi.ts:644](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L644) A record of field metadata for each field in the form. @@ -141,7 +141,7 @@ DerivedFormState.fieldMeta fieldMetaBase: Record, AnyFieldMetaBase>; ``` -Defined in: [packages/form-core/src/FormApi.ts:533](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L533) +Defined in: [packages/form-core/src/FormApi.ts:533](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L533) A record of field metadata for each field in the form, not including the derived properties, like `errors` and such @@ -159,7 +159,7 @@ BaseFormState.fieldMetaBase isBlurred: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:620](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L620) +Defined in: [packages/form-core/src/FormApi.ts:620](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L620) A boolean indicating if any of the form fields have been blurred. @@ -177,7 +177,7 @@ DerivedFormState.isBlurred isDefaultValue: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L632) +Defined in: [packages/form-core/src/FormApi.ts:632](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L632) A boolean indicating if all of the form's fields are the same as default values. @@ -195,7 +195,7 @@ DerivedFormState.isDefaultValue isDirty: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:624](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L624) +Defined in: [packages/form-core/src/FormApi.ts:624](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L624) A boolean indicating if any of the form's fields' values have been modified by the user. Evaluates `true` if the user have modified at least one of the fields. Opposite of `isPristine`. @@ -213,7 +213,7 @@ DerivedFormState.isDirty isFieldsValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:612](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L612) +Defined in: [packages/form-core/src/FormApi.ts:612](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L612) A boolean indicating if all the form fields are valid. Evaluates `true` if there are no field errors. @@ -231,7 +231,7 @@ DerivedFormState.isFieldsValid isFieldsValidating: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:608](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L608) +Defined in: [packages/form-core/src/FormApi.ts:608](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L608) A boolean indicating if any of the form fields are currently validating. @@ -249,7 +249,7 @@ DerivedFormState.isFieldsValidating isFormValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:591](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L591) +Defined in: [packages/form-core/src/FormApi.ts:591](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L591) A boolean indicating if the form is valid. @@ -267,7 +267,7 @@ DerivedFormState.isFormValid isFormValidating: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:587](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L587) +Defined in: [packages/form-core/src/FormApi.ts:587](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L587) A boolean indicating if the form is currently validating. @@ -285,7 +285,7 @@ DerivedFormState.isFormValidating isPristine: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:628](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L628) +Defined in: [packages/form-core/src/FormApi.ts:628](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L628) A boolean indicating if none of the form's fields' values have been modified by the user. Evaluates `true` if the user have not modified any of the fields. Opposite of `isDirty`. @@ -303,7 +303,7 @@ DerivedFormState.isPristine isSubmitSuccessful: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:566](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L566) +Defined in: [packages/form-core/src/FormApi.ts:566](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L566) A boolean indicating if the last submission was successful. @@ -321,7 +321,7 @@ BaseFormState.isSubmitSuccessful isSubmitted: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L554) +Defined in: [packages/form-core/src/FormApi.ts:554](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L554) A boolean indicating if the `onSubmit` function has completed successfully. @@ -343,7 +343,7 @@ BaseFormState.isSubmitted isSubmitting: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:546](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L546) +Defined in: [packages/form-core/src/FormApi.ts:546](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L546) A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called. @@ -369,7 +369,7 @@ BaseFormState.isSubmitting isTouched: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:616](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L616) +Defined in: [packages/form-core/src/FormApi.ts:616](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L616) A boolean indicating if any of the form fields have been touched. @@ -387,7 +387,7 @@ DerivedFormState.isTouched isValid: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L636) A boolean indicating if the form and all its fields are valid. Evaluates `true` if there are no errors. @@ -405,7 +405,7 @@ DerivedFormState.isValid isValidating: boolean; ``` -Defined in: [packages/form-core/src/FormApi.ts:558](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L558) +Defined in: [packages/form-core/src/FormApi.ts:558](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L558) A boolean indicating if the form or any of its fields are currently validating. @@ -423,7 +423,7 @@ BaseFormState.isValidating submissionAttempts: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:562](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L562) +Defined in: [packages/form-core/src/FormApi.ts:562](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L562) A counter for tracking the number of submission attempts. @@ -441,7 +441,7 @@ BaseFormState.submissionAttempts validationMetaMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", undefined | ValidationMeta>; ``` -Defined in: [packages/form-core/src/FormApi.ts:529](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L529) +Defined in: [packages/form-core/src/FormApi.ts:529](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L529) An internal mechanism used for keeping track of validation logic in a form. @@ -459,7 +459,7 @@ BaseFormState.validationMetaMap values: TFormData; ``` -Defined in: [packages/form-core/src/FormApi.ts:512](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L512) +Defined in: [packages/form-core/src/FormApi.ts:512](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L512) The current values of the form fields. diff --git a/docs/reference/interfaces/formvalidators.md b/docs/reference/interfaces/formvalidators.md index e1d8f2d10..411e027b2 100644 --- a/docs/reference/interfaces/formvalidators.md +++ b/docs/reference/interfaces/formvalidators.md @@ -7,7 +7,7 @@ title: FormValidators # Interface: FormValidators\ -Defined in: [packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L156) +Defined in: [packages/form-core/src/FormApi.ts:156](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L156) ## Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/form-core/src/FormApi.ts:156](https://github.com/TanStack/ optional onBlur: TOnBlur; ``` -Defined in: [packages/form-core/src/FormApi.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L185) +Defined in: [packages/form-core/src/FormApi.ts:185](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L185) Optional function that validates the form data when a field loses focus, returns a `FormValidationError` @@ -47,7 +47,7 @@ Optional function that validates the form data when a field loses focus, returns optional onBlurAsync: TOnBlurAsync; ``` -Defined in: [packages/form-core/src/FormApi.ts:189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L189) +Defined in: [packages/form-core/src/FormApi.ts:189](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L189) Optional onBlur asynchronous validation method for when a field loses focus returns a ` FormValidationError` or a promise of `Promise` @@ -59,7 +59,7 @@ Optional onBlur asynchronous validation method for when a field loses focus retu optional onBlurAsyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:193](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L193) +Defined in: [packages/form-core/src/FormApi.ts:193](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L193) The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds. @@ -71,7 +71,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb optional onChange: TOnChange; ``` -Defined in: [packages/form-core/src/FormApi.ts:173](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L173) +Defined in: [packages/form-core/src/FormApi.ts:173](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L173) Optional function that checks the validity of your data whenever a value changes @@ -83,7 +83,7 @@ Optional function that checks the validity of your data whenever a value changes optional onChangeAsync: TOnChangeAsync; ``` -Defined in: [packages/form-core/src/FormApi.ts:177](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L177) +Defined in: [packages/form-core/src/FormApi.ts:177](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L177) Optional onChange asynchronous counterpart to onChange. Useful for more complex validation logic that might involve server requests. @@ -95,7 +95,7 @@ Optional onChange asynchronous counterpart to onChange. Useful for more complex optional onChangeAsyncDebounceMs: number; ``` -Defined in: [packages/form-core/src/FormApi.ts:181](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L181) +Defined in: [packages/form-core/src/FormApi.ts:181](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L181) The default time in milliseconds that if set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds. @@ -107,7 +107,7 @@ The default time in milliseconds that if set to a number larger than 0, will deb optional onMount: TOnMount; ``` -Defined in: [packages/form-core/src/FormApi.ts:169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L169) +Defined in: [packages/form-core/src/FormApi.ts:169](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L169) Optional function that fires as soon as the component mounts. @@ -119,7 +119,7 @@ Optional function that fires as soon as the component mounts. optional onSubmit: TOnSubmit; ``` -Defined in: [packages/form-core/src/FormApi.ts:194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L194) +Defined in: [packages/form-core/src/FormApi.ts:194](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L194) *** @@ -129,4 +129,4 @@ Defined in: [packages/form-core/src/FormApi.ts:194](https://github.com/TanStack/ optional onSubmitAsync: TOnSubmitAsync; ``` -Defined in: [packages/form-core/src/FormApi.ts:195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L195) +Defined in: [packages/form-core/src/FormApi.ts:195](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L195) diff --git a/docs/reference/interfaces/objectdeepkeyandvalue.md b/docs/reference/interfaces/objectdeepkeyandvalue.md index 39c148aa1..7e2dc8df3 100644 --- a/docs/reference/interfaces/objectdeepkeyandvalue.md +++ b/docs/reference/interfaces/objectdeepkeyandvalue.md @@ -7,7 +7,7 @@ title: ObjectDeepKeyAndValue # Interface: ObjectDeepKeyAndValue\ -Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L97) +Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L97) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/form-core/src/util-types.ts:97](https://github.com/TanStac key: ObjectAccessor; ``` -Defined in: [packages/form-core/src/util-types.ts:102](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L102) +Defined in: [packages/form-core/src/util-types.ts:102](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L102) #### Overrides @@ -43,7 +43,7 @@ Defined in: [packages/form-core/src/util-types.ts:102](https://github.com/TanSta value: ObjectValue; ``` -Defined in: [packages/form-core/src/util-types.ts:103](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L103) +Defined in: [packages/form-core/src/util-types.ts:103](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L103) #### Overrides diff --git a/docs/reference/interfaces/standardschemav1issue.md b/docs/reference/interfaces/standardschemav1issue.md index b2d0b5fe7..9730475da 100644 --- a/docs/reference/interfaces/standardschemav1issue.md +++ b/docs/reference/interfaces/standardschemav1issue.md @@ -7,7 +7,7 @@ title: StandardSchemaV1Issue # Interface: StandardSchemaV1Issue -Defined in: [packages/form-core/src/standardSchemaValidator.ts:159](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L159) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:159](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L159) The issue interface of the failure output. @@ -19,7 +19,7 @@ The issue interface of the failure output. readonly message: string; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:163](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L163) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:163](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L163) The error message of the issue. @@ -31,6 +31,6 @@ The error message of the issue. readonly optional path: readonly (PropertyKey | StandardSchemaV1PathSegment)[]; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:167](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L167) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:167](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L167) The path of the issue, if any. diff --git a/docs/reference/interfaces/tupledeepkeyandvalue.md b/docs/reference/interfaces/tupledeepkeyandvalue.md index 26aa68bb3..4098e14db 100644 --- a/docs/reference/interfaces/tupledeepkeyandvalue.md +++ b/docs/reference/interfaces/tupledeepkeyandvalue.md @@ -7,7 +7,7 @@ title: TupleDeepKeyAndValue # Interface: TupleDeepKeyAndValue\ -Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L56) +Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L56) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/form-core/src/util-types.ts:56](https://github.com/TanStac key: `${TParent["key"] extends never ? "" : TParent["key"]}[${TKey}]`; ``` -Defined in: [packages/form-core/src/util-types.ts:61](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L61) +Defined in: [packages/form-core/src/util-types.ts:61](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L61) #### Overrides @@ -45,7 +45,7 @@ value: | Nullable; ``` -Defined in: [packages/form-core/src/util-types.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L62) +Defined in: [packages/form-core/src/util-types.ts:62](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L62) #### Overrides diff --git a/docs/reference/interfaces/unknowndeepkeyandvalue.md b/docs/reference/interfaces/unknowndeepkeyandvalue.md index faa3dc226..8873e50b5 100644 --- a/docs/reference/interfaces/unknowndeepkeyandvalue.md +++ b/docs/reference/interfaces/unknowndeepkeyandvalue.md @@ -7,7 +7,7 @@ title: UnknownDeepKeyAndValue # Interface: UnknownDeepKeyAndValue\ -Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L122) +Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L122) ## Extends @@ -25,7 +25,7 @@ Defined in: [packages/form-core/src/util-types.ts:122](https://github.com/TanSta key: UnknownAccessor; ``` -Defined in: [packages/form-core/src/util-types.ts:124](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L124) +Defined in: [packages/form-core/src/util-types.ts:124](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L124) #### Overrides @@ -39,7 +39,7 @@ Defined in: [packages/form-core/src/util-types.ts:124](https://github.com/TanSta value: unknown; ``` -Defined in: [packages/form-core/src/util-types.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L125) +Defined in: [packages/form-core/src/util-types.ts:125](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L125) #### Overrides diff --git a/docs/reference/type-aliases/allobjectkeys.md b/docs/reference/type-aliases/allobjectkeys.md index 0bdb179d6..1772c3a8d 100644 --- a/docs/reference/type-aliases/allobjectkeys.md +++ b/docs/reference/type-aliases/allobjectkeys.md @@ -11,7 +11,7 @@ title: AllObjectKeys type AllObjectKeys = T extends any ? keyof T & string | number : never; ``` -Defined in: [packages/form-core/src/util-types.ts:80](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L80) +Defined in: [packages/form-core/src/util-types.ts:80](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L80) ## Type Parameters diff --git a/docs/reference/type-aliases/alltuplekeys.md b/docs/reference/type-aliases/alltuplekeys.md index 1e3b6bc66..83b52984d 100644 --- a/docs/reference/type-aliases/alltuplekeys.md +++ b/docs/reference/type-aliases/alltuplekeys.md @@ -11,7 +11,7 @@ title: AllTupleKeys type AllTupleKeys = T extends any ? keyof T & `${number}` : never; ``` -Defined in: [packages/form-core/src/util-types.ts:65](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L65) +Defined in: [packages/form-core/src/util-types.ts:65](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L65) ## Type Parameters diff --git a/docs/reference/type-aliases/anyfieldapi.md b/docs/reference/type-aliases/anyfieldapi.md index ec7f13266..855c83a7f 100644 --- a/docs/reference/type-aliases/anyfieldapi.md +++ b/docs/reference/type-aliases/anyfieldapi.md @@ -11,6 +11,6 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L832) A type representing the Field API with all generics set to `any` for convenience. diff --git a/docs/reference/type-aliases/anyfieldmeta.md b/docs/reference/type-aliases/anyfieldmeta.md index f54865ca1..c9491931f 100644 --- a/docs/reference/type-aliases/anyfieldmeta.md +++ b/docs/reference/type-aliases/anyfieldmeta.md @@ -11,4 +11,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L751) +Defined in: [packages/form-core/src/FieldApi.ts:751](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L751) diff --git a/docs/reference/type-aliases/anyfieldmetabase.md b/docs/reference/type-aliases/anyfieldmetabase.md index 2aa91128d..560b0a998 100644 --- a/docs/reference/type-aliases/anyfieldmetabase.md +++ b/docs/reference/type-aliases/anyfieldmetabase.md @@ -11,4 +11,4 @@ title: AnyFieldMetaBase type AnyFieldMetaBase = FieldMetaBase; ``` -Defined in: [packages/form-core/src/FieldApi.ts:580](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L580) +Defined in: [packages/form-core/src/FieldApi.ts:580](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L580) diff --git a/docs/reference/type-aliases/anyfieldmetaderived.md b/docs/reference/type-aliases/anyfieldmetaderived.md index 44264f45f..c25c8eda4 100644 --- a/docs/reference/type-aliases/anyfieldmetaderived.md +++ b/docs/reference/type-aliases/anyfieldmetaderived.md @@ -11,4 +11,4 @@ title: AnyFieldMetaDerived type AnyFieldMetaDerived = FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L665) +Defined in: [packages/form-core/src/FieldApi.ts:665](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L665) diff --git a/docs/reference/type-aliases/anyformapi.md b/docs/reference/type-aliases/anyformapi.md index 290ac6300..d4a9dc2c2 100644 --- a/docs/reference/type-aliases/anyformapi.md +++ b/docs/reference/type-aliases/anyformapi.md @@ -11,6 +11,6 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L751) A type representing the Form API with all generics set to `any` for convenience. diff --git a/docs/reference/type-aliases/anyformstate.md b/docs/reference/type-aliases/anyformstate.md index edbd5e543..a028e12e1 100644 --- a/docs/reference/type-aliases/anyformstate.md +++ b/docs/reference/type-aliases/anyformstate.md @@ -11,4 +11,4 @@ title: AnyFormState type AnyFormState = FormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L680) +Defined in: [packages/form-core/src/FormApi.ts:680](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L680) diff --git a/docs/reference/type-aliases/arrayaccessor.md b/docs/reference/type-aliases/arrayaccessor.md index f4cff8280..2091e410d 100644 --- a/docs/reference/type-aliases/arrayaccessor.md +++ b/docs/reference/type-aliases/arrayaccessor.md @@ -11,7 +11,7 @@ title: ArrayAccessor type ArrayAccessor = `${TParent["key"] extends never ? "" : TParent["key"]}[${number}]`; ``` -Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L30) +Defined in: [packages/form-core/src/util-types.ts:30](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L30) ## Type Parameters diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md index bc0752417..4374397bd 100644 --- a/docs/reference/type-aliases/baseformstate.md +++ b/docs/reference/type-aliases/baseformstate.md @@ -11,7 +11,7 @@ title: BaseFormState type BaseFormState = object; ``` -Defined in: [packages/form-core/src/FormApi.ts:498](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L498) +Defined in: [packages/form-core/src/FormApi.ts:498](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L498) An object representing the current state of the form. diff --git a/docs/reference/type-aliases/deepkeyandvaluearray.md b/docs/reference/type-aliases/deepkeyandvaluearray.md index 1f91ddf17..2e428ac9e 100644 --- a/docs/reference/type-aliases/deepkeyandvaluearray.md +++ b/docs/reference/type-aliases/deepkeyandvaluearray.md @@ -13,7 +13,7 @@ type DeepKeyAndValueArray = DeepKeysAndValuesImpl>; ``` -Defined in: [packages/form-core/src/util-types.ts:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L41) +Defined in: [packages/form-core/src/util-types.ts:41](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L41) ## Type Parameters diff --git a/docs/reference/type-aliases/deepkeyandvalueobject.md b/docs/reference/type-aliases/deepkeyandvalueobject.md index 7b9886aec..d21a9fc26 100644 --- a/docs/reference/type-aliases/deepkeyandvalueobject.md +++ b/docs/reference/type-aliases/deepkeyandvalueobject.md @@ -13,7 +13,7 @@ type DeepKeyAndValueObject = TAllKeys extends any ? | ObjectDeepKeyAndValue> : never; ``` -Defined in: [packages/form-core/src/util-types.ts:106](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L106) +Defined in: [packages/form-core/src/util-types.ts:106](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L106) ## Type Parameters diff --git a/docs/reference/type-aliases/deepkeyandvaluetuple.md b/docs/reference/type-aliases/deepkeyandvaluetuple.md index 75a62afa0..068610905 100644 --- a/docs/reference/type-aliases/deepkeyandvaluetuple.md +++ b/docs/reference/type-aliases/deepkeyandvaluetuple.md @@ -13,7 +13,7 @@ type DeepKeyAndValueTuple = TAllKeys extends any ? D | TupleDeepKeyAndValue> : never; ``` -Defined in: [packages/form-core/src/util-types.ts:67](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L67) +Defined in: [packages/form-core/src/util-types.ts:67](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L67) ## Type Parameters diff --git a/docs/reference/type-aliases/deepkeys.md b/docs/reference/type-aliases/deepkeys.md index 0a7a03b0a..602b61b17 100644 --- a/docs/reference/type-aliases/deepkeys.md +++ b/docs/reference/type-aliases/deepkeys.md @@ -11,7 +11,7 @@ title: DeepKeys type DeepKeys = unknown extends T ? string : DeepKeysAndValues["key"]; ``` -Defined in: [packages/form-core/src/util-types.ts:160](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L160) +Defined in: [packages/form-core/src/util-types.ts:160](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L160) The keys of an object or array, deeply nested. diff --git a/docs/reference/type-aliases/deepkeysandvalues.md b/docs/reference/type-aliases/deepkeysandvalues.md index d4e456c5b..66faeeb36 100644 --- a/docs/reference/type-aliases/deepkeysandvalues.md +++ b/docs/reference/type-aliases/deepkeysandvalues.md @@ -11,7 +11,7 @@ title: DeepKeysAndValues type DeepKeysAndValues = DeepKeysAndValuesImpl extends AnyDeepKeyAndValue ? DeepKeysAndValuesImpl : never; ``` -Defined in: [packages/form-core/src/util-types.ts:128](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L128) +Defined in: [packages/form-core/src/util-types.ts:128](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L128) ## Type Parameters diff --git a/docs/reference/type-aliases/deepkeysandvaluesimpl.md b/docs/reference/type-aliases/deepkeysandvaluesimpl.md index 1473531cb..476ac7484 100644 --- a/docs/reference/type-aliases/deepkeysandvaluesimpl.md +++ b/docs/reference/type-aliases/deepkeysandvaluesimpl.md @@ -15,7 +15,7 @@ type DeepKeysAndValuesImpl = unknown extends T ? | UnknownDeepKeyAndValue : T extends object ? DeepKeyAndValueObject : TAcc; ``` -Defined in: [packages/form-core/src/util-types.ts:133](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L133) +Defined in: [packages/form-core/src/util-types.ts:133](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L133) ## Type Parameters diff --git a/docs/reference/type-aliases/deepkeysoftype.md b/docs/reference/type-aliases/deepkeysoftype.md index 0d5ce27c2..835d71414 100644 --- a/docs/reference/type-aliases/deepkeysoftype.md +++ b/docs/reference/type-aliases/deepkeysoftype.md @@ -11,7 +11,7 @@ title: DeepKeysOfType type DeepKeysOfType = Extract, AnyDeepKeyAndValue>["key"]; ``` -Defined in: [packages/form-core/src/util-types.ts:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L176) +Defined in: [packages/form-core/src/util-types.ts:176](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L176) The keys of an object or array, deeply nested and only with a value of TValue diff --git a/docs/reference/type-aliases/deeprecord.md b/docs/reference/type-aliases/deeprecord.md index 4e37caab2..98855b3e5 100644 --- a/docs/reference/type-aliases/deeprecord.md +++ b/docs/reference/type-aliases/deeprecord.md @@ -11,7 +11,7 @@ title: DeepRecord type DeepRecord = { [TRecord in DeepKeysAndValues as TRecord["key"]]: TRecord["value"] }; ``` -Defined in: [packages/form-core/src/util-types.ts:153](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L153) +Defined in: [packages/form-core/src/util-types.ts:153](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L153) ## Type Parameters diff --git a/docs/reference/type-aliases/deepvalue.md b/docs/reference/type-aliases/deepvalue.md index 1004a350d..9e93bcedc 100644 --- a/docs/reference/type-aliases/deepvalue.md +++ b/docs/reference/type-aliases/deepvalue.md @@ -11,7 +11,7 @@ title: DeepValue type DeepValue = unknown extends TValue ? TValue : TAccessor extends DeepKeys ? DeepRecord[TAccessor] : never; ``` -Defined in: [packages/form-core/src/util-types.ts:167](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L167) +Defined in: [packages/form-core/src/util-types.ts:167](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L167) Infer the type of a deeply nested property within an object or an array. diff --git a/docs/reference/type-aliases/derivedformstate.md b/docs/reference/type-aliases/derivedformstate.md index c5e5b8dd9..43e691773 100644 --- a/docs/reference/type-aliases/derivedformstate.md +++ b/docs/reference/type-aliases/derivedformstate.md @@ -11,7 +11,7 @@ title: DerivedFormState type DerivedFormState = object; ``` -Defined in: [packages/form-core/src/FormApi.ts:573](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L573) +Defined in: [packages/form-core/src/FormApi.ts:573](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L573) ## Type Parameters diff --git a/docs/reference/type-aliases/fieldinfo.md b/docs/reference/type-aliases/fieldinfo.md index 5005352ad..a18ebf323 100644 --- a/docs/reference/type-aliases/fieldinfo.md +++ b/docs/reference/type-aliases/fieldinfo.md @@ -11,7 +11,7 @@ title: FieldInfo type FieldInfo = object; ``` -Defined in: [packages/form-core/src/FormApi.ts:464](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L464) +Defined in: [packages/form-core/src/FormApi.ts:464](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L464) An object representing the field information for a specific field within the form. diff --git a/docs/reference/type-aliases/fieldmeta.md b/docs/reference/type-aliases/fieldmeta.md index 422ad9d4f..595abcf0d 100644 --- a/docs/reference/type-aliases/fieldmeta.md +++ b/docs/reference/type-aliases/fieldmeta.md @@ -11,7 +11,7 @@ title: FieldMeta type FieldMeta = FieldMetaBase & FieldMetaDerived; ``` -Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L688) +Defined in: [packages/form-core/src/FieldApi.ts:688](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L688) An object type representing the metadata of a field in a form. diff --git a/docs/reference/type-aliases/fieldmetabase.md b/docs/reference/type-aliases/fieldmetabase.md index 2d30ddc75..f4d08800d 100644 --- a/docs/reference/type-aliases/fieldmetabase.md +++ b/docs/reference/type-aliases/fieldmetabase.md @@ -11,7 +11,7 @@ title: FieldMetaBase type FieldMetaBase = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L521) +Defined in: [packages/form-core/src/FieldApi.ts:521](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L521) ## Type Parameters diff --git a/docs/reference/type-aliases/fieldmetaderived.md b/docs/reference/type-aliases/fieldmetaderived.md index a0c99bfa5..d6d0c863e 100644 --- a/docs/reference/type-aliases/fieldmetaderived.md +++ b/docs/reference/type-aliases/fieldmetaderived.md @@ -11,7 +11,7 @@ title: FieldMetaDerived type FieldMetaDerived = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:600](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L600) +Defined in: [packages/form-core/src/FieldApi.ts:600](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L600) ## Type Parameters diff --git a/docs/reference/type-aliases/fieldstate.md b/docs/reference/type-aliases/fieldstate.md index c3284905c..891eae376 100644 --- a/docs/reference/type-aliases/fieldstate.md +++ b/docs/reference/type-aliases/fieldstate.md @@ -11,7 +11,7 @@ title: FieldState type FieldState = object; ``` -Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L774) +Defined in: [packages/form-core/src/FieldApi.ts:774](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L774) An object type representing the state of a field. diff --git a/docs/reference/type-aliases/formvalidatefn.md b/docs/reference/type-aliases/formvalidatefn.md index f7fb1e33d..dad8b05e4 100644 --- a/docs/reference/type-aliases/formvalidatefn.md +++ b/docs/reference/type-aliases/formvalidatefn.md @@ -11,7 +11,7 @@ title: FormValidateFn type FormValidateFn = (props) => unknown; ``` -Defined in: [packages/form-core/src/FormApi.ts:71](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L71) +Defined in: [packages/form-core/src/FormApi.ts:71](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L71) ## Type Parameters diff --git a/docs/reference/type-aliases/formvalidationerror.md b/docs/reference/type-aliases/formvalidationerror.md index c4499ffb2..473428566 100644 --- a/docs/reference/type-aliases/formvalidationerror.md +++ b/docs/reference/type-aliases/formvalidationerror.md @@ -13,7 +13,7 @@ type FormValidationError = | GlobalFormValidationError; ``` -Defined in: [packages/form-core/src/types.ts:84](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L84) +Defined in: [packages/form-core/src/types.ts:84](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/types.ts#L84) ## Type Parameters diff --git a/docs/reference/type-aliases/formvalidator.md b/docs/reference/type-aliases/formvalidator.md index 227effe1b..78688dedb 100644 --- a/docs/reference/type-aliases/formvalidator.md +++ b/docs/reference/type-aliases/formvalidator.md @@ -11,7 +11,7 @@ title: FormValidator type FormValidator = object; ``` -Defined in: [packages/form-core/src/FormApi.ts:126](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L126) +Defined in: [packages/form-core/src/FormApi.ts:126](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L126) ## Type Parameters diff --git a/docs/reference/type-aliases/nullable.md b/docs/reference/type-aliases/nullable.md index eac9cf3b0..bd8a1bd39 100644 --- a/docs/reference/type-aliases/nullable.md +++ b/docs/reference/type-aliases/nullable.md @@ -11,7 +11,7 @@ title: Nullable type Nullable = T & undefined | null; ``` -Defined in: [packages/form-core/src/util-types.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L89) +Defined in: [packages/form-core/src/util-types.ts:89](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L89) ## Type Parameters diff --git a/docs/reference/type-aliases/objectaccessor.md b/docs/reference/type-aliases/objectaccessor.md index 6f3ddeffe..de58cbbb5 100644 --- a/docs/reference/type-aliases/objectaccessor.md +++ b/docs/reference/type-aliases/objectaccessor.md @@ -11,7 +11,7 @@ title: ObjectAccessor type ObjectAccessor = TParent["key"] extends never ? `${TKey}` : `${TParent["key"]}.${TKey}`; ``` -Defined in: [packages/form-core/src/util-types.ts:84](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L84) +Defined in: [packages/form-core/src/util-types.ts:84](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L84) ## Type Parameters diff --git a/docs/reference/type-aliases/objectvalue.md b/docs/reference/type-aliases/objectvalue.md index e43d8c874..78d2283d5 100644 --- a/docs/reference/type-aliases/objectvalue.md +++ b/docs/reference/type-aliases/objectvalue.md @@ -11,7 +11,7 @@ title: ObjectValue type ObjectValue = T[TKey] | Nullable; ``` -Defined in: [packages/form-core/src/util-types.ts:91](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L91) +Defined in: [packages/form-core/src/util-types.ts:91](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L91) ## Type Parameters diff --git a/docs/reference/type-aliases/standardschemav1.md b/docs/reference/type-aliases/standardschemav1.md index 225ebd75c..7e2c5c89f 100644 --- a/docs/reference/type-aliases/standardschemav1.md +++ b/docs/reference/type-aliases/standardschemav1.md @@ -11,7 +11,7 @@ title: StandardSchemaV1 type StandardSchemaV1 = object; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:98](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L98) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:98](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L98) The Standard Schema interface. diff --git a/docs/reference/type-aliases/tstandardschemavalidatorissue.md b/docs/reference/type-aliases/tstandardschemavalidatorissue.md index 2da9b70f9..c2ff62b8a 100644 --- a/docs/reference/type-aliases/tstandardschemavalidatorissue.md +++ b/docs/reference/type-aliases/tstandardschemavalidatorissue.md @@ -11,7 +11,7 @@ title: TStandardSchemaValidatorIssue type TStandardSchemaValidatorIssue = TSource extends "form" ? object : TSource extends "field" ? StandardSchemaV1Issue[] : never; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:11](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L11) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:11](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/tstandardschemavalidatorvalue.md b/docs/reference/type-aliases/tstandardschemavalidatorvalue.md index 28871726d..8b723109b 100644 --- a/docs/reference/type-aliases/tstandardschemavalidatorvalue.md +++ b/docs/reference/type-aliases/tstandardschemavalidatorvalue.md @@ -11,7 +11,7 @@ title: TStandardSchemaValidatorValue type TStandardSchemaValidatorValue = object; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:3](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L3) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:3](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L3) ## Type Parameters diff --git a/docs/reference/type-aliases/tupleaccessor.md b/docs/reference/type-aliases/tupleaccessor.md index defacae6c..a833a5b96 100644 --- a/docs/reference/type-aliases/tupleaccessor.md +++ b/docs/reference/type-aliases/tupleaccessor.md @@ -11,7 +11,7 @@ title: TupleAccessor type TupleAccessor = `${TParent["key"] extends never ? "" : TParent["key"]}[${TKey}]`; ``` -Defined in: [packages/form-core/src/util-types.ts:51](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L51) +Defined in: [packages/form-core/src/util-types.ts:51](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L51) ## Type Parameters diff --git a/docs/reference/type-aliases/unknownaccessor.md b/docs/reference/type-aliases/unknownaccessor.md index 72e3cc7cc..a66dc3bf0 100644 --- a/docs/reference/type-aliases/unknownaccessor.md +++ b/docs/reference/type-aliases/unknownaccessor.md @@ -11,7 +11,7 @@ title: UnknownAccessor type UnknownAccessor = TParent["key"] extends never ? string : `${TParent["key"]}.${string}`; ``` -Defined in: [packages/form-core/src/util-types.ts:119](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L119) +Defined in: [packages/form-core/src/util-types.ts:119](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/util-types.ts#L119) ## Type Parameters diff --git a/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md b/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md index 3c8cec39c..429c49f83 100644 --- a/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md +++ b/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md @@ -14,7 +14,7 @@ type UnwrapFieldAsyncValidateOrFn = | [TValidateOrFn] extends [FieldValidateAsyncFn] ? Awaited> : [TValidateOrFn] extends [StandardSchemaV1] ? StandardSchemaV1Issue[] : undefined; ``` -Defined in: [packages/form-core/src/FieldApi.ts:210](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L210) +Defined in: [packages/form-core/src/FieldApi.ts:210](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L210) ## Type Parameters diff --git a/docs/reference/type-aliases/unwrapfieldvalidateorfn.md b/docs/reference/type-aliases/unwrapfieldvalidateorfn.md index fcf6f90c8..20bc6dca6 100644 --- a/docs/reference/type-aliases/unwrapfieldvalidateorfn.md +++ b/docs/reference/type-aliases/unwrapfieldvalidateorfn.md @@ -14,7 +14,7 @@ type UnwrapFieldValidateOrFn = | [TValidateOrFn] extends [FieldValidateFn] ? ReturnType : [TValidateOrFn] extends [StandardSchemaV1] ? StandardSchemaV1Issue[] : undefined; ``` -Defined in: [packages/form-core/src/FieldApi.ts:128](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L128) +Defined in: [packages/form-core/src/FieldApi.ts:128](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FieldApi.ts#L128) ## Type Parameters diff --git a/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md b/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md index ab749d0d3..8cdf90a6e 100644 --- a/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md +++ b/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md @@ -11,7 +11,7 @@ title: UnwrapFormAsyncValidateOrFn type UnwrapFormAsyncValidateOrFn = [TValidateOrFn] extends [FormValidateAsyncFn] ? Awaited> : [TValidateOrFn] extends [StandardSchemaV1] ? Record : undefined; ``` -Defined in: [packages/form-core/src/FormApi.ts:148](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L148) +Defined in: [packages/form-core/src/FormApi.ts:148](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L148) ## Type Parameters diff --git a/docs/reference/type-aliases/unwrapformvalidateorfn.md b/docs/reference/type-aliases/unwrapformvalidateorfn.md index 0b3683f2a..cb8250837 100644 --- a/docs/reference/type-aliases/unwrapformvalidateorfn.md +++ b/docs/reference/type-aliases/unwrapformvalidateorfn.md @@ -11,7 +11,7 @@ title: UnwrapFormValidateOrFn type UnwrapFormValidateOrFn = [TValidateOrFn] extends [FormValidateFn] ? ReturnType : [TValidateOrFn] extends [StandardSchemaV1] ? Record : undefined; ``` -Defined in: [packages/form-core/src/FormApi.ts:96](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L96) +Defined in: [packages/form-core/src/FormApi.ts:96](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L96) ## Type Parameters diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md index 20d51f7af..b81adde28 100644 --- a/docs/reference/type-aliases/updater.md +++ b/docs/reference/type-aliases/updater.md @@ -11,7 +11,7 @@ title: Updater type Updater = TOutput | UpdaterFn; ``` -Defined in: [packages/form-core/src/utils.ts:12](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L12) +Defined in: [packages/form-core/src/utils.ts:12](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/utils.ts#L12) ## Type Parameters diff --git a/docs/reference/type-aliases/updaterfn.md b/docs/reference/type-aliases/updaterfn.md index d0b2d4fff..1548dbb79 100644 --- a/docs/reference/type-aliases/updaterfn.md +++ b/docs/reference/type-aliases/updaterfn.md @@ -11,7 +11,7 @@ title: UpdaterFn type UpdaterFn = (input) => TOutput; ``` -Defined in: [packages/form-core/src/utils.ts:10](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L10) +Defined in: [packages/form-core/src/utils.ts:10](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/utils.ts#L10) ## Type Parameters diff --git a/docs/reference/type-aliases/validationerror.md b/docs/reference/type-aliases/validationerror.md index 87984446d..4beb564a5 100644 --- a/docs/reference/type-aliases/validationerror.md +++ b/docs/reference/type-aliases/validationerror.md @@ -11,4 +11,4 @@ title: ValidationError type ValidationError = unknown; ``` -Defined in: [packages/form-core/src/types.ts:3](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L3) +Defined in: [packages/form-core/src/types.ts:3](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/types.ts#L3) diff --git a/docs/reference/type-aliases/validationmeta.md b/docs/reference/type-aliases/validationmeta.md index 2e169b755..cf2c235e9 100644 --- a/docs/reference/type-aliases/validationmeta.md +++ b/docs/reference/type-aliases/validationmeta.md @@ -11,7 +11,7 @@ title: ValidationMeta type ValidationMeta = object; ``` -Defined in: [packages/form-core/src/FormApi.ts:454](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L454) +Defined in: [packages/form-core/src/FormApi.ts:454](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/FormApi.ts#L454) An object representing the validation metadata for a field. Not intended for public usage. diff --git a/docs/reference/type-aliases/validationsource.md b/docs/reference/type-aliases/validationsource.md index 0edfb695b..85243a981 100644 --- a/docs/reference/type-aliases/validationsource.md +++ b/docs/reference/type-aliases/validationsource.md @@ -11,4 +11,4 @@ title: ValidationSource type ValidationSource = "form" | "field"; ``` -Defined in: [packages/form-core/src/types.ts:5](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L5) +Defined in: [packages/form-core/src/types.ts:5](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/types.ts#L5) diff --git a/docs/reference/variables/standardschemavalidators.md b/docs/reference/variables/standardschemavalidators.md index 405380eca..7b88f0b05 100644 --- a/docs/reference/variables/standardschemavalidators.md +++ b/docs/reference/variables/standardschemavalidators.md @@ -11,7 +11,7 @@ title: standardSchemaValidators const standardSchemaValidators: object; ``` -Defined in: [packages/form-core/src/standardSchemaValidator.ts:53](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L53) +Defined in: [packages/form-core/src/standardSchemaValidator.ts:53](https://github.com/Pascalmh/tanstack-form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L53) ## Type declaration diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index 77174199c..48c74cf7b 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1451,16 +1451,18 @@ export class FormApi< if ( // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition - currentErrorMap?.[errorMapKey] !== newErrorValue + currentErrorMap?.[errorMapKey] !== newErrorValue || (currentErrorMapSource?.onMount === 'form' && validateObj.cause !== 'server') ) { this.setFieldMeta(field, (prev) => ({ ...prev, errorMap: { ...prev.errorMap, + onMount: undefined, [errorMapKey]: newErrorValue, }, errorSourceMap: { ...prev.errorSourceMap, + onMount: undefined, [errorMapKey]: newSource, }, })) diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index d824bb6a8..378a5d044 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -2986,6 +2986,88 @@ describe('form api', () => { expect(interestsField.state.meta.errors).toStrictEqual([]) }) + it("clears form's onMount validation field errors on next form validation", async () => { + const form = new FormApi({ + defaultValues: { + firstName: '', + middleName: '', + lastName: '', + }, + validators: { + onChange: ({ value }) => { + return { + fields: { + firstName: value.firstName !== 'john' ? 'first name is not john' : null, + lastName: 'last name is required', + } + } + }, + onMount: () => { + return { + fields: { + firstName: 'first name is required', + lastName: 'last name is required', + } + } + }, + }, + }) + + const firstNameField = new FieldApi({ + form, + name: 'firstName', + }) + + const middleNameField = new FieldApi({ + form, + name: 'middleName', + validators: { + onMount: () => 'middle name is required', + }, + }) + + const lastNameField = new FieldApi({ + form, + name: 'lastName', + }) + + firstNameField.mount() + middleNameField.mount() + lastNameField.mount() + form.mount() + + expect(firstNameField.state.meta.errorMap.onMount).toBe('first name is required') + expect(firstNameField.state.meta.errorSourceMap.onMount).toBe('form') + + expect(middleNameField.state.meta.errorMap.onMount).toBe('middle name is required') + expect(middleNameField.state.meta.errorSourceMap.onMount).toBe('field') + + expect(lastNameField.state.meta.errorMap.onMount).toBe('last name is required') + expect(lastNameField.state.meta.errorSourceMap.onMount).toBe('form') + + firstNameField.setValue('other') + + expect(firstNameField.state.meta.errorMap.onChange).toEqual('first name is not john') + expect(firstNameField.state.meta.errorSourceMap.onMount).toBeUndefined() + + expect(middleNameField.state.meta.errorMap.onMount).toBe('middle name is required') + expect(middleNameField.state.meta.errorSourceMap.onMount).toBe('field') + + expect(lastNameField.state.meta.errorMap.onMount).toBeUndefined() + expect(lastNameField.state.meta.errorSourceMap.onMount).toBeUndefined() + + firstNameField.setValue('john') + + expect(firstNameField.state.meta.errorMap.onMount).toBeUndefined() + expect(firstNameField.state.meta.errorSourceMap.onMount).toBeUndefined() + + expect(middleNameField.state.meta.errorSourceMap.onMount).toBe('field') + expect(middleNameField.state.meta.errorMap.onMount).toBe('middle name is required') + + expect(lastNameField.state.meta.errorMap.onMount).toBeUndefined() + expect(lastNameField.state.meta.errorSourceMap.onMount).toBeUndefined() + }) + it('should not change the onBlur state of the fields when the form is submitted', async () => { const form = new FormApi({ defaultValues: { diff --git a/packages/react-form/package.json b/packages/react-form/package.json index df2078346..b44094e99 100644 --- a/packages/react-form/package.json +++ b/packages/react-form/package.json @@ -84,7 +84,9 @@ "@tanstack/form-core": "workspace:*", "@tanstack/react-store": "^0.7.0", "decode-formdata": "^0.9.0", - "devalue": "^5.1.1" + "valibot": "^1.1.0", + "devalue": "^5.1.1", + "zod": "^3.24.4" }, "devDependencies": { "@tanstack/react-start": "^1.120.3", diff --git a/packages/react-form/tests/standardSchema.test.tsx b/packages/react-form/tests/standardSchema.test.tsx new file mode 100644 index 000000000..6b2357a75 --- /dev/null +++ b/packages/react-form/tests/standardSchema.test.tsx @@ -0,0 +1,287 @@ +import { expect, it } from 'vitest' +import { render } from '@testing-library/react' +import * as v from 'valibot' +import * as z from 'zod' +import userEvent from '@testing-library/user-event' +import { useForm } from '../src/useForm' +import type { JSX } from 'react' + +it('should canSubmit with valibot variant schema', async () => { + const schema = v.variant('aOrB', [ + v.object({ + aOrB: v.literal('a'), + a: v.pipe(v.string(), v.nonEmpty()), + b: v.pipe( + v.any(), + v.transform(() => undefined), + ), + }), + v.object({ + aOrB: v.literal('b'), + b: v.pipe(v.string(), v.nonEmpty()), + a: v.pipe( + v.any(), + v.transform(() => undefined), + ), + }), + ]) + + const Component = () => { + const form = useForm({ + defaultValues: { + aOrB: 'a', + a: '', // invalid initial value + b: '', // invalid initial value + }, + validators: { + onMount: schema, + onChange: schema, + }, + }) + + return ( + <> + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + [state.isValid, state.canSubmit] as const} + > + {([isValid, canSubmit]) => ( + <> + + + + )} + + + ) + } + + const { getByTitle, user } = setup() + + function getInput(name: string) { + return getByTitle(name) as HTMLInputElement + } + + // check initial values + expect.soft(getInput('form isValid').value).toBe('false') + expect.soft(getInput('form canSubmit').value).toBe('false') + + // choose option "b" and make "b" valid + await user.clear(getInput('aOrB value')) + await user.type(getInput('aOrB value'), 'b') + await user.type(getInput('b value'), 'foobar') // valid input for "b" + + // check that values are as expected on the Field-level + expect.soft(getInput('aOrB value').value).toBe('b') + expect.soft(getInput('aOrB isValid').value).toBe('true') + expect.soft(getInput('a value').value).toBe('') + expect + .soft(getInput('a isValid').value, "expect field 'a' to be isValid") + .toBe('true') // as we chose "b" option, the value of "a" can be "any"thing + expect.soft(getInput('b value').value).toBe('foobar') + expect.soft(getInput('b isValid').value).toBe('true') // "b" is valid now, as it's not empty anymore + + // check the state on the Form-level + expect + .soft(getInput('form isValid').value, 'expect form.isValid to be true') + .toBe('true') + expect + .soft(getInput('form canSubmit').value, 'expect form.canSubmit to be true') + .toBe('true') +}) + +it('should canSubmit with zod variant schema', async () => { + const schema = z.discriminatedUnion('aOrB', [ + z.object({ + aOrB: z.literal('a'), + a: z.string().min(1), + b: z.any(), + }), + z.object({ + aOrB: z.literal('b'), + b: z.string().min(1), + a: z.any(), + }), + ]) + + type Schema = z.input + + const Component = () => { + const form = useForm({ + defaultValues: { + aOrB: 'a', + a: '', // invalid initial value + b: '', // invalid initial value + } as Schema, + validators: { + onMount: schema, + onChange: schema, + }, + }) + + return ( + <> + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + + {(field) => ( + <> + field.handleChange(e.target.value)} + /> + + + )} + + [state.isValid, state.canSubmit] as const} + > + {([isValid, canSubmit]) => ( + <> + + + + )} + + + ) + } + + const { getByTitle, user } = setup() + + function getInput(name: string) { + return getByTitle(name) as HTMLInputElement + } + + // check initial values + expect.soft(getInput('form isValid').value).toBe('false') + expect.soft(getInput('form canSubmit').value).toBe('false') + + // choose option "b" and make "b" valid + await user.clear(getInput('aOrB value')) + await user.type(getInput('aOrB value'), 'b') + await user.type(getInput('b value'), 'foobar') // valid input for "b" + + // check that values are as expected on the Field-level + expect.soft(getInput('aOrB value').value).toBe('b') + expect.soft(getInput('aOrB isValid').value).toBe('true') + expect.soft(getInput('a value').value).toBe('') + expect + .soft(getInput('a isValid').value, "expect field 'a' to be isValid") + .toBe('true') // as we chose "b" option, the value of "a" can be "any"thing + expect.soft(getInput('b value').value).toBe('foobar') + expect.soft(getInput('b isValid').value).toBe('true') // "b" is valid now, as it's not empty anymore + + // check the state on the Form-level + expect + .soft(getInput('form isValid').value, 'expect form.isValid to be true') + .toBe('true') + expect + .soft(getInput('form canSubmit').value, 'expect form.canSubmit to be true') + .toBe('true') +}) + +function setup(jsx: JSX.Element) { + return { + user: userEvent.setup(), + ...render(jsx), + } +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2e6ad1bb5..7d8cfa947 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -809,6 +809,12 @@ importers: devalue: specifier: ^5.1.1 version: 5.1.1 + valibot: + specifier: ^1.1.0 + version: 1.1.0(typescript@5.8.3) + zod: + specifier: ^3.24.4 + version: 3.24.4 devDependencies: '@tanstack/react-start': specifier: ^1.120.3