From c6419facebccfa68dc07b5541cd351a74a02ae71 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Wed, 22 Jan 2025 09:41:14 +0100 Subject: [PATCH 1/6] feat(core): field meta API --- packages/form-core/src/FieldApi.ts | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index 87dbaa650..84e96293b 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -4,7 +4,12 @@ import { standardSchemaValidator, } from './standardSchemaValidator' import { getAsyncValidatorArray, getBy, getSyncValidatorArray } from './utils' -import type { FieldInfo, FieldsErrorMapFromValidator, FormApi } from './FormApi' +import type { + FieldInfo, + FieldsErrorMapFromValidator, + FormApi, + FormState, +} from './FormApi' import type { StandardSchemaV1 } from './standardSchemaValidator' import type { UpdateMetaOptions, @@ -116,6 +121,13 @@ export type FieldListenerFn< fieldApi: FieldApi }) => void +/** + * @private + */ +export type FieldMetaFn = ( + props: FormState, +) => FieldMetaExtension + export interface FieldValidators< TParentData, TName extends DeepKeys, @@ -285,6 +297,7 @@ export interface FieldListeners< export interface FieldOptions< TParentData, TName extends DeepKeys, + TMetaExtension extends object, TFieldValidator extends | Validator, unknown> | undefined = undefined, @@ -337,6 +350,7 @@ export interface FieldOptions< TFormValidator, TData > + meta?: FieldMetaFn } /** @@ -396,10 +410,15 @@ export type FieldMetaDerived = { isPristine: boolean } +export type FieldMetaExtension = + TMetaExtension + /** * An object type representing the metadata of a field in a form. */ -export type FieldMeta = FieldMetaBase & FieldMetaDerived +export type FieldMeta = FieldMetaBase & + FieldMetaDerived & + FieldMetaExtension /** * An object type representing the state of a field. @@ -597,6 +616,11 @@ export class FieldApi< fieldApi: this, }) + this.setMeta((prev) => ({ + ...prev, + ...this.options.meta?.(this.form.state), + })) + return cleanup } @@ -661,6 +685,8 @@ export class FieldApi< getMeta = () => this.store.state.meta + meta = this.store.state.meta + /** * Sets the field metadata. */ From 06193dcd75102b90425142b2ca60bf29bb0032fa Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Mon, 27 Jan 2025 18:02:26 +0100 Subject: [PATCH 2/6] defualted generic and basic test --- packages/form-core/src/FieldApi.ts | 27 ++++++++++++++--------- packages/form-core/tests/FieldApi.spec.ts | 18 +++++++++++++++ 2 files changed, 34 insertions(+), 11 deletions(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index 84e96293b..3cb960726 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -126,7 +126,7 @@ export type FieldListenerFn< */ export type FieldMetaFn = ( props: FormState, -) => FieldMetaExtension +) => TMetaExtension export interface FieldValidators< TParentData, @@ -297,7 +297,6 @@ export interface FieldListeners< export interface FieldOptions< TParentData, TName extends DeepKeys, - TMetaExtension extends object, TFieldValidator extends | Validator, unknown> | undefined = undefined, @@ -305,6 +304,7 @@ export interface FieldOptions< | Validator | undefined = undefined, TData extends DeepValue = DeepValue, + TMetaExtension extends object = {}, > { /** * The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. @@ -410,20 +410,17 @@ export type FieldMetaDerived = { isPristine: boolean } -export type FieldMetaExtension = - TMetaExtension - /** * An object type representing the metadata of a field in a form. */ export type FieldMeta = FieldMetaBase & FieldMetaDerived & - FieldMetaExtension + TMetaExtension /** * An object type representing the state of a field. */ -export type FieldState = { +export type FieldState = { /** * The current value of the field. */ @@ -431,7 +428,7 @@ export type FieldState = { /** * The current metadata of the field. */ - meta: FieldMeta + meta: FieldMeta } /** @@ -453,6 +450,7 @@ export class FieldApi< | Validator | undefined = undefined, TData extends DeepValue = DeepValue, + TMetaExtension extends object = {}, > { /** * A reference to the form API instance. @@ -481,7 +479,7 @@ export class FieldApi< /** * The field state store. */ - store!: Derived> + store!: Derived> /** * The current field state. */ @@ -529,7 +527,7 @@ export class FieldApi< return { value, meta, - } as FieldState + } as FieldState }, }) @@ -657,6 +655,11 @@ export class FieldApi< this.setMeta(this.state.meta) } + this.setMeta((prev) => ({ + ...prev, + ...this.options.meta?.(this.form.state), + })) + this.options = opts as never this.name = opts.name } @@ -685,7 +688,9 @@ export class FieldApi< getMeta = () => this.store.state.meta - meta = this.store.state.meta + get meta() { + return this.store.state as FieldMeta + } /** * Sets the field metadata. diff --git a/packages/form-core/tests/FieldApi.spec.ts b/packages/form-core/tests/FieldApi.spec.ts index 157bda920..6eaedb69c 100644 --- a/packages/form-core/tests/FieldApi.spec.ts +++ b/packages/form-core/tests/FieldApi.spec.ts @@ -1760,4 +1760,22 @@ describe('field api', () => { nameField.mount() expect(nameField.getMeta().errors).toEqual(['THERE IS AN ERROR']) }) + + it('should have user defined meta', () => { + const form = new FormApi({ + defaultValues: { + name: '', + }, + }) + form.mount() + + const nameField = new FieldApi({ + form, + name: 'name', + meta: () => ({ dinosaur: true }), + }) + + nameField.mount() + expect(nameField.meta.dinosaur).toEqual(true) + }) }) From b81eddb76d18a17e81570b04b482864340f5f0a0 Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Wed, 29 Jan 2025 09:50:01 +0100 Subject: [PATCH 3/6] working mvp and improved test --- packages/form-core/src/FieldApi.ts | 24 +++++++++++------------ packages/form-core/tests/FieldApi.spec.ts | 16 ++++++++++++--- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index 3cb960726..40a10ceaa 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -125,8 +125,8 @@ export type FieldListenerFn< * @private */ export type FieldMetaFn = ( - props: FormState, -) => TMetaExtension + props: Derived>, +) => FieldMeta export interface FieldValidators< TParentData, @@ -366,12 +366,14 @@ export interface FieldApiOptions< | Validator | undefined = undefined, TData extends DeepValue = DeepValue, + TMetaExtension extends object = {}, > extends FieldOptions< TParentData, TName, TFieldValidator, TFormValidator, - TData + TData, + TMetaExtension > { form: FormApi } @@ -655,11 +657,6 @@ export class FieldApi< this.setMeta(this.state.meta) } - this.setMeta((prev) => ({ - ...prev, - ...this.options.meta?.(this.form.state), - })) - this.options = opts as never this.name = opts.name } @@ -683,14 +680,15 @@ export class FieldApi< fieldApi: this, }) + this.setMeta((prev) => ({ + ...prev, + ...this.options.meta?.(this.form.state), + })) + this.validate('change') } - getMeta = () => this.store.state.meta - - get meta() { - return this.store.state as FieldMeta - } + getMeta = () => this.store.state.meta as FieldMeta /** * Sets the field metadata. diff --git a/packages/form-core/tests/FieldApi.spec.ts b/packages/form-core/tests/FieldApi.spec.ts index 6eaedb69c..623618b04 100644 --- a/packages/form-core/tests/FieldApi.spec.ts +++ b/packages/form-core/tests/FieldApi.spec.ts @@ -1764,7 +1764,7 @@ describe('field api', () => { it('should have user defined meta', () => { const form = new FormApi({ defaultValues: { - name: '', + name: 'Stegosaurus', }, }) form.mount() @@ -1772,10 +1772,20 @@ describe('field api', () => { const nameField = new FieldApi({ form, name: 'name', - meta: () => ({ dinosaur: true }), + meta: ({ values }) => ({ + dinosaur: values.name === 'Stegosaurus' ? 'dino' : 'notDino', + }), }) nameField.mount() - expect(nameField.meta.dinosaur).toEqual(true) + + // cant infer dinosaur from getMeta() + expect(nameField.getMeta().dinosaur).toEqual('dino') + + nameField.handleChange('Cat') + + expect(nameField.state.value).toEqual('Cat') + + expect(nameField.getMeta().dinosaur).toEqual('notDino') }) }) From 25e4158184d34c717cf64e0f4c19230ca786f17c Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Wed, 29 Jan 2025 10:41:04 +0100 Subject: [PATCH 4/6] fixed Ts inferance --- packages/form-core/src/FieldApi.ts | 8 +++++--- packages/form-core/tests/FieldApi.spec.ts | 7 +------ 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index 40a10ceaa..f1686bc11 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -126,7 +126,7 @@ export type FieldListenerFn< */ export type FieldMetaFn = ( props: Derived>, -) => FieldMeta +) => TMetaExtension export interface FieldValidators< TParentData, @@ -476,7 +476,8 @@ export class FieldApi< TName, TFieldValidator, TFormValidator, - TData + TData, + TMetaExtension > = {} as any /** * The field state store. @@ -499,7 +500,8 @@ export class FieldApi< TName, TFieldValidator, TFormValidator, - TData + TData, + TMetaExtension >, ) { this.form = opts.form as never diff --git a/packages/form-core/tests/FieldApi.spec.ts b/packages/form-core/tests/FieldApi.spec.ts index 623618b04..dfdffe46f 100644 --- a/packages/form-core/tests/FieldApi.spec.ts +++ b/packages/form-core/tests/FieldApi.spec.ts @@ -1761,7 +1761,7 @@ describe('field api', () => { expect(nameField.getMeta().errors).toEqual(['THERE IS AN ERROR']) }) - it('should have user defined meta', () => { + it('should have user defined meta and react to value change', () => { const form = new FormApi({ defaultValues: { name: 'Stegosaurus', @@ -1778,14 +1778,9 @@ describe('field api', () => { }) nameField.mount() - - // cant infer dinosaur from getMeta() expect(nameField.getMeta().dinosaur).toEqual('dino') nameField.handleChange('Cat') - - expect(nameField.state.value).toEqual('Cat') - expect(nameField.getMeta().dinosaur).toEqual('notDino') }) }) From 3c6edaecf99a1e1d9df3f12a9a6e8a4a2ce34dda Mon Sep 17 00:00:00 2001 From: Harry Whorlow Date: Wed, 29 Jan 2025 13:40:37 +0100 Subject: [PATCH 5/6] build Ts errors --- packages/form-core/src/FieldApi.ts | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/packages/form-core/src/FieldApi.ts b/packages/form-core/src/FieldApi.ts index f1686bc11..f75156a7c 100644 --- a/packages/form-core/src/FieldApi.ts +++ b/packages/form-core/src/FieldApi.ts @@ -462,7 +462,8 @@ export class FieldApi< TName, TFieldValidator, TFormValidator, - TData + TData, + TMetaExtension >['form'] /** * The field name. @@ -544,7 +545,7 @@ export class FieldApi< runValidator< TValue extends { value: TData - fieldApi: FieldApi + fieldApi: FieldApi validationSource: ValidationSource }, TType extends 'validate' | 'validateAsync', @@ -756,7 +757,7 @@ export class FieldApi< TFormValidator >[] - const linkedFields: FieldApi[] = [] + const linkedFields: FieldApi[] = [] for (const field of fields) { if (!field.instance) continue const { onChangeListenTo, onBlurListenTo } = @@ -793,7 +794,9 @@ export class FieldApi< }) return acc.concat(fieldValidates as never) }, - [] as Array & { field: FieldApi }>, + [] as Array< + SyncValidator & { field: FieldApi } + >, ) // Needs type cast as eslint errantly believes this is always falsy @@ -801,7 +804,7 @@ export class FieldApi< batch(() => { const validateFieldFn = ( - field: FieldApi, + field: FieldApi, validateObj: SyncValidator, ) => { const errorMapKey = getErrorMapKey(validateObj.cause) @@ -899,7 +902,7 @@ export class FieldApi< return acc.concat(fieldValidates as never) }, [] as Array< - AsyncValidator & { field: FieldApi } + AsyncValidator & { field: FieldApi } >, ) @@ -919,7 +922,7 @@ export class FieldApi< const linkedPromises: Promise[] = [] const validateFieldAsyncFn = ( - field: FieldApi, + field: FieldApi, validateObj: AsyncValidator, promises: Promise[], ) => { From 72cf93544684ff45fbec4000e54f03b930633e49 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 18 Feb 2025 07:57:06 +0000 Subject: [PATCH 6/6] ci: apply automated fixes and generate docs --- .../reference/classes/tanstackfield.md | 293 ------- .../angular/reference/functions/injectform.md | 28 - .../reference/functions/injectstore.md | 34 - docs/framework/angular/reference/index.md | 15 - .../classes/tanstackformcontroller.md | 159 ---- docs/framework/lit/reference/index.md | 10 - .../react/reference/functions/field.md | 40 - .../react/reference/functions/usefield.md | 42 - .../react/reference/functions/useform.md | 32 - .../react/reference/functions/usestore.md | 62 -- .../react/reference/functions/usetransform.md | 32 - docs/framework/react/reference/index.md | 24 - .../reference/interfaces/reactformapi.md | 60 -- .../reference/type-aliases/fieldcomponent.md | 46 -- .../type-aliases/reactformextendedapi.md | 20 - .../react/reference/type-aliases/usefield.md | 42 - .../solid/reference/functions/createfield.md | 40 - .../solid/reference/functions/createform.md | 28 - .../solid/reference/functions/field.md | 36 - .../solid/reference/functions/usestore.md | 62 -- docs/framework/solid/reference/index.md | 22 - .../reference/interfaces/solidformapi.md | 92 --- .../reference/type-aliases/createfield.md | 42 - .../reference/type-aliases/fieldcomponent.md | 44 -- .../vue/reference/functions/usefield.md | 48 -- .../vue/reference/functions/useform.md | 28 - .../vue/reference/functions/usestore.md | 62 -- docs/framework/vue/reference/index.md | 26 - .../vue/reference/interfaces/vuefieldapi.md | 24 - .../vue/reference/interfaces/vueformapi.md | 90 --- .../reference/type-aliases/fieldcomponent.md | 47 -- .../vue/reference/type-aliases/usefield.md | 50 -- .../vue/reference/variables/field.md | 22 - docs/reference/classes/fieldapi.md | 543 ------------- docs/reference/classes/formapi.md | 748 ------------------ docs/reference/functions/formoptions.md | 31 - .../functions/isstandardschemavalidator.md | 22 - docs/reference/functions/mergeform.md | 32 - docs/reference/functions/shallow.md | 30 - .../functions/standardschemavalidator.md | 22 - docs/reference/index.md | 50 -- docs/reference/interfaces/fieldapioptions.md | 166 ---- docs/reference/interfaces/fieldlisteners.md | 62 -- docs/reference/interfaces/fieldoptions.md | 124 --- docs/reference/interfaces/fieldvalidators.md | 200 ----- docs/reference/interfaces/formoptions.md | 154 ---- docs/reference/interfaces/formvalidators.md | 118 --- docs/reference/type-aliases/baseformstate.md | 92 --- docs/reference/type-aliases/deepkeys.md | 20 - docs/reference/type-aliases/deepvalue.md | 22 - .../type-aliases/derivedformstate.md | 114 --- docs/reference/type-aliases/fieldinfo.md | 40 - docs/reference/type-aliases/fieldmeta.md | 14 - docs/reference/type-aliases/fieldmetabase.md | 54 -- .../type-aliases/fieldmetaderived.md | 30 - .../fieldserrormapfromvalidator.md | 16 - docs/reference/type-aliases/fieldstate.md | 36 - docs/reference/type-aliases/formstate.md | 16 - docs/reference/type-aliases/formvalidatefn.md | 34 - docs/reference/type-aliases/formvalidator.md | 58 -- .../type-aliases/standardschemav1.md | 30 - 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 - 66 files changed, 4674 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/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/isstandardschemavalidator.md delete mode 100644 docs/reference/functions/mergeform.md delete mode 100644 docs/reference/functions/shallow.md delete mode 100644 docs/reference/functions/standardschemavalidator.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/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/fieldserrormapfromvalidator.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/formvalidator.md delete mode 100644 docs/reference/type-aliases/standardschemav1.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 diff --git a/docs/framework/angular/reference/classes/tanstackfield.md b/docs/framework/angular/reference/classes/tanstackfield.md deleted file mode 100644 index 8d8f6dbaa..000000000 --- a/docs/framework/angular/reference/classes/tanstackfield.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -id: TanStackField -title: TanStackField ---- - -# Class: TanStackField\ - -Defined in: [tanstack-field.directive.ts:25](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L25) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Implements - -- `OnInit` -- `OnChanges` -- `OnDestroy` -- `FieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## Constructors - -### new TanStackField() - -```ts -new TanStackField(): TanStackField -``` - -#### Returns - -[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## Properties - -### api - -```ts -api: FieldApi; -``` - -Defined in: [tanstack-field.directive.ts:62](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L62) - -*** - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L48) - -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:47](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L47) - -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:60](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L60) - -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:46](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L46) - -An optional default value for the field. - -#### Implementation of - -```ts -FieldOptions.defaultValue -``` - -*** - -### listeners? - -```ts -optional listeners: NoInfer>; -``` - -Defined in: [tanstack-field.directive.ts:57](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L57) - -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:42](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L42) - -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:50](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L50) - -*** - -### unmount()? - -```ts -optional unmount: () => void; -``` - -Defined in: [tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L78) - -#### Returns - -`void` - -*** - -### validatorAdapter? - -```ts -optional validatorAdapter: TFieldValidator; -``` - -Defined in: [tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L49) - -A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter` - -#### Implementation of - -```ts -FieldOptions.validatorAdapter -``` - -*** - -### validators? - -```ts -optional validators: NoInfer>; -``` - -Defined in: [tanstack-field.directive.ts:54](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L54) - -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:90](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L90) - -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:86](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L86) - -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:80](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.directive.ts#L80) - -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 05b89cd61..000000000 --- a/docs/framework/angular/reference/functions/injectform.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: injectForm -title: injectForm ---- - -# Function: injectForm() - -```ts -function injectForm(opts?): FormApi -``` - -Defined in: [inject-form.ts:5](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-form.ts#L5) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TFormValidator`\> - -## Returns - -`FormApi`\<`TFormData`, `TFormValidator`\> diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md deleted file mode 100644 index d66d6302a..000000000 --- a/docs/framework/angular/reference/functions/injectstore.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: injectStore -title: injectStore ---- - -# Function: injectStore() - -```ts -function injectStore(form, selector?): Signal -``` - -Defined in: [inject-store.ts:4](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-store.ts#L4) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -• **TSelected** = `NoInfer`\<`FormState`\<`TFormData`\>\> - -## Parameters - -### form - -`FormApi`\<`TFormData`, `TFormValidator`\> - -### 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 aab1d7b1d..000000000 --- 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 b5be60c77..000000000 --- a/docs/framework/lit/reference/classes/tanstackformcontroller.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -id: TanStackFormController -title: TanStackFormController ---- - -# Class: TanStackFormController\ - -Defined in: [tanstack-form-controller.ts:81](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L81) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Implements - -- `ReactiveController` - -## Constructors - -### new TanStackFormController() - -```ts -new TanStackFormController(host, config?): TanStackFormController -``` - -Defined in: [tanstack-form-controller.ts:93](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L93) - -#### Parameters - -##### host - -`ReactiveControllerHost` - -##### config? - -`FormOptions`\<`TParentData`, `TFormValidator`\> - -#### Returns - -[`TanStackFormController`](tanstackformcontroller.md)\<`TParentData`, `TFormValidator`\> - -## Properties - -### api - -```ts -api: FormApi; -``` - -Defined in: [tanstack-form-controller.ts:91](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L91) - -## Methods - -### field() - -```ts -field(fieldConfig, render): object -``` - -Defined in: [tanstack-form-controller.ts:112](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L112) - -#### Type Parameters - -• **TName** *extends* `string` \| `number` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`, `IsNullable`\<`TParentData`\>\>, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`, `IsNullable`\<`TParentData`\>\> - -#### Parameters - -##### fieldConfig - -`FieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -##### render - -`renderCallback`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -#### 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:102](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L102) - -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:108](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L108) - -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 4215a3171..000000000 --- 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 908bd0d99..000000000 --- a/docs/framework/react/reference/functions/field.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: Field -title: Field ---- - -# Function: Field() - -```ts -function Field(__namedParameters): ReactNode -``` - -Defined in: [packages/react-form/src/useField.tsx:164](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L164) - -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` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined` - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### \_\_namedParameters - -`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## 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 72bc66835..000000000 --- a/docs/framework/react/reference/functions/usefield.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: useField -title: useField ---- - -# Function: useField() - -```ts -function useField(opts): FieldApi & ReactFieldApi -``` - -Defined in: [packages/react-form/src/useField.tsx:50](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L50) - -A hook for managing a field in a form. - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined` - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -An object with field options. - -## Returns - -`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `ReactFieldApi`\<`TParentData`, `TFormValidator`\> - -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 826335c33..000000000 --- a/docs/framework/react/reference/functions/useform.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: useForm -title: useForm ---- - -# Function: useForm() - -```ts -function useForm(opts?): ReactFormExtendedApi -``` - -Defined in: [packages/react-form/src/useForm.tsx:57](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L57) - -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** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TFormValidator`\> - -## Returns - -[`ReactFormExtendedApi`](../type-aliases/reactformextendedapi.md)\<`TFormData`, `TFormValidator`\> diff --git a/docs/framework/react/reference/functions/usestore.md b/docs/framework/react/reference/functions/usestore.md deleted file mode 100644 index 76f60a8b8..000000000 --- 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 737c8c8af..000000000 --- a/docs/framework/react/reference/functions/usetransform.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: useTransform -title: useTransform ---- - -# Function: useTransform() - -```ts -function useTransform(fn, deps): FormTransform -``` - -Defined in: [packages/react-form/src/useTransform.ts:3](https://github.com/TanStack/form/blob/main/packages/react-form/src/useTransform.ts#L3) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### fn - -(`formBase`) => `FormApi`\<`TFormData`, `TFormValidator`\> - -### deps - -`unknown`[] - -## Returns - -`FormTransform`\<`TFormData`, `TFormValidator`\> diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md deleted file mode 100644 index 599a63e0b..000000000 --- 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 b53804b8d..000000000 --- a/docs/framework/react/reference/interfaces/reactformapi.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -id: ReactFormApi -title: ReactFormApi ---- - -# Interface: ReactFormApi\ - -Defined in: [packages/react-form/src/useForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L14) - -Fields that are added onto the `FormAPI` from `@tanstack/form-core` and returned from `useForm` - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/react-form/src/useForm.tsx:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L21) - -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:25](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L25) - -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`\> - -#### 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 00fc39ca7..000000000 --- a/docs/framework/react/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => ReactNode; -``` - -Defined in: [packages/react-form/src/useField.tsx:134](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L134) - -A type alias representing a field component for a specific form data type. - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### \{ - children, - ...fieldOptions -\} - -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"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 ec56e7c0d..000000000 --- a/docs/framework/react/reference/type-aliases/reactformextendedapi.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: ReactFormExtendedApi -title: ReactFormExtendedApi ---- - -# Type Alias: ReactFormExtendedApi\ - -```ts -type ReactFormExtendedApi = FormApi & ReactFormApi; -``` - -Defined in: [packages/react-form/src/useForm.tsx:34](https://github.com/TanStack/form/blob/main/packages/react-form/src/useForm.tsx#L34) - -An extended version of the `FormApi` class that includes React-specific functionalities from `ReactFormApi` - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` 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 6ebd1f268..000000000 --- a/docs/framework/react/reference/type-aliases/usefield.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: UseField -title: UseField ---- - -# Type Alias: UseField()\ - -```ts -type UseField = (opts) => FieldApi; -``` - -Defined in: [packages/react-form/src/useField.tsx:26](https://github.com/TanStack/form/blob/main/packages/react-form/src/useField.tsx#L26) - -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** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> - -## Returns - -`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md deleted file mode 100644 index 6befedc54..000000000 --- a/docs/framework/solid/reference/functions/createfield.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: createField -title: createField ---- - -# Function: createField() - -```ts -function createField(opts): () => never -``` - -Defined in: [packages/solid-form/src/createField.tsx:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L87) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined` - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -() => `CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## Returns - -`Function` - -### Returns - -`never` diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md deleted file mode 100644 index 4408204c0..000000000 --- a/docs/framework/solid/reference/functions/createform.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: createForm -title: createForm ---- - -# Function: createForm() - -```ts -function createForm(opts?): FormApi & SolidFormApi -``` - -Defined in: [packages/solid-form/src/createForm.tsx:26](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L26) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -## Parameters - -### opts? - -() => `FormOptions`\<`TParentData`, `TFormValidator`\> - -## Returns - -`FormApi`\<`TParentData`, `TFormValidator`\> & [`SolidFormApi`](../interfaces/solidformapi.md)\<`TParentData`, `TFormValidator`\> diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md deleted file mode 100644 index 7cb6956d1..000000000 --- a/docs/framework/solid/reference/functions/field.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: Field -title: Field ---- - -# Function: Field() - -```ts -function Field(props): Element -``` - -Defined in: [packages/solid-form/src/createField.tsx:196](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L196) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined` - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### props - -`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `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 b1251110e..000000000 --- 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.3/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.3/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 704a66cb7..000000000 --- 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 a0ae50053..000000000 --- a/docs/framework/solid/reference/interfaces/solidformapi.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -id: SolidFormApi -title: SolidFormApi ---- - -# Interface: SolidFormApi\ - -Defined in: [packages/solid-form/src/createForm.tsx:11](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L11) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### createField - -```ts -createField: CreateField; -``` - -Defined in: [packages/solid-form/src/createForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L16) - -*** - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/solid-form/src/createForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L15) - -*** - -### Subscribe() - -```ts -Subscribe: (props) => Element; -``` - -Defined in: [packages/solid-form/src/createForm.tsx:20](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L20) - -#### Type Parameters - -• **TSelected** = `FormState`\<`TFormData`\> - -#### Parameters - -##### props - -###### children - -`Element` \| (`state`) => `Element` - -###### selector - -(`state`) => `TSelected` - -#### Returns - -`Element` - -*** - -### useStore() - -```ts -useStore: (selector?) => () => TSelected; -``` - -Defined in: [packages/solid-form/src/createForm.tsx:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.tsx#L17) - -#### Type Parameters - -• **TSelected** = `FormState`\<`TFormData`\> - -#### 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 3c91dcf69..000000000 --- a/docs/framework/solid/reference/type-aliases/createfield.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: CreateField -title: CreateField ---- - -# Type Alias: CreateField()\ - -```ts -type CreateField = (opts) => () => FieldApi & SolidFieldApi; -``` - -Defined in: [packages/solid-form/src/createField.tsx:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L29) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> - -## Returns - -`Function` - -### Returns - -`FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `SolidFieldApi`\<`TParentData`, `TFormValidator`\> 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 d0464a4ea..000000000 --- a/docs/framework/solid/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = ({ - children, - ...fieldOptions -}) => JSXElement; -``` - -Defined in: [packages/solid-form/src/createField.tsx:171](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createField.tsx#L171) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### \{ - children, - ...fieldOptions -\} - -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"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 2f06fddb5..000000000 --- a/docs/framework/vue/reference/functions/usefield.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: useField -title: useField ---- - -# Function: useField() - -```ts -function useField(opts): object -``` - -Defined in: [packages/vue-form/src/useField.tsx:49](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L49) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* `string` \| `number` - -• **TFieldValidator** *extends* - \| `undefined` - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> = `undefined` - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TParentData`, `unknown`\> = `undefined` - -• **TData** = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## 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 2d67b6719..000000000 --- a/docs/framework/vue/reference/functions/useform.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: useForm -title: useForm ---- - -# Function: useForm() - -```ts -function useForm(opts?): FormApi & VueFormApi -``` - -Defined in: [packages/vue-form/src/useForm.tsx:30](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L30) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### opts? - -`FormOptions`\<`TFormData`, `TFormValidator`\> - -## Returns - -`FormApi`\<`TFormData`, `TFormValidator`\> & [`VueFormApi`](../interfaces/vueformapi.md)\<`TFormData`, `TFormValidator`\> diff --git a/docs/framework/vue/reference/functions/usestore.md b/docs/framework/vue/reference/functions/usestore.md deleted file mode 100644 index 60c4f752a..000000000 --- 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.12\_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`\>\> - -## Call Signature - -```ts -function useStore(store, selector?): Readonly> -``` - -Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.7.0\_vue@3.5.12\_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`\>\> diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md deleted file mode 100644 index 27abe16df..000000000 --- a/docs/framework/vue/reference/index.md +++ /dev/null @@ -1,26 +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) -- [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 5b638938c..000000000 --- a/docs/framework/vue/reference/interfaces/vuefieldapi.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: VueFieldApi -title: VueFieldApi ---- - -# Interface: VueFieldApi\ - -Defined in: [packages/vue-form/src/useField.tsx:8](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L8) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/vue-form/src/useField.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L14) diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md deleted file mode 100644 index 9cd097244..000000000 --- a/docs/framework/vue/reference/interfaces/vueformapi.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: VueFormApi -title: VueFormApi ---- - -# Interface: VueFormApi\ - -Defined in: [packages/vue-form/src/useForm.tsx:10](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L10) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### Field - -```ts -Field: FieldComponent; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L14) - -*** - -### Subscribe() - -```ts -Subscribe: (props, context) => any; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:19](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L19) - -#### Type Parameters - -• **TSelected** = `FormState`\<`TFormData`\> - -#### Parameters - -##### props - -###### selector - -(`state`) => `TSelected` - -##### context - -`SetupContext`\<`EmitsOptions`, `SlotsType`\<\{ - `default`: `FormState`\<`TFormData`\>; - \}\>\> - -#### Returns - -`any` - -*** - -### useField - -```ts -useField: UseField; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L15) - -*** - -### useStore() - -```ts -useStore: (selector?) => Readonly>; -``` - -Defined in: [packages/vue-form/src/useForm.tsx:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useForm.tsx#L16) - -#### Type Parameters - -• **TSelected** = `FormState`\<`TFormData`\> - -#### 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 15179546d..000000000 --- a/docs/framework/vue/reference/type-aliases/fieldcomponent.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: FieldComponent -title: FieldComponent ---- - -# Type Alias: FieldComponent()\ - -```ts -type FieldComponent = (fieldOptions, context) => any; -``` - -Defined in: [packages/vue-form/src/useField.tsx:117](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L117) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### fieldOptions - -`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\> - -### context - -`SetupContext`\<\{\}, `SlotsType`\<\{ - `default`: \{ - `field`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>; - `state`: `FieldApi`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>\[`"state"`\]; - \}; - \}\>\> - -## Returns - -`any` 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 5fb33846e..000000000 --- a/docs/framework/vue/reference/type-aliases/usefield.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: UseField -title: UseField ---- - -# Type Alias: UseField()\ - -```ts -type UseField = (opts) => object; -``` - -Defined in: [packages/vue-form/src/useField.tsx:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L17) - -## Type Parameters - -• **TParentData** - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -## Type Parameters - -• **TName** *extends* `DeepKeys`\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<`DeepValue`\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TData** *extends* `DeepValue`\<`TParentData`, `TName`\> = `DeepValue`\<`TParentData`, `TName`\> - -## Parameters - -### opts - -`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"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 8b9c3092d..000000000 --- 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, {}, {}, {}, {}, string, {}, any, ComponentProvideOptions, OptionTypesType<{}, {}, {}, {}, {}, {}>, object & FieldApiOptions & { mode?: "value" | ... 1 more ... | undefined; } & ({ ...; } | { ...; }), {}, {}, {}, {}, {}>; -``` - -Defined in: [packages/vue-form/src/useField.tsx:162](https://github.com/TanStack/form/blob/main/packages/vue-form/src/useField.tsx#L162) - -## Parameters - -### props - -FieldApiOptions\ & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps` - -## Returns - -`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` & \{\} \| \{\}, \{\}, \{\}, \{\}, \{\}, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, \{\}, `false`, \{\}, \{\}, \{\}, \{\}, `string`, \{\}, `any`, `ComponentProvideOptions`, `OptionTypesType`\<\{\}, \{\}, \{\}, \{\}, \{\}, \{\}\>, `object` & FieldApiOptions\ & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}), \{\}, \{\}, \{\}, \{\}, \{\}\> diff --git a/docs/reference/classes/fieldapi.md b/docs/reference/classes/fieldapi.md deleted file mode 100644 index b20740351..000000000 --- a/docs/reference/classes/fieldapi.md +++ /dev/null @@ -1,543 +0,0 @@ ---- -id: FieldApi -title: FieldApi ---- - -# Class: FieldApi\ - -Defined in: [packages/form-core/src/FieldApi.ts:427](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L427) - -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`\> - -• **TFieldValidator** *extends* - \| `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -## Constructors - -### new FieldApi() - -```ts -new FieldApi(opts): FieldApi -``` - -Defined in: [packages/form-core/src/FieldApi.ts:477](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L477) - -Initializes a new `FieldApi` instance. - -#### Parameters - -##### opts - -[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -#### Returns - -[`FieldApi`](fieldapi.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## Properties - -### form - -```ts -form: FormApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:441](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L441) - -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:451](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L451) - -The field name. - -*** - -### options - -```ts -options: FieldApiOptions; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:455](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L455) - -The field options. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:465](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L465) - -The field state store. - -*** - -### timeoutIds - -```ts -timeoutIds: Record; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:472](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L472) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FieldState -``` - -Defined in: [packages/form-core/src/FieldApi.ts:469](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L469) - -The current field state. - -##### Returns - -[`FieldState`](../type-aliases/fieldstate.md)\<`TData`\> - -## Methods - -### getInfo() - -```ts -getInfo(): FieldInfo -``` - -Defined in: [packages/form-core/src/FieldApi.ts:673](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L673) - -Gets the field information object. - -#### Returns - -[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TParentData`, `TFormValidator`\> - -*** - -### getMeta() - -```ts -getMeta(): FieldMeta -``` - -Defined in: [packages/form-core/src/FieldApi.ts:662](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L662) - -#### Returns - -[`FieldMeta`](../type-aliases/fieldmeta.md) - -*** - -### ~~getValue()~~ - -```ts -getValue(): TData -``` - -Defined in: [packages/form-core/src/FieldApi.ts:644](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L644) - -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:1030](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1030) - -Handles the blur event. - -#### Returns - -`void` - -*** - -### handleChange() - -```ts -handleChange(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:1023](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1023) - -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:686](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L686) - -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:567](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L567) - -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:716](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L716) - -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:678](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L678) - -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:704](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L704) - -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:695](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L695) - -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:1050](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L1050) - -Updates the field's errorMap - -#### Parameters - -##### errorMap - -`ValidationErrorMap` - -#### Returns - -`void` - -*** - -### setMeta() - -```ts -setMeta(updater): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:667](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L667) - -Sets the field metadata. - -#### Parameters - -##### updater - -[`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\> - -#### Returns - -`void` - -*** - -### setValue() - -```ts -setValue(updater, options?): void -``` - -Defined in: [packages/form-core/src/FieldApi.ts:651](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L651) - -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:710](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L710) - -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:606](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L606) - -Updates the field instance with new options. - -#### Parameters - -##### opts - -[`FieldApiOptions`](../interfaces/fieldapioptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -#### Returns - -`void` - -*** - -### validate() - -```ts -validate(cause, opts?): - | ValidationError[] -| Promise -``` - -Defined in: [packages/form-core/src/FieldApi.ts:990](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L990) - -Validates the field value. - -#### Parameters - -##### cause - -`ValidationCause` - -##### opts? - -###### skipFormValidation - -`boolean` - -#### Returns - - \| [`ValidationError`](../type-aliases/validationerror.md)[] - \| `Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> diff --git a/docs/reference/classes/formapi.md b/docs/reference/classes/formapi.md deleted file mode 100644 index 2b6275dba..000000000 --- a/docs/reference/classes/formapi.md +++ /dev/null @@ -1,748 +0,0 @@ ---- -id: FormApi -title: FormApi ---- - -# Class: FormApi\ - -Defined in: [packages/form-core/src/FormApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L362) - -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** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Constructors - -### new FormApi() - -```ts -new FormApi(opts?): FormApi -``` - -Defined in: [packages/form-core/src/FormApi.ts:391](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L391) - -Constructs a new `FormApi` instance with the given form options. - -#### Parameters - -##### opts? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> - -#### Returns - -[`FormApi`](formapi.md)\<`TFormData`, `TFormValidator`\> - -## Properties - -### baseStore - -```ts -baseStore: Store, (cb) => BaseFormState>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:370](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L370) - -*** - -### 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:376](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L376) - -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, FieldMeta>>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:371](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L371) - -*** - -### options - -```ts -options: FormOptions = {}; -``` - -Defined in: [packages/form-core/src/FormApi.ts:369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L369) - -The options for the form. - -*** - -### store - -```ts -store: Derived>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L372) - -## Accessors - -### state - -#### Get Signature - -```ts -get state(): FormState -``` - -Defined in: [packages/form-core/src/FormApi.ts:379](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L379) - -##### Returns - -[`FormState`](../type-aliases/formstate.md)\<`TFormData`\> - -## Methods - -### deleteField() - -```ts -deleteField(field): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1240](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1240) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -`void` - -*** - -### getFieldInfo() - -```ts -getFieldInfo(field): FieldInfo -``` - -Defined in: [packages/form-core/src/FormApi.ts:1149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1149) - -Gets the field info of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -[`FieldInfo`](../type-aliases/fieldinfo.md)\<`TFormData`, `TFormValidator`\> - -*** - -### getFieldMeta() - -```ts -getFieldMeta(field): undefined | FieldMeta -``` - -Defined in: [packages/form-core/src/FormApi.ts:1140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1140) - -Gets the metadata of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -`undefined` \| [`FieldMeta`](../type-aliases/fieldmeta.md) - -*** - -### getFieldValue() - -```ts -getFieldValue(field): DeepValue> -``` - -Defined in: [packages/form-core/src/FormApi.ts:1133](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1133) - -Gets the value of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -#### Returns - -[`DeepValue`](../type-aliases/deepvalue.md)\<`TFormData`, `TField`, `IsNullable`\<`TFormData`\>\> - -*** - -### handleSubmit() - -```ts -handleSubmit(): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:1064](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1064) - -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:1269](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1269) - -#### 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:639](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L639) - -#### Returns - -`Function` - -##### Returns - -`void` - -*** - -### moveFieldValues() - -```ts -moveFieldValues( - field, - index1, - index2, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1398](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1398) - -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:1254](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1254) - -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:1327](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1327) - -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:1301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1301) - -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:702](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L702) - -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:1186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1186) - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### fieldMeta - -`Record`\<`TField`, [`FieldMeta`](../type-aliases/fieldmeta.md)\> - -#### Returns - -`Record`\<`TField`, [`FieldMeta`](../type-aliases/fieldmeta.md)\> - -*** - -### setErrorMap() - -```ts -setErrorMap(errorMap): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1425](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1425) - -Updates the form's errorMap - -#### Parameters - -##### errorMap - -`ValidationErrorMap` - -#### Returns - -`void` - -*** - -### setFieldMeta() - -```ts -setFieldMeta(field, updater): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1168) - -Updates the metadata of the specified field. - -#### Type Parameters - -• **TField** *extends* `string` \| `number` - -#### Parameters - -##### field - -`TField` - -##### updater - -[`Updater`](../type-aliases/updater.md)\<[`FieldMeta`](../type-aliases/fieldmeta.md)\> - -#### Returns - -`void` - -*** - -### setFieldValue() - -```ts -setFieldValue( - field, - updater, - opts?): void -``` - -Defined in: [packages/form-core/src/FormApi.ts:1210](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1210) - -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:1369](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L1369) - -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:656](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L656) - -Updates the form options and form state. - -#### Parameters - -##### options? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> - -#### Returns - -`void` - -*** - -### validateAllFields() - -```ts -validateAllFields(cause): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:728](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L728) - -Validates all fields using the correct handlers for a given validation cause. - -#### Parameters - -##### cause - -`ValidationCause` - -#### Returns - -`Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> - -*** - -### validateArrayFieldsStartingFrom() - -```ts -validateArrayFieldsStartingFrom( - field, - index, -cause): Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:758](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L758) - -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`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> - -*** - -### validateField() - -```ts -validateField(field, cause): - | ValidationError[] -| Promise -``` - -Defined in: [packages/form-core/src/FormApi.ts:797](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L797) - -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 - - \| [`ValidationError`](../type-aliases/validationerror.md)[] - \| `Promise`\<[`ValidationError`](../type-aliases/validationerror.md)[]\> diff --git a/docs/reference/functions/formoptions.md b/docs/reference/functions/formoptions.md deleted file mode 100644 index 9b3ff5ea1..000000000 --- a/docs/reference/functions/formoptions.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: formOptions -title: formOptions ---- - -# Function: formOptions() - -```ts -function formOptions(defaultOpts?): - | undefined -| FormOptions -``` - -Defined in: [packages/form-core/src/formOptions.ts:4](https://github.com/TanStack/form/blob/main/packages/form-core/src/formOptions.ts#L4) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### defaultOpts? - -[`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> - -## Returns - - \| `undefined` - \| [`FormOptions`](../interfaces/formoptions.md)\<`TFormData`, `TFormValidator`\> diff --git a/docs/reference/functions/isstandardschemavalidator.md b/docs/reference/functions/isstandardschemavalidator.md deleted file mode 100644 index b3f4a6001..000000000 --- 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:86](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L86) - -## 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 103beee34..000000000 --- a/docs/reference/functions/mergeform.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: mergeForm -title: mergeForm ---- - -# Function: mergeForm() - -```ts -function mergeForm(baseForm, state): FormApi, NoInfer> -``` - -Defined in: [packages/form-core/src/mergeForm.ts:36](https://github.com/TanStack/form/blob/main/packages/form-core/src/mergeForm.ts#L36) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `undefined` \| `Validator`\<`TFormData`, `unknown`\> = `undefined` - -## Parameters - -### baseForm - -[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> - -### state - -`Partial`\<[`FormState`](../type-aliases/formstate.md)\<`TFormData`\>\> - -## Returns - -[`FormApi`](../classes/formapi.md)\<`NoInfer`\<`TFormData`\>, `NoInfer`\<`TFormValidator`\>\> diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md deleted file mode 100644 index 344e80850..000000000 --- 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:328](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.ts#L328) - -## Type Parameters - -• **T** - -## Parameters - -### objA - -`T` - -### objB - -`T` - -## Returns - -`boolean` diff --git a/docs/reference/functions/standardschemavalidator.md b/docs/reference/functions/standardschemavalidator.md deleted file mode 100644 index 22c05433c..000000000 --- a/docs/reference/functions/standardschemavalidator.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: standardSchemaValidator -title: standardSchemaValidator ---- - -# Function: standardSchemaValidator() - -```ts -function standardSchemaValidator(params): Validator> -``` - -Defined in: [packages/form-core/src/standardSchemaValidator.ts:48](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L48) - -## Parameters - -### params - -`Params` = `{}` - -## Returns - -`Validator`\<`unknown`, [`StandardSchemaV1`](../type-aliases/standardschemav1.md)\<`any`, `any`\>\> diff --git a/docs/reference/index.md b/docs/reference/index.md deleted file mode 100644 index 5f9cb9ddf..000000000 --- a/docs/reference/index.md +++ /dev/null @@ -1,50 +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) - -## Type Aliases - -- [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) -- [FieldsErrorMapFromValidator](type-aliases/fieldserrormapfromvalidator.md) -- [FieldState](type-aliases/fieldstate.md) -- [FormState](type-aliases/formstate.md) -- [FormValidateFn](type-aliases/formvalidatefn.md) -- [FormValidator](type-aliases/formvalidator.md) -- [StandardSchemaV1](type-aliases/standardschemav1.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) - -## Functions - -- [formOptions](functions/formoptions.md) -- [isStandardSchemaValidator](functions/isstandardschemavalidator.md) -- [mergeForm](functions/mergeform.md) -- [shallow](functions/shallow.md) -- [standardSchemaValidator](functions/standardschemavalidator.md) diff --git a/docs/reference/interfaces/fieldapioptions.md b/docs/reference/interfaces/fieldapioptions.md deleted file mode 100644 index 842ab2292..000000000 --- a/docs/reference/interfaces/fieldapioptions.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -id: FieldApiOptions -title: FieldApiOptions ---- - -# Interface: FieldApiOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:345](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L345) - -An object type representing the required options for the FieldApi class. - -## Extends - -- [`FieldOptions`](fieldoptions.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L311) - -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:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307) - -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:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L329) - -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:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L303) - -An optional default value for the field. - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`defaultValue`](FieldOptions.md#defaultvalue) - -*** - -### form - -```ts -form: FormApi; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L362) - -*** - -### listeners? - -```ts -optional listeners: FieldListeners; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L333) - -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:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L299) - -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) - -*** - -### validatorAdapter? - -```ts -optional validatorAdapter: TFieldValidator; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L315) - -A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter` - -#### Inherited from - -[`FieldOptions`](fieldoptions.md).[`validatorAdapter`](FieldOptions.md#validatoradapter) - -*** - -### validators? - -```ts -optional validators: FieldValidators; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L319) - -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 c72b78d03..000000000 --- a/docs/reference/interfaces/fieldlisteners.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: FieldListeners -title: FieldListeners ---- - -# Interface: FieldListeners\ - -Defined in: [packages/form-core/src/FieldApi.ts:241](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L241) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **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:259](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L259) - -*** - -### onChange? - -```ts -optional onChange: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:252](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L252) - -*** - -### onMount? - -```ts -optional onMount: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:266](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L266) - -*** - -### onSubmit? - -```ts -optional onSubmit: FieldListenerFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:273](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L273) diff --git a/docs/reference/interfaces/fieldoptions.md b/docs/reference/interfaces/fieldoptions.md deleted file mode 100644 index cdcdaaa80..000000000 --- a/docs/reference/interfaces/fieldoptions.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -id: FieldOptions -title: FieldOptions ---- - -# Interface: FieldOptions\ - -Defined in: [packages/form-core/src/FieldApi.ts:285](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L285) - -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`\> - -• **TFieldValidator** *extends* - \| `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L311) - -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:307](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L307) - -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:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L329) - -An optional object with default metadata for the field. - -*** - -### defaultValue? - -```ts -optional defaultValue: NoInfer; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:303](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L303) - -An optional default value for the field. - -*** - -### listeners? - -```ts -optional listeners: FieldListeners; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L333) - -A list of listeners which attach to the corresponding events - -*** - -### name - -```ts -name: TName; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:299](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L299) - -The field name. The type will be `DeepKeys` to ensure your name is a deep key of the parent dataset. - -*** - -### validatorAdapter? - -```ts -optional validatorAdapter: TFieldValidator; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:315](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L315) - -A validator provided by an extension, like `yupValidator` from `@tanstack/yup-form-adapter` - -*** - -### validators? - -```ts -optional validators: FieldValidators; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L319) - -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 2f34e46a9..000000000 --- a/docs/reference/interfaces/fieldvalidators.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -id: FieldValidators -title: FieldValidators ---- - -# Interface: FieldValidators\ - -Defined in: [packages/form-core/src/FieldApi.ts:119](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L119) - -## Type Parameters - -• **TParentData** - -• **TName** *extends* [`DeepKeys`](../type-aliases/deepkeys.md)\<`TParentData`\> - -• **TFieldValidator** *extends* - \| `Validator`\<[`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\>, `unknown`\> - \| `undefined` = `undefined` - -• **TFormValidator** *extends* `Validator`\<`TParentData`, `unknown`\> \| `undefined` = `undefined` - -• **TData** *extends* [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> = [`DeepValue`](../type-aliases/deepvalue.md)\<`TParentData`, `TName`\> - -## Properties - -### onBlur? - -```ts -optional onBlur: FieldValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L182) - -An optional function, that runs on the blur event of input. -If `validatorAdapter` is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().min(1) // if `zodAdapter` is passed -``` - -*** - -### onBlurAsync? - -```ts -optional onBlurAsync: FieldAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L195) - -An optional property similar to `onBlur` but async validation. If `validatorAdapter` -is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed -``` - -*** - -### onBlurAsyncDebounceMs? - -```ts -optional onBlurAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L208) - -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:212](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L212) - -An optional list of field names that should trigger this field's `onBlur` and `onBlurAsync` events when its value changes - -*** - -### onChange? - -```ts -optional onChange: FieldValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:146](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L146) - -An optional property that takes a `ValidateFn` which is a generic of `TData` and `TParentData`. -If `validatorAdapter` is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().min(1) // if `zodAdapter` is passed -``` - -*** - -### onChangeAsync? - -```ts -optional onChangeAsync: FieldAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:159](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L159) - -An optional property similar to `onChange` but async validation. If `validatorAdapter` -is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed -``` - -*** - -### onChangeAsyncDebounceMs? - -```ts -optional onChangeAsyncDebounceMs: number; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:171](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L171) - -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:175](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L175) - -An optional list of field names that should trigger this field's `onChange` and `onChangeAsync` events when its value changes - -*** - -### onMount? - -```ts -optional onMount: FieldValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:133](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L133) - -An optional function that takes a param of `formApi` which is a generic type of `TData` and `TParentData` - -*** - -### onSubmit? - -```ts -optional onSubmit: FieldValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:219](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L219) - -An optional function, that runs on the submit event of form. -If `validatorAdapter` is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().min(1) // if `zodAdapter` is passed -``` - -*** - -### onSubmitAsync? - -```ts -optional onSubmitAsync: FieldAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:232](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L232) - -An optional property similar to `onSubmit` but async validation. If `validatorAdapter` -is passed, this may also accept a property from the respective adapter - -#### Example - -```ts -z.string().refine(async (val) => val.length > 3, { message: 'Testing 123' }) // if `zodAdapter` is passed -``` diff --git a/docs/reference/interfaces/formoptions.md b/docs/reference/interfaces/formoptions.md deleted file mode 100644 index 20b0eb248..000000000 --- a/docs/reference/interfaces/formoptions.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -id: FormOptions -title: FormOptions ---- - -# Interface: FormOptions\ - -Defined in: [packages/form-core/src/FormApi.ts:150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L150) - -An object representing the options for a form. - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### asyncAlways? - -```ts -optional asyncAlways: boolean; -``` - -Defined in: [packages/form-core/src/FormApi.ts:165](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L165) - -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:169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L169) - -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:161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L161) - -The default state for the form. - -*** - -### defaultValues? - -```ts -optional defaultValues: TFormData; -``` - -Defined in: [packages/form-core/src/FormApi.ts:157](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L157) - -Set initial values for your form. - -*** - -### onSubmit()? - -```ts -optional onSubmit: (props) => any; -``` - -Defined in: [packages/form-core/src/FormApi.ts:181](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L181) - -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`, `TFormValidator`\> - -###### value - -`TFormData` - -#### Returns - -`any` - -*** - -### onSubmitInvalid()? - -```ts -optional onSubmitInvalid: (props) => void; -``` - -Defined in: [packages/form-core/src/FormApi.ts:188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L188) - -Specify an action for scenarios where the user tries to submit an invalid form. - -#### Parameters - -##### props - -###### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TFormValidator`\> - -###### value - -`TFormData` - -#### Returns - -`void` - -*** - -### transform? - -```ts -optional transform: FormTransform; -``` - -Defined in: [packages/form-core/src/FormApi.ts:192](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L192) - -*** - -### validatorAdapter? - -```ts -optional validatorAdapter: TFormValidator; -``` - -Defined in: [packages/form-core/src/FormApi.ts:173](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L173) - -A validator adapter to support usage of extra validation types (IE: Zod, Yup, or Valibot usage) - -*** - -### validators? - -```ts -optional validators: FormValidators; -``` - -Defined in: [packages/form-core/src/FormApi.ts:177](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L177) - -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 04842e036..000000000 --- a/docs/reference/interfaces/formvalidators.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: FormValidators -title: FormValidators ---- - -# Interface: FormValidators\ - -Defined in: [packages/form-core/src/FormApi.ts:98](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L98) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Properties - -### onBlur? - -```ts -optional onBlur: FormValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:121](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L121) - -Optional function that validates the form data when a field loses focus, returns a `FormValidationError` - -*** - -### onBlurAsync? - -```ts -optional onBlurAsync: FormAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L125) - -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:129](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L129) - -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: FormValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:109](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L109) - -Optional function that checks the validity of your data whenever a value changes - -*** - -### onChangeAsync? - -```ts -optional onChangeAsync: FormAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:113](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L113) - -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:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L117) - -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: FormValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:105](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L105) - -Optional function that fires as soon as the component mounts. - -*** - -### onSubmit? - -```ts -optional onSubmit: FormValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:130](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L130) - -*** - -### onSubmitAsync? - -```ts -optional onSubmitAsync: FormAsyncValidateOrFn; -``` - -Defined in: [packages/form-core/src/FormApi.ts:131](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L131) diff --git a/docs/reference/type-aliases/baseformstate.md b/docs/reference/type-aliases/baseformstate.md deleted file mode 100644 index 6b32748a0..000000000 --- a/docs/reference/type-aliases/baseformstate.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -id: BaseFormState -title: BaseFormState ---- - -# Type Alias: BaseFormState\ - -```ts -type BaseFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:230](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L230) - -An object representing the current state of the form. - -## Type Parameters - -• **TFormData** - -## Type declaration - -### errorMap - -```ts -errorMap: FormValidationErrorMap; -``` - -The error map for the form itself. - -### fieldMetaBase - -```ts -fieldMetaBase: Record, FieldMetaBase>; -``` - -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 974a0dd32..000000000 --- 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:85](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L85) - -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 405c68661..000000000 --- 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:109](https://github.com/TanStack/form/blob/main/packages/form-core/src/util-types.ts#L109) - -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 61d22cb56..000000000 --- a/docs/reference/type-aliases/derivedformstate.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -id: DerivedFormState -title: DerivedFormState ---- - -# Type Alias: DerivedFormState\ - -```ts -type DerivedFormState = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L274) - -## Type Parameters - -• **TFormData** - -## Type declaration - -### canSubmit - -```ts -canSubmit: boolean; -``` - -A boolean indicating if the form can be submitted based on its current state. - -### errors - -```ts -errors: ValidationError[]; -``` - -The error array for the form itself. - -### fieldMeta - -```ts -fieldMeta: Record, FieldMeta>; -``` - -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 6b566a853..000000000 --- a/docs/reference/type-aliases/fieldinfo.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: FieldInfo -title: FieldInfo ---- - -# Type Alias: FieldInfo\ - -```ts -type FieldInfo = object; -``` - -Defined in: [packages/form-core/src/FormApi.ts:208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L208) - -An object representing the field information for a specific field within the form. - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Type declaration - -### instance - -```ts -instance: - | FieldApi | undefined, TFormValidator> - | 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 92d188bea..000000000 --- a/docs/reference/type-aliases/fieldmeta.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: FieldMeta -title: FieldMeta ---- - -# Type Alias: FieldMeta - -```ts -type FieldMeta = FieldMetaBase & FieldMetaDerived; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L402) - -An object type representing the metadata of a field in a form. diff --git a/docs/reference/type-aliases/fieldmetabase.md b/docs/reference/type-aliases/fieldmetabase.md deleted file mode 100644 index a09bbb5cf..000000000 --- a/docs/reference/type-aliases/fieldmetabase.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: FieldMetaBase -title: FieldMetaBase ---- - -# Type Alias: FieldMetaBase - -```ts -type FieldMetaBase = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:365](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L365) - -## Type declaration - -### errorMap - -```ts -errorMap: ValidationErrorMap; -``` - -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 1228a198f..000000000 --- a/docs/reference/type-aliases/fieldmetaderived.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: FieldMetaDerived -title: FieldMetaDerived ---- - -# Type Alias: FieldMetaDerived - -```ts -type FieldMetaDerived = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:388](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L388) - -## Type declaration - -### errors - -```ts -errors: ValidationError[]; -``` - -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/fieldserrormapfromvalidator.md b/docs/reference/type-aliases/fieldserrormapfromvalidator.md deleted file mode 100644 index 588ac78ab..000000000 --- a/docs/reference/type-aliases/fieldserrormapfromvalidator.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: FieldsErrorMapFromValidator -title: FieldsErrorMapFromValidator ---- - -# Type Alias: FieldsErrorMapFromValidator\ - -```ts -type FieldsErrorMapFromValidator = Partial, ValidationErrorMap>>; -``` - -Defined in: [packages/form-core/src/FormApi.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L33) - -## Type Parameters - -• **TFormData** diff --git a/docs/reference/type-aliases/fieldstate.md b/docs/reference/type-aliases/fieldstate.md deleted file mode 100644 index 30edf86ef..000000000 --- a/docs/reference/type-aliases/fieldstate.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: FieldState -title: FieldState ---- - -# Type Alias: FieldState\ - -```ts -type FieldState = object; -``` - -Defined in: [packages/form-core/src/FieldApi.ts:407](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi.ts#L407) - -An object type representing the state of a field. - -## Type Parameters - -• **TData** - -## 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 84c777763..000000000 --- a/docs/reference/type-aliases/formstate.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -id: FormState -title: FormState ---- - -# Type Alias: FormState\ - -```ts -type FormState = BaseFormState & DerivedFormState; -``` - -Defined in: [packages/form-core/src/FormApi.ts:325](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L325) - -## Type Parameters - -• **TFormData** diff --git a/docs/reference/type-aliases/formvalidatefn.md b/docs/reference/type-aliases/formvalidatefn.md deleted file mode 100644 index 7c9c2dd68..000000000 --- a/docs/reference/type-aliases/formvalidatefn.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: FormValidateFn -title: FormValidateFn ---- - -# Type Alias: FormValidateFn()\ - -```ts -type FormValidateFn = (props) => FormValidationError; -``` - -Defined in: [packages/form-core/src/FormApi.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L37) - -## Type Parameters - -• **TFormData** - -• **TFormValidator** *extends* `Validator`\<`TFormData`, `unknown`\> \| `undefined` = `undefined` - -## Parameters - -### props - -#### formApi - -[`FormApi`](../classes/formapi.md)\<`TFormData`, `TFormValidator`\> - -#### value - -`TFormData` - -## Returns - -`FormValidationError`\<`TFormData`\> diff --git a/docs/reference/type-aliases/formvalidator.md b/docs/reference/type-aliases/formvalidator.md deleted file mode 100644 index 843136e59..000000000 --- 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:70](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L70) - -## Type Parameters - -• **TFormData** - -• **TType** - -• **TFn** = `unknown` - -## Type declaration - -### validate() - -#### Parameters - -##### options - -###### value - -`TType` - -##### fn - -`TFn` - -#### Returns - -[`ValidationError`](validationerror.md) - -### validateAsync() - -#### Parameters - -##### options - -###### value - -`TType` - -##### fn - -`TFn` - -#### Returns - -`Promise`\<`FormValidationError`\<`TFormData`\>\> diff --git a/docs/reference/type-aliases/standardschemav1.md b/docs/reference/type-aliases/standardschemav1.md deleted file mode 100644 index 041725a53..000000000 --- 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:94](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchemaValidator.ts#L94) - -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/updater.md b/docs/reference/type-aliases/updater.md deleted file mode 100644 index c58c78c54..000000000 --- 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 62365f5fa..000000000 --- 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 774c3fc0c..000000000 --- a/docs/reference/type-aliases/validationerror.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -id: ValidationError -title: ValidationError ---- - -# Type Alias: ValidationError - -```ts -type ValidationError = undefined | false | null | string; -``` - -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 550e0ab74..000000000 --- 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:198](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi.ts#L198) - -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 907c7e33b..000000000 --- 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)