From 3e00e75eaa5db0bee0de62d7fa6c5ed88df921bf Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sat, 11 Jan 2025 09:31:19 +0000 Subject: [PATCH] ci: apply automated fixes and generate docs --- .../vue/reference/functions/usefield.md | 40 +++++++++++-- .../vue/reference/functions/useform.md | 24 ++++++-- docs/framework/vue/reference/index.md | 1 + .../vue/reference/interfaces/vuefieldapi.md | 24 ++++++-- .../vue/reference/interfaces/vueformapi.md | 58 +++++++++---------- .../reference/type-aliases/fieldcomponent.md | 45 ++++++++------ .../type-aliases/fieldcomponentprops.md | 56 ++++++++++++++++++ .../vue/reference/type-aliases/usefield.md | 42 ++++++++++++-- .../vue/reference/variables/field.md | 8 +-- 9 files changed, 224 insertions(+), 74 deletions(-) create mode 100644 docs/framework/vue/reference/type-aliases/fieldcomponentprops.md diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md index 0170d48e0..5f241db2d 100644 --- a/docs/framework/vue/reference/functions/usefield.md +++ b/docs/framework/vue/reference/functions/usefield.md @@ -6,10 +6,10 @@ title: useField # Function: useField() ```ts -function useField(opts): object +function useField(opts): object ``` -Defined in: [packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L49) +Defined in: [packages/vue-form/src/useField.tsx:303](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L303) ## Type Parameters @@ -25,11 +25,41 @@ Defined in: [packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/ • **TData** = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Parameters ### opts -`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> +`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> ## Returns @@ -38,11 +68,11 @@ Defined in: [packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/ ### api ```ts -readonly api: FieldApi & VueFieldApi = fieldApi; +readonly api: FieldApi & VueFieldApi = fieldApi; ``` ### state ```ts -readonly state: Readonly, FieldState>> = fieldState; +readonly state: Readonly, FieldState>> = fieldState; ``` diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md index 2d67b6719..d9a3350f4 100644 --- a/docs/framework/vue/reference/functions/useform.md +++ b/docs/framework/vue/reference/functions/useform.md @@ -6,10 +6,10 @@ title: useForm # Function: useForm() ```ts -function useForm(opts?): FormApi & VueFormApi +function useForm(opts?): FormApi & VueFormApi ``` -Defined in: [packages/vue-form/src/useForm.tsx:30](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L30) +Defined in: [packages/vue-form/src/useForm.tsx:190](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L190) ## Type Parameters @@ -17,12 +17,28 @@ Defined in: [packages/vue-form/src/useForm.tsx:30](https://github.com/TanStack/f • **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Parameters ### opts? -`FormOptions`\<`TFormData`, `TFormValidator`\> +`FormOptions`\<`TFormData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> ## Returns -`FormApi`\<`TFormData`, `TFormValidator`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TFormData`, `TFormValidator`\> +`FormApi`\<`TFormData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TFormData`, `TFormValidator`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 27abe16df..a265548af 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -13,6 +13,7 @@ title: "@tanstack/vue-form" ## Type Aliases - [FieldComponent](type-aliases/fieldcomponent.md) +- [FieldComponentProps](type-aliases/fieldcomponentprops.md) - [UseField](type-aliases/usefield.md) ## Variables diff --git a/docs/framework/vue/reference/interfaces/vuefieldapi.md b/docs/framework/vue/reference/interfaces/vuefieldapi.md index 5b638938c..1ac4caaac 100644 --- a/docs/framework/vue/reference/interfaces/vuefieldapi.md +++ b/docs/framework/vue/reference/interfaces/vuefieldapi.md @@ -3,9 +3,9 @@ id: VueFieldApi title: VueFieldApi --- -# Interface: VueFieldApi\ +# Interface: VueFieldApi\ -Defined in: [packages/vue-form/src/useField.tsx:8](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L8) +Defined in: [packages/vue-form/src/useField.tsx:160](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L160) ## Type Parameters @@ -13,12 +13,28 @@ Defined in: [packages/vue-form/src/useField.tsx:8](https://github.com/TanStack/f • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Properties ### Field ```ts -Field: FieldComponent; +Field: FieldComponent; ``` -Defined in: [packages/vue-form/src/useField.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L14) +Defined in: [packages/vue-form/src/useField.tsx:174](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L174) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md index 9cd097244..406da38d4 100644 --- a/docs/framework/vue/reference/interfaces/vueformapi.md +++ b/docs/framework/vue/reference/interfaces/vueformapi.md @@ -3,9 +3,9 @@ id: VueFormApi title: VueFormApi --- -# Interface: VueFormApi\ +# Interface: VueFormApi\ -Defined in: [packages/vue-form/src/useForm.tsx:10](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L10) +Defined in: [packages/vue-form/src/useForm.tsx:110](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L110) ## Type Parameters @@ -13,57 +13,51 @@ Defined in: [packages/vue-form/src/useForm.tsx:10](https://github.com/TanStack/f • **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` -## Properties - -### Field - -```ts -Field: FieldComponent; -``` +• **TFormOnMountReturn** = `undefined` -Defined in: [packages/vue-form/src/useForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L14) +• **TFormOnChangeReturn** = `undefined` -*** +• **TFormOnChangeAsyncReturn** = `undefined` -### Subscribe() +• **TFormOnBlurReturn** = `undefined` -```ts -Subscribe: (props, context) => any; -``` +• **TFormOnBlurAsyncReturn** = `undefined` -Defined in: [packages/vue-form/src/useForm.tsx:19](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L19) +• **TFormOnSubmitReturn** = `undefined` -#### Type Parameters +• **TFormOnSubmitAsyncReturn** = `undefined` -• **TSelected** = `FormState`\<`TFormData`\> +• **TFormOnServerReturn** = `undefined` -#### Parameters +## Properties -##### props +### Field -###### selector +```ts +Field: FieldComponent; +``` -(`state`) => `TSelected` +Defined in: [packages/vue-form/src/useForm.tsx:122](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L122) -##### context +*** -`SetupContext`\<`EmitsOptions`, `SlotsType`\<\{ - `default`: `FormState`\<`TFormData`\>; - \}\>\> +### Subscribe -#### Returns +```ts +Subscribe: SubscribeComponent; +``` -`any` +Defined in: [packages/vue-form/src/useForm.tsx:177](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L177) *** ### useField ```ts -useField: UseField; +useField: UseField; ``` -Defined in: [packages/vue-form/src/useForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L15) +Defined in: [packages/vue-form/src/useForm.tsx:134](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L134) *** @@ -73,11 +67,11 @@ Defined in: [packages/vue-form/src/useForm.tsx:15](https://github.com/TanStack/f useStore: (selector?) => Readonly>; ``` -Defined in: [packages/vue-form/src/useForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L16) +Defined in: [packages/vue-form/src/useForm.tsx:146](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L146) #### Type Parameters -• **TSelected** = `FormState`\<`TFormData`\> +• **TSelected** = `FormState`\<`TFormData`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> #### Parameters diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponent.md b/docs/framework/vue/reference/type-aliases/fieldcomponent.md index 15179546d..74f63a077 100644 --- a/docs/framework/vue/reference/type-aliases/fieldcomponent.md +++ b/docs/framework/vue/reference/type-aliases/fieldcomponent.md @@ -3,13 +3,18 @@ id: FieldComponent title: FieldComponent --- -# Type Alias: FieldComponent()\ +# Type Alias: FieldComponent()\ ```ts -type FieldComponent = (fieldOptions, context) => any; +type FieldComponent = (props) => CreateComponentPublicInstanceWithMixins, "form">, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {}, false, {}, SlotsType<{ + default: { + field: FieldApi; + state: FieldApi["state"]; + }; +}>>; ``` -Defined in: [packages/vue-form/src/useField.tsx:117](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L117) +Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L17) ## Type Parameters @@ -17,31 +22,33 @@ Defined in: [packages/vue-form/src/useField.tsx:117](https://github.com/TanStack • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` -## Type Parameters +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` -• **TName** *extends* `DeepKeys`\<`TParentData`\> +• **TFormOnSubmitReturn** = `undefined` -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` +• **TFormOnSubmitAsyncReturn** = `undefined` -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> +• **TFormOnServerReturn** = `undefined` ## Parameters -### fieldOptions +### props -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> +`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>, `"form"`\> & `EmitsToProps`\<`EmitsOptions`\> & `PublicProps` -### context +## Returns -`SetupContext`\<\{\}, `SlotsType`\<\{ +`CreateComponentPublicInstanceWithMixins`\<`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>, `"form"`\>, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, `SlotsType`\<\{ `default`: \{ - `field`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>; - `state`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>\[`"state"`\]; + `field`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>; + `state`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>\[`"state"`\]; \}; \}\>\> - -## Returns - -`any` diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md new file mode 100644 index 000000000..fed1560c8 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md @@ -0,0 +1,56 @@ +--- +id: FieldComponentProps +title: FieldComponentProps +--- + +# Type Alias: FieldComponentProps\ + +```ts +type FieldComponentProps = UseFieldOptions; +``` + +Defined in: [packages/vue-form/src/useField.tsx:400](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L400) + +## Type Parameters + +• **TParentData** + +• **TName** *extends* `DeepKeys`\<`TParentData`\> + +• **TFieldValidator** *extends* + \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> + \| `undefined` = `undefined` + +• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` + +• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> + +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md index 5fb33846e..c6c6be4f8 100644 --- a/docs/framework/vue/reference/type-aliases/usefield.md +++ b/docs/framework/vue/reference/type-aliases/usefield.md @@ -3,13 +3,13 @@ id: UseField title: UseField --- -# Type Alias: UseField()\ +# Type Alias: UseField()\ ```ts -type UseField = (opts) => object; +type UseField = (opts) => object; ``` -Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L17) +Defined in: [packages/vue-form/src/useField.tsx:188](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L188) ## Type Parameters @@ -17,6 +17,22 @@ Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/ • **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` +• **TFormOnMountReturn** = `undefined` + +• **TFormOnChangeReturn** = `undefined` + +• **TFormOnChangeAsyncReturn** = `undefined` + +• **TFormOnBlurReturn** = `undefined` + +• **TFormOnBlurAsyncReturn** = `undefined` + +• **TFormOnSubmitReturn** = `undefined` + +• **TFormOnSubmitAsyncReturn** = `undefined` + +• **TFormOnServerReturn** = `undefined` + ## Type Parameters • **TName** *extends* `DeepKeys`\<`TParentData`\> @@ -27,11 +43,25 @@ Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/ • **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> +• **TOnMountReturn** = `undefined` + +• **TOnChangeReturn** = `undefined` + +• **TOnChangeAsyncReturn** = `undefined` + +• **TOnBlurReturn** = `undefined` + +• **TOnBlurAsyncReturn** = `undefined` + +• **TOnSubmitReturn** = `undefined` + +• **TOnSubmitAsyncReturn** = `undefined` + ## Parameters ### opts -`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> +`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\>, `"form"`\> ## Returns @@ -40,11 +70,11 @@ Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/ ### api ```ts -api: FieldApi & VueFieldApi; +api: FieldApi & VueFieldApi; ``` ### state ```ts -state: Readonly["state"]>>; +state: Readonly["state"]>>; ``` diff --git a/docs/framework/vue/reference/variables/field.md b/docs/framework/vue/reference/variables/field.md index 0bd0c0ba5..b9b18bd48 100644 --- a/docs/framework/vue/reference/variables/field.md +++ b/docs/framework/vue/reference/variables/field.md @@ -6,17 +6,17 @@ title: Field # Variable: Field() ```ts -const Field: (props) => CreateComponentPublicInstanceWithMixins & object & {} | {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, OptionTypesType<{}, {}, {}, {}, {}, {}>, object & FieldApiOptions & { ...; } & ({ ...; } | { ...; }), {}, {}, {}, {}, {}>; +const Field: (props) => CreateComponentPublicInstanceWithMixins & object & {} | {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {}, false, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, OptionTypesType<{}, {}, {}, {}, {}, {}>, object & FieldApiOptions & { ...; } & ({ ...; } | { ...; }), {}, {}, {}, {}, {}>; ``` -Defined in: [packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L162) +Defined in: [packages/vue-form/src/useField.tsx:448](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L448) ## Parameters ### props -FieldApiOptions\ & \{ ...; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps` +FieldApiOptions\ & \{ ...; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps` ## Returns -`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` & \{\} \| \{\}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, \{\}, \{\}, \{\}, `string`, \{\}, `any`, `ComponentProvideOptions`, `OptionTypesType`\<\{\}, \{\}, \{\}, \{\}, \{\}, \{\}\>, `object` & FieldApiOptions\ & \{ ...; \} & (\{ ...; \} \| \{ ...; \}), \{\}, \{\}, \{\}, \{\}, \{\}\> +`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`, `TOnMountReturn`, `TOnChangeReturn`, `TOnChangeAsyncReturn`, `TOnBlurReturn`, `TOnBlurAsyncReturn`, `TOnSubmitReturn`, `TOnSubmitAsyncReturn`, `TFormOnMountReturn`, `TFormOnChangeReturn`, `TFormOnChangeAsyncReturn`, `TFormOnBlurReturn`, `TFormOnBlurAsyncReturn`, `TFormOnSubmitReturn`, `TFormOnSubmitAsyncReturn`, `TFormOnServerReturn`\> & `object` & \{\} \| \{\}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, \{\}, \{\}, \{\}, `string`, \{\}, `any`, `ComponentProvideOptions`, `OptionTypesType`\<\{\}, \{\}, \{\}, \{\}, \{\}, \{\}\>, `object` & FieldApiOptions\ & \{ ...; \} & (\{ ...; \} \| \{ ...; \}), \{\}, \{\}, \{\}, \{\}, \{\}\>