From 73032d105912b45f9a6f5a898c52169b56183ad3 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Tue, 18 Feb 2025 17:16:26 +0100 Subject: [PATCH 01/11] feat(core): add getAllErrors to form api --- packages/form-core/src/FormApi.ts | 33 +++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index e4810fd7f5..c9453e16ab 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1865,6 +1865,39 @@ export class FormApi< }) as never, ) } + + /** + * Returns form and field level errors + */ + getAllErrors = () => { + return { + form: this.state.errors, + fields: Object.entries(this.state.fieldMeta).reduce( + (acc, [fieldName, fieldMeta]) => { + // reduces error map down to keys with errors + const fieldErrors = Object.entries( + (fieldMeta as FieldMeta).errorMap, + ).reduce( + (errorAcc, [errorName, errorValue]) => { + if (errorValue != null) { + errorAcc[errorName as ValidationErrorMapKeys] = errorValue + } + + return errorAcc + }, + {} as Record, + ) + + if (Object.keys(fieldErrors).length) { + acc[fieldName] = fieldErrors + } + + return acc + }, + {} as Record, + ), + } + } } function normalizeError(rawError?: FormValidationError): { From 1990fceec0f75ec0ef3cb8a72544d8c5b02fd6b6 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2025 16:25:31 +0000 Subject: [PATCH 02/11] ci: apply automated fixes and generate docs --- docs/reference/classes/formapi.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md index f0b3bec341..0a392222fa 100644 --- a/docs/reference/classes/formapi.md +++ b/docs/reference/classes/formapi.md @@ -151,6 +151,34 @@ Defined in: [packages/form-core/src/FormApi.ts:1661](https://github.com/TanStack *** +### getAllErrors() + +```ts +getAllErrors(): object +``` + +Defined in: [packages/form-core/src/FormApi.ts:1438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1438) + +Returns form and field level errors + +#### Returns + +`object` + +##### fields + +```ts +fields: Record; +``` + +##### form + +```ts +form: ValidationError[]; +``` + +*** + ### getFieldInfo() ```ts From 361eaefaeedd10945040b8af789c767b27817d3f Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Tue, 18 Feb 2025 22:48:49 +0100 Subject: [PATCH 03/11] chore: form getAll spec tests --- packages/form-core/tests/FormApi.spec.ts | 43 ++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index a7dd0ea541..30e165dfbf 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -1462,6 +1462,49 @@ describe('form api', () => { }) }) + it('should return all errors', () => { + const form = new FormApi({ + defaultValues: { + name: 'other', + }, + validators: { + onChange: ({ value }) => { + if (value.name === 'other') return 'onChange - form' + return + }, + onMount: ({ value }) => { + if (value.name === 'other') return 'onMount - form' + return + }, + }, + }) + const field = new FieldApi({ + form, + name: 'name', + validators: { + onChange: ({ value }) => { + if (value === 'other') { + return 'onChange - field' + } + return + }, + }, + }) + + form.mount() + field.mount() + expect(form.getAllErrors()).toEqual({ + fields: {}, + form: ['onMount - form'], + }) + + field.setValue('other') + expect(form.getAllErrors()).toEqual({ + fields: { name: { onChange: 'onChange - field' } }, + form: ['onChange - form'], + }) + }) + it('should reset onChange errors when the issue is resolved', () => { const form = new FormApi({ defaultValues: { From e39acb0e5611d640d1a39868b021c3c1ce1f5066 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Thu, 20 Feb 2025 14:16:14 +0100 Subject: [PATCH 04/11] chore: pr comments pt1 --- packages/form-core/src/FormApi.ts | 47 ++++++++++++++++-------- packages/form-core/tests/FormApi.spec.ts | 20 ++++++++-- 2 files changed, 47 insertions(+), 20 deletions(-) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index c9453e16ab..2a565e2aff 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1870,31 +1870,46 @@ export class FormApi< * Returns form and field level errors */ getAllErrors = () => { + const reduceErrorMap = (errorMap: ValidationErrorMap) => { + return Object.entries(errorMap).reduce( + (errorAcc, [errorName, errorValue]) => { + if (errorValue != null) { + errorAcc[errorName as ValidationErrorMapKeys] = errorValue + } + + return errorAcc + }, + {} as Record, + ) + } + console.log(this.state.errors) + return { - form: this.state.errors, + form: { + errors: this.state.errors, + errorMap: reduceErrorMap(this.state.errorMap as ValidationErrorMap), + }, fields: Object.entries(this.state.fieldMeta).reduce( (acc, [fieldName, fieldMeta]) => { // reduces error map down to keys with errors - const fieldErrors = Object.entries( - (fieldMeta as FieldMeta).errorMap, - ).reduce( - (errorAcc, [errorName, errorValue]) => { - if (errorValue != null) { - errorAcc[errorName as ValidationErrorMapKeys] = errorValue - } - - return errorAcc - }, - {} as Record, - ) + const fieldErrors = reduceErrorMap((fieldMeta as FieldMeta).errorMap) - if (Object.keys(fieldErrors).length) { - acc[fieldName] = fieldErrors + if ( + Object.keys(fieldErrors).length && + (fieldMeta as FieldMeta).errors.length + ) { + acc[fieldName] = { + errors: (fieldMeta as FieldMeta).errors, + errorMap: fieldErrors, + } } return acc }, - {} as Record, + {} as Record< + string, + { errors: ValidationError[]; errorMap: ValidationErrorMap } + >, ), } } diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index 30e165dfbf..fcaf56498a 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -1466,6 +1466,7 @@ describe('form api', () => { const form = new FormApi({ defaultValues: { name: 'other', + age: 'hi', }, validators: { onChange: ({ value }) => { @@ -1495,13 +1496,24 @@ describe('form api', () => { field.mount() expect(form.getAllErrors()).toEqual({ fields: {}, - form: ['onMount - form'], + form: { + errors: ['onMount - form'], + errorMap: { onMount: 'onMount - form' }, + }, }) field.setValue('other') - expect(form.getAllErrors()).toEqual({ - fields: { name: { onChange: 'onChange - field' } }, - form: ['onChange - form'], + expect(form.getAllErrors()).toStrictEqual({ + fields: { + name: { + errors: ['onChange - field'], + errorMap: { onChange: 'onChange - field' }, + }, + }, + form: { + errors: ['onChange - form'], + errorMap: { onChange: 'onChange - form' }, + }, }) }) From acc17cc7c81e21e5a4c2657cf3fbc5a3fafa8abe Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Fri, 21 Feb 2025 17:30:50 +0000 Subject: [PATCH 05/11] ci: apply automated fixes and generate docs --- .../reference/classes/tanstackfield.md | 317 ------- .../angular/reference/functions/injectform.md | 42 - .../reference/functions/injectstore.md | 48 -- docs/framework/angular/reference/index.md | 15 - .../classes/tanstackformcontroller.md | 183 ---- docs/framework/lit/reference/index.md | 10 - .../react/reference/functions/field.md | 64 -- .../react/reference/functions/usefield.md | 66 -- .../react/reference/functions/useform.md | 46 - .../react/reference/functions/usestore.md | 62 -- .../react/reference/functions/usetransform.md | 46 - docs/framework/react/reference/index.md | 24 - .../reference/interfaces/reactformapi.md | 74 -- .../reference/type-aliases/fieldcomponent.md | 70 -- .../type-aliases/reactformextendedapi.md | 34 - .../react/reference/type-aliases/usefield.md | 66 -- .../solid/reference/functions/createfield.md | 64 -- .../solid/reference/functions/createform.md | 42 - .../solid/reference/functions/field.md | 60 -- .../solid/reference/functions/usestore.md | 62 -- docs/framework/solid/reference/index.md | 22 - .../reference/interfaces/solidformapi.md | 106 --- .../reference/type-aliases/createfield.md | 66 -- .../reference/type-aliases/fieldcomponent.md | 68 -- .../vue/reference/functions/usefield.md | 72 -- .../vue/reference/functions/useform.md | 42 - .../vue/reference/functions/usestore.md | 62 -- docs/framework/vue/reference/index.md | 27 - .../vue/reference/interfaces/vuefieldapi.md | 38 - .../vue/reference/interfaces/vueformapi.md | 82 -- .../reference/type-aliases/fieldcomponent.md | 52 -- .../type-aliases/fieldcomponentprops.md | 50 -- .../vue/reference/type-aliases/usefield.md | 74 -- .../vue/reference/variables/field.md | 22 - docs/reference/classes/fieldapi.md | 564 ------------- docs/reference/classes/formapi.md | 787 ------------------ docs/reference/functions/formoptions.md | 45 - .../functions/isglobalformvalidationerror.md | 22 - .../functions/isstandardschemavalidator.md | 22 - docs/reference/functions/mergeform.md | 30 - docs/reference/functions/shallow.md | 30 - docs/reference/index.md | 67 -- docs/reference/interfaces/fieldapioptions.md | 190 ----- docs/reference/interfaces/fieldlisteners.md | 56 -- docs/reference/interfaces/fieldoptions.md | 132 --- docs/reference/interfaces/fieldvalidators.md | 202 ----- docs/reference/interfaces/formoptions.md | 156 ---- docs/reference/interfaces/formvalidators.md | 130 --- .../interfaces/standardschemav1issue.md | 34 - docs/reference/type-aliases/anyfieldapi.md | 14 - docs/reference/type-aliases/anyfieldmeta.md | 12 - .../type-aliases/anyfieldmetabase.md | 12 - .../type-aliases/anyfieldmetaderived.md | 12 - docs/reference/type-aliases/anyformapi.md | 14 - docs/reference/type-aliases/anyformstate.md | 12 - docs/reference/type-aliases/baseformstate.md | 108 --- docs/reference/type-aliases/deepkeys.md | 20 - docs/reference/type-aliases/deepvalue.md | 22 - .../type-aliases/derivedformstate.md | 138 --- docs/reference/type-aliases/fieldinfo.md | 38 - docs/reference/type-aliases/fieldmeta.md | 50 -- docs/reference/type-aliases/fieldmetabase.md | 90 -- .../type-aliases/fieldmetaderived.md | 73 -- docs/reference/type-aliases/fieldstate.md | 68 -- docs/reference/type-aliases/formstate.md | 32 - docs/reference/type-aliases/formvalidatefn.md | 32 - .../type-aliases/formvalidationerror.md | 18 - docs/reference/type-aliases/formvalidator.md | 58 -- .../type-aliases/standardschemav1.md | 30 - .../tstandardschemavalidatorvalue.md | 30 - .../unwrapfieldasyncvalidateorfn.md | 25 - .../type-aliases/unwrapfieldvalidateorfn.md | 25 - .../unwrapformasyncvalidateorfn.md | 16 - .../type-aliases/unwrapformvalidateorfn.md | 16 - .../type-aliases/unwraponelevelofarray.md | 16 - docs/reference/type-aliases/updater.md | 18 - docs/reference/type-aliases/updaterfn.md | 28 - .../reference/type-aliases/validationerror.md | 12 - docs/reference/type-aliases/validationmeta.md | 24 - .../type-aliases/validationsource.md | 12 - .../variables/standardschemavalidators.md | 57 -- 81 files changed, 5777 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/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/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/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/unwraponelevelofarray.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 1f82a06b44..0000000000 --- a/docs/framework/angular/reference/classes/tanstackfield.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -id: TanStackField -title: TanStackField ---- - -# Class: TanStackField\ - -Defined in: [tanstack-field.directive.ts:32](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L32) - -## 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`\> - -## 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`\> - -## Properties - -### api - -```ts -api: FieldApi; -``` - -Defined in: [tanstack-field.directive.ts:131](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L131) - -*** - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [tanstack-field.directive.ts:81](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L81) - -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:80](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80) - -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:108](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L108) - -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:79](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L79) - -An optional default value for the field. - -#### Implementation of - -```ts -FieldOptions.defaultValue -``` - -*** - -### disableErrorFlat? - -```ts -optional disableErrorFlat: boolean; -``` - -Defined in: [tanstack-field.directive.ts:129](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129) - -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:107](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L107) - -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:82](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L82) - -*** - -### 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:93](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L93) - -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 2d1390639c..0000000000 --- a/docs/framework/angular/reference/functions/injectform.md +++ /dev/null @@ -1,42 +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`\> - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -## Returns - -`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md deleted file mode 100644 index 0d19fc8de4..0000000000 --- a/docs/framework/angular/reference/functions/injectstore.md +++ /dev/null @@ -1,48 +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`\> - -• **TSelected** = `NoInfer`\<`FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\>\> - -## Parameters - -### form - -`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -### 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 aab1d7b1d1..0000000000 --- a/docs/framework/angular/reference/index.md +++ /dev/null @@ -1,15 +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 8523a27157..0000000000 --- a/docs/framework/lit/reference/classes/tanstackformcontroller.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -id: TanStackFormController -title: TanStackFormController ---- - -# Class: TanStackFormController\ - -Defined in: [tanstack-form-controller.ts:183](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L183) - -## 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`\> - -## Implements - -- `ReactiveController` - -## Constructors - -### new TanStackFormController() - -```ts -new TanStackFormController(host, config?): TanStackFormController -``` - -Defined in: [tanstack-form-controller.ts:210](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L210) - -#### Parameters - -##### host - -`ReactiveControllerHost` - -##### config? - -`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -#### Returns - -[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## Properties - -### api - -```ts -api: FormApi; -``` - -Defined in: [tanstack-form-controller.ts:198](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L198) - -## Methods - -### field() - -```ts -field(fieldConfig, render): object -``` - -Defined in: [tanstack-form-controller.ts:249](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L249) - -#### 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`\> - -#### 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:239](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L239) - -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:245](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L245) - -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 4215a31714..0000000000 --- a/docs/framework/lit/reference/index.md +++ /dev/null @@ -1,10 +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/field.md b/docs/framework/react/reference/functions/field.md deleted file mode 100644 index 4bdf6c2eff..0000000000 --- a/docs/framework/react/reference/functions/field.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: Field -title: Field ---- - -# Function: Field() - -```ts -function Field(__namedParameters): ReactNode -``` - -Defined in: [packages/react-form/src/useField.tsx:352](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L352) - -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`\> - -## Parameters - -### \_\_namedParameters - -`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## 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 f2e75d6460..0000000000 --- a/docs/framework/react/reference/functions/usefield.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: useField -title: useField ---- - -# Function: useField() - -```ts -function useField(opts): FieldApi & ReactFieldApi -``` - -Defined in: [packages/react-form/src/useField.tsx:125](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L125) - -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`\> - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -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`\> & `ReactFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -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 a8dd55524f..0000000000 --- a/docs/framework/react/reference/functions/useform.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: useForm -title: useForm ---- - -# Function: useForm() - -```ts -function useForm(opts?): ReactFormExtendedApi -``` - -Defined in: [packages/react-form/src/useForm.tsx:137](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L137) - -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`\> - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -## Returns - -[`ReactFormExtendedApi`](../type-aliases/reactformextendedapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md deleted file mode 100644 index 76f60a8b8e..0000000000 --- a/docs/framework/react/reference/functions/usestore.md +++ /dev/null @@ -1,62 +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 52b6a6f586..0000000000 --- a/docs/framework/react/reference/functions/usetransform.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: useTransform -title: useTransform ---- - -# Function: useTransform() - -```ts -function useTransform(fn, deps): FormTransform -``` - -Defined in: [packages/react-form/src/useTransform.ts:8](https://github.com/TanStack/form/blob/main/packages/react-form/src/useTransform.ts#L8) - -## 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`\> - -## Parameters - -### fn - -(`formBase`) => `FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -### deps - -`unknown`[] - -## Returns - -`FormTransform`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md deleted file mode 100644 index 599a63e0b7..0000000000 --- a/docs/framework/react/reference/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: "@tanstack/react-form" -title: "@tanstack/react-form" ---- - -# @tanstack/react-form - -## Interfaces - -- [ReactFormApi](interfaces/reactformapi.md) - -## Type Aliases - -- [FieldComponent](type-aliases/fieldcomponent.md) -- [ReactFormExtendedApi](type-aliases/reactformextendedapi.md) -- [UseField](type-aliases/usefield.md) - -## Functions - -- [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 c11deb9c7c..0000000000 --- a/docs/framework/react/reference/interfaces/reactformapi.md +++ /dev/null @@ -1,74 +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`\> - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/react-form/src/useForm.tsx:35](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L35) - -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:49](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L49) - -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/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md deleted file mode 100644 index f7d1388c03..0000000000 --- a/docs/framework/react/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => ReactNode; -``` - -Defined in: [packages/react-form/src/useField.tsx:294](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L294) - -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`\> - -## 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`\>, `"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 66ca3973ea..0000000000 --- a/docs/framework/react/reference/type-aliases/reactformextendedapi.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: ReactFormExtendedApi -title: ReactFormExtendedApi ---- - -# Type Alias: ReactFormExtendedApi\ - -```ts -type ReactFormExtendedApi = FormApi & ReactFormApi; -``` - -Defined in: [packages/react-form/src/useForm.tsx:86](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L86) - -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`\> 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 2fdea33cb0..0000000000 --- a/docs/framework/react/reference/type-aliases/usefield.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: UseField -title: UseField ---- - -# Type Alias: UseField()\ - -```ts -type UseField = (opts) => FieldApi; -``` - -Defined in: [packages/react-form/src/useField.tsx:48](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L48) - -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`\> - -## 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`\>, `"form"`\> - -## Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md deleted file mode 100644 index bb7a449ee6..0000000000 --- a/docs/framework/solid/reference/functions/createfield.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -id: createField -title: createField ---- - -# Function: createField() - -```ts -function createField(opts): () => FieldApi & SolidFieldApi -``` - -Defined in: [packages/solid-form/src/createField.tsx:225](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L225) - -## 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`\> - -## Parameters - -### opts - -() => `CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## Returns - -`Function` - -### Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md deleted file mode 100644 index eccd2d43d4..0000000000 --- a/docs/framework/solid/reference/functions/createform.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: createForm -title: createForm ---- - -# Function: createForm() - -```ts -function createForm(opts?): FormApi & SolidFormApi -``` - -Defined in: [packages/solid-form/src/createForm.tsx:114](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L114) - -## 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`\> - -## Parameters - -### opts? - -() => `FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## Returns - -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md deleted file mode 100644 index 7c4edc74e7..0000000000 --- a/docs/framework/solid/reference/functions/field.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: Field -title: Field ---- - -# Function: Field() - -```ts -function Field(props): Element -``` - -Defined in: [packages/solid-form/src/createField.tsx:460](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L460) - -## 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`\> - -## Parameters - -### props - -`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `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 bf10af9e46..0000000000 --- a/docs/framework/solid/reference/functions/usestore.md +++ /dev/null @@ -1,62 +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 704a66cb77..0000000000 --- a/docs/framework/solid/reference/index.md +++ /dev/null @@ -1,22 +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 4a13b75067..0000000000 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: SolidFormApi -title: SolidFormApi ---- - -# Interface: SolidFormApi\ - -Defined in: [packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) - -## 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`\> - -## 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:27](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L27) - -*** - -### Subscribe() - -```ts -Subscribe: (props) => Element; -``` - -Defined in: [packages/solid-form/src/createForm.tsx:80](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L80) - -#### Type Parameters - -• **TSelected** = `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:49](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L49) - -#### Type Parameters - -• **TSelected** = `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 6ee4c533f5..0000000000 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: CreateField -title: CreateField ---- - -# Type Alias: CreateField()\ - -```ts -type CreateField = (opts) => () => FieldApi & SolidFieldApi; -``` - -Defined in: [packages/solid-form/src/createField.tsx:47](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L47) - -## 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`\> - -## 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 - -() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>, `"form"`\> - -## Returns - -`Function` - -### Returns - -`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> 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 0199395e6f..0000000000 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => JSXElement; -``` - -Defined in: [packages/solid-form/src/createField.tsx:407](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L407) - -## 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`\> - -## 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`\>, `"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 ebb68ccfd1..0000000000 --- a/docs/framework/vue/reference/functions/usefield.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: useField -title: useField ---- - -# Function: useField() - -```ts -function useField(opts): object -``` - -Defined in: [packages/vue-form/src/useField.tsx:291](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L291) - -## 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`\> - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## 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 a061b613f8..0000000000 --- a/docs/framework/vue/reference/functions/useform.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: useForm -title: useForm ---- - -# Function: useForm() - -```ts -function useForm(opts?): FormApi & VueFormApi -``` - -Defined in: [packages/vue-form/src/useForm.tsx:192](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L192) - -## 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`\> - -## Parameters - -### opts? - -`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## Returns - -`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/vue/reference/functions/usestore.md b/docs/framework/vue/reference/functions/usestore.md deleted file mode 100644 index 2967ed2cc5..0000000000 --- a/docs/framework/vue/reference/functions/usestore.md +++ /dev/null @@ -1,62 +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.7.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.7.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 a265548afd..0000000000 --- a/docs/framework/vue/reference/index.md +++ /dev/null @@ -1,27 +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 7ac1e82d88..0000000000 --- a/docs/framework/vue/reference/interfaces/vuefieldapi.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: VueFieldApi -title: VueFieldApi ---- - -# Interface: VueFieldApi\ - -Defined in: [packages/vue-form/src/useField.tsx:159](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L159) - -## 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`\> - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/vue-form/src/useField.tsx:170](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L170) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md deleted file mode 100644 index ad948871fe..0000000000 --- a/docs/framework/vue/reference/interfaces/vueformapi.md +++ /dev/null @@ -1,82 +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`\> - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:126](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L126) - -*** - -### Subscribe - -```ts -Subscribe: SubscribeComponent; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:179](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L179) - -*** - -### useField - -```ts -useField: UseField; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:137](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L137) - -*** - -### useStore() - -```ts -useStore: (selector?) => Readonly>; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:148](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L148) - -#### 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 ec31cb22fe..0000000000 --- a/docs/framework/vue/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,52 +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`\> - -## Parameters - -### props - -`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>, `"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`\>, `"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`\>; - `state`: `FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>\[`"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 54c77f8a9f..0000000000 --- a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: FieldComponentProps -title: FieldComponentProps ---- - -# Type Alias: FieldComponentProps\ - -```ts -type FieldComponentProps = UseFieldOptions; -``` - -Defined in: [packages/vue-form/src/useField.tsx:385](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L385) - -## 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`\> 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 f54c91d467..0000000000 --- a/docs/framework/vue/reference/type-aliases/usefield.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -id: UseField -title: UseField ---- - -# Type Alias: UseField()\ - -```ts -type UseField = (opts) => object; -``` - -Defined in: [packages/vue-form/src/useField.tsx:183](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L183) - -## 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`\> - -## 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`\>, `"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 99d3585ad8..0000000000 --- a/docs/framework/vue/reference/variables/field.md +++ /dev/null @@ -1,22 +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:431](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L431) - -## 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`\> & `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 034c060a40..0000000000 --- a/docs/reference/classes/fieldapi.md +++ /dev/null @@ -1,564 +0,0 @@ ---- -id: FieldApi -title: FieldApi ---- - -# Class: FieldApi\ - -Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) - -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`\> - -## Constructors - -### new FieldApi() - -```ts -new FieldApi(opts): FieldApi -``` - -Defined in: [packages/form-core/src/FieldApi.ts:943](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L943) - -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`\> - -#### Returns - -[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> - -## Properties - -### form - -```ts -form: FormApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:861](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L861) - -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:884](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L884) - -The field name. - -*** - -### options - -```ts -options: FieldApiOptions; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:888](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L888) - -The field options. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L911) - -The field state store. - -*** - -### timeoutIds - -```ts -timeoutIds: Record; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L938) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FieldState -``` - -Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) - -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:1189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1189) - -Gets the field information object. - -#### Returns - -[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`\> - -*** - -### getMeta() - -```ts -getMeta(): FieldMeta -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1157](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1157) - -#### 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:1139](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1139) - -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:1561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1561) - -Handles the blur event. - -#### Returns - -`void` - -*** - -### handleChange() - -```ts -handleChange(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1554) - -Handles the change event. - -#### Parameters - -##### updater - -[`Updater`](../type-aliases/updater.md)\<`TData`\> - -#### Returns - -`void` - -*** - -### insertValue() - -```ts -insertValue( - index, - value, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) - -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 - -`Promise`\<`void`\> - -*** - -### mount() - -```ts -mount(): () => void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1046) - -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:1232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1232) - -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:1194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1194) - -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?): Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1220) - -Removes a value at the specified index. - -#### Parameters - -##### index - -`number` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### replaceValue() - -```ts -replaceValue( - index, - value, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1211](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1211) - -Replaces a value at the specified index. - -#### Parameters - -##### index - -`number` - -##### value - -`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### setErrorMap() - -```ts -setErrorMap(errorMap): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1581](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1581) - -Updates the field's errorMap - -#### Parameters - -##### errorMap - -`ValidationErrorMap` - -#### Returns - -`void` - -*** - -### setMeta() - -```ts -setMeta(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1162) - -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:1146](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1146) - -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:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1226) - -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:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) - -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`\> - -#### Returns - -`void` - -*** - -### validate() - -```ts -validate(cause, opts?): unknown[] | Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1521) - -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 0a392222fa..0000000000 --- a/docs/reference/classes/formapi.md +++ /dev/null @@ -1,787 +0,0 @@ ---- -id: FormApi -title: FormApi ---- - -# Class: FormApi\ - -Defined in: [packages/form-core/src/FormApi.ts:622](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L622) - -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`\> - -## Constructors - -### new FormApi() - -```ts -new FormApi(opts?): FormApi -``` - -Defined in: [packages/form-core/src/FormApi.ts:691](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L691) - -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`\> - -#### Returns - -[`FormApi`](formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -## Properties - -### baseStore - -```ts -baseStore: Store>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) - -*** - -### 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:677](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L677) - -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:660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L660) - -*** - -### options - -```ts -options: FormOptions = {}; -``` - -Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) - -The options for the form. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L661) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FormState -``` - -Defined in: [packages/form-core/src/FormApi.ts:679](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L679) - -##### 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:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1661) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -`void` - -*** - -### getAllErrors() - -```ts -getAllErrors(): object -``` - -Defined in: [packages/form-core/src/FormApi.ts:1438](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1438) - -Returns form and field level errors - -#### Returns - -`object` - -##### fields - -```ts -fields: Record; -``` - -##### form - -```ts -form: ValidationError[]; -``` - -*** - -### getFieldInfo() - -```ts -getFieldInfo(field): FieldInfo -``` - -Defined in: [packages/form-core/src/FormApi.ts:1570](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1570) - -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:1561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1561) - -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:1554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1554) - -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() - -```ts -handleSubmit(): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1485) - -Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks. - -#### Returns - -`Promise`\<`void`\> - -*** - -### insertFieldValue() - -```ts -insertFieldValue( - field, - index, - value, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1690](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1690) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### index - -`number` - -##### value - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### mount() - -```ts -mount(): () => void -``` - -Defined in: [packages/form-core/src/FormApi.ts:989](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L989) - -#### Returns - -`Function` - -##### Returns - -`void` - -*** - -### moveFieldValues() - -```ts -moveFieldValues( - field, - index1, - index2, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1819](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1819) - -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:1675](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1675) - -Pushes a value into an array field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### value - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### removeFieldValue() - -```ts -removeFieldValue( - field, - index, -opts?): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1748](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1748) - -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:1722](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1722) - -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`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`Promise`\<`void`\> - -*** - -### reset() - -```ts -reset(values?, opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1064](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1064) - -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:1607](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1607) - -#### 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:1846](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1846) - -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:1589](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1589) - -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:1631](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1631) - -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`, `IsNullable`\<`TFormData`\>\>\> - -##### opts? - -`UpdateMetaOptions` - -#### Returns - -`void` - -*** - -### swapFieldValues() - -```ts -swapFieldValues( - field, - index1, - index2, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1790](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1790) - -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:1006](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1006) - -Updates the form options and form state. - -#### Parameters - -##### options? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -#### Returns - -`void` - -*** - -### validateAllFields() - -```ts -validateAllFields(cause): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1090](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1090) - -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:1120](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1120) - -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:1159](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1159) - -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 606254e447..0000000000 --- a/docs/reference/functions/formoptions.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: formOptions -title: formOptions ---- - -# Function: formOptions() - -```ts -function formOptions(defaultOpts?): - | undefined -| FormOptions -``` - -Defined in: [packages/form-core/src/formOptions.ts:7](https://github.com/TanStack/form/blob/main/packages/form-core/src/formOptions.ts#L7) - -## 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`\> - -## Parameters - -### defaultOpts? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> - -## Returns - - \| `undefined` - \| [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/reference/functions/isglobalformvalidationerror.md b/docs/reference/functions/isglobalformvalidationerror.md deleted file mode 100644 index a771692c42..0000000000 --- a/docs/reference/functions/isglobalformvalidationerror.md +++ /dev/null @@ -1,22 +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 4aeab95bdf..0000000000 --- a/docs/reference/functions/isstandardschemavalidator.md +++ /dev/null @@ -1,22 +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 f5bbb18587..0000000000 --- a/docs/reference/functions/mergeform.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: mergeForm -title: mergeForm ---- - -# Function: mergeForm() - -```ts -function mergeForm(baseForm, state): FormApi, any, any, any, any, any, any, any, any> -``` - -Defined in: [packages/form-core/src/mergeForm.ts:74](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L74) - -## Type Parameters - -• **TFormData** - -## Parameters - -### baseForm - -[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `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`\> diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md deleted file mode 100644 index 34c6411893..0000000000 --- a/docs/reference/functions/shallow.md +++ /dev/null @@ -1,30 +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 545c5b5b0f..0000000000 --- a/docs/reference/index.md +++ /dev/null @@ -1,67 +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) -- [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) -- [UnwrapOneLevelOfArray](type-aliases/unwraponelevelofarray.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 51e00a278a..0000000000 --- a/docs/reference/interfaces/fieldapioptions.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -id: FieldApiOptions -title: FieldApiOptions ---- - -# Interface: FieldApiOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L423) - -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`\> - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L370) - -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:366](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L366) - -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:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L389) - -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:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) - -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:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417) - -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:460](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L460) - -*** - -### listeners? - -```ts -optional listeners: FieldListeners; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) - -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:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) - -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:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L374) - -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 d2a6a3a7ef..0000000000 --- a/docs/reference/interfaces/fieldlisteners.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -id: FieldListeners -title: FieldListeners ---- - -# Interface: FieldListeners\ - -Defined in: [packages/form-core/src/FieldApi.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L323) - -## 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:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L329) - -*** - -### onChange? - -```ts -optional onChange: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L328) - -*** - -### onMount? - -```ts -optional onMount: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:330](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L330) - -*** - -### onSubmit? - -```ts -optional onSubmit: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L331) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md deleted file mode 100644 index 12300fc75d..0000000000 --- a/docs/reference/interfaces/fieldoptions.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -id: FieldOptions -title: FieldOptions ---- - -# Interface: FieldOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L337) - -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:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L370) - -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:366](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L366) - -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:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L389) - -An optional object with default metadata for the field. - -*** - -### defaultValue? - -```ts -optional defaultValue: NoInfer; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) - -An optional default value for the field. - -*** - -### disableErrorFlat? - -```ts -optional disableErrorFlat: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417) - -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:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) - -A list of listeners which attach to the corresponding events - -*** - -### name - -```ts -name: TName; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) - -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:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L374) - -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 1bce2beb92..0000000000 --- a/docs/reference/interfaces/fieldvalidators.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -id: FieldValidators -title: FieldValidators ---- - -# Interface: FieldValidators\ - -Defined in: [packages/form-core/src/FieldApi.ts:242](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L242) - -## 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:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L291) - -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:297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L297) - -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:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L304) - -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:308](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L308) - -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:269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L269) - -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:275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L275) - -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:281](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L281) - -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:285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L285) - -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:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L263) - -An optional function, that runs on the mount event of input. - -*** - -### onSubmit? - -```ts -optional onSubmit: TOnSubmit; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:314](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L314) - -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:320](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L320) - -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/formoptions.md b/docs/reference/interfaces/formoptions.md deleted file mode 100644 index 70ddb79eb3..0000000000 --- a/docs/reference/interfaces/formoptions.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -id: FormOptions -title: FormOptions ---- - -# Interface: FormOptions\ - -Defined in: [packages/form-core/src/FormApi.ts:232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L232) - -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`\> - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FormApi.ts:266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L266) - -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:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270) - -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:250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L250) - -The default state for the form. - -*** - -### defaultValues? - -```ts -optional defaultValues: TFormData; -``` - -Defined in: [packages/form-core/src/FormApi.ts:246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L246) - -Set initial values for your form. - -*** - -### onSubmit()? - -```ts -optional onSubmit: (props) => any; -``` - -Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L287) - -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`\> - -###### value - -`TFormData` - -#### Returns - -`any` - -*** - -### onSubmitInvalid()? - -```ts -optional onSubmitInvalid: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L304) - -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`\> - -###### value - -`TFormData` - -#### Returns - -`void` - -*** - -### transform? - -```ts -optional transform: FormTransform; -``` - -Defined in: [packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L318) - -*** - -### validators? - -```ts -optional validators: FormValidators; -``` - -Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274) - -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 41b1c336f0..0000000000 --- a/docs/reference/interfaces/formvalidators.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -id: FormValidators -title: FormValidators ---- - -# Interface: FormValidators\ - -Defined in: [packages/form-core/src/FormApi.ts:147](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L147) - -## 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:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L176) - -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:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L180) - -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:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L184) - -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:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L164) - -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:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L168) - -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:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L172) - -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:160](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L160) - -Optional function that fires as soon as the component mounts. - -*** - -### onSubmit? - -```ts -optional onSubmit: TOnSubmit; -``` - -Defined in: [packages/form-core/src/FormApi.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L185) - -*** - -### onSubmitAsync? - -```ts -optional onSubmitAsync: TOnSubmitAsync; -``` - -Defined in: [packages/form-core/src/FormApi.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L186) diff --git a/docs/reference/interfaces/standardschemav1issue.md b/docs/reference/interfaces/standardschemav1issue.md deleted file mode 100644 index d8a5f51407..0000000000 --- a/docs/reference/interfaces/standardschemav1issue.md +++ /dev/null @@ -1,34 +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 b1023743ad..0000000000 --- a/docs/reference/type-aliases/anyfieldapi.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFieldApi -title: AnyFieldApi ---- - -# Type Alias: AnyFieldApi - -```ts -type AnyFieldApi = FieldApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:802](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L802) - -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 e6af8d6711..0000000000 --- a/docs/reference/type-aliases/anyfieldmeta.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: AnyFieldMeta -title: AnyFieldMeta ---- - -# Type Alias: AnyFieldMeta - -```ts -type AnyFieldMeta = FieldMeta; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:721](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L721) diff --git a/docs/reference/type-aliases/anyfieldmetabase.md b/docs/reference/type-aliases/anyfieldmetabase.md deleted file mode 100644 index 2ecf5cd423..0000000000 --- a/docs/reference/type-aliases/anyfieldmetabase.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: AnyFieldMetaBase -title: AnyFieldMetaBase ---- - -# Type Alias: AnyFieldMetaBase - -```ts -type AnyFieldMetaBase = FieldMetaBase; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L543) diff --git a/docs/reference/type-aliases/anyfieldmetaderived.md b/docs/reference/type-aliases/anyfieldmetaderived.md deleted file mode 100644 index 11ab936fa4..0000000000 --- a/docs/reference/type-aliases/anyfieldmetaderived.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: AnyFieldMetaDerived -title: AnyFieldMetaDerived ---- - -# Type Alias: AnyFieldMetaDerived - -```ts -type AnyFieldMetaDerived = FieldMetaDerived; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:635](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L635) diff --git a/docs/reference/type-aliases/anyformapi.md b/docs/reference/type-aliases/anyformapi.md deleted file mode 100644 index 2e3e5e04df..0000000000 --- a/docs/reference/type-aliases/anyformapi.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: AnyFormApi -title: AnyFormApi ---- - -# Type Alias: AnyFormApi - -```ts -type AnyFormApi = FormApi; -``` - -Defined in: [packages/form-core/src/FormApi.ts:613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L613) - -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 4ff923f5fa..0000000000 --- a/docs/reference/type-aliases/anyformstate.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: AnyFormState -title: AnyFormState ---- - -# Type Alias: AnyFormState - -```ts -type AnyFormState = FormState; -``` - -Defined in: [packages/form-core/src/FormApi.ts:543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L543) diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md deleted file mode 100644 index 6ff1511eb5..0000000000 --- a/docs/reference/type-aliases/baseformstate.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -id: BaseFormState -title: BaseFormState ---- - -# Type Alias: BaseFormState\ - -```ts -type BaseFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L377) - -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 - -### 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 - -### 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 d3535e3b84..0000000000 --- a/docs/reference/type-aliases/deepkeys.md +++ /dev/null @@ -1,20 +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:87](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L87) - -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 9cc682ab6d..0000000000 --- a/docs/reference/type-aliases/deepvalue.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: DeepValue -title: DeepValue ---- - -# Type Alias: DeepValue\ - -```ts -type DeepValue = unknown extends TValue ? TValue : TValue extends ReadonlyArray ? TAccessor extends `[${infer TBrackets}].${infer TAfter}` ? DeepValue, TAfter> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends keyof TValue ? TValue[TAccessor] : TValue[TAccessor & number] : TValue extends Record ? TAccessor extends `${infer TBefore}[${infer TEverythingElse}` ? DeepValue, `[${TEverythingElse}`> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends `${infer TBefore}.${infer TAfter}` ? DeepValue, TAfter> : TAccessor extends string ? TNullable extends true ? Nullable : TValue[TAccessor] : never : never; -``` - -Defined in: [packages/form-core/src/util-types.ts:111](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L111) - -Infer the type of a deeply nested property within an object or an array. - -## Type Parameters - -• **TValue** - -• **TAccessor** - -• **TNullable** *extends* `boolean` = `IsNullable`\<`TValue`\> diff --git a/docs/reference/type-aliases/derivedformstate.md b/docs/reference/type-aliases/derivedformstate.md deleted file mode 100644 index fe6fe33c88..0000000000 --- a/docs/reference/type-aliases/derivedformstate.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: DerivedFormState -title: DerivedFormState ---- - -# Type Alias: DerivedFormState\ - -```ts -type DerivedFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:440](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L440) - -## 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 8e3427cb6f..0000000000 --- a/docs/reference/type-aliases/fieldinfo.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: FieldInfo -title: FieldInfo ---- - -# Type Alias: FieldInfo\ - -```ts -type FieldInfo = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:344](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L344) - -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 f5d85f842c..0000000000 --- a/docs/reference/type-aliases/fieldmeta.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: FieldMeta -title: FieldMeta ---- - -# Type Alias: FieldMeta\ - -```ts -type FieldMeta = FieldMetaBase & FieldMetaDerived; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:658](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L658) - -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 f7b3c10d91..0000000000 --- a/docs/reference/type-aliases/fieldmetabase.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: FieldMetaBase -title: FieldMetaBase ---- - -# Type Alias: FieldMetaBase\ - -```ts -type FieldMetaBase = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L473) - -## 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 7f7251eacd..0000000000 --- a/docs/reference/type-aliases/fieldmetaderived.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: FieldMetaDerived -title: FieldMetaDerived ---- - -# Type Alias: FieldMetaDerived\ - -```ts -type FieldMetaDerived = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:563](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L563) - -## 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 096794d1b9..0000000000 --- a/docs/reference/type-aliases/fieldstate.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -id: FieldState -title: FieldState ---- - -# Type Alias: FieldState\ - -```ts -type FieldState = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:744](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L744) - -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 6b146bdc4b..0000000000 --- a/docs/reference/type-aliases/formstate.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: FormState -title: FormState ---- - -# Type Alias: FormState\ - -```ts -type FormState = BaseFormState & DerivedFormState; -``` - -Defined in: [packages/form-core/src/FormApi.ts:510](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L510) - -## 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 4d3e91f026..0000000000 --- a/docs/reference/type-aliases/formvalidatefn.md +++ /dev/null @@ -1,32 +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`\> - -#### 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 4b455b416a..0000000000 --- a/docs/reference/type-aliases/formvalidationerror.md +++ /dev/null @@ -1,18 +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 6929439e25..0000000000 --- a/docs/reference/type-aliases/formvalidator.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -id: FormValidator -title: FormValidator ---- - -# Type Alias: FormValidator\ - -```ts -type FormValidator = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L117) - -## 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 fe75351bf6..0000000000 --- a/docs/reference/type-aliases/standardschemav1.md +++ /dev/null @@ -1,30 +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 b984ed7e0e..0000000000 --- a/docs/reference/type-aliases/tstandardschemavalidatorvalue.md +++ /dev/null @@ -1,30 +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 500eb59bb1..0000000000 --- a/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: UnwrapFieldAsyncValidateOrFn -title: UnwrapFieldAsyncValidateOrFn ---- - -# Type Alias: UnwrapFieldAsyncValidateOrFn\ - -```ts -type UnwrapFieldAsyncValidateOrFn = - | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined - | UnwrapFormAsyncValidateOrFn extends infer TFormValidateVal ? 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:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L184) - -## 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 7f81338817..0000000000 --- a/docs/reference/type-aliases/unwrapfieldvalidateorfn.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: UnwrapFieldValidateOrFn -title: UnwrapFieldValidateOrFn ---- - -# Type Alias: UnwrapFieldValidateOrFn\ - -```ts -type UnwrapFieldValidateOrFn = - | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined - | UnwrapFormValidateOrFn extends infer TFormValidateVal ? 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:114](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L114) - -## 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 f0c6a404c5..0000000000 --- a/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md +++ /dev/null @@ -1,16 +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:139](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L139) - -## 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 f74081dfd2..0000000000 --- a/docs/reference/type-aliases/unwrapformvalidateorfn.md +++ /dev/null @@ -1,16 +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:88](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L88) - -## Type Parameters - -• **TValidateOrFn** *extends* `undefined` \| `FormValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwraponelevelofarray.md b/docs/reference/type-aliases/unwraponelevelofarray.md deleted file mode 100644 index 1c24252b13..0000000000 --- a/docs/reference/type-aliases/unwraponelevelofarray.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: UnwrapOneLevelOfArray -title: UnwrapOneLevelOfArray ---- - -# Type Alias: UnwrapOneLevelOfArray\ - -```ts -type UnwrapOneLevelOfArray = T extends infer U[] ? U : T; -``` - -Defined in: [packages/form-core/src/util-types.ts:4](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L4) - -## Type Parameters - -• **T** diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md deleted file mode 100644 index c58c78c54f..0000000000 --- a/docs/reference/type-aliases/updater.md +++ /dev/null @@ -1,18 +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 62365f5fa3..0000000000 --- a/docs/reference/type-aliases/updaterfn.md +++ /dev/null @@ -1,28 +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 5421ef7baf..0000000000 --- a/docs/reference/type-aliases/validationerror.md +++ /dev/null @@ -1,12 +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 c2616fbae6..0000000000 --- a/docs/reference/type-aliases/validationmeta.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: ValidationMeta -title: ValidationMeta ---- - -# Type Alias: ValidationMeta - -```ts -type ValidationMeta = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L334) - -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 907c7e33bf..0000000000 --- a/docs/reference/type-aliases/validationsource.md +++ /dev/null @@ -1,12 +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 e94b3e430d..0000000000 --- a/docs/reference/variables/standardschemavalidators.md +++ /dev/null @@ -1,57 +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`: \{\}; - \}\> From aac4d08099e32076ce6d370b5c411318eefcad59 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Fri, 21 Feb 2025 18:34:55 +0100 Subject: [PATCH 06/11] fix: rebase fixed --- packages/form-core/src/FormApi.ts | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index 2a565e2aff..c4bd62a449 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1882,24 +1882,25 @@ export class FormApi< {} as Record, ) } - console.log(this.state.errors) return { form: { errors: this.state.errors, - errorMap: reduceErrorMap(this.state.errorMap as ValidationErrorMap), + errorMap: reduceErrorMap(this.state.errorMap), }, fields: Object.entries(this.state.fieldMeta).reduce( (acc, [fieldName, fieldMeta]) => { // reduces error map down to keys with errors - const fieldErrors = reduceErrorMap((fieldMeta as FieldMeta).errorMap) + const fieldErrors = reduceErrorMap( + (fieldMeta as AnyFieldMeta).errorMap, + ) if ( Object.keys(fieldErrors).length && - (fieldMeta as FieldMeta).errors.length + (fieldMeta as AnyFieldMeta).errors.length ) { acc[fieldName] = { - errors: (fieldMeta as FieldMeta).errors, + errors: (fieldMeta as AnyFieldMeta).errors, errorMap: fieldErrors, } } From 1cab489fc322dfd4c9ecbed3eb92723373f596a4 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Fri, 21 Feb 2025 17:36:06 +0000 Subject: [PATCH 07/11] ci: apply automated fixes and generate docs --- .../reference/classes/tanstackfield.md | 317 +++++++ .../angular/reference/functions/injectform.md | 42 + .../reference/functions/injectstore.md | 48 ++ docs/framework/angular/reference/index.md | 15 + .../classes/tanstackformcontroller.md | 183 ++++ docs/framework/lit/reference/index.md | 10 + .../react/reference/functions/field.md | 64 ++ .../react/reference/functions/usefield.md | 66 ++ .../react/reference/functions/useform.md | 46 + .../react/reference/functions/usestore.md | 62 ++ .../react/reference/functions/usetransform.md | 46 + docs/framework/react/reference/index.md | 24 + .../reference/interfaces/reactformapi.md | 74 ++ .../reference/type-aliases/fieldcomponent.md | 70 ++ .../type-aliases/reactformextendedapi.md | 34 + .../react/reference/type-aliases/usefield.md | 66 ++ .../solid/reference/functions/createfield.md | 64 ++ .../solid/reference/functions/createform.md | 42 + .../solid/reference/functions/field.md | 60 ++ .../solid/reference/functions/usestore.md | 62 ++ docs/framework/solid/reference/index.md | 22 + .../reference/interfaces/solidformapi.md | 106 +++ .../reference/type-aliases/createfield.md | 66 ++ .../reference/type-aliases/fieldcomponent.md | 68 ++ .../vue/reference/functions/usefield.md | 72 ++ .../vue/reference/functions/useform.md | 42 + .../vue/reference/functions/usestore.md | 62 ++ docs/framework/vue/reference/index.md | 27 + .../vue/reference/interfaces/vuefieldapi.md | 38 + .../vue/reference/interfaces/vueformapi.md | 82 ++ .../reference/type-aliases/fieldcomponent.md | 52 ++ .../type-aliases/fieldcomponentprops.md | 50 ++ .../vue/reference/type-aliases/usefield.md | 74 ++ .../vue/reference/variables/field.md | 22 + docs/reference/classes/fieldapi.md | 564 ++++++++++++ docs/reference/classes/formapi.md | 810 ++++++++++++++++++ docs/reference/functions/formoptions.md | 45 + .../functions/isglobalformvalidationerror.md | 22 + .../functions/isstandardschemavalidator.md | 22 + docs/reference/functions/mergeform.md | 30 + docs/reference/functions/shallow.md | 30 + docs/reference/index.md | 67 ++ docs/reference/interfaces/fieldapioptions.md | 190 ++++ docs/reference/interfaces/fieldlisteners.md | 56 ++ docs/reference/interfaces/fieldoptions.md | 132 +++ docs/reference/interfaces/fieldvalidators.md | 202 +++++ docs/reference/interfaces/formoptions.md | 156 ++++ docs/reference/interfaces/formvalidators.md | 130 +++ .../interfaces/standardschemav1issue.md | 34 + docs/reference/type-aliases/anyfieldapi.md | 14 + docs/reference/type-aliases/anyfieldmeta.md | 12 + .../type-aliases/anyfieldmetabase.md | 12 + .../type-aliases/anyfieldmetaderived.md | 12 + docs/reference/type-aliases/anyformapi.md | 14 + docs/reference/type-aliases/anyformstate.md | 12 + docs/reference/type-aliases/baseformstate.md | 108 +++ docs/reference/type-aliases/deepkeys.md | 20 + docs/reference/type-aliases/deepvalue.md | 22 + .../type-aliases/derivedformstate.md | 138 +++ docs/reference/type-aliases/fieldinfo.md | 38 + docs/reference/type-aliases/fieldmeta.md | 50 ++ docs/reference/type-aliases/fieldmetabase.md | 90 ++ .../type-aliases/fieldmetaderived.md | 73 ++ docs/reference/type-aliases/fieldstate.md | 68 ++ docs/reference/type-aliases/formstate.md | 32 + docs/reference/type-aliases/formvalidatefn.md | 32 + .../type-aliases/formvalidationerror.md | 18 + docs/reference/type-aliases/formvalidator.md | 58 ++ .../type-aliases/standardschemav1.md | 30 + .../tstandardschemavalidatorvalue.md | 30 + .../unwrapfieldasyncvalidateorfn.md | 25 + .../type-aliases/unwrapfieldvalidateorfn.md | 25 + .../unwrapformasyncvalidateorfn.md | 16 + .../type-aliases/unwrapformvalidateorfn.md | 16 + .../type-aliases/unwraponelevelofarray.md | 16 + docs/reference/type-aliases/updater.md | 18 + docs/reference/type-aliases/updaterfn.md | 28 + .../reference/type-aliases/validationerror.md | 12 + docs/reference/type-aliases/validationmeta.md | 24 + .../type-aliases/validationsource.md | 12 + .../variables/standardschemavalidators.md | 57 ++ 81 files changed, 5800 insertions(+) create mode 100644 docs/framework/angular/reference/classes/tanstackfield.md create mode 100644 docs/framework/angular/reference/functions/injectform.md create mode 100644 docs/framework/angular/reference/functions/injectstore.md create mode 100644 docs/framework/angular/reference/index.md create mode 100644 docs/framework/lit/reference/classes/tanstackformcontroller.md create mode 100644 docs/framework/lit/reference/index.md create mode 100644 docs/framework/react/reference/functions/field.md create mode 100644 docs/framework/react/reference/functions/usefield.md create mode 100644 docs/framework/react/reference/functions/useform.md create mode 100644 docs/framework/react/reference/functions/usestore.md create mode 100644 docs/framework/react/reference/functions/usetransform.md create mode 100644 docs/framework/react/reference/index.md create mode 100644 docs/framework/react/reference/interfaces/reactformapi.md create mode 100644 docs/framework/react/reference/type-aliases/fieldcomponent.md create mode 100644 docs/framework/react/reference/type-aliases/reactformextendedapi.md create mode 100644 docs/framework/react/reference/type-aliases/usefield.md create mode 100644 docs/framework/solid/reference/functions/createfield.md create mode 100644 docs/framework/solid/reference/functions/createform.md create mode 100644 docs/framework/solid/reference/functions/field.md create mode 100644 docs/framework/solid/reference/functions/usestore.md create mode 100644 docs/framework/solid/reference/index.md create mode 100644 docs/framework/solid/reference/interfaces/solidformapi.md create mode 100644 docs/framework/solid/reference/type-aliases/createfield.md create mode 100644 docs/framework/solid/reference/type-aliases/fieldcomponent.md create mode 100644 docs/framework/vue/reference/functions/usefield.md create mode 100644 docs/framework/vue/reference/functions/useform.md create mode 100644 docs/framework/vue/reference/functions/usestore.md create mode 100644 docs/framework/vue/reference/index.md create mode 100644 docs/framework/vue/reference/interfaces/vuefieldapi.md create mode 100644 docs/framework/vue/reference/interfaces/vueformapi.md create mode 100644 docs/framework/vue/reference/type-aliases/fieldcomponent.md create mode 100644 docs/framework/vue/reference/type-aliases/fieldcomponentprops.md create mode 100644 docs/framework/vue/reference/type-aliases/usefield.md create mode 100644 docs/framework/vue/reference/variables/field.md create mode 100644 docs/reference/classes/fieldapi.md create mode 100644 docs/reference/classes/formapi.md create mode 100644 docs/reference/functions/formoptions.md create mode 100644 docs/reference/functions/isglobalformvalidationerror.md create mode 100644 docs/reference/functions/isstandardschemavalidator.md create mode 100644 docs/reference/functions/mergeform.md create mode 100644 docs/reference/functions/shallow.md create mode 100644 docs/reference/index.md create mode 100644 docs/reference/interfaces/fieldapioptions.md create mode 100644 docs/reference/interfaces/fieldlisteners.md create mode 100644 docs/reference/interfaces/fieldoptions.md create mode 100644 docs/reference/interfaces/fieldvalidators.md create mode 100644 docs/reference/interfaces/formoptions.md create mode 100644 docs/reference/interfaces/formvalidators.md create mode 100644 docs/reference/interfaces/standardschemav1issue.md create mode 100644 docs/reference/type-aliases/anyfieldapi.md create mode 100644 docs/reference/type-aliases/anyfieldmeta.md create mode 100644 docs/reference/type-aliases/anyfieldmetabase.md create mode 100644 docs/reference/type-aliases/anyfieldmetaderived.md create mode 100644 docs/reference/type-aliases/anyformapi.md create mode 100644 docs/reference/type-aliases/anyformstate.md create mode 100644 docs/reference/type-aliases/baseformstate.md create mode 100644 docs/reference/type-aliases/deepkeys.md create mode 100644 docs/reference/type-aliases/deepvalue.md create mode 100644 docs/reference/type-aliases/derivedformstate.md create mode 100644 docs/reference/type-aliases/fieldinfo.md create mode 100644 docs/reference/type-aliases/fieldmeta.md create mode 100644 docs/reference/type-aliases/fieldmetabase.md create mode 100644 docs/reference/type-aliases/fieldmetaderived.md create mode 100644 docs/reference/type-aliases/fieldstate.md create mode 100644 docs/reference/type-aliases/formstate.md create mode 100644 docs/reference/type-aliases/formvalidatefn.md create mode 100644 docs/reference/type-aliases/formvalidationerror.md create mode 100644 docs/reference/type-aliases/formvalidator.md create mode 100644 docs/reference/type-aliases/standardschemav1.md create mode 100644 docs/reference/type-aliases/tstandardschemavalidatorvalue.md create mode 100644 docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md create mode 100644 docs/reference/type-aliases/unwrapfieldvalidateorfn.md create mode 100644 docs/reference/type-aliases/unwrapformasyncvalidateorfn.md create mode 100644 docs/reference/type-aliases/unwrapformvalidateorfn.md create mode 100644 docs/reference/type-aliases/unwraponelevelofarray.md create mode 100644 docs/reference/type-aliases/updater.md create mode 100644 docs/reference/type-aliases/updaterfn.md create mode 100644 docs/reference/type-aliases/validationerror.md create mode 100644 docs/reference/type-aliases/validationmeta.md create mode 100644 docs/reference/type-aliases/validationsource.md create 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 new file mode 100644 index 0000000000..1f82a06b44 --- /dev/null +++ b/docs/framework/angular/reference/classes/tanstackfield.md @@ -0,0 +1,317 @@ +--- +id: TanStackField +title: TanStackField +--- + +# Class: TanStackField\ + +Defined in: [tanstack-field.directive.ts:32](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L32) + +## 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`\> + +## 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`\> + +## Properties + +### api + +```ts +api: FieldApi; +``` + +Defined in: [tanstack-field.directive.ts:131](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L131) + +*** + +### asyncAlways? + +```ts +optional asyncAlways: boolean; +``` + +Defined in: [tanstack-field.directive.ts:81](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L81) + +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:80](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80) + +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:108](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L108) + +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:79](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L79) + +An optional default value for the field. + +#### Implementation of + +```ts +FieldOptions.defaultValue +``` + +*** + +### disableErrorFlat? + +```ts +optional disableErrorFlat: boolean; +``` + +Defined in: [tanstack-field.directive.ts:129](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L129) + +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:107](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L107) + +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:82](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L82) + +*** + +### 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:93](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L93) + +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 new file mode 100644 index 0000000000..2d1390639c --- /dev/null +++ b/docs/framework/angular/reference/functions/injectform.md @@ -0,0 +1,42 @@ +--- +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`\> + +## Parameters + +### opts? + +`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +## Returns + +`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md new file mode 100644 index 0000000000..0d19fc8de4 --- /dev/null +++ b/docs/framework/angular/reference/functions/injectstore.md @@ -0,0 +1,48 @@ +--- +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`\> + +• **TSelected** = `NoInfer`\<`FormState`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\>\> + +## Parameters + +### form + +`FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +### selector? + +(`state`) => `TSelected` + +## Returns + +`Signal`\<`TSelected`\> diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md new file mode 100644 index 0000000000..aab1d7b1d1 --- /dev/null +++ b/docs/framework/angular/reference/index.md @@ -0,0 +1,15 @@ +--- +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 new file mode 100644 index 0000000000..8523a27157 --- /dev/null +++ b/docs/framework/lit/reference/classes/tanstackformcontroller.md @@ -0,0 +1,183 @@ +--- +id: TanStackFormController +title: TanStackFormController +--- + +# Class: TanStackFormController\ + +Defined in: [tanstack-form-controller.ts:183](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L183) + +## 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`\> + +## Implements + +- `ReactiveController` + +## Constructors + +### new TanStackFormController() + +```ts +new TanStackFormController(host, config?): TanStackFormController +``` + +Defined in: [tanstack-form-controller.ts:210](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L210) + +#### Parameters + +##### host + +`ReactiveControllerHost` + +##### config? + +`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +#### Returns + +[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Properties + +### api + +```ts +api: FormApi; +``` + +Defined in: [tanstack-form-controller.ts:198](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L198) + +## Methods + +### field() + +```ts +field(fieldConfig, render): object +``` + +Defined in: [tanstack-form-controller.ts:249](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L249) + +#### 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`\> + +#### 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:239](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L239) + +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:245](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L245) + +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 new file mode 100644 index 0000000000..4215a31714 --- /dev/null +++ b/docs/framework/lit/reference/index.md @@ -0,0 +1,10 @@ +--- +id: "@tanstack/lit-form" +title: "@tanstack/lit-form" +--- + +# @tanstack/lit-form + +## Classes + +- [TanStackFormController](classes/tanstackformcontroller.md) diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md new file mode 100644 index 0000000000..4bdf6c2eff --- /dev/null +++ b/docs/framework/react/reference/functions/field.md @@ -0,0 +1,64 @@ +--- +id: Field +title: Field +--- + +# Function: Field() + +```ts +function Field(__namedParameters): ReactNode +``` + +Defined in: [packages/react-form/src/useField.tsx:352](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L352) + +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`\> + +## Parameters + +### \_\_namedParameters + +`FieldComponentProps`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Returns + +`ReactNode` diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md new file mode 100644 index 0000000000..f2e75d6460 --- /dev/null +++ b/docs/framework/react/reference/functions/usefield.md @@ -0,0 +1,66 @@ +--- +id: useField +title: useField +--- + +# Function: useField() + +```ts +function useField(opts): FieldApi & ReactFieldApi +``` + +Defined in: [packages/react-form/src/useField.tsx:125](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L125) + +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`\> + +## Parameters + +### opts + +`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +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`\> & `ReactFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +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 new file mode 100644 index 0000000000..a8dd55524f --- /dev/null +++ b/docs/framework/react/reference/functions/useform.md @@ -0,0 +1,46 @@ +--- +id: useForm +title: useForm +--- + +# Function: useForm() + +```ts +function useForm(opts?): ReactFormExtendedApi +``` + +Defined in: [packages/react-form/src/useForm.tsx:137](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L137) + +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`\> + +## Parameters + +### opts? + +`FormOptions`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +## Returns + +[`ReactFormExtendedApi`](../type-aliases/reactformextendedapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md new file mode 100644 index 0000000000..76f60a8b8e --- /dev/null +++ b/docs/framework/react/reference/functions/usestore.md @@ -0,0 +1,62 @@ +--- +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 new file mode 100644 index 0000000000..52b6a6f586 --- /dev/null +++ b/docs/framework/react/reference/functions/usetransform.md @@ -0,0 +1,46 @@ +--- +id: useTransform +title: useTransform +--- + +# Function: useTransform() + +```ts +function useTransform(fn, deps): FormTransform +``` + +Defined in: [packages/react-form/src/useTransform.ts:8](https://github.com/TanStack/form/blob/main/packages/react-form/src/useTransform.ts#L8) + +## 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`\> + +## Parameters + +### fn + +(`formBase`) => `FormApi`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +### deps + +`unknown`[] + +## Returns + +`FormTransform`\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md new file mode 100644 index 0000000000..599a63e0b7 --- /dev/null +++ b/docs/framework/react/reference/index.md @@ -0,0 +1,24 @@ +--- +id: "@tanstack/react-form" +title: "@tanstack/react-form" +--- + +# @tanstack/react-form + +## Interfaces + +- [ReactFormApi](interfaces/reactformapi.md) + +## Type Aliases + +- [FieldComponent](type-aliases/fieldcomponent.md) +- [ReactFormExtendedApi](type-aliases/reactformextendedapi.md) +- [UseField](type-aliases/usefield.md) + +## Functions + +- [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 new file mode 100644 index 0000000000..c11deb9c7c --- /dev/null +++ b/docs/framework/react/reference/interfaces/reactformapi.md @@ -0,0 +1,74 @@ +--- +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`\> + +## Properties + +### Field + +```ts +Field: FieldComponent; +``` + +Defined in: [packages/react-form/src/useForm.tsx:35](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L35) + +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:49](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L49) + +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/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md new file mode 100644 index 0000000000..f7d1388c03 --- /dev/null +++ b/docs/framework/react/reference/type-aliases/fieldcomponent.md @@ -0,0 +1,70 @@ +--- +id: FieldComponent +title: FieldComponent +--- + +# Type Alias: FieldComponent()\ + +```ts +type FieldComponent = ({ + children, + ...fieldOptions +}) => ReactNode; +``` + +Defined in: [packages/react-form/src/useField.tsx:294](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L294) + +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`\> + +## 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`\>, `"form"`\> + +## Returns + +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/reactformextendedapi.md b/docs/framework/react/reference/type-aliases/reactformextendedapi.md new file mode 100644 index 0000000000..66ca3973ea --- /dev/null +++ b/docs/framework/react/reference/type-aliases/reactformextendedapi.md @@ -0,0 +1,34 @@ +--- +id: ReactFormExtendedApi +title: ReactFormExtendedApi +--- + +# Type Alias: ReactFormExtendedApi\ + +```ts +type ReactFormExtendedApi = FormApi & ReactFormApi; +``` + +Defined in: [packages/react-form/src/useForm.tsx:86](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L86) + +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`\> diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md new file mode 100644 index 0000000000..2fdea33cb0 --- /dev/null +++ b/docs/framework/react/reference/type-aliases/usefield.md @@ -0,0 +1,66 @@ +--- +id: UseField +title: UseField +--- + +# Type Alias: UseField()\ + +```ts +type UseField = (opts) => FieldApi; +``` + +Defined in: [packages/react-form/src/useField.tsx:48](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L48) + +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`\> + +## 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`\>, `"form"`\> + +## Returns + +`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md new file mode 100644 index 0000000000..bb7a449ee6 --- /dev/null +++ b/docs/framework/solid/reference/functions/createfield.md @@ -0,0 +1,64 @@ +--- +id: createField +title: createField +--- + +# Function: createField() + +```ts +function createField(opts): () => FieldApi & SolidFieldApi +``` + +Defined in: [packages/solid-form/src/createField.tsx:225](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L225) + +## 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`\> + +## Parameters + +### opts + +() => `CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Returns + +`Function` + +### Returns + +`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md new file mode 100644 index 0000000000..eccd2d43d4 --- /dev/null +++ b/docs/framework/solid/reference/functions/createform.md @@ -0,0 +1,42 @@ +--- +id: createForm +title: createForm +--- + +# Function: createForm() + +```ts +function createForm(opts?): FormApi & SolidFormApi +``` + +Defined in: [packages/solid-form/src/createForm.tsx:114](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L114) + +## 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`\> + +## Parameters + +### opts? + +() => `FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Returns + +`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md new file mode 100644 index 0000000000..7c4edc74e7 --- /dev/null +++ b/docs/framework/solid/reference/functions/field.md @@ -0,0 +1,60 @@ +--- +id: Field +title: Field +--- + +# Function: Field() + +```ts +function Field(props): Element +``` + +Defined in: [packages/solid-form/src/createField.tsx:460](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L460) + +## 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`\> + +## Parameters + +### props + +`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `object` + +## Returns + +`Element` diff --git a/docs/framework/solid/reference/functions/usestore.md b/docs/framework/solid/reference/functions/usestore.md new file mode 100644 index 0000000000..bf10af9e46 --- /dev/null +++ b/docs/framework/solid/reference/functions/usestore.md @@ -0,0 +1,62 @@ +--- +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 new file mode 100644 index 0000000000..704a66cb77 --- /dev/null +++ b/docs/framework/solid/reference/index.md @@ -0,0 +1,22 @@ +--- +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 new file mode 100644 index 0000000000..4a13b75067 --- /dev/null +++ b/docs/framework/solid/reference/interfaces/solidformapi.md @@ -0,0 +1,106 @@ +--- +id: SolidFormApi +title: SolidFormApi +--- + +# Interface: SolidFormApi\ + +Defined in: [packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) + +## 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`\> + +## 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:27](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L27) + +*** + +### Subscribe() + +```ts +Subscribe: (props) => Element; +``` + +Defined in: [packages/solid-form/src/createForm.tsx:80](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L80) + +#### Type Parameters + +• **TSelected** = `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:49](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L49) + +#### Type Parameters + +• **TSelected** = `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 new file mode 100644 index 0000000000..6ee4c533f5 --- /dev/null +++ b/docs/framework/solid/reference/type-aliases/createfield.md @@ -0,0 +1,66 @@ +--- +id: CreateField +title: CreateField +--- + +# Type Alias: CreateField()\ + +```ts +type CreateField = (opts) => () => FieldApi & SolidFieldApi; +``` + +Defined in: [packages/solid-form/src/createField.tsx:47](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L47) + +## 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`\> + +## 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 + +() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>, `"form"`\> + +## Returns + +`Function` + +### Returns + +`FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & `SolidFieldApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md new file mode 100644 index 0000000000..0199395e6f --- /dev/null +++ b/docs/framework/solid/reference/type-aliases/fieldcomponent.md @@ -0,0 +1,68 @@ +--- +id: FieldComponent +title: FieldComponent +--- + +# Type Alias: FieldComponent()\ + +```ts +type FieldComponent = ({ + children, + ...fieldOptions +}) => JSXElement; +``` + +Defined in: [packages/solid-form/src/createField.tsx:407](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L407) + +## 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`\> + +## 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`\>, `"form"`\> + +## Returns + +`JSXElement` diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md new file mode 100644 index 0000000000..ebb68ccfd1 --- /dev/null +++ b/docs/framework/vue/reference/functions/usefield.md @@ -0,0 +1,72 @@ +--- +id: useField +title: useField +--- + +# Function: useField() + +```ts +function useField(opts): object +``` + +Defined in: [packages/vue-form/src/useField.tsx:291](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L291) + +## 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`\> + +## Parameters + +### opts + +`UseFieldOptions`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## 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 new file mode 100644 index 0000000000..a061b613f8 --- /dev/null +++ b/docs/framework/vue/reference/functions/useform.md @@ -0,0 +1,42 @@ +--- +id: useForm +title: useForm +--- + +# Function: useForm() + +```ts +function useForm(opts?): FormApi & VueFormApi +``` + +Defined in: [packages/vue-form/src/useForm.tsx:192](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L192) + +## 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`\> + +## Parameters + +### opts? + +`FormOptions`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Returns + +`FormApi`\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TParentData`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> diff --git a/docs/framework/vue/reference/functions/usestore.md b/docs/framework/vue/reference/functions/usestore.md new file mode 100644 index 0000000000..2967ed2cc5 --- /dev/null +++ b/docs/framework/vue/reference/functions/usestore.md @@ -0,0 +1,62 @@ +--- +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.7.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.7.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 new file mode 100644 index 0000000000..a265548afd --- /dev/null +++ b/docs/framework/vue/reference/index.md @@ -0,0 +1,27 @@ +--- +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 new file mode 100644 index 0000000000..7ac1e82d88 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/vuefieldapi.md @@ -0,0 +1,38 @@ +--- +id: VueFieldApi +title: VueFieldApi +--- + +# Interface: VueFieldApi\ + +Defined in: [packages/vue-form/src/useField.tsx:159](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L159) + +## 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`\> + +## Properties + +### Field + +```ts +Field: FieldComponent; +``` + +Defined in: [packages/vue-form/src/useField.tsx:170](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L170) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md new file mode 100644 index 0000000000..ad948871fe --- /dev/null +++ b/docs/framework/vue/reference/interfaces/vueformapi.md @@ -0,0 +1,82 @@ +--- +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`\> + +## Properties + +### Field + +```ts +Field: FieldComponent; +``` + +Defined in: [packages/vue-form/src/useForm.tsx:126](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L126) + +*** + +### Subscribe + +```ts +Subscribe: SubscribeComponent; +``` + +Defined in: [packages/vue-form/src/useForm.tsx:179](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L179) + +*** + +### useField + +```ts +useField: UseField; +``` + +Defined in: [packages/vue-form/src/useForm.tsx:137](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L137) + +*** + +### useStore() + +```ts +useStore: (selector?) => Readonly>; +``` + +Defined in: [packages/vue-form/src/useForm.tsx:148](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L148) + +#### 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 new file mode 100644 index 0000000000..ec31cb22fe --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/fieldcomponent.md @@ -0,0 +1,52 @@ +--- +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`\> + +## Parameters + +### props + +`Omit`\<[`FieldComponentProps`](fieldcomponentprops.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>, `"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`\>, `"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`\>; + `state`: `FieldApi`\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\>\[`"state"`\]; + \}; + \}\>\> diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md new file mode 100644 index 0000000000..54c77f8a9f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/fieldcomponentprops.md @@ -0,0 +1,50 @@ +--- +id: FieldComponentProps +title: FieldComponentProps +--- + +# Type Alias: FieldComponentProps\ + +```ts +type FieldComponentProps = UseFieldOptions; +``` + +Defined in: [packages/vue-form/src/useField.tsx:385](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L385) + +## 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`\> diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md new file mode 100644 index 0000000000..f54c91d467 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/usefield.md @@ -0,0 +1,74 @@ +--- +id: UseField +title: UseField +--- + +# Type Alias: UseField()\ + +```ts +type UseField = (opts) => object; +``` + +Defined in: [packages/vue-form/src/useField.tsx:183](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L183) + +## 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`\> + +## 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`\>, `"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 new file mode 100644 index 0000000000..99d3585ad8 --- /dev/null +++ b/docs/framework/vue/reference/variables/field.md @@ -0,0 +1,22 @@ +--- +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:431](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L431) + +## 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`\> & `object` & \{\} \| \{\}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, \{\}\> diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md new file mode 100644 index 0000000000..034c060a40 --- /dev/null +++ b/docs/reference/classes/fieldapi.md @@ -0,0 +1,564 @@ +--- +id: FieldApi +title: FieldApi +--- + +# Class: FieldApi\ + +Defined in: [packages/form-core/src/FieldApi.ts:832](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L832) + +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`\> + +## Constructors + +### new FieldApi() + +```ts +new FieldApi(opts): FieldApi +``` + +Defined in: [packages/form-core/src/FieldApi.ts:943](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L943) + +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`\> + +#### Returns + +[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TFormOnMount`, `TFormOnChange`, `TFormOnChangeAsync`, `TFormOnBlur`, `TFormOnBlurAsync`, `TFormOnSubmit`, `TFormOnSubmitAsync`, `TFormOnServer`\> + +## Properties + +### form + +```ts +form: FormApi; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:861](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L861) + +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:884](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L884) + +The field name. + +*** + +### options + +```ts +options: FieldApiOptions; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:888](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L888) + +The field options. + +*** + +### store + +```ts +store: Derived>; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:911](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L911) + +The field state store. + +*** + +### timeoutIds + +```ts +timeoutIds: Record; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:938](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L938) + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): FieldState +``` + +Defined in: [packages/form-core/src/FieldApi.ts:935](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L935) + +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:1189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1189) + +Gets the field information object. + +#### Returns + +[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`\> + +*** + +### getMeta() + +```ts +getMeta(): FieldMeta +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1157](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1157) + +#### 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:1139](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1139) + +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:1561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1561) + +Handles the blur event. + +#### Returns + +`void` + +*** + +### handleChange() + +```ts +handleChange(updater): void +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1554) + +Handles the change event. + +#### Parameters + +##### updater + +[`Updater`](../type-aliases/updater.md)\<`TData`\> + +#### Returns + +`void` + +*** + +### insertValue() + +```ts +insertValue( + index, + value, +opts?): Promise +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1202) + +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 + +`Promise`\<`void`\> + +*** + +### mount() + +```ts +mount(): () => void +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1046](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1046) + +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:1232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1232) + +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:1194](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1194) + +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?): Promise +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1220) + +Removes a value at the specified index. + +#### Parameters + +##### index + +`number` + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`Promise`\<`void`\> + +*** + +### replaceValue() + +```ts +replaceValue( + index, + value, +opts?): Promise +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1211](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1211) + +Replaces a value at the specified index. + +#### Parameters + +##### index + +`number` + +##### value + +`TData` *extends* `any`[] ? `TData`\<`TData`\>\[`number`\] : `never` + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`Promise`\<`void`\> + +*** + +### setErrorMap() + +```ts +setErrorMap(errorMap): void +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1581](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1581) + +Updates the field's errorMap + +#### Parameters + +##### errorMap + +`ValidationErrorMap` + +#### Returns + +`void` + +*** + +### setMeta() + +```ts +setMeta(updater): void +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1162](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1162) + +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:1146](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1146) + +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:1226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1226) + +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:1088](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1088) + +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`\> + +#### Returns + +`void` + +*** + +### validate() + +```ts +validate(cause, opts?): unknown[] | Promise +``` + +Defined in: [packages/form-core/src/FieldApi.ts:1521](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1521) + +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 new file mode 100644 index 0000000000..6f90aa8a74 --- /dev/null +++ b/docs/reference/classes/formapi.md @@ -0,0 +1,810 @@ +--- +id: FormApi +title: FormApi +--- + +# Class: FormApi\ + +Defined in: [packages/form-core/src/FormApi.ts:622](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L622) + +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`\> + +## Constructors + +### new FormApi() + +```ts +new FormApi(opts?): FormApi +``` + +Defined in: [packages/form-core/src/FormApi.ts:691](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L691) + +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`\> + +#### Returns + +[`FormApi`](formapi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +## Properties + +### baseStore + +```ts +baseStore: Store>; +``` + +Defined in: [packages/form-core/src/FormApi.ts:647](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L647) + +*** + +### 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:677](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L677) + +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:660](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L660) + +*** + +### options + +```ts +options: FormOptions = {}; +``` + +Defined in: [packages/form-core/src/FormApi.ts:636](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L636) + +The options for the form. + +*** + +### store + +```ts +store: Derived>; +``` + +Defined in: [packages/form-core/src/FormApi.ts:661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L661) + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): FormState +``` + +Defined in: [packages/form-core/src/FormApi.ts:679](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L679) + +##### 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:1661](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1661) + +#### Type Parameters + +• **TField** *extends* `string` \| `number` + +#### Parameters + +##### field + +`TField` + +#### Returns + +`void` + +*** + +### getAllErrors() + +```ts +getAllErrors(): object +``` + +Defined in: [packages/form-core/src/FormApi.ts:1872](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1872) + +Returns form and field level errors + +#### Returns + +`object` + +##### fields + +```ts +fields: Record; +``` + +##### form + +```ts +form: object; +``` + +###### form.errorMap + +```ts +errorMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", unknown>; +``` + +###### 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:1570](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1570) + +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:1561](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1561) + +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:1554](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1554) + +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() + +```ts +handleSubmit(): Promise +``` + +Defined in: [packages/form-core/src/FormApi.ts:1485](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1485) + +Handles the form submission, performs validation, and calls the appropriate onSubmit or onInvalidSubmit callbacks. + +#### Returns + +`Promise`\<`void`\> + +*** + +### insertFieldValue() + +```ts +insertFieldValue( + field, + index, + value, +opts?): Promise +``` + +Defined in: [packages/form-core/src/FormApi.ts:1690](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1690) + +#### Type Parameters + +• **TField** *extends* `string` \| `number` + +#### Parameters + +##### field + +`TField` + +##### index + +`number` + +##### value + +[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`Promise`\<`void`\> + +*** + +### mount() + +```ts +mount(): () => void +``` + +Defined in: [packages/form-core/src/FormApi.ts:989](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L989) + +#### Returns + +`Function` + +##### Returns + +`void` + +*** + +### moveFieldValues() + +```ts +moveFieldValues( + field, + index1, + index2, + opts?): void +``` + +Defined in: [packages/form-core/src/FormApi.ts:1819](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1819) + +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:1675](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1675) + +Pushes a value into an array field. + +#### Type Parameters + +• **TField** *extends* `string` \| `number` + +#### Parameters + +##### field + +`TField` + +##### value + +[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`void` + +*** + +### removeFieldValue() + +```ts +removeFieldValue( + field, + index, +opts?): Promise +``` + +Defined in: [packages/form-core/src/FormApi.ts:1748](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1748) + +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:1722](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1722) + +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`, `IsNullable`\<`TFormData`\>\> *extends* `any`[] ? `any`[] & [`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\>\[`number`\] : `never` + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`Promise`\<`void`\> + +*** + +### reset() + +```ts +reset(values?, opts?): void +``` + +Defined in: [packages/form-core/src/FormApi.ts:1064](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1064) + +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:1607](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1607) + +#### 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:1846](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1846) + +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:1589](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1589) + +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:1631](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1631) + +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`, `IsNullable`\<`TFormData`\>\>\> + +##### opts? + +`UpdateMetaOptions` + +#### Returns + +`void` + +*** + +### swapFieldValues() + +```ts +swapFieldValues( + field, + index1, + index2, + opts?): void +``` + +Defined in: [packages/form-core/src/FormApi.ts:1790](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1790) + +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:1006](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1006) + +Updates the form options and form state. + +#### Parameters + +##### options? + +[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +#### Returns + +`void` + +*** + +### validateAllFields() + +```ts +validateAllFields(cause): Promise +``` + +Defined in: [packages/form-core/src/FormApi.ts:1090](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1090) + +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:1120](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1120) + +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:1159](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1159) + +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 new file mode 100644 index 0000000000..606254e447 --- /dev/null +++ b/docs/reference/functions/formoptions.md @@ -0,0 +1,45 @@ +--- +id: formOptions +title: formOptions +--- + +# Function: formOptions() + +```ts +function formOptions(defaultOpts?): + | undefined +| FormOptions +``` + +Defined in: [packages/form-core/src/formOptions.ts:7](https://github.com/TanStack/form/blob/main/packages/form-core/src/formOptions.ts#L7) + +## 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`\> + +## Parameters + +### defaultOpts? + +[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> + +## Returns + + \| `undefined` + \| [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnServer`\> diff --git a/docs/reference/functions/isglobalformvalidationerror.md b/docs/reference/functions/isglobalformvalidationerror.md new file mode 100644 index 0000000000..a771692c42 --- /dev/null +++ b/docs/reference/functions/isglobalformvalidationerror.md @@ -0,0 +1,22 @@ +--- +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 new file mode 100644 index 0000000000..4aeab95bdf --- /dev/null +++ b/docs/reference/functions/isstandardschemavalidator.md @@ -0,0 +1,22 @@ +--- +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 new file mode 100644 index 0000000000..f5bbb18587 --- /dev/null +++ b/docs/reference/functions/mergeform.md @@ -0,0 +1,30 @@ +--- +id: mergeForm +title: mergeForm +--- + +# Function: mergeForm() + +```ts +function mergeForm(baseForm, state): FormApi, any, any, any, any, any, any, any, any> +``` + +Defined in: [packages/form-core/src/mergeForm.ts:74](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L74) + +## Type Parameters + +• **TFormData** + +## Parameters + +### baseForm + +[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `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`\> diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md new file mode 100644 index 0000000000..34c6411893 --- /dev/null +++ b/docs/reference/functions/shallow.md @@ -0,0 +1,30 @@ +--- +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 new file mode 100644 index 0000000000..545c5b5b0f --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,67 @@ +--- +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) +- [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) +- [UnwrapOneLevelOfArray](type-aliases/unwraponelevelofarray.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 new file mode 100644 index 0000000000..51e00a278a --- /dev/null +++ b/docs/reference/interfaces/fieldapioptions.md @@ -0,0 +1,190 @@ +--- +id: FieldApiOptions +title: FieldApiOptions +--- + +# Interface: FieldApiOptions\ + +Defined in: [packages/form-core/src/FieldApi.ts:423](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L423) + +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`\> + +## Properties + +### asyncAlways? + +```ts +optional asyncAlways: boolean; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L370) + +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:366](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L366) + +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:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L389) + +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:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) + +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:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417) + +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:460](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L460) + +*** + +### listeners? + +```ts +optional listeners: FieldListeners; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) + +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:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) + +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:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L374) + +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 new file mode 100644 index 0000000000..d2a6a3a7ef --- /dev/null +++ b/docs/reference/interfaces/fieldlisteners.md @@ -0,0 +1,56 @@ +--- +id: FieldListeners +title: FieldListeners +--- + +# Interface: FieldListeners\ + +Defined in: [packages/form-core/src/FieldApi.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L323) + +## 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:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L329) + +*** + +### onChange? + +```ts +optional onChange: FieldListenerFn; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L328) + +*** + +### onMount? + +```ts +optional onMount: FieldListenerFn; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:330](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L330) + +*** + +### onSubmit? + +```ts +optional onSubmit: FieldListenerFn; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:331](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L331) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md new file mode 100644 index 0000000000..12300fc75d --- /dev/null +++ b/docs/reference/interfaces/fieldoptions.md @@ -0,0 +1,132 @@ +--- +id: FieldOptions +title: FieldOptions +--- + +# Interface: FieldOptions\ + +Defined in: [packages/form-core/src/FieldApi.ts:337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L337) + +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:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L370) + +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:366](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L366) + +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:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L389) + +An optional object with default metadata for the field. + +*** + +### defaultValue? + +```ts +optional defaultValue: NoInfer; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) + +An optional default value for the field. + +*** + +### disableErrorFlat? + +```ts +optional disableErrorFlat: boolean; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L417) + +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:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L413) + +A list of listeners which attach to the corresponding events + +*** + +### name + +```ts +name: TName; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L358) + +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:374](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L374) + +A list of validators to pass to the field diff --git a/docs/reference/interfaces/fieldvalidators.md b/docs/reference/interfaces/fieldvalidators.md new file mode 100644 index 0000000000..1bce2beb92 --- /dev/null +++ b/docs/reference/interfaces/fieldvalidators.md @@ -0,0 +1,202 @@ +--- +id: FieldValidators +title: FieldValidators +--- + +# Interface: FieldValidators\ + +Defined in: [packages/form-core/src/FieldApi.ts:242](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L242) + +## 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:291](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L291) + +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:297](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L297) + +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:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L304) + +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:308](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L308) + +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:269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L269) + +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:275](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L275) + +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:281](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L281) + +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:285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L285) + +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:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L263) + +An optional function, that runs on the mount event of input. + +*** + +### onSubmit? + +```ts +optional onSubmit: TOnSubmit; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:314](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L314) + +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:320](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L320) + +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/formoptions.md b/docs/reference/interfaces/formoptions.md new file mode 100644 index 0000000000..70ddb79eb3 --- /dev/null +++ b/docs/reference/interfaces/formoptions.md @@ -0,0 +1,156 @@ +--- +id: FormOptions +title: FormOptions +--- + +# Interface: FormOptions\ + +Defined in: [packages/form-core/src/FormApi.ts:232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L232) + +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`\> + +## Properties + +### asyncAlways? + +```ts +optional asyncAlways: boolean; +``` + +Defined in: [packages/form-core/src/FormApi.ts:266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L266) + +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:270](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L270) + +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:250](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L250) + +The default state for the form. + +*** + +### defaultValues? + +```ts +optional defaultValues: TFormData; +``` + +Defined in: [packages/form-core/src/FormApi.ts:246](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L246) + +Set initial values for your form. + +*** + +### onSubmit()? + +```ts +optional onSubmit: (props) => any; +``` + +Defined in: [packages/form-core/src/FormApi.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L287) + +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`\> + +###### value + +`TFormData` + +#### Returns + +`any` + +*** + +### onSubmitInvalid()? + +```ts +optional onSubmitInvalid: (props) => void; +``` + +Defined in: [packages/form-core/src/FormApi.ts:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L304) + +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`\> + +###### value + +`TFormData` + +#### Returns + +`void` + +*** + +### transform? + +```ts +optional transform: FormTransform; +``` + +Defined in: [packages/form-core/src/FormApi.ts:318](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L318) + +*** + +### validators? + +```ts +optional validators: FormValidators; +``` + +Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274) + +A list of validators to pass to the form diff --git a/docs/reference/interfaces/formvalidators.md b/docs/reference/interfaces/formvalidators.md new file mode 100644 index 0000000000..41b1c336f0 --- /dev/null +++ b/docs/reference/interfaces/formvalidators.md @@ -0,0 +1,130 @@ +--- +id: FormValidators +title: FormValidators +--- + +# Interface: FormValidators\ + +Defined in: [packages/form-core/src/FormApi.ts:147](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L147) + +## 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:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L176) + +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:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L180) + +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:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L184) + +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:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L164) + +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:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L168) + +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:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L172) + +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:160](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L160) + +Optional function that fires as soon as the component mounts. + +*** + +### onSubmit? + +```ts +optional onSubmit: TOnSubmit; +``` + +Defined in: [packages/form-core/src/FormApi.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L185) + +*** + +### onSubmitAsync? + +```ts +optional onSubmitAsync: TOnSubmitAsync; +``` + +Defined in: [packages/form-core/src/FormApi.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L186) diff --git a/docs/reference/interfaces/standardschemav1issue.md b/docs/reference/interfaces/standardschemav1issue.md new file mode 100644 index 0000000000..d8a5f51407 --- /dev/null +++ b/docs/reference/interfaces/standardschemav1issue.md @@ -0,0 +1,34 @@ +--- +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 new file mode 100644 index 0000000000..b1023743ad --- /dev/null +++ b/docs/reference/type-aliases/anyfieldapi.md @@ -0,0 +1,14 @@ +--- +id: AnyFieldApi +title: AnyFieldApi +--- + +# Type Alias: AnyFieldApi + +```ts +type AnyFieldApi = FieldApi; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:802](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L802) + +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 new file mode 100644 index 0000000000..e6af8d6711 --- /dev/null +++ b/docs/reference/type-aliases/anyfieldmeta.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldMeta +title: AnyFieldMeta +--- + +# Type Alias: AnyFieldMeta + +```ts +type AnyFieldMeta = FieldMeta; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:721](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L721) diff --git a/docs/reference/type-aliases/anyfieldmetabase.md b/docs/reference/type-aliases/anyfieldmetabase.md new file mode 100644 index 0000000000..2ecf5cd423 --- /dev/null +++ b/docs/reference/type-aliases/anyfieldmetabase.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldMetaBase +title: AnyFieldMetaBase +--- + +# Type Alias: AnyFieldMetaBase + +```ts +type AnyFieldMetaBase = FieldMetaBase; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L543) diff --git a/docs/reference/type-aliases/anyfieldmetaderived.md b/docs/reference/type-aliases/anyfieldmetaderived.md new file mode 100644 index 0000000000..11ab936fa4 --- /dev/null +++ b/docs/reference/type-aliases/anyfieldmetaderived.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldMetaDerived +title: AnyFieldMetaDerived +--- + +# Type Alias: AnyFieldMetaDerived + +```ts +type AnyFieldMetaDerived = FieldMetaDerived; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:635](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L635) diff --git a/docs/reference/type-aliases/anyformapi.md b/docs/reference/type-aliases/anyformapi.md new file mode 100644 index 0000000000..2e3e5e04df --- /dev/null +++ b/docs/reference/type-aliases/anyformapi.md @@ -0,0 +1,14 @@ +--- +id: AnyFormApi +title: AnyFormApi +--- + +# Type Alias: AnyFormApi + +```ts +type AnyFormApi = FormApi; +``` + +Defined in: [packages/form-core/src/FormApi.ts:613](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L613) + +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 new file mode 100644 index 0000000000..4ff923f5fa --- /dev/null +++ b/docs/reference/type-aliases/anyformstate.md @@ -0,0 +1,12 @@ +--- +id: AnyFormState +title: AnyFormState +--- + +# Type Alias: AnyFormState + +```ts +type AnyFormState = FormState; +``` + +Defined in: [packages/form-core/src/FormApi.ts:543](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L543) diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md new file mode 100644 index 0000000000..6ff1511eb5 --- /dev/null +++ b/docs/reference/type-aliases/baseformstate.md @@ -0,0 +1,108 @@ +--- +id: BaseFormState +title: BaseFormState +--- + +# Type Alias: BaseFormState\ + +```ts +type BaseFormState = object; +``` + +Defined in: [packages/form-core/src/FormApi.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L377) + +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 + +### 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 + +### 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 new file mode 100644 index 0000000000..d3535e3b84 --- /dev/null +++ b/docs/reference/type-aliases/deepkeys.md @@ -0,0 +1,20 @@ +--- +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:87](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L87) + +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 new file mode 100644 index 0000000000..9cc682ab6d --- /dev/null +++ b/docs/reference/type-aliases/deepvalue.md @@ -0,0 +1,22 @@ +--- +id: DeepValue +title: DeepValue +--- + +# Type Alias: DeepValue\ + +```ts +type DeepValue = unknown extends TValue ? TValue : TValue extends ReadonlyArray ? TAccessor extends `[${infer TBrackets}].${infer TAfter}` ? DeepValue, TAfter> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends keyof TValue ? TValue[TAccessor] : TValue[TAccessor & number] : TValue extends Record ? TAccessor extends `${infer TBefore}[${infer TEverythingElse}` ? DeepValue, `[${TEverythingElse}`> : TAccessor extends `[${infer TBrackets}]` ? DeepValue : TAccessor extends `${infer TBefore}.${infer TAfter}` ? DeepValue, TAfter> : TAccessor extends string ? TNullable extends true ? Nullable : TValue[TAccessor] : never : never; +``` + +Defined in: [packages/form-core/src/util-types.ts:111](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L111) + +Infer the type of a deeply nested property within an object or an array. + +## Type Parameters + +• **TValue** + +• **TAccessor** + +• **TNullable** *extends* `boolean` = `IsNullable`\<`TValue`\> diff --git a/docs/reference/type-aliases/derivedformstate.md b/docs/reference/type-aliases/derivedformstate.md new file mode 100644 index 0000000000..fe6fe33c88 --- /dev/null +++ b/docs/reference/type-aliases/derivedformstate.md @@ -0,0 +1,138 @@ +--- +id: DerivedFormState +title: DerivedFormState +--- + +# Type Alias: DerivedFormState\ + +```ts +type DerivedFormState = object; +``` + +Defined in: [packages/form-core/src/FormApi.ts:440](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L440) + +## 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 new file mode 100644 index 0000000000..8e3427cb6f --- /dev/null +++ b/docs/reference/type-aliases/fieldinfo.md @@ -0,0 +1,38 @@ +--- +id: FieldInfo +title: FieldInfo +--- + +# Type Alias: FieldInfo\ + +```ts +type FieldInfo = object; +``` + +Defined in: [packages/form-core/src/FormApi.ts:344](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L344) + +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 new file mode 100644 index 0000000000..f5d85f842c --- /dev/null +++ b/docs/reference/type-aliases/fieldmeta.md @@ -0,0 +1,50 @@ +--- +id: FieldMeta +title: FieldMeta +--- + +# Type Alias: FieldMeta\ + +```ts +type FieldMeta = FieldMetaBase & FieldMetaDerived; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:658](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L658) + +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 new file mode 100644 index 0000000000..f7b3c10d91 --- /dev/null +++ b/docs/reference/type-aliases/fieldmetabase.md @@ -0,0 +1,90 @@ +--- +id: FieldMetaBase +title: FieldMetaBase +--- + +# Type Alias: FieldMetaBase\ + +```ts +type FieldMetaBase = object; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:473](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L473) + +## 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 new file mode 100644 index 0000000000..7f7251eacd --- /dev/null +++ b/docs/reference/type-aliases/fieldmetaderived.md @@ -0,0 +1,73 @@ +--- +id: FieldMetaDerived +title: FieldMetaDerived +--- + +# Type Alias: FieldMetaDerived\ + +```ts +type FieldMetaDerived = object; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:563](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L563) + +## 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 new file mode 100644 index 0000000000..096794d1b9 --- /dev/null +++ b/docs/reference/type-aliases/fieldstate.md @@ -0,0 +1,68 @@ +--- +id: FieldState +title: FieldState +--- + +# Type Alias: FieldState\ + +```ts +type FieldState = object; +``` + +Defined in: [packages/form-core/src/FieldApi.ts:744](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L744) + +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 new file mode 100644 index 0000000000..6b146bdc4b --- /dev/null +++ b/docs/reference/type-aliases/formstate.md @@ -0,0 +1,32 @@ +--- +id: FormState +title: FormState +--- + +# Type Alias: FormState\ + +```ts +type FormState = BaseFormState & DerivedFormState; +``` + +Defined in: [packages/form-core/src/FormApi.ts:510](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L510) + +## 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 new file mode 100644 index 0000000000..4d3e91f026 --- /dev/null +++ b/docs/reference/type-aliases/formvalidatefn.md @@ -0,0 +1,32 @@ +--- +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`\> + +#### value + +`TFormData` + +## Returns + +`unknown` diff --git a/docs/reference/type-aliases/formvalidationerror.md b/docs/reference/type-aliases/formvalidationerror.md new file mode 100644 index 0000000000..4b455b416a --- /dev/null +++ b/docs/reference/type-aliases/formvalidationerror.md @@ -0,0 +1,18 @@ +--- +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 new file mode 100644 index 0000000000..6929439e25 --- /dev/null +++ b/docs/reference/type-aliases/formvalidator.md @@ -0,0 +1,58 @@ +--- +id: FormValidator +title: FormValidator +--- + +# Type Alias: FormValidator\ + +```ts +type FormValidator = object; +``` + +Defined in: [packages/form-core/src/FormApi.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L117) + +## 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 new file mode 100644 index 0000000000..fe75351bf6 --- /dev/null +++ b/docs/reference/type-aliases/standardschemav1.md @@ -0,0 +1,30 @@ +--- +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 new file mode 100644 index 0000000000..b984ed7e0e --- /dev/null +++ b/docs/reference/type-aliases/tstandardschemavalidatorvalue.md @@ -0,0 +1,30 @@ +--- +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 new file mode 100644 index 0000000000..500eb59bb1 --- /dev/null +++ b/docs/reference/type-aliases/unwrapfieldasyncvalidateorfn.md @@ -0,0 +1,25 @@ +--- +id: UnwrapFieldAsyncValidateOrFn +title: UnwrapFieldAsyncValidateOrFn +--- + +# Type Alias: UnwrapFieldAsyncValidateOrFn\ + +```ts +type UnwrapFieldAsyncValidateOrFn = + | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined + | UnwrapFormAsyncValidateOrFn extends infer TFormValidateVal ? 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:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L184) + +## 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 new file mode 100644 index 0000000000..7f81338817 --- /dev/null +++ b/docs/reference/type-aliases/unwrapfieldvalidateorfn.md @@ -0,0 +1,25 @@ +--- +id: UnwrapFieldValidateOrFn +title: UnwrapFieldValidateOrFn +--- + +# Type Alias: UnwrapFieldValidateOrFn\ + +```ts +type UnwrapFieldValidateOrFn = + | [TFormValidateOrFn] extends [StandardSchemaV1] ? TName extends keyof TStandardOut ? StandardSchemaV1Issue[] : undefined : undefined + | UnwrapFormValidateOrFn extends infer TFormValidateVal ? 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:114](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L114) + +## 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 new file mode 100644 index 0000000000..f0c6a404c5 --- /dev/null +++ b/docs/reference/type-aliases/unwrapformasyncvalidateorfn.md @@ -0,0 +1,16 @@ +--- +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:139](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L139) + +## Type Parameters + +• **TValidateOrFn** *extends* `undefined` \| `FormAsyncValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwrapformvalidateorfn.md b/docs/reference/type-aliases/unwrapformvalidateorfn.md new file mode 100644 index 0000000000..f74081dfd2 --- /dev/null +++ b/docs/reference/type-aliases/unwrapformvalidateorfn.md @@ -0,0 +1,16 @@ +--- +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:88](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L88) + +## Type Parameters + +• **TValidateOrFn** *extends* `undefined` \| `FormValidateOrFn`\<`any`\> diff --git a/docs/reference/type-aliases/unwraponelevelofarray.md b/docs/reference/type-aliases/unwraponelevelofarray.md new file mode 100644 index 0000000000..1c24252b13 --- /dev/null +++ b/docs/reference/type-aliases/unwraponelevelofarray.md @@ -0,0 +1,16 @@ +--- +id: UnwrapOneLevelOfArray +title: UnwrapOneLevelOfArray +--- + +# Type Alias: UnwrapOneLevelOfArray\ + +```ts +type UnwrapOneLevelOfArray = T extends infer U[] ? U : T; +``` + +Defined in: [packages/form-core/src/util-types.ts:4](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L4) + +## Type Parameters + +• **T** diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md new file mode 100644 index 0000000000..c58c78c54f --- /dev/null +++ b/docs/reference/type-aliases/updater.md @@ -0,0 +1,18 @@ +--- +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 new file mode 100644 index 0000000000..62365f5fa3 --- /dev/null +++ b/docs/reference/type-aliases/updaterfn.md @@ -0,0 +1,28 @@ +--- +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 new file mode 100644 index 0000000000..5421ef7baf --- /dev/null +++ b/docs/reference/type-aliases/validationerror.md @@ -0,0 +1,12 @@ +--- +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 new file mode 100644 index 0000000000..c2616fbae6 --- /dev/null +++ b/docs/reference/type-aliases/validationmeta.md @@ -0,0 +1,24 @@ +--- +id: ValidationMeta +title: ValidationMeta +--- + +# Type Alias: ValidationMeta + +```ts +type ValidationMeta = object; +``` + +Defined in: [packages/form-core/src/FormApi.ts:334](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L334) + +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 new file mode 100644 index 0000000000..907c7e33bf --- /dev/null +++ b/docs/reference/type-aliases/validationsource.md @@ -0,0 +1,12 @@ +--- +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 new file mode 100644 index 0000000000..e94b3e430d --- /dev/null +++ b/docs/reference/variables/standardschemavalidators.md @@ -0,0 +1,57 @@ +--- +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`: \{\}; + \}\> From 19f4956221a914d5447662f453cc5a9e9a6df814 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Mon, 24 Feb 2025 08:08:17 +0100 Subject: [PATCH 08/11] chore: pr comments --- packages/form-core/src/FormApi.ts | 28 +++++------------------- packages/form-core/tests/FormApi.spec.ts | 2 +- 2 files changed, 6 insertions(+), 24 deletions(-) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index c4bd62a449..b3b3c912e9 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1870,45 +1870,27 @@ export class FormApi< * Returns form and field level errors */ getAllErrors = () => { - const reduceErrorMap = (errorMap: ValidationErrorMap) => { - return Object.entries(errorMap).reduce( - (errorAcc, [errorName, errorValue]) => { - if (errorValue != null) { - errorAcc[errorName as ValidationErrorMapKeys] = errorValue - } - - return errorAcc - }, - {} as Record, - ) - } - return { form: { errors: this.state.errors, - errorMap: reduceErrorMap(this.state.errorMap), + errorMap: this.state.errorMap, }, fields: Object.entries(this.state.fieldMeta).reduce( (acc, [fieldName, fieldMeta]) => { - // reduces error map down to keys with errors - const fieldErrors = reduceErrorMap( - (fieldMeta as AnyFieldMeta).errorMap, - ) - if ( - Object.keys(fieldErrors).length && + Object.keys(fieldMeta as AnyFieldMeta).length && (fieldMeta as AnyFieldMeta).errors.length ) { - acc[fieldName] = { + acc[fieldName as DeepKeys] = { errors: (fieldMeta as AnyFieldMeta).errors, - errorMap: fieldErrors, + errorMap: (fieldMeta as AnyFieldMeta).errorMap, } } return acc }, {} as Record< - string, + DeepKeys, { errors: ValidationError[]; errorMap: ValidationErrorMap } >, ), diff --git a/packages/form-core/tests/FormApi.spec.ts b/packages/form-core/tests/FormApi.spec.ts index fcaf56498a..73197daea4 100644 --- a/packages/form-core/tests/FormApi.spec.ts +++ b/packages/form-core/tests/FormApi.spec.ts @@ -1503,7 +1503,7 @@ describe('form api', () => { }) field.setValue('other') - expect(form.getAllErrors()).toStrictEqual({ + expect(form.getAllErrors()).toEqual({ fields: { name: { errors: ['onChange - field'], From a0dba4e2ed2cd0092a3fc92db29bb4c02f7938f3 Mon Sep 17 00:00:00 2001 From: Leonardo Montini Date: Mon, 24 Feb 2025 10:19:05 +0100 Subject: [PATCH 09/11] chore: add explicit type --- packages/form-core/src/FormApi.ts | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/packages/form-core/src/FormApi.ts b/packages/form-core/src/FormApi.ts index b3b3c912e9..a599b8cd5f 100644 --- a/packages/form-core/src/FormApi.ts +++ b/packages/form-core/src/FormApi.ts @@ -1869,7 +1869,34 @@ export class FormApi< /** * Returns form and field level errors */ - getAllErrors = () => { + getAllErrors = (): { + form: { + errors: Array< + | UnwrapFormValidateOrFn + | UnwrapFormValidateOrFn + | UnwrapFormAsyncValidateOrFn + | UnwrapFormValidateOrFn + | UnwrapFormAsyncValidateOrFn + | UnwrapFormValidateOrFn + | UnwrapFormAsyncValidateOrFn + | UnwrapFormAsyncValidateOrFn + > + errorMap: FormValidationErrorMap< + UnwrapFormValidateOrFn, + UnwrapFormValidateOrFn, + UnwrapFormAsyncValidateOrFn, + UnwrapFormValidateOrFn, + UnwrapFormAsyncValidateOrFn, + UnwrapFormValidateOrFn, + UnwrapFormAsyncValidateOrFn, + UnwrapFormAsyncValidateOrFn + > + } + fields: Record< + DeepKeys, + { errors: ValidationError[]; errorMap: ValidationErrorMap } + > + } => { return { form: { errors: this.state.errors, From ea951d0ae7b2bddd54a515829d8231197dfe77ea Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 24 Feb 2025 09:20:30 +0000 Subject: [PATCH 10/11] ci: apply automated fixes and generate docs --- docs/reference/classes/formapi.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md index 6f90aa8a74..49077da8b6 100644 --- a/docs/reference/classes/formapi.md +++ b/docs/reference/classes/formapi.md @@ -168,7 +168,7 @@ Returns form and field level errors ##### fields ```ts -fields: Record, { errorMap: ValidationErrorMap; errors: unknown[]; }>; @@ -183,7 +183,7 @@ form: object; ###### form.errorMap ```ts -errorMap: Record<"onChange" | "onBlur" | "onSubmit" | "onMount" | "onServer", unknown>; +errorMap: FormValidationErrorMap, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormValidateOrFn, UnwrapFormAsyncValidateOrFn, UnwrapFormAsyncValidateOrFn>; ``` ###### form.errors From 34c00fab9e94b54bb028fa6b45fbbb47feb4bb7b Mon Sep 17 00:00:00 2001 From: Leonardo Montini Date: Mon, 24 Feb 2025 20:14:10 +0100 Subject: [PATCH 11/11] test: add type tests for getAllErrors --- packages/form-core/tests/FormApi.test-d.ts | 57 ++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 packages/form-core/tests/FormApi.test-d.ts diff --git a/packages/form-core/tests/FormApi.test-d.ts b/packages/form-core/tests/FormApi.test-d.ts new file mode 100644 index 0000000000..220d483a8b --- /dev/null +++ b/packages/form-core/tests/FormApi.test-d.ts @@ -0,0 +1,57 @@ +import { assertType, it } from 'vitest' +import { FormApi } from '../src' +import type { ValidationError, ValidationErrorMap } from '../src' + +it('should return all errors matching the right type from getAllErrors', () => { + const form = new FormApi({ + defaultValues: { + firstName: '', + lastName: '', + }, + validators: { + onChange: () => ['onChange'] as const, + onMount: () => 10 as const, + onBlur: () => ({ onBlur: true as const, onBlurNumber: 1 }), + onSubmit: () => 'onSubmit' as const, + onBlurAsync: () => Promise.resolve('onBlurAsync' as const), + onChangeAsync: () => Promise.resolve('onChangeAsync' as const), + onSubmitAsync: () => Promise.resolve('onSubmitAsync' as const), + }, + }) + + const errors = form.getAllErrors() + + errors.form.errorMap.onChange + + assertType<{ + onBlur?: { onBlur: true; onBlurNumber: number } | 'onBlurAsync' + onChange?: readonly ['onChange'] | 'onChangeAsync' + onMount?: 10 + onSubmit?: 'onSubmit' | 'onSubmitAsync' + onServer?: undefined + }>(errors.form.errorMap) + + assertType< + ( + | readonly ['onChange'] + | 'onChangeAsync' + | 10 + | 'onSubmit' + | 'onSubmitAsync' + | { onBlur: true; onBlurNumber: number } + | 'onBlurAsync' + | undefined + )[] + >(errors.form.errors) + + assertType<{ + firstName: { + errors: ValidationError[] + errorMap: ValidationErrorMap + } + lastName: { + errors: ValidationError[] + errorMap: ValidationErrorMap + } + }>(errors.fields) +})