From 59a1eb3afc9cf27331f12263327238095805b9ec Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Sun, 9 Mar 2025 22:08:53 +0100 Subject: [PATCH 1/4] feat(core): form listeners --- packages/form-core/src/FieldApi.ts | 48 ++++++++ packages/form-core/src/FormApi.ts | 97 ++++++++++++++++ packages/form-core/tests/FormApi.spec.ts | 138 ++++++++++++++++++++++- 3 files changed, 282 insertions(+), 1 deletion(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index 3013e7aaa..888bf4a06 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -1183,6 +1183,12 @@ export class FieldApi< fieldApi: this, }) + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) + this.validate('change') } @@ -1233,6 +1239,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1249,6 +1261,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1265,6 +1283,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1277,6 +1301,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1289,6 +1319,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1301,6 +1337,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onChange?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** @@ -1644,6 +1686,12 @@ export class FieldApi< value: this.state.value, fieldApi: this, }) + + this.form.options.listeners?.onBlur?.({ + fieldName: this.name, + fieldValue: this.state.value as any, + formApi: this.form, + }) } /** diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index e2640f8c9..410eed337 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -231,6 +231,81 @@ export interface FormTransform< deps: unknown[] } +export interface FormListeners< + TField extends DeepKeys, + TFormData, + TOnMount extends undefined | FormValidateOrFn, + TOnChange extends undefined | FormValidateOrFn, + TOnChangeAsync extends undefined | FormAsyncValidateOrFn, + TOnBlur extends undefined | FormValidateOrFn, + TOnBlurAsync extends undefined | FormAsyncValidateOrFn, + TOnSubmit extends undefined | FormValidateOrFn, + TOnSubmitAsync extends undefined | FormAsyncValidateOrFn, + TOnServer extends undefined | FormAsyncValidateOrFn, + TSubmitMeta = never, +> { + onChange?: (props: { + fieldName: TField + fieldValue: DeepValue + formApi: FormApi< + TFormData, + TOnMount, + TOnChange, + TOnChangeAsync, + TOnBlur, + TOnBlurAsync, + TOnSubmit, + TOnSubmitAsync, + TOnServer, + TSubmitMeta + > + }) => void + onBlur?: (props: { + fieldName: TField + fieldValue: DeepValue + formApi: FormApi< + TFormData, + TOnMount, + TOnChange, + TOnChangeAsync, + TOnBlur, + TOnBlurAsync, + TOnSubmit, + TOnSubmitAsync, + TOnServer, + TSubmitMeta + > + }) => void + onMount?: (props: { + formApi: FormApi< + TFormData, + TOnMount, + TOnChange, + TOnChangeAsync, + TOnBlur, + TOnBlurAsync, + TOnSubmit, + TOnSubmitAsync, + TOnServer, + TSubmitMeta + > + }) => void + onSubmit?: (props: { + formApi: FormApi< + TFormData, + TOnMount, + TOnChange, + TOnChangeAsync, + TOnBlur, + TOnBlurAsync, + TOnSubmit, + TOnSubmitAsync, + TOnServer, + TSubmitMeta + > + }) => void +} + /** * An object representing the options for a form. */ @@ -293,6 +368,23 @@ export interface FormOptions< */ onSubmitMeta?: TSubmitMeta + /** + * form level listeners + */ + listeners?: FormListeners< + DeepKeys, + TFormData, + TOnMount, + TOnChange, + TOnChangeAsync, + TOnBlur, + TOnBlurAsync, + TOnSubmit, + TOnSubmitAsync, + TOnServer, + TSubmitMeta + > + /** * 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` */ @@ -1053,6 +1145,9 @@ export class FormApi< cleanupFieldMetaDerived() cleanupStoreDerived() } + + this.options.listeners?.onMount?.({ formApi: this }) + const { onMount } = this.options.validators || {} if (!onMount) return cleanup this.validateSync('mount') @@ -1633,6 +1728,8 @@ export class FormApi< ) }) + this.options.listeners?.onSubmit?.({ formApi: this }) + try { // Run the submit code await this.options.onSubmit?.({ diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index 49543bf8b..a42b63337 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -1956,7 +1956,143 @@ describe('form api', () => { expect(form.state.errors).toStrictEqual(['first name is required']) }) - it('should run listener onSubmit', async () => { + it('should run the form listener onSubmit', async () => { + let triggered!: string + const form = new FormApi({ + defaultValues: { + name: 'test', + }, + listeners: { + onSubmit: ({ formApi }) => { + triggered = formApi.state.values.name + }, + }, + }) + + form.mount() + await form.handleSubmit() + + expect(triggered).toStrictEqual('test') + }) + + it('should run the form listener onMount', async () => { + let triggered!: string + const form = new FormApi({ + defaultValues: { + name: 'test', + }, + listeners: { + onMount: ({ formApi }) => { + triggered = formApi.state.values.name + }, + }, + }) + + form.mount() + + expect(triggered).toStrictEqual('test') + }) + + it('should run the form listener onChange', async () => { + let triggered!: string + let name!: string + + const form = new FormApi({ + defaultValues: { + name: 'test', + }, + listeners: { + onChange: ({ fieldValue, fieldName }) => { + triggered = fieldValue + name = fieldName + }, + }, + }) + form.mount() + + const field = new FieldApi({ + form, + name: 'name', + }) + field.mount() + field.setValue('newTest') + + expect(triggered).toStrictEqual('newTest') + expect(name).toStrictEqual('name') + }) + + it('should run the form listener onChange when the field array is changed', () => { + let arr!: any + let name!: string + + const form = new FormApi({ + defaultValues: { + items: ['one', 'two'], + }, + listeners: { + onChange: ({ fieldValue, fieldName }) => { + arr = fieldValue + name = fieldName + }, + }, + }) + form.mount() + + const field = new FieldApi({ + form, + name: 'items', + }) + field.mount() + + field.removeValue(1) + expect(arr).toStrictEqual(['one']) + expect(name).toStrictEqual('items') + + field.replaceValue(0, 'start') + expect(arr).toStrictEqual(['start']) + + field.pushValue('end') + expect(arr).toStrictEqual(['start', 'end']) + + field.insertValue(1, 'middle') + expect(arr).toStrictEqual(['start', 'middle', 'end']) + + field.swapValues(0, 2) + expect(arr).toStrictEqual(['end', 'middle', 'start']) + + field.moveValue(0, 1) + expect(arr).toStrictEqual(['middle', 'end', 'start']) + }) + + it('should run the form listener onBlur', async () => { + let triggered!: string + let name!: string + + const form = new FormApi({ + defaultValues: { + name: 'test', + }, + listeners: { + onBlur: ({ fieldValue, fieldName }) => { + triggered = fieldValue + name = fieldName + }, + }, + }) + form.mount() + + const field = new FieldApi({ + form, + name: 'name', + }) + field.mount() + field.handleBlur() + + expect(triggered).toStrictEqual('test') + expect(name).toStrictEqual('name') + }) + + it('should run the field listener onSubmit', async () => { const form = new FormApi({ defaultValues: { name: 'test', From b0f47d628227ed756ba45320e0321c43eb200c5e Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sun, 9 Mar 2025 21:24:02 +0000 Subject: [PATCH 2/4] ci: apply automated fixes and generate docs --- docs/reference/classes/fieldapi.md | 26 ++-- docs/reference/classes/formapi.md | 62 ++++---- docs/reference/index.md | 1 + docs/reference/interfaces/formlisteners.md | 138 ++++++++++++++++++ docs/reference/interfaces/formoptions.md | 32 ++-- docs/reference/type-aliases/anyformapi.md | 2 +- docs/reference/type-aliases/anyformstate.md | 2 +- docs/reference/type-aliases/baseformstate.md | 2 +- .../type-aliases/derivedformstate.md | 2 +- docs/reference/type-aliases/fieldinfo.md | 2 +- docs/reference/type-aliases/formstate.md | 2 +- docs/reference/type-aliases/validationmeta.md | 2 +- 12 files changed, 212 insertions(+), 61 deletions(-) create mode 100644 docs/reference/interfaces/formlisteners.md diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md index 4b06bdeef..a51c0068a 100644 --- a/docs/reference/classes/fieldapi.md +++ b/docs/reference/classes/fieldapi.md @@ -163,7 +163,7 @@ The current field state. getInfo(): FieldInfo ``` -Defined in: [packages/form-core/src/FieldApi.ts:1221](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1221) +Defined in: [packages/form-core/src/FieldApi.ts:1227](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1227) Gets the field information object. @@ -179,7 +179,7 @@ Gets the field information object. getMeta(): FieldMeta ``` -Defined in: [packages/form-core/src/FieldApi.ts:1189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1189) +Defined in: [packages/form-core/src/FieldApi.ts:1195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1195) #### Returns @@ -213,7 +213,7 @@ Use `field.state.value` instead. handleBlur(): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1632](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1632) +Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) Handles the blur event. @@ -229,7 +229,7 @@ Handles the blur event. handleChange(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1625](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1625) +Defined in: [packages/form-core/src/FieldApi.ts:1667](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1667) Handles the change event. @@ -254,7 +254,7 @@ insertValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1241) +Defined in: [packages/form-core/src/FieldApi.ts:1253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1253) Inserts a value at the specified index, shifting the subsequent values to the right. @@ -307,7 +307,7 @@ moveValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) +Defined in: [packages/form-core/src/FieldApi.ts:1333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1333) Moves the value at the first specified index to the second specified index. @@ -337,7 +337,7 @@ Moves the value at the first specified index to the second specified index. pushValue(value, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1226) +Defined in: [packages/form-core/src/FieldApi.ts:1232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1232) Pushes a new value to the field. @@ -363,7 +363,7 @@ Pushes a new value to the field. removeValue(index, opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1273](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1273) +Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) Removes a value at the specified index. @@ -392,7 +392,7 @@ replaceValue( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1257](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1257) +Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) Replaces a value at the specified index. @@ -422,7 +422,7 @@ Replaces a value at the specified index. setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1652](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1652) +Defined in: [packages/form-core/src/FieldApi.ts:1700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1700) Updates the field's errorMap @@ -444,7 +444,7 @@ Updates the field's errorMap setMeta(updater): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1194) +Defined in: [packages/form-core/src/FieldApi.ts:1200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1200) Sets the field metadata. @@ -495,7 +495,7 @@ swapValues( opts?): void ``` -Defined in: [packages/form-core/src/FieldApi.ts:1285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1285) +Defined in: [packages/form-core/src/FieldApi.ts:1315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1315) Swaps the values at the specified indices. @@ -547,7 +547,7 @@ Updates the field instance with new options. validate(cause, opts?): unknown[] | Promise ``` -Defined in: [packages/form-core/src/FieldApi.ts:1592](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1592) +Defined in: [packages/form-core/src/FieldApi.ts:1634](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1634) Validates the field value. diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md index b276d961b..117c295cf 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:659](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L659) +Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) 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:746](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L746) +Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) 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:686](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L686) +Defined in: [packages/form-core/src/FormApi.ts:778](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L778) *** @@ -77,7 +77,7 @@ Defined in: [packages/form-core/src/FormApi.ts:686](https://github.com/TanStack/ fieldInfo: Record ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, FieldInfo>; ``` -Defined in: [packages/form-core/src/FormApi.ts:716](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L716) +Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) 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 ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, AnyFieldMeta>>; ``` -Defined in: [packages/form-core/src/FormApi.ts:699](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L699) +Defined in: [packages/form-core/src/FormApi.ts:791](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L791) *** @@ -99,7 +99,7 @@ Defined in: [packages/form-core/src/FormApi.ts:699](https://github.com/TanStack/ options: FormOptions = {}; ``` -Defined in: [packages/form-core/src/FormApi.ts:674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L674) +Defined in: [packages/form-core/src/FormApi.ts:766](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L766) The options for the form. @@ -111,7 +111,7 @@ The options for the form. store: Derived>; ``` -Defined in: [packages/form-core/src/FormApi.ts:700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L700) +Defined in: [packages/form-core/src/FormApi.ts:792](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L792) ## Accessors @@ -123,7 +123,7 @@ Defined in: [packages/form-core/src/FormApi.ts:700](https://github.com/TanStack/ get state(): FormState ``` -Defined in: [packages/form-core/src/FormApi.ts:718](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L718) +Defined in: [packages/form-core/src/FormApi.ts:810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L810) ##### Returns @@ -137,7 +137,7 @@ Defined in: [packages/form-core/src/FormApi.ts:718](https://github.com/TanStack/ deleteField(field): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1772](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1772) +Defined in: [packages/form-core/src/FormApi.ts:1869](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1869) #### Type Parameters @@ -161,7 +161,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1772](https://github.com/TanStack getAllErrors(): object ``` -Defined in: [packages/form-core/src/FormApi.ts:1988](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1988) +Defined in: [packages/form-core/src/FormApi.ts:2085](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2085) Returns form and field level errors @@ -212,7 +212,7 @@ errors: ( getFieldInfo(field): FieldInfo ``` -Defined in: [packages/form-core/src/FormApi.ts:1681](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1681) +Defined in: [packages/form-core/src/FormApi.ts:1778](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1778) 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:1672](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1672) +Defined in: [packages/form-core/src/FormApi.ts:1769](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1769) 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:1665](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1665) +Defined in: [packages/form-core/src/FormApi.ts:1762](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1762) 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:1581](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1581) +Defined in: [packages/form-core/src/FormApi.ts:1676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1676) Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit 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:1582](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1582) +Defined in: [packages/form-core/src/FormApi.ts:1677](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1677) Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks. @@ -332,7 +332,7 @@ insertFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1811](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1811) +Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) #### Type Parameters @@ -368,7 +368,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1811](https://github.com/TanStack mount(): () => void ``` -Defined in: [packages/form-core/src/FormApi.ts:1049](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1049) +Defined in: [packages/form-core/src/FormApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1141) #### Returns @@ -390,7 +390,7 @@ moveFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1935) +Defined in: [packages/form-core/src/FormApi.ts:2032](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2032) Moves the value at the first specified index to the second specified index within an array field. @@ -431,7 +431,7 @@ pushFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1796](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1796) +Defined in: [packages/form-core/src/FormApi.ts:1893](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1893) Pushes a value into an array field. @@ -468,7 +468,7 @@ removeFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1869](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1869) +Defined in: [packages/form-core/src/FormApi.ts:1966](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1966) Removes a value from an array field at the specified index. @@ -506,7 +506,7 @@ replaceFieldValue( opts?): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1843](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1843) +Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940) Replaces a value into an array field at the specified index. @@ -544,7 +544,7 @@ Replaces a value into an array field at the specified index. reset(values?, opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1134](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1134) +Defined in: [packages/form-core/src/FormApi.ts:1229](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1229) 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. @@ -577,7 +577,7 @@ Optional options to control the reset behavior. resetFieldMeta(fieldMeta): Record ``` -Defined in: [packages/form-core/src/FormApi.ts:1718](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1718) +Defined in: [packages/form-core/src/FormApi.ts:1815](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1815) #### Type Parameters @@ -601,7 +601,7 @@ Defined in: [packages/form-core/src/FormApi.ts:1718](https://github.com/TanStack setErrorMap(errorMap): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1962](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1962) +Defined in: [packages/form-core/src/FormApi.ts:2059](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2059) Updates the form's errorMap @@ -623,7 +623,7 @@ Updates the form's errorMap setFieldMeta(field, updater): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1700) +Defined in: [packages/form-core/src/FormApi.ts:1797](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1797) Updates the metadata of the specified field. @@ -656,7 +656,7 @@ setFieldValue( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1742](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1742) +Defined in: [packages/form-core/src/FormApi.ts:1839](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1839) Sets the value of the specified field and optionally updates the touched state. @@ -694,7 +694,7 @@ swapFieldValues( opts?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1906](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1906) +Defined in: [packages/form-core/src/FormApi.ts:2003](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2003) Swaps the values at the specified indices within an array field. @@ -732,7 +732,7 @@ Swaps the values at the specified indices within an array field. update(options?): void ``` -Defined in: [packages/form-core/src/FormApi.ts:1066](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1066) +Defined in: [packages/form-core/src/FormApi.ts:1161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1161) Updates the form options and form state. @@ -754,7 +754,7 @@ Updates the form options and form state. validateAllFields(cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1160](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1160) +Defined in: [packages/form-core/src/FormApi.ts:1255](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1255) Validates all fields using the correct handlers for a given validation cause. @@ -779,7 +779,7 @@ validateArrayFieldsStartingFrom( cause): Promise ``` -Defined in: [packages/form-core/src/FormApi.ts:1190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1190) +Defined in: [packages/form-core/src/FormApi.ts:1285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1285) 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. @@ -813,7 +813,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:1229](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1229) +Defined in: [packages/form-core/src/FormApi.ts:1324](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1324) Validates a specified field in the form using the correct handlers for a given validation type. diff --git a/docs/reference/index.md b/docs/reference/index.md index a87090a70..77d1cc30a 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -18,6 +18,7 @@ title: "@tanstack/form-core" - [FieldListeners](interfaces/fieldlisteners.md) - [FieldOptions](interfaces/fieldoptions.md) - [FieldValidators](interfaces/fieldvalidators.md) +- [FormListeners](interfaces/formlisteners.md) - [FormOptions](interfaces/formoptions.md) - [FormValidators](interfaces/formvalidators.md) - [StandardSchemaV1Issue](interfaces/standardschemav1issue.md) diff --git a/docs/reference/interfaces/formlisteners.md b/docs/reference/interfaces/formlisteners.md new file mode 100644 index 000000000..a36385650 --- /dev/null +++ b/docs/reference/interfaces/formlisteners.md @@ -0,0 +1,138 @@ +--- +id: FormListeners +title: FormListeners +--- + + + +# Interface: FormListeners\ + +Defined in: [packages/form-core/src/FormApi.ts:234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L234) + +## Type Parameters + +• **TField** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TFormData`\> + +• **TFormData** + +• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> + +• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> + +• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> + +• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> + +• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> + +• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> + +• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> + +• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> + +• **TSubmitMeta** = `never` + +## Properties + +### onBlur()? + +```ts +optional onBlur: (props) => void; +``` + +Defined in: [packages/form-core/src/FormApi.ts:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L263) + +#### Parameters + +##### props + +###### fieldName + +`TField` + +###### fieldValue + +[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> + +###### formApi + +[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> + +#### Returns + +`void` + +*** + +### onChange()? + +```ts +optional onChange: (props) => void; +``` + +Defined in: [packages/form-core/src/FormApi.ts:247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L247) + +#### Parameters + +##### props + +###### fieldName + +`TField` + +###### fieldValue + +[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> + +###### formApi + +[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> + +#### Returns + +`void` + +*** + +### onMount()? + +```ts +optional onMount: (props) => void; +``` + +Defined in: [packages/form-core/src/FormApi.ts:279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L279) + +#### Parameters + +##### props + +###### formApi + +[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> + +#### Returns + +`void` + +*** + +### onSubmit()? + +```ts +optional onSubmit: (props) => void; +``` + +Defined in: [packages/form-core/src/FormApi.ts:293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L293) + +#### Parameters + +##### props + +###### formApi + +[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> + +#### Returns + +`void` diff --git a/docs/reference/interfaces/formoptions.md b/docs/reference/interfaces/formoptions.md index 9d496df9f..82c203c6b 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:237](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L237) +Defined in: [packages/form-core/src/FormApi.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L312) 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:272](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L272) +Defined in: [packages/form-core/src/FormApi.ts:347](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L347) 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:276](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L276) +Defined in: [packages/form-core/src/FormApi.ts:351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L351) 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 defaultState: Partial>; ``` -Defined in: [packages/form-core/src/FormApi.ts:256](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L256) +Defined in: [packages/form-core/src/FormApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L331) The default state for the form. @@ -77,19 +77,31 @@ The default state for the form. optional defaultValues: TFormData; ``` -Defined in: [packages/form-core/src/FormApi.ts:252](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L252) +Defined in: [packages/form-core/src/FormApi.ts:327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L327) Set initial values for your form. *** +### listeners? + +```ts +optional listeners: FormListeners ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>; +``` + +Defined in: [packages/form-core/src/FormApi.ts:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L374) + +form level listeners + +*** + ### onSubmit()? ```ts optional onSubmit: (props) => any; ``` -Defined in: [packages/form-core/src/FormApi.ts:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L299) +Defined in: [packages/form-core/src/FormApi.ts:391](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L391) 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` @@ -121,7 +133,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:318](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L318) +Defined in: [packages/form-core/src/FormApi.ts:410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L410) Specify an action for scenarios where the user tries to submit an invalid form. @@ -149,7 +161,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:294](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L294) +Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369) onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props @@ -161,7 +173,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:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L333) +Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L425) *** @@ -171,6 +183,6 @@ Defined in: [packages/form-core/src/FormApi.ts:333](https://github.com/TanStack/ optional validators: FormValidators; ``` -Defined in: [packages/form-core/src/FormApi.ts:280](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L280) +Defined in: [packages/form-core/src/FormApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355) A list of validators to pass to the form diff --git a/docs/reference/type-aliases/anyformapi.md b/docs/reference/type-aliases/anyformapi.md index fd215a60c..9fb5c501e 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:639](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L639) +Defined in: [packages/form-core/src/FormApi.ts:731](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L731) 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 50698c96f..6a51910a8 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:568](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L568) +Defined in: [packages/form-core/src/FormApi.ts:660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L660) diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md index be32e3405..cb5a62018 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:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L394) +Defined in: [packages/form-core/src/FormApi.ts:486](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L486) An object representing the current state of the form. diff --git a/docs/reference/type-aliases/derivedformstate.md b/docs/reference/type-aliases/derivedformstate.md index cf30bf075..712ac2cfd 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:465](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L465) +Defined in: [packages/form-core/src/FormApi.ts:557](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L557) ## Type Parameters diff --git a/docs/reference/type-aliases/fieldinfo.md b/docs/reference/type-aliases/fieldinfo.md index fe7df7439..08521d479 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:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L360) +Defined in: [packages/form-core/src/FormApi.ts:452](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L452) An object representing the field information for a specific field within the form. diff --git a/docs/reference/type-aliases/formstate.md b/docs/reference/type-aliases/formstate.md index ff23c8776..645a758ba 100644 --- a/docs/reference/type-aliases/formstate.md +++ b/docs/reference/type-aliases/formstate.md @@ -11,7 +11,7 @@ title: FormState type FormState = BaseFormState & DerivedFormState; ``` -Defined in: [packages/form-core/src/FormApi.ts:535](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L535) +Defined in: [packages/form-core/src/FormApi.ts:627](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L627) ## Type Parameters diff --git a/docs/reference/type-aliases/validationmeta.md b/docs/reference/type-aliases/validationmeta.md index 41633bdab..883bf6201 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:350](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L350) +Defined in: [packages/form-core/src/FormApi.ts:442](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L442) An object representing the validation metadata for a field. Not intended for public usage. From 664635a22b9db143d13f5154cdc03b262afeaec4 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Wed, 12 Mar 2025 12:07:27 +0100 Subject: [PATCH 3/4] chore: removed fieldValue --- packages/form-core/src/FormApi.ts | 9 +++++---- packages/form-core/tests/FormApi.spec.ts | 16 ++++++++-------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index 410eed337..4848f2a5a 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -232,7 +232,6 @@ export interface FormTransform< } export interface FormListeners< - TField extends DeepKeys, TFormData, TOnMount extends undefined | FormValidateOrFn, TOnChange extends undefined | FormValidateOrFn, @@ -242,11 +241,11 @@ export interface FormListeners< TOnSubmit extends undefined | FormValidateOrFn, TOnSubmitAsync extends undefined | FormAsyncValidateOrFn, TOnServer extends undefined | FormAsyncValidateOrFn, + TField extends DeepKeys, TSubmitMeta = never, > { onChange?: (props: { fieldName: TField - fieldValue: DeepValue formApi: FormApi< TFormData, TOnMount, @@ -260,9 +259,9 @@ export interface FormListeners< TSubmitMeta > }) => void + onBlur?: (props: { fieldName: TField - fieldValue: DeepValue formApi: FormApi< TFormData, TOnMount, @@ -276,6 +275,7 @@ export interface FormListeners< TSubmitMeta > }) => void + onMount?: (props: { formApi: FormApi< TFormData, @@ -290,6 +290,7 @@ export interface FormListeners< TSubmitMeta > }) => void + onSubmit?: (props: { formApi: FormApi< TFormData, @@ -372,7 +373,6 @@ export interface FormOptions< * form level listeners */ listeners?: FormListeners< - DeepKeys, TFormData, TOnMount, TOnChange, @@ -382,6 +382,7 @@ export interface FormOptions< TOnSubmit, TOnSubmitAsync, TOnServer, + DeepKeys, TSubmitMeta > diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index a42b63337..dda3952a3 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -1994,16 +1994,15 @@ describe('form api', () => { }) it('should run the form listener onChange', async () => { - let triggered!: string let name!: string const form = new FormApi({ defaultValues: { name: 'test', + age: 0, }, listeners: { - onChange: ({ fieldValue, fieldName }) => { - triggered = fieldValue + onChange: ({ formApi, fieldName }) => { name = fieldName }, }, @@ -2017,7 +2016,7 @@ describe('form api', () => { field.mount() field.setValue('newTest') - expect(triggered).toStrictEqual('newTest') + expect(form.state.values[name]).toStrictEqual('newTest') expect(name).toStrictEqual('name') }) @@ -2028,10 +2027,11 @@ describe('form api', () => { const form = new FormApi({ defaultValues: { items: ['one', 'two'], + age: 0, }, listeners: { - onChange: ({ fieldValue, fieldName }) => { - arr = fieldValue + onChange: ({ formApi, fieldName }) => { + arr = formApi.state.values[fieldName] name = fieldName }, }, @@ -2071,10 +2071,10 @@ describe('form api', () => { const form = new FormApi({ defaultValues: { name: 'test', + age: 0, }, listeners: { - onBlur: ({ fieldValue, fieldName }) => { - triggered = fieldValue + onBlur: ({ fieldName, formApi }) => { name = fieldName }, }, From cd42633ed852831024815f58c7330bba437e0291 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 12 Mar 2025 11:08:38 +0000 Subject: [PATCH 4/4] ci: apply automated fixes and generate docs --- .../reference/classes/tanstackfield.md | 321 ------- .../angular/reference/functions/injectform.md | 46 - .../reference/functions/injectstore.md | 52 -- docs/framework/angular/reference/index.md | 17 - .../classes/tanstackformcontroller.md | 187 ---- docs/framework/lit/reference/index.md | 12 - .../reference/functions/createformhook.md | 118 --- .../functions/createformhookcontexts.md | 54 -- .../react/reference/functions/field.md | 68 -- .../react/reference/functions/usefield.md | 70 -- .../react/reference/functions/useform.md | 50 -- .../react/reference/functions/usestore.md | 64 -- .../react/reference/functions/usetransform.md | 28 - docs/framework/react/reference/index.md | 29 - .../reference/interfaces/reactformapi.md | 78 -- .../reference/interfaces/withformprops.md | 72 -- .../reference/type-aliases/fieldcomponent.md | 76 -- .../type-aliases/reactformextendedapi.md | 38 - .../react/reference/type-aliases/usefield.md | 70 -- .../solid/reference/functions/createfield.md | 68 -- .../solid/reference/functions/createform.md | 46 - .../solid/reference/functions/field.md | 64 -- .../solid/reference/functions/usestore.md | 64 -- docs/framework/solid/reference/index.md | 24 - .../reference/interfaces/solidformapi.md | 110 --- .../reference/type-aliases/createfield.md | 72 -- .../reference/type-aliases/fieldcomponent.md | 72 -- .../vue/reference/functions/usefield.md | 76 -- .../vue/reference/functions/useform.md | 46 - .../vue/reference/functions/usestore.md | 64 -- docs/framework/vue/reference/index.md | 29 - .../vue/reference/interfaces/vuefieldapi.md | 42 - .../vue/reference/interfaces/vueformapi.md | 86 -- .../reference/type-aliases/fieldcomponent.md | 56 -- .../type-aliases/fieldcomponentprops.md | 54 -- .../vue/reference/type-aliases/usefield.md | 78 -- .../vue/reference/variables/field.md | 24 - docs/reference/classes/fieldapi.md | 568 ------------ docs/reference/classes/formapi.md | 836 ------------------ docs/reference/functions/formoptions.md | 28 - .../functions/isglobalformvalidationerror.md | 24 - .../functions/isstandardschemavalidator.md | 24 - docs/reference/functions/mergeform.md | 32 - docs/reference/functions/shallow.md | 32 - docs/reference/index.md | 69 -- docs/reference/interfaces/fieldapioptions.md | 194 ---- docs/reference/interfaces/fieldlisteners.md | 58 -- docs/reference/interfaces/fieldoptions.md | 134 --- docs/reference/interfaces/fieldvalidators.md | 204 ----- docs/reference/interfaces/formlisteners.md | 138 --- docs/reference/interfaces/formoptions.md | 188 ---- docs/reference/interfaces/formvalidators.md | 132 --- .../interfaces/standardschemav1issue.md | 36 - docs/reference/type-aliases/anyfieldapi.md | 16 - docs/reference/type-aliases/anyfieldmeta.md | 14 - .../type-aliases/anyfieldmetabase.md | 14 - .../type-aliases/anyfieldmetaderived.md | 14 - docs/reference/type-aliases/anyformapi.md | 16 - docs/reference/type-aliases/anyformstate.md | 14 - docs/reference/type-aliases/baseformstate.md | 126 --- docs/reference/type-aliases/deepkeys.md | 22 - docs/reference/type-aliases/deepvalue.md | 26 - .../type-aliases/derivedformstate.md | 140 --- docs/reference/type-aliases/fieldinfo.md | 40 - docs/reference/type-aliases/fieldmeta.md | 52 -- docs/reference/type-aliases/fieldmetabase.md | 92 -- .../type-aliases/fieldmetaderived.md | 75 -- docs/reference/type-aliases/fieldstate.md | 70 -- docs/reference/type-aliases/formstate.md | 34 - docs/reference/type-aliases/formvalidatefn.md | 34 - .../type-aliases/formvalidationerror.md | 20 - docs/reference/type-aliases/formvalidator.md | 60 -- .../type-aliases/standardschemav1.md | 32 - .../tstandardschemavalidatorvalue.md | 32 - .../unwrapfieldasyncvalidateorfn.md | 27 - .../type-aliases/unwrapfieldvalidateorfn.md | 27 - .../unwrapformasyncvalidateorfn.md | 18 - .../type-aliases/unwrapformvalidateorfn.md | 18 - docs/reference/type-aliases/updater.md | 20 - docs/reference/type-aliases/updaterfn.md | 30 - .../reference/type-aliases/validationerror.md | 14 - docs/reference/type-aliases/validationmeta.md | 26 - .../type-aliases/validationsource.md | 14 - .../variables/standardschemavalidators.md | 59 -- 84 files changed, 6418 deletions(-) delete mode 100644 docs/framework/angular/reference/classes/tanstackfield.md delete mode 100644 docs/framework/angular/reference/functions/injectform.md delete mode 100644 docs/framework/angular/reference/functions/injectstore.md delete mode 100644 docs/framework/angular/reference/index.md delete mode 100644 docs/framework/lit/reference/classes/tanstackformcontroller.md delete mode 100644 docs/framework/lit/reference/index.md delete mode 100644 docs/framework/react/reference/functions/createformhook.md delete mode 100644 docs/framework/react/reference/functions/createformhookcontexts.md delete mode 100644 docs/framework/react/reference/functions/field.md delete mode 100644 docs/framework/react/reference/functions/usefield.md delete mode 100644 docs/framework/react/reference/functions/useform.md delete mode 100644 docs/framework/react/reference/functions/usestore.md delete mode 100644 docs/framework/react/reference/functions/usetransform.md delete mode 100644 docs/framework/react/reference/index.md delete mode 100644 docs/framework/react/reference/interfaces/reactformapi.md delete mode 100644 docs/framework/react/reference/interfaces/withformprops.md delete mode 100644 docs/framework/react/reference/type-aliases/fieldcomponent.md delete mode 100644 docs/framework/react/reference/type-aliases/reactformextendedapi.md delete mode 100644 docs/framework/react/reference/type-aliases/usefield.md delete mode 100644 docs/framework/solid/reference/functions/createfield.md delete mode 100644 docs/framework/solid/reference/functions/createform.md delete mode 100644 docs/framework/solid/reference/functions/field.md delete mode 100644 docs/framework/solid/reference/functions/usestore.md delete mode 100644 docs/framework/solid/reference/index.md delete mode 100644 docs/framework/solid/reference/interfaces/solidformapi.md delete mode 100644 docs/framework/solid/reference/type-aliases/createfield.md delete mode 100644 docs/framework/solid/reference/type-aliases/fieldcomponent.md delete mode 100644 docs/framework/vue/reference/functions/usefield.md delete mode 100644 docs/framework/vue/reference/functions/useform.md delete mode 100644 docs/framework/vue/reference/functions/usestore.md delete mode 100644 docs/framework/vue/reference/index.md delete mode 100644 docs/framework/vue/reference/interfaces/vuefieldapi.md delete mode 100644 docs/framework/vue/reference/interfaces/vueformapi.md delete mode 100644 docs/framework/vue/reference/type-aliases/fieldcomponent.md delete mode 100644 docs/framework/vue/reference/type-aliases/fieldcomponentprops.md delete mode 100644 docs/framework/vue/reference/type-aliases/usefield.md delete mode 100644 docs/framework/vue/reference/variables/field.md delete mode 100644 docs/reference/classes/fieldapi.md delete mode 100644 docs/reference/classes/formapi.md delete mode 100644 docs/reference/functions/formoptions.md delete mode 100644 docs/reference/functions/isglobalformvalidationerror.md delete mode 100644 docs/reference/functions/isstandardschemavalidator.md delete mode 100644 docs/reference/functions/mergeform.md delete mode 100644 docs/reference/functions/shallow.md delete mode 100644 docs/reference/index.md delete mode 100644 docs/reference/interfaces/fieldapioptions.md delete mode 100644 docs/reference/interfaces/fieldlisteners.md delete mode 100644 docs/reference/interfaces/fieldoptions.md delete mode 100644 docs/reference/interfaces/fieldvalidators.md delete mode 100644 docs/reference/interfaces/formlisteners.md delete mode 100644 docs/reference/interfaces/formoptions.md delete mode 100644 docs/reference/interfaces/formvalidators.md delete mode 100644 docs/reference/interfaces/standardschemav1issue.md delete mode 100644 docs/reference/type-aliases/anyfieldapi.md delete mode 100644 docs/reference/type-aliases/anyfieldmeta.md delete mode 100644 docs/reference/type-aliases/anyfieldmetabase.md delete mode 100644 docs/reference/type-aliases/anyfieldmetaderived.md delete mode 100644 docs/reference/type-aliases/anyformapi.md delete mode 100644 docs/reference/type-aliases/anyformstate.md delete mode 100644 docs/reference/type-aliases/baseformstate.md delete mode 100644 docs/reference/type-aliases/deepkeys.md delete mode 100644 docs/reference/type-aliases/deepvalue.md delete mode 100644 docs/reference/type-aliases/derivedformstate.md delete mode 100644 docs/reference/type-aliases/fieldinfo.md delete mode 100644 docs/reference/type-aliases/fieldmeta.md delete mode 100644 docs/reference/type-aliases/fieldmetabase.md delete mode 100644 docs/reference/type-aliases/fieldmetaderived.md delete mode 100644 docs/reference/type-aliases/fieldstate.md delete mode 100644 docs/reference/type-aliases/formstate.md delete mode 100644 docs/reference/type-aliases/formvalidatefn.md delete mode 100644 docs/reference/type-aliases/formvalidationerror.md delete mode 100644 docs/reference/type-aliases/formvalidator.md delete mode 100644 docs/reference/type-aliases/standardschemav1.md delete mode 100644 docs/reference/type-aliases/tstandardschemavalidatorvalue.md delete mode 100644 docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md delete mode 100644 docs/reference/type-aliases/unwrapfieldvalidateorfn.md delete mode 100644 docs/reference/type-aliases/unwrapformasyncvalidateorfn.md delete mode 100644 docs/reference/type-aliases/unwrapformvalidateorfn.md delete mode 100644 docs/reference/type-aliases/updater.md delete mode 100644 docs/reference/type-aliases/updaterfn.md delete mode 100644 docs/reference/type-aliases/validationerror.md delete mode 100644 docs/reference/type-aliases/validationmeta.md delete mode 100644 docs/reference/type-aliases/validationsource.md delete mode 100644 docs/reference/variables/standardschemavalidators.md diff --git a/docs/framework/angular/reference/classes/tanstackfield.md b/docs/framework/angular/reference/classes/tanstackfield.md deleted file mode 100644 index c15d5b235..000000000 --- a/docs/framework/angular/reference/classes/tanstackfield.md +++ /dev/null @@ -1,321 +0,0 @@ ---- -id: TanStackField -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) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Implements - -- `OnInit` -- `OnChanges` -- `OnDestroy` -- `FieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\> - -## Constructors - -### new TanStackField() - -```ts -new TanStackField(): TanStackField -``` - -#### Returns - -[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -## Properties - -### api - -```ts -api: FieldApi; -``` - -Defined in: [tanstack-field.directive.ts:129](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129) - -*** - -### asyncAlways? - -```ts -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) - -If `true`, always run async validation, even if there are errors emitted during synchronous validation. - -#### Implementation of - -```ts -FieldOptions.asyncAlways -``` - -*** - -### asyncDebounceMs? - -```ts -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) - -The default time to debounce async validation if there is not a more specific debounce time passed. - -#### Implementation of - -```ts -FieldOptions.asyncDebounceMs -``` - -*** - -### defaultMeta? - -```ts -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) - -An optional object with default metadata for the field. - -#### Implementation of - -```ts -FieldOptions.defaultMeta -``` - -*** - -### defaultValue? - -```ts -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) - -An optional default value for the field. - -#### Implementation of - -```ts -FieldOptions.defaultValue -``` - -*** - -### disableErrorFlat? - -```ts -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) - -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. - -#### Implementation of - -```ts -FieldOptions.disableErrorFlat -``` - -*** - -### listeners? - -```ts -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) - -A list of listeners which attach to the corresponding events - -#### Implementation of - -```ts -FieldOptions.listeners -``` - -*** - -### name - -```ts -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) - -The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. - -#### Implementation of - -```ts -FieldOptions.name -``` - -*** - -### tanstackField - -```ts -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) - -*** - -### unmount()? - -```ts -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) - -#### Returns - -`void` - -*** - -### validators? - -```ts -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) - -A list of validators to pass to the field - -#### Implementation of - -```ts -FieldOptions.validators -``` - -## Methods - -### ngOnChanges() - -```ts -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) - -A callback method that is invoked immediately after the -default change detector has checked data-bound properties -if at least one has changed, and before the view and content -children are checked. - -#### Returns - -`void` - -#### Implementation of - -```ts -OnChanges.ngOnChanges -``` - -*** - -### ngOnDestroy() - -```ts -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) - -A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. - -#### Returns - -`void` - -#### Implementation of - -```ts -OnDestroy.ngOnDestroy -``` - -*** - -### ngOnInit() - -```ts -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) - -A callback method that is invoked immediately after the -default change detector has checked the directive's -data-bound properties for the first time, -and before any of the view or content children have been checked. -It is invoked only once when the directive is instantiated. - -#### Returns - -`void` - -#### Implementation of - -```ts -OnInit.ngOnInit -``` diff --git a/docs/framework/angular/reference/functions/injectform.md b/docs/framework/angular/reference/functions/injectform.md deleted file mode 100644 index 08bdeed3c..000000000 --- a/docs/framework/angular/reference/functions/injectform.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: injectForm -title: injectForm ---- - - - -# Function: injectForm() - -```ts -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) - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -## Returns - -`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md deleted file mode 100644 index fad9e10ed..000000000 --- a/docs/framework/angular/reference/functions/injectstore.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: injectStore -title: injectStore ---- - - - -# Function: injectStore() - -```ts -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) - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -• **TSelected** = `NoInfer`\<`FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\>\> - -## Parameters - -### form - -`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -### selector? - -(`state`) => `TSelected` - -## Returns - -`Signal`\<`TSelected`\> diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md deleted file mode 100644 index 3110ff697..000000000 --- a/docs/framework/angular/reference/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: "@tanstack/angular-form" -title: "@tanstack/angular-form" ---- - - - -# @tanstack/angular-form - -## Classes - -- [TanStackField](classes/tanstackfield.md) - -## Functions - -- [injectForm](functions/injectform.md) -- [injectStore](functions/injectstore.md) diff --git a/docs/framework/lit/reference/classes/tanstackformcontroller.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md deleted file mode 100644 index dcc822099..000000000 --- a/docs/framework/lit/reference/classes/tanstackformcontroller.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -id: TanStackFormController -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Implements - -- `ReactiveController` - -## Constructors - -### new TanStackFormController() - -```ts -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) - -#### Parameters - -##### host - -`ReactiveControllerHost` - -##### config? - -`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -#### Returns - -[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -## Properties - -### api - -```ts -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) - -## Methods - -### field() - -```ts -field(fieldConfig, render): object -``` - -Defined in: [tanstack-form-controller.ts:260](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L260) - -#### Type Parameters - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -#### Parameters - -##### fieldConfig - -`FieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\> - -##### render - -`renderCallback`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -#### Returns - -`object` - -##### values - -```ts -values: object; -``` - -###### values.form - -```ts -form: FormApi; -``` - -###### values.options - -```ts -options: FieldOptions; -``` - -###### values.render - -```ts -render: renderCallback; -``` - -*** - -### hostConnected() - -```ts -hostConnected(): void -``` - -Defined in: [tanstack-form-controller.ts:250](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L250) - -Called when the host is connected to the component tree. For custom -element hosts, this corresponds to the `connectedCallback()` lifecycle, -which is only called when the component is connected to the document. - -#### Returns - -`void` - -#### Implementation of - -```ts -ReactiveController.hostConnected -``` - -*** - -### hostDisconnected() - -```ts -hostDisconnected(): void -``` - -Defined in: [tanstack-form-controller.ts:256](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L256) - -Called when the host is disconnected from the component tree. For custom -element hosts, this corresponds to the `disconnectedCallback()` lifecycle, -which is called the host or an ancestor component is disconnected from the -document. - -#### Returns - -`void` - -#### Implementation of - -```ts -ReactiveController.hostDisconnected -``` diff --git a/docs/framework/lit/reference/index.md b/docs/framework/lit/reference/index.md deleted file mode 100644 index 7bb43cc14..000000000 --- a/docs/framework/lit/reference/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: "@tanstack/lit-form" -title: "@tanstack/lit-form" ---- - - - -# @tanstack/lit-form - -## Classes - -- [TanStackFormController](classes/tanstackformcontroller.md) diff --git a/docs/framework/react/reference/functions/createformhook.md b/docs/framework/react/reference/functions/createformhook.md deleted file mode 100644 index 47c289840..000000000 --- a/docs/framework/react/reference/functions/createformhook.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: createFormHook -title: createFormHook ---- - - - -# Function: createFormHook() - -```ts -function createFormHook(__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) - -## Type Parameters - -• **TComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\> - -• **TFormComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\> - -## Parameters - -### \_\_namedParameters - -`CreateFormHookProps`\<`TComponents`, `TFormComponents`\> - -## Returns - -`object` - -### useAppForm() - -```ts -useAppForm: (props) => AppFieldExtendedReactFormApi; -``` - -#### Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -#### Parameters - -##### props - -`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`AppFieldExtendedReactFormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\> - -### withForm() - -```ts -withForm: (__namedParameters) => (props) => Element; -``` - -#### Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -• **TRenderProps** *extends* `Record`\<`string`, `unknown`\> = \{\} - -#### Parameters - -##### \_\_namedParameters - -[`WithFormProps`](../interfaces/withformprops.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`, `TRenderProps`\> - -#### Returns - -`Function` - -##### Parameters - -###### props - -`PropsWithChildren`\<`NoInfer`\<`UnwrapOrAny`\<`TRenderProps`\>\> & `object`\> - -##### Returns - -`Element` diff --git a/docs/framework/react/reference/functions/createformhookcontexts.md b/docs/framework/react/reference/functions/createformhookcontexts.md deleted file mode 100644 index a01aba533..000000000 --- a/docs/framework/react/reference/functions/createformhookcontexts.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: createFormHookContexts -title: createFormHookContexts ---- - - - -# Function: createFormHookContexts() - -```ts -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) - -## Returns - -`object` - -### fieldContext - -```ts -fieldContext: Context; -``` - -### formContext - -```ts -formContext: Context; -``` - -### useFieldContext() - -```ts -useFieldContext: () => FieldApi; -``` - -#### Type Parameters - -• **TData** - -#### Returns - -`FieldApi`\<`any`, `string`, `TData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> - -### useFormContext() - -```ts -useFormContext: () => ReactFormExtendedApi, any, any, any, any, any, any, any, any, any>; -``` - -#### Returns - -[`ReactFormExtendedApi`](../type-aliases/reactformextendedapi.md)\<`Record`\<`string`, `never`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md deleted file mode 100644 index 1f9a8accb..000000000 --- a/docs/framework/react/reference/functions/field.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: Field -title: Field ---- - - - -# Function: Field() - -```ts -function Field(__namedParameters): ReactNode -``` - -Defined in: [packages/react-form/src/useField.tsx:369](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L369) - -A function component that takes field options and a render function as children and returns a React component. - -The `Field` component uses the `useField` hook internally to manage the field instance. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TPatentSubmitMeta** - -## Parameters - -### \_\_namedParameters - -`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> - -## Returns - -`ReactNode` diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md deleted file mode 100644 index 3129ca3e7..000000000 --- a/docs/framework/react/reference/functions/usefield.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: useField -title: useField ---- - - - -# Function: useField() - -```ts -function useField(opts): FieldApi & ReactFieldApi -``` - -Defined in: [packages/react-form/src/useField.tsx:130](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L130) - -A hook for managing a field in a form. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TPatentSubmitMeta** - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> - -An object with field options. - -## Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> & `ReactFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> - -The `FieldApi` instance for the specified field. diff --git a/docs/framework/react/reference/functions/useform.md b/docs/framework/react/reference/functions/useform.md deleted file mode 100644 index cc3de3c7a..000000000 --- a/docs/framework/react/reference/functions/useform.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: useForm -title: useForm ---- - - - -# Function: useForm() - -```ts -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) - -A custom React Hook that returns an extended instance of the `FormApi` class. - -This API encapsulates all the necessary functionalities related to the form. It allows you to manage form state, handle submissions, and interact with form fields - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -## Returns - -[`ReactFormExtendedApi`](../type-aliases/reactformextendedapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md deleted file mode 100644 index 2b982db00..000000000 --- a/docs/framework/react/reference/functions/usestore.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: useStore -title: useStore ---- - - - -# Function: useStore() - -## Call Signature - -```ts -function useStore(store, selector?): TSelected -``` - -Defined in: node\_modules/.pnpm/@tanstack+react-store@0.7.0\_react-dom@19.0.0\_react@19.0.0\_\_react@19.0.0/node\_modules/@tanstack/react-store/dist/esm/index.d.ts:7 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Store`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`TSelected` - -## Call Signature - -```ts -function useStore(store, selector?): TSelected -``` - -Defined in: node\_modules/.pnpm/@tanstack+react-store@0.7.0\_react-dom@19.0.0\_react@19.0.0\_\_react@19.0.0/node\_modules/@tanstack/react-store/dist/esm/index.d.ts:8 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Derived`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`TSelected` diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md deleted file mode 100644 index 6545c00a1..000000000 --- a/docs/framework/react/reference/functions/usetransform.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: useTransform -title: useTransform ---- - - - -# Function: useTransform() - -```ts -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) - -## Parameters - -### fn - -(`formBase`) => `AnyFormApi` - -### deps - -`unknown`[] - -## Returns - -`FormTransform`\<`any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md deleted file mode 100644 index 5915cff40..000000000 --- a/docs/framework/react/reference/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: "@tanstack/react-form" -title: "@tanstack/react-form" ---- - - - -# @tanstack/react-form - -## Interfaces - -- [ReactFormApi](interfaces/reactformapi.md) -- [WithFormProps](interfaces/withformprops.md) - -## Type Aliases - -- [FieldComponent](type-aliases/fieldcomponent.md) -- [ReactFormExtendedApi](type-aliases/reactformextendedapi.md) -- [UseField](type-aliases/usefield.md) - -## Functions - -- [createFormHook](functions/createformhook.md) -- [createFormHookContexts](functions/createformhookcontexts.md) -- [Field](functions/field.md) -- [useField](functions/usefield.md) -- [useForm](functions/useform.md) -- [useStore](functions/usestore.md) -- [useTransform](functions/usetransform.md) diff --git a/docs/framework/react/reference/interfaces/reactformapi.md b/docs/framework/react/reference/interfaces/reactformapi.md deleted file mode 100644 index 96896a2f2..000000000 --- a/docs/framework/react/reference/interfaces/reactformapi.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: ReactFormApi -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) - -Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm` - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -## Properties - -### Field - -```ts -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) - -A React component to render form fields. With this, you can render and manage individual form fields. - -*** - -### Subscribe() - -```ts -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) - -A `Subscribe` function that allows you to listen and react to changes in the form's state. It's especially useful when you need to execute side effects or render specific components in response to state updates. - -#### Type Parameters - -• **TSelected** = `FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -#### Parameters - -##### props - -###### children - -`ReactNode` \| (`state`) => `ReactNode` - -###### selector? - -(`state`) => `TSelected` - -#### Returns - -`ReactNode` diff --git a/docs/framework/react/reference/interfaces/withformprops.md b/docs/framework/react/reference/interfaces/withformprops.md deleted file mode 100644 index fc40a17dc..000000000 --- a/docs/framework/react/reference/interfaces/withformprops.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: WithFormProps -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) - -## Extends - -- `FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** - -• **TFieldComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\> - -• **TFormComponents** *extends* `Record`\<`string`, `ComponentType`\<`any`\>\> - -• **TRenderProps** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `never`\> - -## Properties - -### props? - -```ts -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) - -*** - -### render() - -```ts -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) - -#### Parameters - -##### props - -`PropsWithChildren`\<`NoInfer`\<`TRenderProps`\> & `object`\> - -#### Returns - -`Element` diff --git a/docs/framework/react/reference/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md deleted file mode 100644 index 940f32542..000000000 --- a/docs/framework/react/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - - - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => ReactNode; -``` - -Defined in: [packages/react-form/src/useField.tsx:307](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L307) - -A type alias representing a field component for a specific form data type. - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TPatentSubmitMeta** - -• **ExtendedApi** = \{\} - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Parameters - -### \{ - children, - ...fieldOptions -\} - -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`, `ExtendedApi`\>, `"form"`\> - -## Returns - -`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/reactformextendedapi.md b/docs/framework/react/reference/type-aliases/reactformextendedapi.md deleted file mode 100644 index 64961b7c8..000000000 --- a/docs/framework/react/reference/type-aliases/reactformextendedapi.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: ReactFormExtendedApi -title: ReactFormExtendedApi ---- - - - -# Type Alias: ReactFormExtendedApi\ - -```ts -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) - -An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi` - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md deleted file mode 100644 index 3d3226bab..000000000 --- a/docs/framework/react/reference/type-aliases/usefield.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: UseField -title: UseField ---- - - - -# Type Alias: UseField()\ - -```ts -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) - -A type representing a hook for using a field in a form with the given form data type. - -A function that takes an optional object with a `name` property and field options, and returns a `FieldApi` instance for the specified field. - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TPatentSubmitMeta** - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Parameters - -### opts - -`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\>, `"form"`\> - -## Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TPatentSubmitMeta`\> diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md deleted file mode 100644 index 6b6769ef5..000000000 --- a/docs/framework/solid/reference/functions/createfield.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: createField -title: createField ---- - - - -# Function: createField() - -```ts -function createField(opts): () => FieldApi & SolidFieldApi -``` - -Defined in: [packages/solid-form/src/createField.tsx:236](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L236) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Parameters - -### opts - -() => `CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> - -## Returns - -`Function` - -### Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md deleted file mode 100644 index 0be913e98..000000000 --- a/docs/framework/solid/reference/functions/createform.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: createForm -title: createForm ---- - - - -# Function: createForm() - -```ts -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Parameters - -### opts? - -() => `FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -## Returns - -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md deleted file mode 100644 index 5c2a3f014..000000000 --- a/docs/framework/solid/reference/functions/field.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: Field -title: Field ---- - - - -# Function: Field() - -```ts -function Field(props): Element -``` - -Defined in: [packages/solid-form/src/createField.tsx:480](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L480) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Parameters - -### props - -`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> & `object` - -## Returns - -`Element` diff --git a/docs/framework/solid/reference/functions/usestore.md b/docs/framework/solid/reference/functions/usestore.md deleted file mode 100644 index a2456113e..000000000 --- a/docs/framework/solid/reference/functions/usestore.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: useStore -title: useStore ---- - - - -# Function: useStore() - -## Call Signature - -```ts -function useStore(store, selector?): Accessor -``` - -Defined in: node\_modules/.pnpm/@tanstack+solid-store@0.7.0\_solid-js@1.9.4/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:8 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Store`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`Accessor`\<`TSelected`\> - -## Call Signature - -```ts -function useStore(store, selector?): Accessor -``` - -Defined in: node\_modules/.pnpm/@tanstack+solid-store@0.7.0\_solid-js@1.9.4/node\_modules/@tanstack/solid-store/dist/esm/index.d.ts:9 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Derived`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`Accessor`\<`TSelected`\> diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md deleted file mode 100644 index 29000ff25..000000000 --- a/docs/framework/solid/reference/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: "@tanstack/solid-form" -title: "@tanstack/solid-form" ---- - - - -# @tanstack/solid-form - -## Interfaces - -- [SolidFormApi](interfaces/solidformapi.md) - -## Type Aliases - -- [CreateField](type-aliases/createfield.md) -- [FieldComponent](type-aliases/fieldcomponent.md) - -## Functions - -- [createField](functions/createfield.md) -- [createForm](functions/createform.md) -- [Field](functions/field.md) -- [useStore](functions/usestore.md) diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md deleted file mode 100644 index f8a9c5951..000000000 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -id: SolidFormApi -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Properties - -### createField - -```ts -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) - -*** - -### Field - -```ts -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) - -*** - -### Subscribe() - -```ts -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) - -#### Type Parameters - -• **TSelected** = `NoInfer`\<`FormState`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>\> - -#### Parameters - -##### props - -###### children - -`Element` \| (`state`) => `Element` - -###### selector? - -(`state`) => `TSelected` - -#### Returns - -`Element` - -*** - -### useStore() - -```ts -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) - -#### Type Parameters - -• **TSelected** = `NoInfer`\<`FormState`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>\> - -#### Parameters - -##### selector? - -(`state`) => `TSelected` - -#### Returns - -`Function` - -##### Returns - -`TSelected` diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md deleted file mode 100644 index bacbe6a84..000000000 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: CreateField -title: CreateField ---- - - - -# Type Alias: CreateField()\ - -```ts -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TSubmitMeta** - -## Parameters - -### opts - -() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\>, `"form"`\> - -## Returns - -`Function` - -### Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md deleted file mode 100644 index 84aefbf0a..000000000 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - - - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => JSXElement; -``` - -Defined in: [packages/solid-form/src/createField.tsx:425](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L425) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Parameters - -### \{ - children, - ...fieldOptions -\} - -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>, `"form"`\> - -## Returns - -`JSXElement` diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md deleted file mode 100644 index 7ac8f59fc..000000000 --- a/docs/framework/vue/reference/functions/usefield.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: useField -title: useField ---- - - - -# Function: useField() - -```ts -function useField(opts): object -``` - -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 - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TData** - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> - -## Returns - -`object` - -### api - -```ts -readonly api: FieldApi & VueFieldApi = fieldApi; -``` - -### state - -```ts -readonly state: Readonly, FieldState>> = fieldState; -``` diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md deleted file mode 100644 index 3feb93bbf..000000000 --- a/docs/framework/vue/reference/functions/useform.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: useForm -title: useForm ---- - - - -# Function: useForm() - -```ts -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Parameters - -### opts? - -`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> - -## Returns - -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TSubmitMeta`\> diff --git a/docs/framework/vue/reference/functions/usestore.md b/docs/framework/vue/reference/functions/usestore.md deleted file mode 100644 index ff39b8e48..000000000 --- a/docs/framework/vue/reference/functions/usestore.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: useStore -title: useStore ---- - - - -# Function: useStore() - -## Call Signature - -```ts -function useStore(store, selector?): Readonly> -``` - -Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.7.0\_vue@3.5.13\_typescript@5.8.2\_/node\_modules/@tanstack/vue-store/dist/esm/index.d.ts:8 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Store`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`Readonly`\<`Ref`\<`TSelected`, `TSelected`\>\> - -## Call Signature - -```ts -function useStore(store, selector?): Readonly> -``` - -Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.7.0\_vue@3.5.13\_typescript@5.8.2\_/node\_modules/@tanstack/vue-store/dist/esm/index.d.ts:9 - -### Type Parameters - -• **TState** - -• **TSelected** = `NoInfer`\<`TState`\> - -### Parameters - -#### store - -`Derived`\<`TState`, `any`\> - -#### selector? - -(`state`) => `TSelected` - -### Returns - -`Readonly`\<`Ref`\<`TSelected`, `TSelected`\>\> diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md deleted file mode 100644 index 0ff69a5aa..000000000 --- a/docs/framework/vue/reference/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: "@tanstack/vue-form" -title: "@tanstack/vue-form" ---- - - - -# @tanstack/vue-form - -## Interfaces - -- [VueFieldApi](interfaces/vuefieldapi.md) -- [VueFormApi](interfaces/vueformapi.md) - -## Type Aliases - -- [FieldComponent](type-aliases/fieldcomponent.md) -- [FieldComponentProps](type-aliases/fieldcomponentprops.md) -- [UseField](type-aliases/usefield.md) - -## Variables - -- [Field](variables/field.md) - -## Functions - -- [useField](functions/usefield.md) -- [useForm](functions/useform.md) -- [useStore](functions/usestore.md) diff --git a/docs/framework/vue/reference/interfaces/vuefieldapi.md b/docs/framework/vue/reference/interfaces/vuefieldapi.md deleted file mode 100644 index 7ac8a49fd..000000000 --- a/docs/framework/vue/reference/interfaces/vuefieldapi.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: VueFieldApi -title: VueFieldApi ---- - - - -# Interface: VueFieldApi\ - -Defined in: [packages/vue-form/src/useField.tsx:164](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L164) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/vue-form/src/useField.tsx:176](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L176) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md deleted file mode 100644 index 7055de265..000000000 --- a/docs/framework/vue/reference/interfaces/vueformapi.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: VueFormApi -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) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TSubmitMeta** - -## Properties - -### Field - -```ts -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) - -*** - -### Subscribe - -```ts -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) - -*** - -### useField - -```ts -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) - -*** - -### useStore() - -```ts -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) - -#### Type Parameters - -• **TSelected** = `FormState`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -#### Parameters - -##### selector? - -(`state`) => `TSelected` - -#### Returns - -`Readonly`\<`Ref`\<`TSelected`, `TSelected`\>\> diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponent.md b/docs/framework/vue/reference/type-aliases/fieldcomponent.md deleted file mode 100644 index 9ec7ede80..000000000 --- a/docs/framework/vue/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - - - -# Type Alias: FieldComponent()\ - -```ts -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:24](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L24) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Parameters - -### props - -`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>, `"form"`\> & `EmitsToProps`\<`EmitsOptions`\> & `PublicProps` - -## Returns - -`CreateComponentPublicInstanceWithMixins`\<`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>, `"form"`\>, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, `SlotsType`\<\{ - `default`: \{ - `field`: `FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>; - `state`: `FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>\[`"state"`\]; - \}; - \}\>\> diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md deleted file mode 100644 index 60eac66d1..000000000 --- a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -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`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md deleted file mode 100644 index 980cd7b48..000000000 --- a/docs/framework/vue/reference/type-aliases/usefield.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: UseField -title: UseField ---- - - - -# Type Alias: UseField()\ - -```ts -type UseField = (opts) => object; -``` - -Defined in: [packages/vue-form/src/useField.tsx:190](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L190) - -## Type Parameters - -• **TParentData** - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Parameters - -### opts - -`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\>, `"form"`\> - -## Returns - -`object` - -### api - -```ts -api: FieldApi & VueFieldApi; -``` - -### state - -```ts -state: Readonly["state"]>>; -``` diff --git a/docs/framework/vue/reference/variables/field.md b/docs/framework/vue/reference/variables/field.md deleted file mode 100644 index f2fca429d..000000000 --- a/docs/framework/vue/reference/variables/field.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: Field -title: Field ---- - - - -# Variable: Field() - -```ts -const Field: (props) => CreateComponentPublicInstanceWithMixins & object & {} | {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {}, false, {}, {}>; -``` - -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` - -## Returns - -`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> & `object` & \{\} \| \{\}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, \{\}\> diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md deleted file mode 100644 index a51c0068a..000000000 --- a/docs/reference/classes/fieldapi.md +++ /dev/null @@ -1,568 +0,0 @@ ---- -id: FieldApi -title: FieldApi ---- - - - -# Class: FieldApi\ - -Defined in: [packages/form-core/src/FieldApi.ts:859](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L859) - -A class representing the API for managing a form field. - -Normally, you will not need to create a new `FieldApi` instance directly. -Instead, you will use a framework hook/function like `useField` or `createField` -to create a new instance for you that uses your framework's reactivity model. -However, if you need to create a new instance manually, you can do so by calling -the `new FieldApi` constructor. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Constructors - -### new FieldApi() - -```ts -new FieldApi(opts): FieldApi -``` - -Defined in: [packages/form-core/src/FieldApi.ts:973](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L973) - -Initializes a new `FieldApi` instance. - -#### Parameters - -##### opts - -[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> - -#### Returns - -[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> - -## Properties - -### form - -```ts -form: FormApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:889](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L889) - -A reference to the form API instance. - -*** - -### name - -```ts -name: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TParentData extends any[] ? PrefixArrayAccessor, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor, []> : TParentData extends string | number | bigint | boolean ? "" : never; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:913](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L913) - -The field name. - -*** - -### options - -```ts -options: FieldApiOptions; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:917](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L917) - -The field options. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:941](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L941) - -The field state store. - -*** - -### timeoutIds - -```ts -timeoutIds: Record; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:968](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L968) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FieldState -``` - -Defined in: [packages/form-core/src/FieldApi.ts:965](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L965) - -The current field state. - -##### Returns - -[`FieldState`](../type-aliases/fieldstate.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`\> - -## Methods - -### getInfo() - -```ts -getInfo(): FieldInfo -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1227](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1227) - -Gets the field information object. - -#### Returns - -[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`\> - -*** - -### getMeta() - -```ts -getMeta(): FieldMeta -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1195) - -#### Returns - -[`FieldMeta`](../type-aliases/fieldmeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`\> - -*** - -### ~~getValue()~~ - -```ts -getValue(): TData -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1171](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1171) - -Gets the current field value. - -#### Returns - -`TData` - -#### Deprecated - -Use `field.state.value` instead. - -*** - -### handleBlur() - -```ts -handleBlur(): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1674](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1674) - -Handles the blur event. - -#### Returns - -`void` - -*** - -### handleChange() - -```ts -handleChange(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1667](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1667) - -Handles the change event. - -#### Parameters - -##### updater - -[`Updater`](../type-aliases/updater.md)\<`TData`\> - -#### Returns - -`void` - -*** - -### insertValue() - -```ts -insertValue( - index, - value, - opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1253](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1253) - -Inserts a value at the specified index, shifting the subsequent values to the right. - -#### Parameters - -##### index - -`number` - -##### value - -`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### mount() - -```ts -mount(): () => void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1077](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1077) - -Mounts the field instance to the form. - -#### Returns - -`Function` - -##### Returns - -`void` - -*** - -### moveValue() - -```ts -moveValue( - aIndex, - bIndex, - opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1333) - -Moves the value at the first specified index to the second specified index. - -#### Parameters - -##### aIndex - -`number` - -##### bIndex - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### pushValue() - -```ts -pushValue(value, opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1232) - -Pushes a new value to the field. - -#### Parameters - -##### value - -`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### removeValue() - -```ts -removeValue(index, opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1297) - -Removes a value at the specified index. - -#### Parameters - -##### index - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### replaceValue() - -```ts -replaceValue( - index, - value, - opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1275) - -Replaces a value at the specified index. - -#### Parameters - -##### index - -`number` - -##### value - -`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### setErrorMap() - -```ts -setErrorMap(errorMap): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1700](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1700) - -Updates the field's errorMap - -#### Parameters - -##### errorMap - -`ValidationErrorMap` - -#### Returns - -`void` - -*** - -### setMeta() - -```ts -setMeta(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1200](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1200) - -Sets the field metadata. - -#### Parameters - -##### updater - -[`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`\>\> - -#### Returns - -`void` - -*** - -### setValue() - -```ts -setValue(updater, options?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1178](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1178) - -Sets the field value and run the `change` validator. - -#### Parameters - -##### updater - -[`Updater`](../type-aliases/updater.md)\<`TData`\> - -##### options? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### swapValues() - -```ts -swapValues( - aIndex, - bIndex, - opts?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1315) - -Swaps the values at the specified indices. - -#### Parameters - -##### aIndex - -`number` - -##### bIndex - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### update() - -```ts -update(opts): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1119](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1119) - -Updates the field instance with new options. - -#### Parameters - -##### opts - -[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`, `TParentSubmitMeta`\> - -#### Returns - -`void` - -*** - -### validate() - -```ts -validate(cause, opts?): unknown[] | Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1634](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1634) - -Validates the field value. - -#### Parameters - -##### cause - -`ValidationCause` - -##### opts? - -###### skipFormValidation? - -`boolean` - -#### Returns - -`unknown`[] \| `Promise`\<`unknown`[]\> diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md deleted file mode 100644 index 117c295cf..000000000 --- a/docs/reference/classes/formapi.md +++ /dev/null @@ -1,836 +0,0 @@ ---- -id: FormApi -title: FormApi ---- - - - -# Class: FormApi\ - -Defined in: [packages/form-core/src/FormApi.ts:751](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L751) - -A class representing the Form API. It handles the logic and interactions with the form state. - -Normally, you will not need to create a new `FormApi` instance directly. Instead, you will use a framework -hook/function like `useForm` or `createForm` to create a new instance for you that uses your framework's reactivity model. -However, if you need to create a new instance manually, you can do so by calling the `new FormApi` constructor. - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** = `never` - -## Constructors - -### new FormApi() - -```ts -new FormApi(opts?): FormApi -``` - -Defined in: [packages/form-core/src/FormApi.ts:838](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L838) - -Constructs a new `FormApi` instance with the given form options. - -#### Parameters - -##### opts? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -[`FormApi`](formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -## Properties - -### baseStore - -```ts -baseStore: Store>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:778](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L778) - -*** - -### fieldInfo - -```ts -fieldInfo: Record ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, FieldInfo>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:808](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L808) - -A record of field information for each field in the form. - -*** - -### fieldMetaDerived - -```ts -fieldMetaDerived: Derived ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, AnyFieldMeta>>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:791](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L791) - -*** - -### options - -```ts -options: FormOptions = {}; -``` - -Defined in: [packages/form-core/src/FormApi.ts:766](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L766) - -The options for the form. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:792](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L792) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FormState -``` - -Defined in: [packages/form-core/src/FormApi.ts:810](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L810) - -##### Returns - -[`FormState`](../type-aliases/formstate.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -## Methods - -### deleteField() - -```ts -deleteField(field): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1869](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1869) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -`void` - -*** - -### getAllErrors() - -```ts -getAllErrors(): object -``` - -Defined in: [packages/form-core/src/FormApi.ts:2085](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2085) - -Returns form and field level errors - -#### Returns - -`object` - -##### fields - -```ts -fields: Record, { - errorMap: ValidationErrorMap; - errors: unknown[]; -}>; -``` - -##### form - -```ts -form: object; -``` - -###### form.errorMap - -```ts -errorMap: FormValidationErrorMap, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormAsyncValidateOrFn>; -``` - -###### form.errors - -```ts -errors: ( - | UnwrapFormValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormAsyncValidateOrFn)[]; -``` - -*** - -### getFieldInfo() - -```ts -getFieldInfo(field): FieldInfo -``` - -Defined in: [packages/form-core/src/FormApi.ts:1778](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1778) - -Gets the field info of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TFormData`\> - -*** - -### getFieldMeta() - -```ts -getFieldMeta(field): undefined | AnyFieldMeta -``` - -Defined in: [packages/form-core/src/FormApi.ts:1769](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1769) - -Gets the metadata of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -`undefined` \| [`AnyFieldMeta`](../type-aliases/anyfieldmeta.md) - -*** - -### getFieldValue() - -```ts -getFieldValue(field): DeepValue -``` - -Defined in: [packages/form-core/src/FormApi.ts:1762](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1762) - -Gets the value of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> - -*** - -### handleSubmit() - -#### Call Signature - -```ts -handleSubmit(): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1676](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1676) - -Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks. - -##### Returns - -`Promise`\<`void`\> - -#### Call Signature - -```ts -handleSubmit(submitMeta): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1677](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1677) - -Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks. - -##### Parameters - -###### submitMeta - -`TSubmitMeta` - -##### Returns - -`Promise`\<`void`\> - -*** - -### insertFieldValue() - -```ts -insertFieldValue( - field, - index, - value, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1908](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1908) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index - -`number` - -##### value - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### mount() - -```ts -mount(): () => void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1141) - -#### Returns - -`Function` - -##### Returns - -`void` - -*** - -### moveFieldValues() - -```ts -moveFieldValues( - field, - index1, - index2, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:2032](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2032) - -Moves the value at the first specified index to the second specified index within an array field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index1 - -`number` - -##### index2 - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### pushFieldValue() - -```ts -pushFieldValue( - field, - value, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1893](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1893) - -Pushes a value into an array field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### value - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### removeFieldValue() - -```ts -removeFieldValue( - field, - index, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1966](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1966) - -Removes a value from an array field at the specified index. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### replaceFieldValue() - -```ts -replaceFieldValue( - field, - index, - value, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1940](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1940) - -Replaces a value into an array field at the specified index. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index - -`number` - -##### value - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### reset() - -```ts -reset(values?, opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1229](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1229) - -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. - -#### Parameters - -##### values? - -`TFormData` - -Optional values to reset the form to. - -##### opts? - -Optional options to control the reset behavior. - -###### keepDefaultValues? - -`boolean` - -#### Returns - -`void` - -*** - -### resetFieldMeta() - -```ts -resetFieldMeta(fieldMeta): Record -``` - -Defined in: [packages/form-core/src/FormApi.ts:1815](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1815) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### fieldMeta - -`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/anyfieldmeta.md)\> - -#### Returns - -`Record`\<`TField`, [`AnyFieldMeta`](../type-aliases/anyfieldmeta.md)\> - -*** - -### setErrorMap() - -```ts -setErrorMap(errorMap): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:2059](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2059) - -Updates the form's errorMap - -#### Parameters - -##### errorMap - -`ValidationErrorMap`\<`TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\> - -#### Returns - -`void` - -*** - -### setFieldMeta() - -```ts -setFieldMeta(field, updater): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1797](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1797) - -Updates the metadata of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### updater - -[`Updater`](../type-aliases/updater.md)\<[`AnyFieldMeta`](../type-aliases/anyfieldmeta.md)\> - -#### Returns - -`void` - -*** - -### setFieldValue() - -```ts -setFieldValue( - field, - updater, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1839](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1839) - -Sets the value of the specified field and optionally updates the touched state. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### updater - -[`Updater`](../type-aliases/updater.md)\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, \[\]\>\> - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### swapFieldValues() - -```ts -swapFieldValues( - field, - index1, - index2, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:2003](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L2003) - -Swaps the values at the specified indices within an array field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index1 - -`number` - -##### index2 - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### update() - -```ts -update(options?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1161) - -Updates the form options and form state. - -#### Parameters - -##### options? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`void` - -*** - -### validateAllFields() - -```ts -validateAllFields(cause): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1255](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1255) - -Validates all fields using the correct handlers for a given validation cause. - -#### Parameters - -##### cause - -`ValidationCause` - -#### Returns - -`Promise`\<`unknown`[]\> - -*** - -### validateArrayFieldsStartingFrom() - -```ts -validateArrayFieldsStartingFrom( - field, - index, -cause): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1285) - -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. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index - -`number` - -##### cause - -`ValidationCause` - -#### Returns - -`Promise`\<`unknown`[]\> - -*** - -### validateField() - -```ts -validateField(field, cause): unknown[] | Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1324](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1324) - -Validates a specified field in the form using the correct handlers for a given validation type. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### cause - -`ValidationCause` - -#### Returns - -`unknown`[] \| `Promise`\<`unknown`[]\> diff --git a/docs/reference/functions/formoptions.md b/docs/reference/functions/formoptions.md deleted file mode 100644 index 7fa483b5b..000000000 --- a/docs/reference/functions/formoptions.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: formOptions -title: formOptions ---- - - - -# Function: formOptions() - -```ts -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) - -## Type Parameters - -• **T** *extends* `Partial`\<[`FormOptions`](../interfaces/formoptions.md)\<`any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\> - -## Parameters - -### defaultOpts - -`T` - -## Returns - -`T` diff --git a/docs/reference/functions/isglobalformvalidationerror.md b/docs/reference/functions/isglobalformvalidationerror.md deleted file mode 100644 index d60ec331d..000000000 --- a/docs/reference/functions/isglobalformvalidationerror.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: isGlobalFormValidationError -title: isGlobalFormValidationError ---- - - - -# Function: isGlobalFormValidationError() - -```ts -function isGlobalFormValidationError(error): error is GlobalFormValidationError -``` - -Defined in: [packages/form-core/src/utils.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L328) - -## Parameters - -### error - -`unknown` - -## Returns - -`error is GlobalFormValidationError` diff --git a/docs/reference/functions/isstandardschemavalidator.md b/docs/reference/functions/isstandardschemavalidator.md deleted file mode 100644 index 6f3b6552c..000000000 --- a/docs/reference/functions/isstandardschemavalidator.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: isStandardSchemaValidator -title: isStandardSchemaValidator ---- - - - -# Function: isStandardSchemaValidator() - -```ts -function isStandardSchemaValidator(validator): validator is StandardSchemaV1 -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:75](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L75) - -## Parameters - -### validator - -`unknown` - -## Returns - -`validator is StandardSchemaV1` diff --git a/docs/reference/functions/mergeform.md b/docs/reference/functions/mergeform.md deleted file mode 100644 index 24238089b..000000000 --- a/docs/reference/functions/mergeform.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: mergeForm -title: mergeForm ---- - - - -# Function: mergeForm() - -```ts -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) - -## Type Parameters - -• **TFormData** - -## Parameters - -### baseForm - -[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> - -### state - -`Partial`\<[`FormState`](../type-aliases/formstate.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\>\> - -## Returns - -[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md deleted file mode 100644 index 04634ad73..000000000 --- a/docs/reference/functions/shallow.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: shallow -title: shallow ---- - - - -# Function: shallow() - -```ts -function shallow(objA, objB): boolean -``` - -Defined in: [packages/form-core/src/utils.ts:334](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L334) - -## Type Parameters - -• **T** - -## Parameters - -### objA - -`T` - -### objB - -`T` - -## Returns - -`boolean` diff --git a/docs/reference/index.md b/docs/reference/index.md deleted file mode 100644 index 77d1cc30a..000000000 --- a/docs/reference/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: "@tanstack/form-core" -title: "@tanstack/form-core" ---- - - - -# @tanstack/form-core - -## Classes - -- [FieldApi](classes/fieldapi.md) -- [FormApi](classes/formapi.md) - -## Interfaces - -- [FieldApiOptions](interfaces/fieldapioptions.md) -- [FieldListeners](interfaces/fieldlisteners.md) -- [FieldOptions](interfaces/fieldoptions.md) -- [FieldValidators](interfaces/fieldvalidators.md) -- [FormListeners](interfaces/formlisteners.md) -- [FormOptions](interfaces/formoptions.md) -- [FormValidators](interfaces/formvalidators.md) -- [StandardSchemaV1Issue](interfaces/standardschemav1issue.md) - -## Type Aliases - -- [AnyFieldApi](type-aliases/anyfieldapi.md) -- [AnyFieldMeta](type-aliases/anyfieldmeta.md) -- [AnyFieldMetaBase](type-aliases/anyfieldmetabase.md) -- [AnyFieldMetaDerived](type-aliases/anyfieldmetaderived.md) -- [AnyFormApi](type-aliases/anyformapi.md) -- [AnyFormState](type-aliases/anyformstate.md) -- [BaseFormState](type-aliases/baseformstate.md) -- [DeepKeys](type-aliases/deepkeys.md) -- [DeepValue](type-aliases/deepvalue.md) -- [DerivedFormState](type-aliases/derivedformstate.md) -- [FieldInfo](type-aliases/fieldinfo.md) -- [FieldMeta](type-aliases/fieldmeta.md) -- [FieldMetaBase](type-aliases/fieldmetabase.md) -- [FieldMetaDerived](type-aliases/fieldmetaderived.md) -- [FieldState](type-aliases/fieldstate.md) -- [FormState](type-aliases/formstate.md) -- [FormValidateFn](type-aliases/formvalidatefn.md) -- [FormValidationError](type-aliases/formvalidationerror.md) -- [FormValidator](type-aliases/formvalidator.md) -- [StandardSchemaV1](type-aliases/standardschemav1.md) -- [TStandardSchemaValidatorValue](type-aliases/tstandardschemavalidatorvalue.md) -- [UnwrapFieldAsyncValidateOrFn](type-aliases/unwrapfieldasyncvalidateorfn.md) -- [UnwrapFieldValidateOrFn](type-aliases/unwrapfieldvalidateorfn.md) -- [UnwrapFormAsyncValidateOrFn](type-aliases/unwrapformasyncvalidateorfn.md) -- [UnwrapFormValidateOrFn](type-aliases/unwrapformvalidateorfn.md) -- [Updater](type-aliases/updater.md) -- [UpdaterFn](type-aliases/updaterfn.md) -- [ValidationError](type-aliases/validationerror.md) -- [ValidationMeta](type-aliases/validationmeta.md) -- [ValidationSource](type-aliases/validationsource.md) - -## Variables - -- [standardSchemaValidators](variables/standardschemavalidators.md) - -## Functions - -- [formOptions](functions/formoptions.md) -- [isGlobalFormValidationError](functions/isglobalformvalidationerror.md) -- [isStandardSchemaValidator](functions/isstandardschemavalidator.md) -- [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) diff --git a/docs/reference/interfaces/fieldapioptions.md b/docs/reference/interfaces/fieldapioptions.md deleted file mode 100644 index 16109d166..000000000 --- a/docs/reference/interfaces/fieldapioptions.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -id: FieldApiOptions -title: FieldApiOptions ---- - - - -# Interface: FieldApiOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:447](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L447) - -An object type representing the required options for the FieldApi class. - -## Extends - -- [`FieldOptions`](fieldoptions.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`\> - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TParentSubmitMeta** - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L394) - -If `true`, always run async validation, even if there are errors emitted during synchronous validation. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`asyncAlways`](FieldOptions.md#asyncalways) - -*** - -### asyncDebounceMs? - -```ts -optional asyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L390) - -The default time to debounce async validation if there is not a more specific debounce time passed. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`asyncDebounceMs`](FieldOptions.md#asyncdebouncems) - -*** - -### defaultMeta? - -```ts -optional defaultMeta: Partial>; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) - -An optional object with default metadata for the field. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`defaultMeta`](FieldOptions.md#defaultmeta) - -*** - -### defaultValue? - -```ts -optional defaultValue: NoInfer; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L386) - -An optional default value for the field. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`defaultValue`](FieldOptions.md#defaultvalue) - -*** - -### disableErrorFlat? - -```ts -optional disableErrorFlat: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L441) - -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. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`disableErrorFlat`](FieldOptions.md#disableerrorflat) - -*** - -### form - -```ts -form: FormApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L485) - -*** - -### listeners? - -```ts -optional listeners: FieldListeners; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:437](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L437) - -A list of listeners which attach to the corresponding events - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`listeners`](FieldOptions.md#listeners) - -*** - -### name - -```ts -name: TName; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L382) - -The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`name`](FieldOptions.md#name) - -*** - -### validators? - -```ts -optional validators: FieldValidators; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L398) - -A list of validators to pass to the field - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`validators`](FieldOptions.md#validators) diff --git a/docs/reference/interfaces/fieldlisteners.md b/docs/reference/interfaces/fieldlisteners.md deleted file mode 100644 index e0cfca1e0..000000000 --- a/docs/reference/interfaces/fieldlisteners.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: FieldListeners -title: FieldListeners ---- - - - -# Interface: FieldListeners\ - -Defined in: [packages/form-core/src/FieldApi.ts:347](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L347) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -## Properties - -### onBlur? - -```ts -optional onBlur: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:353](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L353) - -*** - -### onChange? - -```ts -optional onChange: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:352](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L352) - -*** - -### onMount? - -```ts -optional onMount: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:354](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L354) - -*** - -### onSubmit? - -```ts -optional onSubmit: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L355) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md deleted file mode 100644 index 8f3dee93a..000000000 --- a/docs/reference/interfaces/fieldoptions.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -id: FieldOptions -title: FieldOptions ---- - - - -# Interface: FieldOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:361](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L361) - -An object type representing the options for a field in a form. - -## Extended by - -- [`FieldApiOptions`](fieldapioptions.md) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:394](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L394) - -If `true`, always run async validation, even if there are errors emitted during synchronous validation. - -*** - -### asyncDebounceMs? - -```ts -optional asyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:390](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L390) - -The default time to debounce async validation if there is not a more specific debounce time passed. - -*** - -### defaultMeta? - -```ts -optional defaultMeta: Partial>; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) - -An optional object with default metadata for the field. - -*** - -### defaultValue? - -```ts -optional defaultValue: NoInfer; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L386) - -An optional default value for the field. - -*** - -### disableErrorFlat? - -```ts -optional disableErrorFlat: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L441) - -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. - -*** - -### listeners? - -```ts -optional listeners: FieldListeners; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:437](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L437) - -A list of listeners which attach to the corresponding events - -*** - -### name - -```ts -name: TName; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:382](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L382) - -The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. - -*** - -### validators? - -```ts -optional validators: FieldValidators; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:398](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L398) - -A list of validators to pass to the field diff --git a/docs/reference/interfaces/fieldvalidators.md b/docs/reference/interfaces/fieldvalidators.md deleted file mode 100644 index 8d5f44c66..000000000 --- a/docs/reference/interfaces/fieldvalidators.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -id: FieldValidators -title: FieldValidators ---- - - - -# Interface: FieldValidators\ - -Defined in: [packages/form-core/src/FieldApi.ts:266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L266) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -## Properties - -### onBlur? - -```ts -optional onBlur: TOnBlur; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L315) - -An optional function, that runs on the blur event of input. - -#### Example - -```ts -z.string().min(1) -``` - -*** - -### onBlurAsync? - -```ts -optional onBlurAsync: TOnBlurAsync; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:321](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L321) - -An optional property similar to `onBlur` but async validation. - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) -``` - -*** - -### onBlurAsyncDebounceMs? - -```ts -optional onBlurAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L328) - -An optional number to represent how long the `onBlurAsync` should wait before running - -If set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds - -*** - -### onBlurListenTo? - -```ts -optional onBlurListenTo: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TParentData extends any[] ? PrefixArrayAccessor, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor, []> : TParentData extends string | number | bigint | boolean ? "" : never[]; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L332) - -An optional list of field names that should trigger this field's `onBlur` and `onBlurAsync` events when its value changes - -*** - -### onChange? - -```ts -optional onChange: TOnChange; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L293) - -An optional function, that runs on the change event of input. - -#### Example - -```ts -z.string().min(1) -``` - -*** - -### onChangeAsync? - -```ts -optional onChangeAsync: TOnChangeAsync; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L299) - -An optional property similar to `onChange` but async validation - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) -``` - -*** - -### onChangeAsyncDebounceMs? - -```ts -optional onChangeAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:305](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L305) - -An optional number to represent how long the `onChangeAsync` should wait before running - -If set to a number larger than 0, will debounce the async validation event by this length of time in milliseconds - -*** - -### onChangeListenTo? - -```ts -optional onChangeListenTo: unknown extends TParentData ? string : TParentData extends readonly any[] & IsTuple ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TParentData extends any[] ? PrefixArrayAccessor, [any]> : TParentData extends Date ? never : TParentData extends object ? PrefixObjectAccessor, []> : TParentData extends string | number | bigint | boolean ? "" : never[]; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:309](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L309) - -An optional list of field names that should trigger this field's `onChange` and `onChangeAsync` events when its value changes - -*** - -### onMount? - -```ts -optional onMount: TOnMount; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L287) - -An optional function, that runs on the mount event of input. - -*** - -### onSubmit? - -```ts -optional onSubmit: TOnSubmit; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:338](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L338) - -An optional function, that runs on the submit event of form. - -#### Example - -```ts -z.string().min(1) -``` - -*** - -### onSubmitAsync? - -```ts -optional onSubmitAsync: TOnSubmitAsync; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:344](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L344) - -An optional property similar to `onSubmit` but async validation. - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) -``` diff --git a/docs/reference/interfaces/formlisteners.md b/docs/reference/interfaces/formlisteners.md deleted file mode 100644 index a36385650..000000000 --- a/docs/reference/interfaces/formlisteners.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: FormListeners -title: FormListeners ---- - - - -# Interface: FormListeners\ - -Defined in: [packages/form-core/src/FormApi.ts:234](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L234) - -## Type Parameters - -• **TField** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TFormData`\> - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** = `never` - -## Properties - -### onBlur()? - -```ts -optional onBlur: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L263) - -#### Parameters - -##### props - -###### fieldName - -`TField` - -###### fieldValue - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`void` - -*** - -### onChange()? - -```ts -optional onChange: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L247) - -#### Parameters - -##### props - -###### fieldName - -`TField` - -###### fieldValue - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`\> - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`void` - -*** - -### onMount()? - -```ts -optional onMount: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:279](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L279) - -#### Parameters - -##### props - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`void` - -*** - -### onSubmit()? - -```ts -optional onSubmit: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:293](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L293) - -#### Parameters - -##### props - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -#### Returns - -`void` diff --git a/docs/reference/interfaces/formoptions.md b/docs/reference/interfaces/formoptions.md deleted file mode 100644 index 82c203c6b..000000000 --- a/docs/reference/interfaces/formoptions.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -id: FormOptions -title: FormOptions ---- - - - -# Interface: FormOptions\ - -Defined in: [packages/form-core/src/FormApi.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L312) - -An object representing the options for a form. - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TSubmitMeta** = `never` - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FormApi.ts:347](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L347) - -If true, always run async validation, even when sync validation has produced an error. Defaults to undefined. - -*** - -### asyncDebounceMs? - -```ts -optional asyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FormApi.ts:351](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L351) - -Optional time in milliseconds if you want to introduce a delay before firing off an async action. - -*** - -### defaultState? - -```ts -optional defaultState: Partial>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L331) - -The default state for the form. - -*** - -### defaultValues? - -```ts -optional defaultValues: TFormData; -``` - -Defined in: [packages/form-core/src/FormApi.ts:327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L327) - -Set initial values for your form. - -*** - -### listeners? - -```ts -optional listeners: FormListeners ? PrefixTupleAccessor, AllowedIndexes, never>, []> : TFormData extends any[] ? PrefixArrayAccessor, [any]> : TFormData extends Date ? never : TFormData extends object ? PrefixObjectAccessor, []> : TFormData extends string | number | bigint | boolean ? "" : never, TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L374) - -form level listeners - -*** - -### onSubmit()? - -```ts -optional onSubmit: (props) => any; -``` - -Defined in: [packages/form-core/src/FormApi.ts:391](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L391) - -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` - -#### Parameters - -##### props - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -###### meta - -`TSubmitMeta` - -###### value - -`TFormData` - -#### Returns - -`any` - -*** - -### onSubmitInvalid()? - -```ts -optional onSubmitInvalid: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:410](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L410) - -Specify an action for scenarios where the user tries to submit an invalid form. - -#### Parameters - -##### props - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`, `TSubmitMeta`\> - -###### value - -`TFormData` - -#### Returns - -`void` - -*** - -### onSubmitMeta? - -```ts -optional onSubmitMeta: TSubmitMeta; -``` - -Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369) - -onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props - -*** - -### transform? - -```ts -optional transform: FormTransform, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L425) - -*** - -### validators? - -```ts -optional validators: FormValidators; -``` - -Defined in: [packages/form-core/src/FormApi.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L355) - -A list of validators to pass to the form diff --git a/docs/reference/interfaces/formvalidators.md b/docs/reference/interfaces/formvalidators.md deleted file mode 100644 index 8b128b41b..000000000 --- a/docs/reference/interfaces/formvalidators.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -id: FormValidators -title: FormValidators ---- - - - -# Interface: FormValidators\ - -Defined in: [packages/form-core/src/FormApi.ts:149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L149) - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -## Properties - -### onBlur? - -```ts -optional onBlur: TOnBlur; -``` - -Defined in: [packages/form-core/src/FormApi.ts:178](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L178) - -Optional function that validates the form data when a field loses focus, returns a `FormValidationError` - -*** - -### onBlurAsync? - -```ts -optional onBlurAsync: TOnBlurAsync; -``` - -Defined in: [packages/form-core/src/FormApi.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L182) - -Optional onBlur asynchronous validation method for when a field loses focus returns a ` FormValidationError` or a promise of `Promise` - -*** - -### onBlurAsyncDebounceMs? - -```ts -optional onBlurAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FormApi.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L186) - -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. - -*** - -### onChange? - -```ts -optional onChange: TOnChange; -``` - -Defined in: [packages/form-core/src/FormApi.ts:166](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L166) - -Optional function that checks the validity of your data whenever a value changes - -*** - -### onChangeAsync? - -```ts -optional onChangeAsync: TOnChangeAsync; -``` - -Defined in: [packages/form-core/src/FormApi.ts:170](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L170) - -Optional onChange asynchronous counterpart to onChange. Useful for more complex validation logic that might involve server requests. - -*** - -### onChangeAsyncDebounceMs? - -```ts -optional onChangeAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FormApi.ts:174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L174) - -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. - -*** - -### onMount? - -```ts -optional onMount: TOnMount; -``` - -Defined in: [packages/form-core/src/FormApi.ts:162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L162) - -Optional function that fires as soon as the component mounts. - -*** - -### onSubmit? - -```ts -optional onSubmit: TOnSubmit; -``` - -Defined in: [packages/form-core/src/FormApi.ts:187](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L187) - -*** - -### onSubmitAsync? - -```ts -optional onSubmitAsync: TOnSubmitAsync; -``` - -Defined in: [packages/form-core/src/FormApi.ts:188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L188) diff --git a/docs/reference/interfaces/standardschemav1issue.md b/docs/reference/interfaces/standardschemav1issue.md deleted file mode 100644 index 119ef8cb3..000000000 --- a/docs/reference/interfaces/standardschemav1issue.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: StandardSchemaV1Issue -title: StandardSchemaV1Issue ---- - - - -# Interface: StandardSchemaV1Issue - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:144](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L144) - -The issue interface of the failure output. - -## Properties - -### message - -```ts -readonly message: string; -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:148](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L148) - -The error message of the issue. - -*** - -### path? - -```ts -readonly optional path: readonly (PropertyKey | StandardSchemaV1PathSegment)[]; -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:152](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L152) - -The path of the issue, if any. diff --git a/docs/reference/type-aliases/anyfieldapi.md b/docs/reference/type-aliases/anyfieldapi.md deleted file mode 100644 index 9db1bfefa..000000000 --- a/docs/reference/type-aliases/anyfieldapi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: AnyFieldApi -title: AnyFieldApi ---- - - - -# Type Alias: AnyFieldApi - -```ts -type AnyFieldApi = FieldApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:828](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L828) - -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 deleted file mode 100644 index abbfd3049..000000000 --- a/docs/reference/type-aliases/anyfieldmeta.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFieldMeta -title: AnyFieldMeta ---- - - - -# Type Alias: AnyFieldMeta - -```ts -type AnyFieldMeta = FieldMeta; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:747](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L747) diff --git a/docs/reference/type-aliases/anyfieldmetabase.md b/docs/reference/type-aliases/anyfieldmetabase.md deleted file mode 100644 index 34a5f25ad..000000000 --- a/docs/reference/type-aliases/anyfieldmetabase.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFieldMetaBase -title: AnyFieldMetaBase ---- - - - -# Type Alias: AnyFieldMetaBase - -```ts -type AnyFieldMetaBase = FieldMetaBase; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:569](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L569) diff --git a/docs/reference/type-aliases/anyfieldmetaderived.md b/docs/reference/type-aliases/anyfieldmetaderived.md deleted file mode 100644 index 71df55bfb..000000000 --- a/docs/reference/type-aliases/anyfieldmetaderived.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFieldMetaDerived -title: AnyFieldMetaDerived ---- - - - -# Type Alias: AnyFieldMetaDerived - -```ts -type AnyFieldMetaDerived = FieldMetaDerived; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L661) diff --git a/docs/reference/type-aliases/anyformapi.md b/docs/reference/type-aliases/anyformapi.md deleted file mode 100644 index 9fb5c501e..000000000 --- a/docs/reference/type-aliases/anyformapi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: AnyFormApi -title: AnyFormApi ---- - - - -# Type Alias: AnyFormApi - -```ts -type AnyFormApi = FormApi; -``` - -Defined in: [packages/form-core/src/FormApi.ts:731](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L731) - -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 deleted file mode 100644 index 6a51910a8..000000000 --- a/docs/reference/type-aliases/anyformstate.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFormState -title: AnyFormState ---- - - - -# Type Alias: AnyFormState - -```ts -type AnyFormState = FormState; -``` - -Defined in: [packages/form-core/src/FormApi.ts:660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L660) diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md deleted file mode 100644 index cb5a62018..000000000 --- a/docs/reference/type-aliases/baseformstate.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: BaseFormState -title: BaseFormState ---- - - - -# Type Alias: BaseFormState\ - -```ts -type BaseFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:486](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L486) - -An object representing the current state of the form. - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -## Type declaration - -### \_force\_re\_eval? - -```ts -optional _force_re_eval: boolean; -``` - -@private, used to force a re-evaluation of the form state when options change - -### errorMap - -```ts -errorMap: FormValidationErrorMap, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormAsyncValidateOrFn>; -``` - -The error map for the form itself. - -### fieldMetaBase - -```ts -fieldMetaBase: Record, AnyFieldMetaBase>; -``` - -A record of field metadata for each field in the form, not including the derived properties, like `errors` and such - -### isSubmitSuccessful - -```ts -isSubmitSuccessful: boolean; -``` - -A boolean indicating if the last submission was successful. - -### isSubmitted - -```ts -isSubmitted: boolean; -``` - -A boolean indicating if the form has been submitted. - -### isSubmitting - -```ts -isSubmitting: boolean; -``` - -A boolean indicating if the form is currently in the process of being submitted after `handleSubmit` is called. - -Goes back to `false` when submission completes for one of the following reasons: -- the validation step returned errors. -- the `onSubmit` function has completed. - -Note: if you're running async operations in your `onSubmit` function make sure to await them to ensure `isSubmitting` is set to `false` only when the async operation completes. - -This is useful for displaying loading indicators or disabling form inputs during submission. - -### isValidating - -```ts -isValidating: boolean; -``` - -A boolean indicating if the form or any of its fields are currently validating. - -### submissionAttempts - -```ts -submissionAttempts: number; -``` - -A counter for tracking the number of submission attempts. - -### validationMetaMap - -```ts -validationMetaMap: Record; -``` - -An internal mechanism used for keeping track of validation logic in a form. - -### values - -```ts -values: TFormData; -``` - -The current values of the form fields. diff --git a/docs/reference/type-aliases/deepkeys.md b/docs/reference/type-aliases/deepkeys.md deleted file mode 100644 index 64559e493..000000000 --- a/docs/reference/type-aliases/deepkeys.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: DeepKeys -title: DeepKeys ---- - - - -# Type Alias: DeepKeys\ - -```ts -type DeepKeys = TDepth["length"] extends 5 ? never : unknown extends T ? PrefixFromDepth : T extends readonly any[] & IsTuple ? PrefixTupleAccessor, TDepth> : T extends any[] ? PrefixArrayAccessor : T extends Date ? never : T extends object ? PrefixObjectAccessor : T extends string | number | boolean | bigint ? "" : never; -``` - -Defined in: [packages/form-core/src/util-types.ts:70](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L70) - -The keys of an object or array, deeply nested. - -## Type Parameters - -• **T** - -• **TDepth** *extends* `any`[] = \[\] diff --git a/docs/reference/type-aliases/deepvalue.md b/docs/reference/type-aliases/deepvalue.md deleted file mode 100644 index 22f9dd033..000000000 --- a/docs/reference/type-aliases/deepvalue.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: DeepValue -title: DeepValue ---- - - - -# Type Alias: DeepValue\ - -```ts -type DeepValue = unknown extends TValue ? TValue : TDepth["length"] extends 10 ? unknown : TValue extends ReadonlyArray ? TAccessor extends `[${infer TBrackets}].${infer TAfter}` ? DeepValue, TAfter, [...TDepth, any]> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends keyof TValue ? TValue[TAccessor] : TValue[TAccessor & number] : TAccessor extends `${infer TBefore}[${infer TEverythingElse}` ? DeepValue, `[${TEverythingElse}`, [...TDepth, any]> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends `${infer TBefore}.${infer TAfter}` ? DeepValue, TAfter, [...TDepth, any]> : TAccessor extends string ? - | Get - | ApplyNull<...> | ApplyUndefined<...> : never; -``` - -Defined in: [packages/form-core/src/util-types.ts:104](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L104) - -Infer the type of a deeply nested property within an object or an array. - -## Type Parameters - -• **TValue** - -• **TAccessor** - -• **TDepth** *extends* `ReadonlyArray`\<`any`\> = \[\] diff --git a/docs/reference/type-aliases/derivedformstate.md b/docs/reference/type-aliases/derivedformstate.md deleted file mode 100644 index 712ac2cfd..000000000 --- a/docs/reference/type-aliases/derivedformstate.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -id: DerivedFormState -title: DerivedFormState ---- - - - -# Type Alias: DerivedFormState\ - -```ts -type DerivedFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:557](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L557) - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -## Type declaration - -### canSubmit - -```ts -canSubmit: boolean; -``` - -A boolean indicating if the form can be submitted based on its current state. - -### errors - -```ts -errors: ( - | UnwrapFormValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormValidateOrFn - | UnwrapFormAsyncValidateOrFn - | UnwrapFormAsyncValidateOrFn)[]; -``` - -The error array for the form itself. - -### fieldMeta - -```ts -fieldMeta: Record, AnyFieldMeta>; -``` - -A record of field metadata for each field in the form. - -### isBlurred - -```ts -isBlurred: boolean; -``` - -A boolean indicating if any of the form fields have been blurred. - -### isDirty - -```ts -isDirty: boolean; -``` - -A boolean indicating if any of the form's fields' values have been modified by the user. `True` if the user have modified at least one of the fields. Opposite of `isPristine`. - -### isFieldsValid - -```ts -isFieldsValid: boolean; -``` - -A boolean indicating if all the form fields are valid. - -### isFieldsValidating - -```ts -isFieldsValidating: boolean; -``` - -A boolean indicating if any of the form fields are currently validating. - -### isFormValid - -```ts -isFormValid: boolean; -``` - -A boolean indicating if the form is valid. - -### isFormValidating - -```ts -isFormValidating: boolean; -``` - -A boolean indicating if the form is currently validating. - -### isPristine - -```ts -isPristine: boolean; -``` - -A boolean indicating if none of the form's fields' values have been modified by the user. `True` if the user have not modified any of the fields. Opposite of `isDirty`. - -### isTouched - -```ts -isTouched: boolean; -``` - -A boolean indicating if any of the form fields have been touched. - -### isValid - -```ts -isValid: boolean; -``` - -A boolean indicating if the form and all its fields are valid. diff --git a/docs/reference/type-aliases/fieldinfo.md b/docs/reference/type-aliases/fieldinfo.md deleted file mode 100644 index 08521d479..000000000 --- a/docs/reference/type-aliases/fieldinfo.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: FieldInfo -title: FieldInfo ---- - - - -# Type Alias: FieldInfo\ - -```ts -type FieldInfo = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:452](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L452) - -An object representing the field information for a specific field within the form. - -## Type Parameters - -• **TFormData** - -## Type declaration - -### instance - -```ts -instance: - | FieldApi - | null; -``` - -An instance of the FieldAPI. - -### validationMetaMap - -```ts -validationMetaMap: Record; -``` - -A record of field validation internal handling. diff --git a/docs/reference/type-aliases/fieldmeta.md b/docs/reference/type-aliases/fieldmeta.md deleted file mode 100644 index 14f0df130..000000000 --- a/docs/reference/type-aliases/fieldmeta.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: FieldMeta -title: FieldMeta ---- - - - -# Type Alias: FieldMeta\ - -```ts -type FieldMeta = FieldMetaBase & FieldMetaDerived; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:684](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L684) - -An object type representing the metadata of a field in a form. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> diff --git a/docs/reference/type-aliases/fieldmetabase.md b/docs/reference/type-aliases/fieldmetabase.md deleted file mode 100644 index 236e3709a..000000000 --- a/docs/reference/type-aliases/fieldmetabase.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -id: FieldMetaBase -title: FieldMetaBase ---- - - - -# Type Alias: FieldMetaBase\ - -```ts -type FieldMetaBase = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:499](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L499) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -## Type declaration - -### errorMap - -```ts -errorMap: ValidationErrorMap, UnwrapFieldValidateOrFn, UnwrapFieldAsyncValidateOrFn, UnwrapFieldValidateOrFn, UnwrapFieldAsyncValidateOrFn, UnwrapFieldValidateOrFn, UnwrapFieldAsyncValidateOrFn>; -``` - -A map of errors related to the field value. - -### isBlurred - -```ts -isBlurred: boolean; -``` - -A flag indicating whether the field has been blurred. - -### isDirty - -```ts -isDirty: boolean; -``` - -A flag that is `true` if the field's value has been modified by the user. Opposite of `isPristine`. - -### isTouched - -```ts -isTouched: boolean; -``` - -A flag indicating whether the field has been touched. - -### isValidating - -```ts -isValidating: boolean; -``` - -A flag indicating whether the field is currently being validated. diff --git a/docs/reference/type-aliases/fieldmetaderived.md b/docs/reference/type-aliases/fieldmetaderived.md deleted file mode 100644 index 1f7bb3888..000000000 --- a/docs/reference/type-aliases/fieldmetaderived.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: FieldMetaDerived -title: FieldMetaDerived ---- - - - -# Type Alias: FieldMetaDerived\ - -```ts -type FieldMetaDerived = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:589](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L589) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -## Type declaration - -### errors - -```ts -errors: ( - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray> - | UnwrapOneLevelOfArray>)[]; -``` - -An array of errors related to the field value. - -### isPristine - -```ts -isPristine: boolean; -``` - -A flag that is `true` if the field's value has not been modified by the user. Opposite of `isDirty`. diff --git a/docs/reference/type-aliases/fieldstate.md b/docs/reference/type-aliases/fieldstate.md deleted file mode 100644 index c1043845e..000000000 --- a/docs/reference/type-aliases/fieldstate.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: FieldState -title: FieldState ---- - - - -# Type Alias: FieldState\ - -```ts -type FieldState = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:770](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L770) - -An object type representing the state of a field. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TData** *extends* [`DeepValue`](deepvalue.md)\<`TParentData`, `TName`\> - -• **TOnMount** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChange** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlur** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmit** *extends* `undefined` \| `FieldValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`TParentData`, `TName`, `TData`\> - -• **TFormOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TParentData`\> - -• **TFormOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TParentData`\> - -## Type declaration - -### meta - -```ts -meta: FieldMeta; -``` - -The current metadata of the field. - -### value - -```ts -value: TData; -``` - -The current value of the field. diff --git a/docs/reference/type-aliases/formstate.md b/docs/reference/type-aliases/formstate.md deleted file mode 100644 index 645a758ba..000000000 --- a/docs/reference/type-aliases/formstate.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: FormState -title: FormState ---- - - - -# Type Alias: FormState\ - -```ts -type FormState = BaseFormState & DerivedFormState; -``` - -Defined in: [packages/form-core/src/FormApi.ts:627](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L627) - -## Type Parameters - -• **TFormData** - -• **TOnMount** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChange** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnChangeAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnBlur** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnBlurAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnSubmit** *extends* `undefined` \| `FormValidateOrFn`\<`TFormData`\> - -• **TOnSubmitAsync** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> - -• **TOnServer** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`TFormData`\> diff --git a/docs/reference/type-aliases/formvalidatefn.md b/docs/reference/type-aliases/formvalidatefn.md deleted file mode 100644 index 1e4620e27..000000000 --- a/docs/reference/type-aliases/formvalidatefn.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: FormValidateFn -title: FormValidateFn ---- - - - -# Type Alias: FormValidateFn()\ - -```ts -type FormValidateFn = (props) => unknown; -``` - -Defined in: [packages/form-core/src/FormApi.ts:64](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L64) - -## Type Parameters - -• **TFormData** - -## Parameters - -### props - -#### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`, `any`\> - -#### value - -`TFormData` - -## Returns - -`unknown` diff --git a/docs/reference/type-aliases/formvalidationerror.md b/docs/reference/type-aliases/formvalidationerror.md deleted file mode 100644 index e8178d450..000000000 --- a/docs/reference/type-aliases/formvalidationerror.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: FormValidationError -title: FormValidationError ---- - - - -# Type Alias: FormValidationError\ - -```ts -type FormValidationError = - | ValidationError -| GlobalFormValidationError; -``` - -Defined in: [packages/form-core/src/types.ts:58](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.ts#L58) - -## Type Parameters - -• **TFormData** diff --git a/docs/reference/type-aliases/formvalidator.md b/docs/reference/type-aliases/formvalidator.md deleted file mode 100644 index 49db33665..000000000 --- a/docs/reference/type-aliases/formvalidator.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: FormValidator -title: FormValidator ---- - - - -# Type Alias: FormValidator\ - -```ts -type FormValidator = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:119](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L119) - -## Type Parameters - -• **TFormData** - -• **TType** - -• **TFn** = `unknown` - -## Type declaration - -### validate() - -#### Parameters - -##### options - -###### value - -`TType` - -##### fn - -`TFn` - -#### Returns - -`unknown` - -### validateAsync() - -#### Parameters - -##### options - -###### value - -`TType` - -##### fn - -`TFn` - -#### Returns - -`Promise`\<`unknown`\> diff --git a/docs/reference/type-aliases/standardschemav1.md b/docs/reference/type-aliases/standardschemav1.md deleted file mode 100644 index 17cb0125f..000000000 --- a/docs/reference/type-aliases/standardschemav1.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: StandardSchemaV1 -title: StandardSchemaV1 ---- - - - -# Type Alias: StandardSchemaV1\ - -```ts -type StandardSchemaV1 = object; -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:83](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L83) - -The Standard Schema interface. - -## Type Parameters - -• **Input** = `unknown` - -• **Output** = `Input` - -## Type declaration - -### ~standard - -```ts -readonly ~standard: StandardSchemaV1Props; -``` - -The Standard Schema properties. diff --git a/docs/reference/type-aliases/tstandardschemavalidatorvalue.md b/docs/reference/type-aliases/tstandardschemavalidatorvalue.md deleted file mode 100644 index 313ee227f..000000000 --- a/docs/reference/type-aliases/tstandardschemavalidatorvalue.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: TStandardSchemaValidatorValue -title: TStandardSchemaValidatorValue ---- - - - -# Type Alias: TStandardSchemaValidatorValue\ - -```ts -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) - -## Type Parameters - -• **TData** - -## Type declaration - -### validationSource - -```ts -validationSource: ValidationSource; -``` - -### value - -```ts -value: TData; -``` diff --git a/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md b/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md deleted file mode 100644 index f2ed90556..000000000 --- a/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: UnwrapFieldAsyncValidateOrFn -title: UnwrapFieldAsyncValidateOrFn ---- - - - -# Type Alias: UnwrapFieldAsyncValidateOrFn\ - -```ts -type UnwrapFieldAsyncValidateOrFn = - | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined - | UnwrapFormAsyncValidateOrFnForInner extends infer TFormValidateVal ? TFormValidateVal extends object ? [DeepValue] extends [never] ? undefined : StandardSchemaV1Issue[] : TFormValidateVal extends object ? TName extends keyof TFormValidateVal["fields"] ? TFormValidateVal["fields"][TName] : undefined : undefined : never - | [TValidateOrFn] extends [FieldValidateAsyncFn] ? Awaited> : [TValidateOrFn] extends [StandardSchemaV1] ? StandardSchemaV1Issue[] : undefined; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:203](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L203) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TValidateOrFn** *extends* `undefined` \| `FieldAsyncValidateOrFn`\<`any`, `any`, `any`\> - -• **TFormValidateOrFn** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwrapfieldvalidateorfn.md b/docs/reference/type-aliases/unwrapfieldvalidateorfn.md deleted file mode 100644 index c58816352..000000000 --- a/docs/reference/type-aliases/unwrapfieldvalidateorfn.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -id: UnwrapFieldValidateOrFn -title: UnwrapFieldValidateOrFn ---- - - - -# Type Alias: UnwrapFieldValidateOrFn\ - -```ts -type UnwrapFieldValidateOrFn = - | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined - | UnwrapFormValidateOrFnForInner extends infer TFormValidateVal ? TFormValidateVal extends object ? [DeepValue] extends [never] ? undefined : StandardSchemaV1Issue[] : TFormValidateVal extends object ? TName extends keyof TFormValidateVal["fields"] ? TFormValidateVal["fields"][TName] : undefined : undefined : never - | [TValidateOrFn] extends [FieldValidateFn] ? ReturnType : [TValidateOrFn] extends [StandardSchemaV1] ? StandardSchemaV1Issue[] : undefined; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:120](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L120) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](deepkeys.md)\<`TParentData`\> - -• **TValidateOrFn** *extends* `undefined` \| `FieldValidateOrFn`\<`any`, `any`, `any`\> - -• **TFormValidateOrFn** *extends* `undefined` \| `FormValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md b/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md deleted file mode 100644 index 2f97738fa..000000000 --- a/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: UnwrapFormAsyncValidateOrFn -title: UnwrapFormAsyncValidateOrFn ---- - - - -# Type Alias: UnwrapFormAsyncValidateOrFn\ - -```ts -type UnwrapFormAsyncValidateOrFn = [TValidateOrFn] extends [FormValidateAsyncFn] ? Awaited> : [TValidateOrFn] extends [StandardSchemaV1] ? Record : undefined; -``` - -Defined in: [packages/form-core/src/FormApi.ts:141](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L141) - -## Type Parameters - -• **TValidateOrFn** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwrapformvalidateorfn.md b/docs/reference/type-aliases/unwrapformvalidateorfn.md deleted file mode 100644 index 7ec18923c..000000000 --- a/docs/reference/type-aliases/unwrapformvalidateorfn.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -id: UnwrapFormValidateOrFn -title: UnwrapFormValidateOrFn ---- - - - -# Type Alias: UnwrapFormValidateOrFn\ - -```ts -type UnwrapFormValidateOrFn = [TValidateOrFn] extends [FormValidateFn] ? ReturnType : [TValidateOrFn] extends [StandardSchemaV1] ? Record : undefined; -``` - -Defined in: [packages/form-core/src/FormApi.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L89) - -## Type Parameters - -• **TValidateOrFn** *extends* `undefined` \| `FormValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md deleted file mode 100644 index bbbefe1b3..000000000 --- a/docs/reference/type-aliases/updater.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: Updater -title: Updater ---- - - - -# Type Alias: Updater\ - -```ts -type Updater = TOutput | UpdaterFn; -``` - -Defined in: [packages/form-core/src/utils.ts:7](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L7) - -## Type Parameters - -• **TInput** - -• **TOutput** = `TInput` diff --git a/docs/reference/type-aliases/updaterfn.md b/docs/reference/type-aliases/updaterfn.md deleted file mode 100644 index c0f917772..000000000 --- a/docs/reference/type-aliases/updaterfn.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: UpdaterFn -title: UpdaterFn ---- - - - -# Type Alias: UpdaterFn()\ - -```ts -type UpdaterFn = (input) => TOutput; -``` - -Defined in: [packages/form-core/src/utils.ts:5](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L5) - -## Type Parameters - -• **TInput** - -• **TOutput** = `TInput` - -## Parameters - -### input - -`TInput` - -## Returns - -`TOutput` diff --git a/docs/reference/type-aliases/validationerror.md b/docs/reference/type-aliases/validationerror.md deleted file mode 100644 index 87984446d..000000000 --- a/docs/reference/type-aliases/validationerror.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: ValidationError -title: ValidationError ---- - - - -# Type Alias: ValidationError - -```ts -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) diff --git a/docs/reference/type-aliases/validationmeta.md b/docs/reference/type-aliases/validationmeta.md deleted file mode 100644 index 883bf6201..000000000 --- a/docs/reference/type-aliases/validationmeta.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: ValidationMeta -title: ValidationMeta ---- - - - -# Type Alias: ValidationMeta - -```ts -type ValidationMeta = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:442](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L442) - -An object representing the validation metadata for a field. Not intended for public usage. - -## Type declaration - -### lastAbortController - -```ts -lastAbortController: AbortController; -``` - -An abort controller stored in memory to cancel previous async validation attempts. diff --git a/docs/reference/type-aliases/validationsource.md b/docs/reference/type-aliases/validationsource.md deleted file mode 100644 index 0edfb695b..000000000 --- a/docs/reference/type-aliases/validationsource.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: ValidationSource -title: ValidationSource ---- - - - -# Type Alias: ValidationSource - -```ts -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) diff --git a/docs/reference/variables/standardschemavalidators.md b/docs/reference/variables/standardschemavalidators.md deleted file mode 100644 index 4ee3c9688..000000000 --- a/docs/reference/variables/standardschemavalidators.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: standardSchemaValidators -title: standardSchemaValidators ---- - - - -# Variable: standardSchemaValidators - -```ts -const standardSchemaValidators: object; -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:48](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L48) - -## Type declaration - -### validate() - -#### Parameters - -##### \_\_namedParameters - -[`TStandardSchemaValidatorValue`](../type-aliases/tstandardschemavalidatorvalue.md)\<`unknown`\> - -##### schema - -[`StandardSchemaV1`](../type-aliases/standardschemav1.md) - -#### Returns - - \| `undefined` - \| readonly [`StandardSchemaV1Issue`](../interfaces/standardschemav1issue.md)[] - \| \{ - `fields`: \{\}; - `form`: \{\}; - \} - -### validateAsync() - -#### Parameters - -##### \_\_namedParameters - -[`TStandardSchemaValidatorValue`](../type-aliases/tstandardschemavalidatorvalue.md)\<`unknown`\> - -##### schema - -[`StandardSchemaV1`](../type-aliases/standardschemav1.md) - -#### Returns - -`Promise`\< - \| `undefined` - \| readonly [`StandardSchemaV1Issue`](../interfaces/standardschemav1issue.md)[] - \| \{ - `fields`: \{\}; - `form`: \{\}; - \}\>