diff --git a/docs/framework/angular/reference/classes/TanStackAppArrayField.md b/docs/framework/angular/reference/classes/TanStackAppArrayField.md index ad4fdf2ea..092c6d352 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 cfdd07523..28741bcad 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 fcc15993a..f8950adb5 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 cf4bf1ffe..a21dacbfd 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 e5543b7f0..4943a60cc 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 fdcf95370..286ae97c8 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 8fc133731..f530e68e8 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 2d77551aa..1d31c7dc4 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 9becb5e04..521da6446 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 0d0a396ef..158b90030 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/AngularFormType.md b/docs/framework/angular/reference/type-aliases/AngularFormType.md index 2a608bd83..255f9c874 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:17](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-type.ts#L17) +Defined in: [form-type.ts:17](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-type.ts#L17) Resolves a reusable options object to its concrete Angular form type. diff --git a/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md b/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md index ce7eaa973..03e788e68 100644 --- a/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md +++ b/docs/framework/angular/reference/type-aliases/AnyAngularFormApi.md @@ -9,6 +9,6 @@ title: AnyAngularFormApi type AnyAngularFormApi = AnyInternalFormApi; ``` -Defined in: [form-type.ts:14](https://github.com/TanStack/form/blob/main/packages/angular-form/src/form-type.ts#L14) +Defined in: [form-type.ts:14](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/angular-form/src/form-type.ts#L14) An Angular form instance when its concrete data shape is not known. diff --git a/docs/framework/lit/reference/classes/TanStackFormController.md b/docs/framework/lit/reference/classes/TanStackFormController.md index aaf921057..a307846dd 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/getFieldGroupHelpers.md b/docs/framework/lit/reference/functions/getFieldGroupHelpers.md index b4c9dec81..9563595d7 100644 --- a/docs/framework/lit/reference/functions/getFieldGroupHelpers.md +++ b/docs/framework/lit/reference/functions/getFieldGroupHelpers.md @@ -9,7 +9,7 @@ title: getFieldGroupHelpers function getFieldGroupHelpers(): FieldGroupHelpers; ``` -Defined in: [with-fields.ts:339](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L339) +Defined in: [with-fields.ts:339](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L339) ## Returns diff --git a/docs/framework/lit/reference/functions/getFormType.md b/docs/framework/lit/reference/functions/getFormType.md index b52d81405..e8065161e 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:26](https://github.com/TanStack/form/blob/main/packages/lit-form/src/get-form-type.ts#L26) +Defined in: [get-form-type.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/get-form-type.ts#L26) 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/FieldGroupFieldSlot.md b/docs/framework/lit/reference/interfaces/FieldGroupFieldSlot.md index 085c78fd1..932fc3b78 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: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) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [with-fields.ts:29](https://github.com/TanStack/form/blob/main/packa readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [with-fields.ts:34](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L34) +Defined in: [with-fields.ts:34](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L34) *** @@ -35,4 +35,4 @@ Defined in: [with-fields.ts:34](https://github.com/TanStack/form/blob/main/packa readonly mode: TMode; ``` -Defined in: [with-fields.ts:33](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L33) +Defined in: [with-fields.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L33) diff --git a/docs/framework/lit/reference/interfaces/LitFieldMethods.md b/docs/framework/lit/reference/interfaces/LitFieldMethods.md index 0c77be361..d3554847d 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 796128a15..21af9605b 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/FieldGroupDefinition.md b/docs/framework/lit/reference/type-aliases/FieldGroupDefinition.md index d26e26ee4..b4912f24e 100644 --- a/docs/framework/lit/reference/type-aliases/FieldGroupDefinition.md +++ b/docs/framework/lit/reference/type-aliases/FieldGroupDefinition.md @@ -9,7 +9,7 @@ title: FieldGroupDefinition type FieldGroupDefinition = LitFieldGroupApi> & object; ``` -Defined in: [with-fields.ts:88](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L88) +Defined in: [with-fields.ts:88](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L88) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldBindings.md index f63dce441..324785ac3 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:103](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L103) +Defined in: [with-fields.ts:103](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L103) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/lit/reference/type-aliases/FieldGroupFieldData.md index 850d92783..3552af14d 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: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) ## Type Parameters diff --git a/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md b/docs/framework/lit/reference/type-aliases/LitFieldGroupApi.md index 66207f8d8..82bf5092f 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:76](https://github.com/TanStack/form/blob/main/packages/lit-form/src/with-fields.ts#L76) +Defined in: [with-fields.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/with-fields.ts#L76) ## Type Declaration diff --git a/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md b/docs/framework/lit/reference/type-aliases/LitFormGroupApi.md index 10cc7a736..bf8e48fa9 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 8de1006d9..8830d50ee 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:9](https://github.com/TanStack/form/blob/main/packages/lit-form/src/get-form-type.ts#L9) +Defined in: [get-form-type.ts:9](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/lit-form/src/get-form-type.ts#L9) Resolves reusable form options to their concrete Lit controller type. diff --git a/docs/framework/preact/reference/classes/ReadonlyStore.md b/docs/framework/preact/reference/classes/ReadonlyStore.md new file mode 100644 index 000000000..3db81ebb6 --- /dev/null +++ b/docs/framework/preact/reference/classes/ReadonlyStore.md @@ -0,0 +1,124 @@ +--- +id: ReadonlyStore +title: ReadonlyStore +--- + +# Class: ReadonlyStore\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:22 + +## Type Parameters + +### T + +`T` + +## Implements + +- `Omit`\<[`Store`](Store.md)\<`T`\>, `"setState"` \| `"actions"`\> + +## Constructors + +### Constructor + +```ts +new ReadonlyStore(getValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:24 + +#### Parameters + +##### getValue + +(`prev?`) => `T` + +#### Returns + +`ReadonlyStore`\<`T`\> + +### Constructor + +```ts +new ReadonlyStore(initialValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:25 + +#### Parameters + +##### initialValue + +`T` + +#### Returns + +`ReadonlyStore`\<`T`\> + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:26 + +##### Returns + +`T` + +#### Implementation of + +```ts +Omit.state +``` + +## Methods + +### get() + +```ts +get(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:27 + +#### Returns + +`T` + +#### Implementation of + +```ts +Omit.get +``` + +*** + +### subscribe() + +```ts +subscribe(observerOrFn): Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:28 + +#### Parameters + +##### observerOrFn + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +#### Returns + +[`Subscription`](../interfaces/Subscription.md) + +#### Implementation of + +```ts +Omit.subscribe +``` diff --git a/docs/framework/preact/reference/classes/Store.md b/docs/framework/preact/reference/classes/Store.md new file mode 100644 index 000000000..9c356d4f9 --- /dev/null +++ b/docs/framework/preact/reference/classes/Store.md @@ -0,0 +1,158 @@ +--- +id: Store +title: Store +--- + +# Class: Store\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:11 + +## Type Parameters + +### T + +`T` + +### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) = `never` + +## Constructors + +### Constructor + +```ts +new Store(getValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:14 + +#### Parameters + +##### getValue + +(`prev?`) => `T` + +#### Returns + +`Store`\<`T`, `TActions`\> + +### Constructor + +```ts +new Store(initialValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:15 + +#### Parameters + +##### initialValue + +`T` + +#### Returns + +`Store`\<`T`, `TActions`\> + +### Constructor + +```ts +new Store(initialValue, actionsFactory): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:16 + +#### Parameters + +##### initialValue + +`NonFunction`\<`T`\> + +##### actionsFactory + +[`StoreActionsFactory`](../type-aliases/StoreActionsFactory.md)\<`T`, `TActions`\> + +#### Returns + +`Store`\<`T`, `TActions`\> + +## Properties + +### actions + +```ts +readonly actions: TActions; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:13 + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:18 + +##### Returns + +`T` + +## Methods + +### get() + +```ts +get(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:19 + +#### Returns + +`T` + +*** + +### setState() + +```ts +setState(updater): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:17 + +#### Parameters + +##### updater + +(`prev`) => `T` + +#### Returns + +`void` + +*** + +### subscribe() + +```ts +subscribe(observerOrFn): Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:20 + +#### Parameters + +##### observerOrFn + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +#### Returns + +[`Subscription`](../interfaces/Subscription.md) diff --git a/docs/framework/preact/reference/functions/Subscribe.md b/docs/framework/preact/reference/functions/Subscribe.md new file mode 100644 index 000000000..49da591d0 --- /dev/null +++ b/docs/framework/preact/reference/functions/Subscribe.md @@ -0,0 +1,36 @@ +--- +id: Subscribe +title: Subscribe +--- + +# Function: Subscribe() + +```ts +function Subscribe(props): ComponentChildren; +``` + +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. + +This is useful for opting into state re-renders for specific parts of the state. + +## Type Parameters + +### TSourceData + +`TSourceData` + +### TSelected + +`TSelected` + +## Parameters + +### props + +[`SubscribeProps`](../interfaces/SubscribeProps.md)\<`TSourceData`, `TSelected`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/functions/batch.md b/docs/framework/preact/reference/functions/batch.md new file mode 100644 index 000000000..90a86573f --- /dev/null +++ b/docs/framework/preact/reference/functions/batch.md @@ -0,0 +1,22 @@ +--- +id: batch +title: batch +--- + +# Function: batch() + +```ts +function batch(fn): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:5 + +## Parameters + +### fn + +() => `void` + +## Returns + +`void` diff --git a/docs/framework/preact/reference/functions/createAsyncAtom.md b/docs/framework/preact/reference/functions/createAsyncAtom.md new file mode 100644 index 000000000..013b66fbf --- /dev/null +++ b/docs/framework/preact/reference/functions/createAsyncAtom.md @@ -0,0 +1,32 @@ +--- +id: createAsyncAtom +title: createAsyncAtom +--- + +# Function: createAsyncAtom() + +```ts +function createAsyncAtom(getValue, options?): ReadonlyAtom>; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:16 + +## Type Parameters + +### T + +`T` + +## Parameters + +### getValue + +() => `Promise`\<`T`\> + +### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`AsyncAtomState`\<`T`, `unknown`\>\> + +## Returns + +[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`AsyncAtomState`\<`T`, `unknown`\>\> diff --git a/docs/framework/preact/reference/functions/createAtom.md b/docs/framework/preact/reference/functions/createAtom.md new file mode 100644 index 000000000..a48f2de04 --- /dev/null +++ b/docs/framework/preact/reference/functions/createAtom.md @@ -0,0 +1,62 @@ +--- +id: createAtom +title: createAtom +--- + +# Function: createAtom() + +## Call Signature + +```ts +function createAtom(getValue, options?): ReadonlyAtom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:17 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`T`\> + +## Call Signature + +```ts +function createAtom(initialValue, options?): Atom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:18 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`Atom`](../interfaces/Atom.md)\<`T`\> diff --git a/docs/framework/preact/reference/functions/createFormHook.md b/docs/framework/preact/reference/functions/createFormHook.md new file mode 100644 index 000000000..1a40c7676 --- /dev/null +++ b/docs/framework/preact/reference/functions/createFormHook.md @@ -0,0 +1,28 @@ +--- +id: createFormHook +title: createFormHook +--- + +# Function: createFormHook() + +```ts +function createFormHook(createOptions): AppFormHookResult; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](../type-aliases/AnyPreactFormComponentMap.md) + +## Parameters + +### createOptions + +`TComponents` + +## Returns + +[`AppFormHookResult`](../interfaces/AppFormHookResult.md)\<`TComponents`\> diff --git a/docs/framework/preact/reference/functions/createStore.md b/docs/framework/preact/reference/functions/createStore.md new file mode 100644 index 000000000..70e32d306 --- /dev/null +++ b/docs/framework/preact/reference/functions/createStore.md @@ -0,0 +1,86 @@ +--- +id: createStore +title: createStore +--- + +# Function: createStore() + +## Call Signature + +```ts +function createStore(getValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:30 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +### Returns + +[`ReadonlyStore`](../classes/ReadonlyStore.md)\<`T`\> + +## Call Signature + +```ts +function createStore(initialValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:31 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +### Returns + +[`Store`](../classes/Store.md)\<`T`\> + +## Call Signature + +```ts +function createStore(initialValue, actions): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:32 + +### Type Parameters + +#### T + +`T` + +#### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) + +### Parameters + +#### initialValue + +`NonFunction`\<`T`\> + +#### actions + +[`StoreActionsFactory`](../type-aliases/StoreActionsFactory.md)\<`T`, `TActions`\> + +### Returns + +[`Store`](../classes/Store.md)\<`T`, `TActions`\> diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md new file mode 100644 index 000000000..3a4a9b0e7 --- /dev/null +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -0,0 +1,95 @@ +--- +id: createStoreContext +title: createStoreContext +--- + +# Function: createStoreContext() + +```ts +function createStoreContext(): object; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/createStoreContext.d.ts:44 + +Creates a typed Preact context for sharing a bundle of atoms and stores with +a subtree. + +The returned `StoreProvider` only transports the provided object through +Preact context. Consumers destructure the contextual atoms and stores, then +compose them with the existing hooks like [useSelector](useSelector.md) and +[useAtom](useAtom.md). + +The object shape is preserved exactly, so keyed atoms and stores remain fully +typed when read back with `useStoreContext()`. + +## Type Parameters + +### TValue + +`TValue` *extends* `object` + +## Returns + +`object` + +### StoreProvider + +```ts +StoreProvider: (__namedParameters) => Element; +``` + +#### Parameters + +##### \_\_namedParameters + +###### children? + +`ComponentChildren` + +###### value + +`TValue` + +#### Returns + +`Element` + +### useStoreContext + +```ts +useStoreContext: () => TValue; +``` + +#### Returns + +`TValue` + +## Example + +```tsx +const { StoreProvider, useStoreContext } = createStoreContext<{ + countAtom: Atom + totalsStore: Store<{ count: number }> +}>() + +function CountButton() { + const { countAtom, totalsStore } = useStoreContext() + const count = useSelector(countAtom) + const total = useSelector(totalsStore, (state) => state.count) + + return ( + + ) +} +``` + +## Throws + +When `useStoreContext()` is called outside the matching `StoreProvider`. diff --git a/docs/framework/preact/reference/functions/flush.md b/docs/framework/preact/reference/functions/flush.md new file mode 100644 index 000000000..733f2da2a --- /dev/null +++ b/docs/framework/preact/reference/functions/flush.md @@ -0,0 +1,16 @@ +--- +id: flush +title: flush +--- + +# Function: flush() + +```ts +function flush(): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:6 + +## Returns + +`void` diff --git a/docs/framework/preact/reference/functions/getFieldGroupHelpers.md b/docs/framework/preact/reference/functions/getFieldGroupHelpers.md new file mode 100644 index 000000000..c6476d7cb --- /dev/null +++ b/docs/framework/preact/reference/functions/getFieldGroupHelpers.md @@ -0,0 +1,16 @@ +--- +id: getFieldGroupHelpers +title: getFieldGroupHelpers +--- + +# Function: getFieldGroupHelpers() + +```ts +function getFieldGroupHelpers(): FieldGroupHelpers>; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:217](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L217) + +## Returns + +[`FieldGroupHelpers`](../interfaces/FieldGroupHelpers.md)\<`Record`\<`never`, `never`\>\> diff --git a/docs/framework/preact/reference/functions/getFormHookHelpers.md b/docs/framework/preact/reference/functions/getFormHookHelpers.md new file mode 100644 index 000000000..b34d981c8 --- /dev/null +++ b/docs/framework/preact/reference/functions/getFormHookHelpers.md @@ -0,0 +1,16 @@ +--- +id: getFormHookHelpers +title: getFormHookHelpers +--- + +# Function: getFormHookHelpers() + +```ts +function getFormHookHelpers(): FormHookHelpers; +``` + +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 + +[`FormHookHelpers`](../interfaces/FormHookHelpers.md) diff --git a/docs/framework/preact/reference/functions/shallow.md b/docs/framework/preact/reference/functions/shallow.md new file mode 100644 index 000000000..021c4473c --- /dev/null +++ b/docs/framework/preact/reference/functions/shallow.md @@ -0,0 +1,32 @@ +--- +id: shallow +title: shallow +--- + +# Function: shallow() + +```ts +function shallow(objA, objB): boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/shallow.d.ts:2 + +## Type Parameters + +### T + +`T` + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/framework/preact/reference/functions/toObserver.md b/docs/framework/preact/reference/functions/toObserver.md new file mode 100644 index 000000000..dd7bb1090 --- /dev/null +++ b/docs/framework/preact/reference/functions/toObserver.md @@ -0,0 +1,39 @@ +--- +id: toObserver +title: toObserver +--- + +# Function: toObserver() + +```ts +function toObserver( + nextHandler?, + errorHandler?, +completionHandler?): Observer; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:4 + +## Type Parameters + +### T + +`T` + +## Parameters + +### nextHandler? + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +### errorHandler? + +(`error`) => `void` + +### completionHandler? + +() => `void` + +## Returns + +[`Observer`](../type-aliases/Observer.md)\<`T`\> diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md new file mode 100644 index 000000000..149bb8edd --- /dev/null +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -0,0 +1,49 @@ +--- +id: useAtom +title: useAtom +--- + +# Function: useAtom() + +```ts +function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useAtom.d.ts:22 + +Returns the current atom value together with a stable setter. + +Use this when a component needs to both read and update the same writable +atom. + +## Type Parameters + +### TValue + +`TValue` + +## Parameters + +### atom + +[`Atom`](../interfaces/Atom.md)\<`TValue`\> + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TValue`\> + +## Returns + +\[`TValue`, (`fn`) => `void` & (`value`) => `void`\] + +## Example + +```tsx +const [count, setCount] = useAtom(countAtom) + +return ( + +) +``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md new file mode 100644 index 000000000..f4b4a4e97 --- /dev/null +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -0,0 +1,104 @@ +--- +id: useCreateAtom +title: useCreateAtom +--- + +# Function: useCreateAtom() + +## Call Signature + +```ts +function useCreateAtom(getValue, options?): ReadonlyAtom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useCreateAtom.d.ts:25 + +Creates a stable atom instance for the lifetime of the component. + +Pass an initial value to create a writable atom, or a getter function to +create a readonly derived atom. This mirrors [createAtom](createAtom.md), but only +creates the atom once per component mount. + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`T`\> + +### Example + +```tsx +function Counter() { + const countAtom = useCreateAtom(0) + const [count, setCount] = useAtom(countAtom) + + return ( + + ) +} +``` + +## Call Signature + +```ts +function useCreateAtom(initialValue, options?): Atom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useCreateAtom.d.ts:26 + +Creates a stable atom instance for the lifetime of the component. + +Pass an initial value to create a writable atom, or a getter function to +create a readonly derived atom. This mirrors [createAtom](createAtom.md), but only +creates the atom once per component mount. + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`Atom`](../interfaces/Atom.md)\<`T`\> + +### Example + +```tsx +function Counter() { + const countAtom = useCreateAtom(0) + const [count, setCount] = useAtom(countAtom) + + return ( + + ) +} +``` diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md new file mode 100644 index 000000000..b0c3019b6 --- /dev/null +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -0,0 +1,161 @@ +--- +id: useCreateStore +title: useCreateStore +--- + +# Function: useCreateStore() + +## Call Signature + +```ts +function useCreateStore(getValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useCreateStore.d.ts:30 + +Creates a stable store instance for the lifetime of the component. + +Pass an initial value to create a writable store, or a getter function to +create a readonly derived store. This mirrors [createStore](createStore.md), but only +creates the store once per component mount. + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +### Returns + +[`ReadonlyStore`](../classes/ReadonlyStore.md)\<`T`\> + +### Example + +```tsx +function Counter() { + const counterStore = useCreateStore({ count: 0 }) + const count = useSelector(counterStore, (state) => state.count) + const setState = useSetValue(counterStore) + + return ( + + ) +} +``` + +## Call Signature + +```ts +function useCreateStore(initialValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useCreateStore.d.ts:31 + +Creates a stable store instance for the lifetime of the component. + +Pass an initial value to create a writable store, or a getter function to +create a readonly derived store. This mirrors [createStore](createStore.md), but only +creates the store once per component mount. + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +### Returns + +[`Store`](../classes/Store.md)\<`T`\> + +### Example + +```tsx +function Counter() { + const counterStore = useCreateStore({ count: 0 }) + const count = useSelector(counterStore, (state) => state.count) + const setState = useSetValue(counterStore) + + return ( + + ) +} +``` + +## Call Signature + +```ts +function useCreateStore(initialValue, actions): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useCreateStore.d.ts:32 + +Creates a stable store instance for the lifetime of the component. + +Pass an initial value to create a writable store, or a getter function to +create a readonly derived store. This mirrors [createStore](createStore.md), but only +creates the store once per component mount. + +### Type Parameters + +#### T + +`T` + +#### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) + +### Parameters + +#### initialValue + +`NonFunction`\<`T`\> + +#### actions + +[`StoreActionsFactory`](../type-aliases/StoreActionsFactory.md)\<`T`, `TActions`\> + +### Returns + +[`Store`](../classes/Store.md)\<`T`, `TActions`\> + +### Example + +```tsx +function Counter() { + const counterStore = useCreateStore({ count: 0 }) + const count = useSelector(counterStore, (state) => state.count) + const setState = useSetValue(counterStore) + + return ( + + ) +} +``` diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md new file mode 100644 index 000000000..dd3f3162a --- /dev/null +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -0,0 +1,60 @@ +--- +id: useSelector +title: useSelector +--- + +# Function: useSelector() + +```ts +function useSelector( + source, + selector?, + options?): TSelected; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useSelector.d.ts:29 + +Selects a slice of state from an atom or store and subscribes the component +to that selection. + +This is the primary Preact read hook for TanStack Store. Use it when a +component only needs part of a source value, or omit the selector to +subscribe to the whole value. + +## Type Parameters + +### TSource + +`TSource` + +### TSelected + +`TSelected` = `NoInfer`\<`TSource`\> + +## Parameters + +### source + +`SelectionSource`\<`TSource`\> + +### selector? + +(`snapshot`) => `TSelected` + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TSelected`\> + +## Returns + +`TSelected` + +## Examples + +```tsx +const count = useSelector(counterStore, (state) => state.count) +``` + +```tsx +const value = useSelector(countAtom) +``` diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md new file mode 100644 index 000000000..97fcc8c81 --- /dev/null +++ b/docs/framework/preact/reference/functions/useStore.md @@ -0,0 +1,64 @@ +--- +id: _useStore +title: _useStore +--- + +# Function: \_useStore() + +```ts +function _useStore( + store, + selector, + options?): [TSelected, [TActions] extends [never] ? (updater) => void : TActions]; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/\_useStore.d.ts:22 + +Experimental combined read+write hook for stores, mirroring useAtom's tuple +pattern. + +Returns `[selected, actions]` when the store has an actions factory, or +`[selected, setState]` for plain stores. + +## Type Parameters + +### TState + +`TState` + +### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) + +### TSelected + +`TSelected` = `NoInfer`\<`TState`\> + +## Parameters + +### store + +[`Store`](../classes/Store.md)\<`TState`, `TActions`\> + +### selector + +(`state`) => `TSelected` + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TSelected`\> + +## Returns + +\[`TSelected`, \[`TActions`\] *extends* \[`never`\] ? (`updater`) => `void` : `TActions`\] + +## Example + +```tsx +// Store with actions +const [cats, { addCat }] = _useStore(petStore, (s) => s.cats) + +// Store without actions +const [count, setState] = _useStore(plainStore, (s) => s) +setState((prev) => prev + 1) +``` diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md new file mode 100644 index 000000000..29b432a8b --- /dev/null +++ b/docs/framework/preact/reference/index.md @@ -0,0 +1,121 @@ +--- +id: "@tanstack/preact-form" +title: "@tanstack/preact-form" +--- + +# @tanstack/preact-form + +## Classes + +- [ReadonlyStore](classes/ReadonlyStore.md) +- [Store](classes/Store.md) + +## Interfaces + +- [AppFormHookResult](interfaces/AppFormHookResult.md) +- [AppFormOptions](interfaces/AppFormOptions.md) +- [AppFormOptionsApi](interfaces/AppFormOptionsApi.md) +- [Atom](interfaces/Atom.md) +- [AtomOptions](interfaces/AtomOptions.md) +- [BaseAtom](interfaces/BaseAtom.md) +- [FieldGroupApi](interfaces/FieldGroupApi.md) +- [FieldGroupArrayFieldComponent](interfaces/FieldGroupArrayFieldComponent.md) +- [FieldGroupFieldComponent](interfaces/FieldGroupFieldComponent.md) +- [FieldGroupFieldSlot](interfaces/FieldGroupFieldSlot.md) +- [FieldGroupHelper](interfaces/FieldGroupHelper.md) +- [FieldGroupHelpers](interfaces/FieldGroupHelpers.md) +- [FormHookHelpers](interfaces/FormHookHelpers.md) +- [InternalBaseAtom](interfaces/InternalBaseAtom.md) +- [InternalReadonlyAtom](interfaces/InternalReadonlyAtom.md) +- [InteropSubscribable](interfaces/InteropSubscribable.md) +- [PreactFormComponentMap](interfaces/PreactFormComponentMap.md) +- [PreactFormFieldProps](interfaces/PreactFormFieldProps.md) +- [PreactFormGroupApi](interfaces/PreactFormGroupApi.md) +- [PreactFormGroupComponent](interfaces/PreactFormGroupComponent.md) +- [PreactFormGroupFieldComponent](interfaces/PreactFormGroupFieldComponent.md) +- [PreactFormGroupProps](interfaces/PreactFormGroupProps.md) +- [PreactTanStackFormComponents](interfaces/PreactTanStackFormComponents.md) +- [Readable](interfaces/Readable.md) +- [ReadonlyAtom](interfaces/ReadonlyAtom.md) +- [Subscribable](interfaces/Subscribable.md) +- [SubscribeProps](interfaces/SubscribeProps.md) +- [Subscription](interfaces/Subscription.md) +- [UseSelectorOptions](interfaces/UseSelectorOptions.md) + +## Type Aliases + +- [AnyAtom](type-aliases/AnyAtom.md) +- [AnyFieldGroupApi](type-aliases/AnyFieldGroupApi.md) +- [AnyFieldGroupFieldSlot](type-aliases/AnyFieldGroupFieldSlot.md) +- [AnyPreactFormApi](type-aliases/AnyPreactFormApi.md) +- [AnyPreactFormComponentMap](type-aliases/AnyPreactFormComponentMap.md) +- [AppFormComponent](type-aliases/AppFormComponent.md) +- [CrossVersionPreactNode](type-aliases/CrossVersionPreactNode.md) +- [DefaultPreactFormComponentMap](type-aliases/DefaultPreactFormComponentMap.md) +- [DefineFieldsFn](type-aliases/DefineFieldsFn.md) +- [FieldGroupDefinition](type-aliases/FieldGroupDefinition.md) +- [FieldGroupFieldBindingForSlot](type-aliases/FieldGroupFieldBindingForSlot.md) +- [FieldGroupFieldBindings](type-aliases/FieldGroupFieldBindings.md) +- [FieldGroupFieldBindingsOf](type-aliases/FieldGroupFieldBindingsOf.md) +- [FieldGroupFieldComponentsOf](type-aliases/FieldGroupFieldComponentsOf.md) +- [FieldGroupFieldData](type-aliases/FieldGroupFieldData.md) +- [FieldGroupFieldNameForSlot](type-aliases/FieldGroupFieldNameForSlot.md) +- [FieldGroupFieldNames](type-aliases/FieldGroupFieldNames.md) +- [FieldGroupFields](type-aliases/FieldGroupFields.md) +- [FieldGroupFieldSlotAllows](type-aliases/FieldGroupFieldSlotAllows.md) +- [FieldGroupFieldSlotMode](type-aliases/FieldGroupFieldSlotMode.md) +- [FieldGroupFieldSlotModeOf](type-aliases/FieldGroupFieldSlotModeOf.md) +- [FieldGroupFieldSlotValue](type-aliases/FieldGroupFieldSlotValue.md) +- [FieldGroupFieldsOf](type-aliases/FieldGroupFieldsOf.md) +- [FieldGroupFieldsPropName](type-aliases/FieldGroupFieldsPropName.md) +- [FieldGroupForm](type-aliases/FieldGroupForm.md) +- [FieldGroupFormState](type-aliases/FieldGroupFormState.md) +- [FieldGroupSubscribeComponent](type-aliases/FieldGroupSubscribeComponent.md) +- [FieldGroupSubscribeProps](type-aliases/FieldGroupSubscribeProps.md) +- [FieldGroupWithFieldsFn](type-aliases/FieldGroupWithFieldsFn.md) +- [LooseFieldGroupFieldSlot](type-aliases/LooseFieldGroupFieldSlot.md) +- [Observer](type-aliases/Observer.md) +- [PreactAppFormApi](type-aliases/PreactAppFormApi.md) +- [PreactFieldApi](type-aliases/PreactFieldApi.md) +- [PreactFormApi](type-aliases/PreactFormApi.md) +- [PreactFormArrayFieldComponent](type-aliases/PreactFormArrayFieldComponent.md) +- [PreactFormFieldComponent](type-aliases/PreactFormFieldComponent.md) +- [PreactFormGroupArrayFieldComponent](type-aliases/PreactFormGroupArrayFieldComponent.md) +- [PreactFormGroupSubscribeComponent](type-aliases/PreactFormGroupSubscribeComponent.md) +- [PreactFormGroupSubscribeProps](type-aliases/PreactFormGroupSubscribeProps.md) +- [PreactFormSubscribeComponent](type-aliases/PreactFormSubscribeComponent.md) +- [PreactFormSubscribeProps](type-aliases/PreactFormSubscribeProps.md) +- [PreactFormType](type-aliases/PreactFormType.md) +- [Selection](type-aliases/Selection.md) +- [StoreAction](type-aliases/StoreAction.md) +- [StoreActionMap](type-aliases/StoreActionMap.md) +- [StoreActionsFactory](type-aliases/StoreActionsFactory.md) +- [StrictFieldGroupFieldSlot](type-aliases/StrictFieldGroupFieldSlot.md) +- [SubscribeSource](type-aliases/SubscribeSource.md) +- [UseAppFormHook](type-aliases/UseAppFormHook.md) +- [UseFormHook](type-aliases/UseFormHook.md) + +## Variables + +- [useForm](variables/useForm.md) +- [~~useStore~~](variables/useStore.md) + +## Functions + +- [\_useStore](functions/useStore.md) +- [batch](functions/batch.md) +- [createAsyncAtom](functions/createAsyncAtom.md) +- [createAtom](functions/createAtom.md) +- [createFormHook](functions/createFormHook.md) +- [createStore](functions/createStore.md) +- [createStoreContext](functions/createStoreContext.md) +- [flush](functions/flush.md) +- [getFieldGroupHelpers](functions/getFieldGroupHelpers.md) +- [getFormHookHelpers](functions/getFormHookHelpers.md) +- [shallow](functions/shallow.md) +- [Subscribe](functions/Subscribe.md) +- [toObserver](functions/toObserver.md) +- [useAtom](functions/useAtom.md) +- [useCreateAtom](functions/useCreateAtom.md) +- [useCreateStore](functions/useCreateStore.md) +- [useSelector](functions/useSelector.md) diff --git a/docs/framework/preact/reference/interfaces/AppFormHookResult.md b/docs/framework/preact/reference/interfaces/AppFormHookResult.md new file mode 100644 index 000000000..5e672a076 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/AppFormHookResult.md @@ -0,0 +1,62 @@ +--- +id: AppFormHookResult +title: AppFormHookResult +--- + +# Interface: AppFormHookResult\ + +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 + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](../type-aliases/AnyPreactFormComponentMap.md) + +## Properties + +### appFormOptions + +```ts +appFormOptions: AppFormOptionsApi; +``` + +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) + +*** + +### getAppFieldGroupHelpers + +```ts +getAppFieldGroupHelpers: () => FieldGroupHelpers; +``` + +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) + +#### Returns + +[`FieldGroupHelpers`](FieldGroupHelpers.md)\<`TComponents`\[`"fieldComponents"`\]\> + +*** + +### useAppForm + +```ts +useAppForm: UseAppFormHook; +``` + +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L32) + +*** + +### useFormContext + +```ts +useFormContext: () => PreactAppFormApi; +``` + +Defined in: [packages/preact-form/src/AppForm/createFormHookTypes.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/AppForm/createFormHookTypes.public.ts#L33) + +#### Returns + +[`PreactAppFormApi`](../type-aliases/PreactAppFormApi.md)\<`any`, `any`, `TComponents`\> diff --git a/docs/framework/preact/reference/interfaces/AppFormOptions.md b/docs/framework/preact/reference/interfaces/AppFormOptions.md new file mode 100644 index 000000000..db9731e20 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/AppFormOptions.md @@ -0,0 +1,40 @@ +--- +id: AppFormOptions +title: AppFormOptions +--- + +# Interface: AppFormOptions\ + +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 + +- `FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](../type-aliases/AnyPreactFormComponentMap.md) + +## Properties + +### \[componentsSymbol\] + +```ts +[componentsSymbol]: TComponents; +``` + +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 new file mode 100644 index 000000000..5e6de7665 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/AppFormOptionsApi.md @@ -0,0 +1,112 @@ +--- +id: AppFormOptionsApi +title: AppFormOptionsApi +--- + +# Interface: AppFormOptionsApi()\ + +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 + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](../type-aliases/AnyPreactFormComponentMap.md) + +```ts +AppFormOptionsApi(options): AppFormOptions; +``` + +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 + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`AppFormOptions`](AppFormOptions.md)\<`TFormData`, `TFormValidators`, `TSubmitReturn`, `TComponents`\> + +## Properties + +### looseSchema + +```ts +looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; +``` + +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 + +##### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`any`\> + +##### TFormData + +`TFormData` *extends* `any` + +##### TSubmitReturn + +`TSubmitReturn` + +#### Parameters + +##### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +#### Returns + +[`AppFormOptions`](AppFormOptions.md)\<`InferUnion`\<`TFormData`, `FormValidatorData`\<`TFormValidators`\>\>, `TFormValidators`, `TSubmitReturn`, `TComponents`\> + +*** + +### strictSchema + +```ts +strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; +``` + +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 + +##### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`any`\> + +##### TFormData + +`TFormData` *extends* `any` + +##### TSubmitReturn + +`TSubmitReturn` + +#### Parameters + +##### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +#### Returns + +[`AppFormOptions`](AppFormOptions.md)\<`FormValidatorData`\<`TFormValidators`\>, `TFormValidators`, `TSubmitReturn`, `TComponents`\> diff --git a/docs/framework/preact/reference/interfaces/Atom.md b/docs/framework/preact/reference/interfaces/Atom.md new file mode 100644 index 000000000..abee2295d --- /dev/null +++ b/docs/framework/preact/reference/interfaces/Atom.md @@ -0,0 +1,62 @@ +--- +id: Atom +title: Atom +--- + +# Interface: Atom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:29 + +## Extends + +- [`BaseAtom`](BaseAtom.md)\<`T`\> + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`get`](BaseAtom.md#get) + +*** + +### set + +```ts +set: (fn) => void & (value) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:31 + +Sets the value of the atom using a function. + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`subscribe`](BaseAtom.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/AtomOptions.md b/docs/framework/preact/reference/interfaces/AtomOptions.md new file mode 100644 index 000000000..12e6fb877 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/AtomOptions.md @@ -0,0 +1,38 @@ +--- +id: AtomOptions +title: AtomOptions +--- + +# Interface: AtomOptions\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:33 + +## Type Parameters + +### T + +`T` + +## Properties + +### compare? + +```ts +optional compare?: (prev, next) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:34 + +#### Parameters + +##### prev + +`T` + +##### next + +`T` + +#### Returns + +`boolean` diff --git a/docs/framework/preact/reference/interfaces/BaseAtom.md b/docs/framework/preact/reference/interfaces/BaseAtom.md new file mode 100644 index 000000000..ac15f7f6c --- /dev/null +++ b/docs/framework/preact/reference/interfaces/BaseAtom.md @@ -0,0 +1,55 @@ +--- +id: BaseAtom +title: BaseAtom +--- + +# Interface: BaseAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:22 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\>.[`Readable`](Readable.md)\<`T`\> + +## Extended by + +- [`Atom`](Atom.md) +- [`ReadonlyAtom`](ReadonlyAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`Readable`](Readable.md).[`get`](Readable.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/FieldGroupApi.md b/docs/framework/preact/reference/interfaces/FieldGroupApi.md new file mode 100644 index 000000000..5c0fee8ed --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupApi.md @@ -0,0 +1,62 @@ +--- +id: FieldGroupApi +title: FieldGroupApi +--- + +# Interface: FieldGroupApi\ + +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 + +- `FormApiFieldMethods`\<`TFieldData`\>.`FormApiArrayMethods`\<`TFieldData`\> + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> = `Record`\<`never`, `never`\> + +## Properties + +### ArrayField + +```ts +ArrayField: FieldGroupArrayFieldComponent; +``` + +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) + +*** + +### atom + +```ts +atom: ReadonlyAtom; +``` + +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) + +*** + +### Field + +```ts +Field: FieldGroupFieldComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: FieldGroupSubscribeComponent; +``` + +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 new file mode 100644 index 000000000..03497fe44 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupArrayFieldComponent.md @@ -0,0 +1,40 @@ +--- +id: FieldGroupArrayFieldComponent +title: FieldGroupArrayFieldComponent +--- + +# Interface: FieldGroupArrayFieldComponent()\ + +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 + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +```ts +FieldGroupArrayFieldComponent(props): ComponentChildren; +``` + +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 + +### TFieldName + +`TFieldName` *extends* `never` + +## Parameters + +### props + +[`PreactFormFieldProps`](PreactFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`\<`ValidationIssue`, `ValidationIssue`\>, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md b/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md new file mode 100644 index 000000000..283116fee --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupFieldComponent.md @@ -0,0 +1,40 @@ +--- +id: FieldGroupFieldComponent +title: FieldGroupFieldComponent +--- + +# Interface: FieldGroupFieldComponent()\ + +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 + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +```ts +FieldGroupFieldComponent(props): ComponentChildren; +``` + +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 + +### TFieldName + +`TFieldName` *extends* `string` + +## Parameters + +### props + +[`PreactFormFieldProps`](PreactFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`\<`ValidationIssue`, `ValidationIssue`\>, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md new file mode 100644 index 000000000..38cde53a0 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupFieldSlot.md @@ -0,0 +1,38 @@ +--- +id: FieldGroupFieldSlot +title: FieldGroupFieldSlot +--- + +# Interface: FieldGroupFieldSlot\ + +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) + +## Type Parameters + +### TValue + +`TValue` + +### TMode + +`TMode` *extends* [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md) = [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md) + +## Properties + +### \[fieldGroupFieldSlotValueSymbol\] + +```ts +readonly [fieldGroupFieldSlotValueSymbol]: TValue; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L27) + +*** + +### mode + +```ts +readonly mode: TMode; +``` + +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/interfaces/FieldGroupHelper.md b/docs/framework/preact/reference/interfaces/FieldGroupHelper.md new file mode 100644 index 000000000..60ace6e57 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupHelper.md @@ -0,0 +1,48 @@ +--- +id: FieldGroupHelper +title: FieldGroupHelper +--- + +# Interface: FieldGroupHelper + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L181) + +## Properties + +### loose + +```ts +loose: () => LooseFieldGroupFieldSlot; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L183) + +#### Type Parameters + +##### TValue + +`TValue` + +#### Returns + +[`LooseFieldGroupFieldSlot`](../type-aliases/LooseFieldGroupFieldSlot.md)\<`TValue`\> + +*** + +### strict + +```ts +strict: () => StrictFieldGroupFieldSlot; +``` + +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 + +##### TValue + +`TValue` + +#### Returns + +[`StrictFieldGroupFieldSlot`](../type-aliases/StrictFieldGroupFieldSlot.md)\<`TValue`\> diff --git a/docs/framework/preact/reference/interfaces/FieldGroupHelpers.md b/docs/framework/preact/reference/interfaces/FieldGroupHelpers.md new file mode 100644 index 000000000..764a68856 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FieldGroupHelpers.md @@ -0,0 +1,44 @@ +--- +id: FieldGroupHelpers +title: FieldGroupHelpers +--- + +# Interface: FieldGroupHelpers\ + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:199](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L199) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### defineFields + +```ts +defineFields: DefineFieldsFn; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:203](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L203) + +*** + +### helper + +```ts +helper: FieldGroupHelper; +``` + +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) + +*** + +### withFields + +```ts +withFields: FieldGroupWithFieldsFn; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:204](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L204) diff --git a/docs/framework/preact/reference/interfaces/FormHookHelpers.md b/docs/framework/preact/reference/interfaces/FormHookHelpers.md new file mode 100644 index 000000000..d985f3f08 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/FormHookHelpers.md @@ -0,0 +1,28 @@ +--- +id: FormHookHelpers +title: FormHookHelpers +--- + +# Interface: FormHookHelpers + +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 + +### fieldBrand + +```ts +fieldBrand: FieldBrandHelper; +``` + +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) + +*** + +### fieldComponent + +```ts +fieldComponent: FieldComponentHelper; +``` + +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/InternalBaseAtom.md b/docs/framework/preact/reference/interfaces/InternalBaseAtom.md new file mode 100644 index 000000000..cb05b8c49 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/InternalBaseAtom.md @@ -0,0 +1,88 @@ +--- +id: InternalBaseAtom +title: InternalBaseAtom +--- + +# Interface: InternalBaseAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:23 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\>.[`Readable`](Readable.md)\<`T`\> + +## Extended by + +- [`InternalReadonlyAtom`](InternalReadonlyAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### \_snapshot + +```ts +_snapshot: T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:25 + +**`Internal`** + +*** + +### \_update + +```ts +_update: (getValue?) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:27 + +**`Internal`** + +#### Parameters + +##### getValue? + +`T` \| ((`snapshot`) => `T`) + +#### Returns + +`boolean` + +*** + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`Readable`](Readable.md).[`get`](Readable.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/InternalReadonlyAtom.md b/docs/framework/preact/reference/interfaces/InternalReadonlyAtom.md new file mode 100644 index 000000000..a600ae031 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/InternalReadonlyAtom.md @@ -0,0 +1,172 @@ +--- +id: InternalReadonlyAtom +title: InternalReadonlyAtom +--- + +# Interface: InternalReadonlyAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:37 + +## Extends + +- [`InternalBaseAtom`](InternalBaseAtom.md)\<`T`\>.`ReactiveNode` + +## Type Parameters + +### T + +`T` + +## Properties + +### \_snapshot + +```ts +_snapshot: T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:25 + +**`Internal`** + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`_snapshot`](InternalBaseAtom.md#_snapshot) + +*** + +### \_update + +```ts +_update: (getValue?) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:27 + +**`Internal`** + +#### Parameters + +##### getValue? + +`T` \| ((`snapshot`) => `T`) + +#### Returns + +`boolean` + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`_update`](InternalBaseAtom.md#_update) + +*** + +### deps? + +```ts +optional deps?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:3 + +#### Inherited from + +```ts +ReactiveNode.deps +``` + +*** + +### depsTail? + +```ts +optional depsTail?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:4 + +#### Inherited from + +```ts +ReactiveNode.depsTail +``` + +*** + +### flags + +```ts +flags: number; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:7 + +#### Inherited from + +```ts +ReactiveNode.flags +``` + +*** + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`get`](InternalBaseAtom.md#get) + +*** + +### subs? + +```ts +optional subs?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:5 + +#### Inherited from + +```ts +ReactiveNode.subs +``` + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`subscribe`](InternalBaseAtom.md#subscribe) + +*** + +### subsTail? + +```ts +optional subsTail?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:6 + +#### Inherited from + +```ts +ReactiveNode.subsTail +``` diff --git a/docs/framework/preact/reference/interfaces/InteropSubscribable.md b/docs/framework/preact/reference/interfaces/InteropSubscribable.md new file mode 100644 index 000000000..2d0f2130c --- /dev/null +++ b/docs/framework/preact/reference/interfaces/InteropSubscribable.md @@ -0,0 +1,38 @@ +--- +id: InteropSubscribable +title: InteropSubscribable +--- + +# Interface: InteropSubscribable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:5 + +## Extended by + +- [`Subscribable`](Subscribable.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### subscribe + +```ts +subscribe: (observer) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:6 + +#### Parameters + +##### observer + +[`Observer`](../type-aliases/Observer.md)\<`T`\> + +#### Returns + +[`Subscription`](Subscription.md) diff --git a/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md b/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md new file mode 100644 index 000000000..d96164229 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormComponentMap.md @@ -0,0 +1,38 @@ +--- +id: PreactFormComponentMap +title: PreactFormComponentMap +--- + +# Interface: PreactFormComponentMap\ + +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 + +### TFormComponents + +`TFormComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### fieldComponents + +```ts +fieldComponents: TFieldComponents; +``` + +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) + +*** + +### formComponents + +```ts +formComponents: TFormComponents; +``` + +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 new file mode 100644 index 000000000..b6e61bfbb --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormFieldProps.md @@ -0,0 +1,66 @@ +--- +id: PreactFormFieldProps +title: PreactFormFieldProps +--- + +# Interface: PreactFormFieldProps\ + +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 + +- `FieldApiOptions`\<`TFieldData`, `TFieldName`, `TFieldValue`, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\> + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFieldName + +`TFieldName` + +### TFieldValue + +`TFieldValue` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TFieldData`, `TFieldName`, `TFieldValue`\> + +### TGroupFieldError + +`TGroupFieldError` + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### children + +```ts +children: (fieldApi) => ComponentChildren; +``` + +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 + +##### fieldApi + +[`PreactFieldApi`](../type-aliases/PreactFieldApi.md)\<`TFieldName`, `TFieldValue`, `ToFieldError`\<`NoInfer`\<`TFieldValidators`\>, `TGroupFieldError`, `TFormErrorTypes`\>, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> + +#### Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md b/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md new file mode 100644 index 000000000..bab236cbb --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupApi.md @@ -0,0 +1,68 @@ +--- +id: PreactFormGroupApi +title: PreactFormGroupApi +--- + +# Interface: PreactFormGroupApi\ + +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 + +- `FormGroupApi`\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupErrorTypes`, `TFormErrorTypes`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TGroupName + +`TGroupName` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### ArrayField + +```ts +ArrayField: PreactFormGroupArrayFieldComponent; +``` + +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) + +*** + +### Field + +```ts +Field: PreactFormGroupFieldComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: PreactFormGroupSubscribeComponent; +``` + +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 new file mode 100644 index 000000000..f10927896 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupComponent.md @@ -0,0 +1,52 @@ +--- +id: PreactFormGroupComponent +title: PreactFormGroupComponent +--- + +# Interface: PreactFormGroupComponent()\ + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +```ts +PreactFormGroupComponent(props): ComponentChildren; +``` + +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 + +### TGroupName + +`TGroupName` *extends* `string` + +### TGroupValue + +`TGroupValue` + +### TGroupValidators + +`TGroupValidators` *extends* `FormGroupValidators`\<`TGroupValue`\> + +## Parameters + +### props + +[`PreactFormGroupProps`](PreactFormGroupProps.md)\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupValidators`, `TFormErrorTypes`, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md b/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md new file mode 100644 index 000000000..5068bf699 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupFieldComponent.md @@ -0,0 +1,56 @@ +--- +id: PreactFormGroupFieldComponent +title: PreactFormGroupFieldComponent +--- + +# Interface: PreactFormGroupFieldComponent()\ + +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 + +### TFormData + +`TFormData` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +```ts +PreactFormGroupFieldComponent(props): ComponentChildren; +``` + +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 + +### TFieldName + +`TFieldName` *extends* `string` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>\> + +## Parameters + +### props + +[`PreactFormFieldProps`](PreactFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md b/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md new file mode 100644 index 000000000..ae106b35a --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactFormGroupProps.md @@ -0,0 +1,58 @@ +--- +id: PreactFormGroupProps +title: PreactFormGroupProps +--- + +# Interface: PreactFormGroupProps\ + +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 + +- `Omit`\<`FormGroupOptions`\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupValidators`, `TFormErrorTypes`\>, `"form"`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TGroupName + +`TGroupName` + +### TGroupValue + +`TGroupValue` + +### TGroupValidators + +`TGroupValidators` *extends* `FormGroupValidators`\<`TGroupValue`\> + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### children + +```ts +children: (groupApi) => ComponentChildren; +``` + +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 + +##### groupApi + +[`PreactFormGroupApi`](PreactFormGroupApi.md)\<`TFormData`, `TGroupName`, `TGroupValue`, `ToFormGroupErrorTypes`\<`NoInfer`\<`TGroupValidators`\>\>, `TFormErrorTypes`, `TFieldComponents`\> + +#### Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md b/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md new file mode 100644 index 000000000..381493d9f --- /dev/null +++ b/docs/framework/preact/reference/interfaces/PreactTanStackFormComponents.md @@ -0,0 +1,64 @@ +--- +id: PreactTanStackFormComponents +title: PreactTanStackFormComponents +--- + +# Interface: PreactTanStackFormComponents\ + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Properties + +### ArrayField + +```ts +ArrayField: PreactFormArrayFieldComponent; +``` + +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) + +*** + +### Field + +```ts +Field: PreactFormFieldComponent; +``` + +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 + +*** + +### FormGroup + +```ts +FormGroup: PreactFormGroupComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: PreactFormSubscribeComponent; +``` + +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/Readable.md b/docs/framework/preact/reference/interfaces/Readable.md new file mode 100644 index 000000000..161714e02 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/Readable.md @@ -0,0 +1,51 @@ +--- +id: Readable +title: Readable +--- + +# Interface: Readable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:19 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\> + +## Extended by + +- [`BaseAtom`](BaseAtom.md) +- [`InternalBaseAtom`](InternalBaseAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/ReadonlyAtom.md b/docs/framework/preact/reference/interfaces/ReadonlyAtom.md new file mode 100644 index 000000000..8ebcdab4d --- /dev/null +++ b/docs/framework/preact/reference/interfaces/ReadonlyAtom.md @@ -0,0 +1,60 @@ +--- +id: ReadonlyAtom +title: ReadonlyAtom +--- + +# Interface: ReadonlyAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:49 + +An atom that is read-only and cannot be set. + +## Example + +```ts +const atom = createAtom(() => 42); +// @ts-expect-error - Cannot set a readonly atom +atom.set(43); +``` + +## Extends + +- [`BaseAtom`](BaseAtom.md)\<`T`\> + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`get`](BaseAtom.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`subscribe`](BaseAtom.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/Subscribable.md b/docs/framework/preact/reference/interfaces/Subscribable.md new file mode 100644 index 000000000..415e8a400 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/Subscribable.md @@ -0,0 +1,38 @@ +--- +id: Subscribable +title: Subscribable +--- + +# Interface: Subscribable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:16 + +## Extends + +- [`InteropSubscribable`](InteropSubscribable.md)\<`T`\> + +## Extended by + +- [`BaseAtom`](BaseAtom.md) +- [`InternalBaseAtom`](InternalBaseAtom.md) +- [`Readable`](Readable.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Overrides + +[`InteropSubscribable`](InteropSubscribable.md).[`subscribe`](InteropSubscribable.md#subscribe) diff --git a/docs/framework/preact/reference/interfaces/SubscribeProps.md b/docs/framework/preact/reference/interfaces/SubscribeProps.md new file mode 100644 index 000000000..4d5f829cf --- /dev/null +++ b/docs/framework/preact/reference/interfaces/SubscribeProps.md @@ -0,0 +1,86 @@ +--- +id: SubscribeProps +title: SubscribeProps +--- + +# Interface: SubscribeProps\ + +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. + +## Type Parameters + +### TSourceData + +`TSourceData` + +### TSelected + +`TSelected` + +## Properties + +### children + +```ts +children: ComponentChildren | ((state) => ComponentChildren); +``` + +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) + +*** + +### selector + +```ts +selector: (state) => TSelected; +``` + +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). + +#### Parameters + +##### state + +`TSourceData` + +#### Returns + +`TSelected` + +*** + +### source + +```ts +source: SubscribeSource; +``` + +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) + +*** + +### when? + +```ts +optional when?: (selected) => boolean; +``` + +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`. + +#### Parameters + +##### selected + +`NoInfer`\<`TSelected`\> + +#### Returns + +`boolean` diff --git a/docs/framework/preact/reference/interfaces/Subscription.md b/docs/framework/preact/reference/interfaces/Subscription.md new file mode 100644 index 000000000..8ed05ffc5 --- /dev/null +++ b/docs/framework/preact/reference/interfaces/Subscription.md @@ -0,0 +1,22 @@ +--- +id: Subscription +title: Subscription +--- + +# Interface: Subscription + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:13 + +## Properties + +### unsubscribe + +```ts +unsubscribe: () => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:14 + +#### Returns + +`void` diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md new file mode 100644 index 000000000..2bc3ec15d --- /dev/null +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -0,0 +1,38 @@ +--- +id: UseSelectorOptions +title: UseSelectorOptions +--- + +# Interface: UseSelectorOptions\ + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useSelector.d.ts:2 + +## Type Parameters + +### TSelected + +`TSelected` + +## Properties + +### compare? + +```ts +optional compare?: (a, b) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useSelector.d.ts:3 + +#### Parameters + +##### a + +`TSelected` + +##### b + +`TSelected` + +#### Returns + +`boolean` diff --git a/docs/framework/preact/reference/type-aliases/AnyAtom.md b/docs/framework/preact/reference/type-aliases/AnyAtom.md new file mode 100644 index 000000000..cced299e9 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AnyAtom.md @@ -0,0 +1,12 @@ +--- +id: AnyAtom +title: AnyAtom +--- + +# Type Alias: AnyAtom + +```ts +type AnyAtom = BaseAtom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:36 diff --git a/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md new file mode 100644 index 000000000..319c6b487 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AnyFieldGroupApi.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldGroupApi +title: AnyFieldGroupApi +--- + +# Type Alias: AnyFieldGroupApi + +```ts +type AnyFieldGroupApi = FieldGroupApi>>; +``` + +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 new file mode 100644 index 000000000..444dcded3 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldGroupFieldSlot +title: AnyFieldGroupFieldSlot +--- + +# Type Alias: AnyFieldGroupFieldSlot + +```ts +type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L30) diff --git a/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md b/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md new file mode 100644 index 000000000..9b9c28ad5 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AnyPreactFormApi.md @@ -0,0 +1,12 @@ +--- +id: AnyPreactFormApi +title: AnyPreactFormApi +--- + +# Type Alias: AnyPreactFormApi + +```ts +type AnyPreactFormApi = AnyFormApi & PreactTanStackFormComponents; +``` + +Defined in: [packages/preact-form/src/PreactForm/formApiTypes.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/formApiTypes.public.ts#L26) diff --git a/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md b/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md new file mode 100644 index 000000000..b58171203 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AnyPreactFormComponentMap.md @@ -0,0 +1,12 @@ +--- +id: AnyPreactFormComponentMap +title: AnyPreactFormComponentMap +--- + +# Type Alias: AnyPreactFormComponentMap + +```ts +type AnyPreactFormComponentMap = PreactFormComponentMap>, Record>>; +``` + +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 new file mode 100644 index 000000000..cf2fae0a3 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/AppFormComponent.md @@ -0,0 +1,14 @@ +--- +id: AppFormComponent +title: AppFormComponent +--- + +# Type Alias: AppFormComponent + +```ts +type AppFormComponent = FunctionComponent<{ + children: Exclude>; +}>; +``` + +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 new file mode 100644 index 000000000..5947bb631 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/CrossVersionPreactNode.md @@ -0,0 +1,15 @@ +--- +id: CrossVersionPreactNode +title: CrossVersionPreactNode +--- + +# Type Alias: CrossVersionPreactNode + +```ts +type CrossVersionPreactNode = ReturnType>; +``` + +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 new file mode 100644 index 000000000..6349e23a5 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/DefaultPreactFormComponentMap.md @@ -0,0 +1,12 @@ +--- +id: DefaultPreactFormComponentMap +title: DefaultPreactFormComponentMap +--- + +# Type Alias: DefaultPreactFormComponentMap + +```ts +type DefaultPreactFormComponentMap = PreactFormComponentMap, Record>; +``` + +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/DefineFieldsFn.md b/docs/framework/preact/reference/type-aliases/DefineFieldsFn.md new file mode 100644 index 000000000..8e4016bac --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/DefineFieldsFn.md @@ -0,0 +1,34 @@ +--- +id: DefineFieldsFn +title: DefineFieldsFn +--- + +# Type Alias: DefineFieldsFn\ + +```ts +type DefineFieldsFn = (fields) => FieldGroupDefinition; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:188](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L188) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +## Parameters + +### fields + +`TFields` + +## Returns + +[`FieldGroupDefinition`](FieldGroupDefinition.md)\<`TFields`, `TFieldComponents`\> diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupDefinition.md b/docs/framework/preact/reference/type-aliases/FieldGroupDefinition.md new file mode 100644 index 000000000..a4d201462 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupDefinition.md @@ -0,0 +1,30 @@ +--- +id: FieldGroupDefinition +title: FieldGroupDefinition +--- + +# Type Alias: FieldGroupDefinition\ + +```ts +type FieldGroupDefinition = FieldGroupApi, TFieldComponents> & object; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:101](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L101) + +## Type Declaration + +### \[fieldGroupFieldsSymbol\] + +```ts +readonly [fieldGroupFieldsSymbol]: TFields; +``` + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> = `Record`\<`never`, `never`\> diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md new file mode 100644 index 000000000..b765f25c3 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindingForSlot +title: FieldGroupFieldBindingForSlot +--- + +# Type Alias: FieldGroupFieldBindingForSlot\ + +```ts +type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:125](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L125) + +## Type Parameters + +### TFormData + +`TFormData` + +### TSlot + +`TSlot` *extends* [`AnyFieldGroupFieldSlot`](AnyFieldGroupFieldSlot.md) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md new file mode 100644 index 000000000..6f014f1f9 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindings.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindings +title: FieldGroupFieldBindings +--- + +# Type Alias: FieldGroupFieldBindings\ + +```ts +type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L135) + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +### TFormData + +`TFormData` = `any` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md new file mode 100644 index 000000000..c99cd9991 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindingsOf +title: FieldGroupFieldBindingsOf +--- + +# Type Alias: FieldGroupFieldBindingsOf\ + +```ts +type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L145) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` + +### TFormData + +`TFormData` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md new file mode 100644 index 000000000..504766b91 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldComponentsOf +title: FieldGroupFieldComponentsOf +--- + +# Type Alias: FieldGroupFieldComponentsOf\ + +```ts +type FieldGroupFieldComponentsOf = TFieldGroup extends FieldGroupDefinition ? TFieldComponents : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:111](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L111) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md new file mode 100644 index 000000000..ba9065716 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldData.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldData +title: FieldGroupFieldData +--- + +# Type Alias: FieldGroupFieldData\ + +```ts +type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:87](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L87) + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md new file mode 100644 index 000000000..f1ed3e766 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldNameForSlot +title: FieldGroupFieldNameForSlot +--- + +# Type Alias: FieldGroupFieldNameForSlot\ + +```ts +type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:63](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L63) + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TSlot + +`TSlot` *extends* [`AnyFieldGroupFieldSlot`](AnyFieldGroupFieldSlot.md) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md new file mode 100644 index 000000000..86d8524e1 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldNames.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldNames +title: FieldGroupFieldNames +--- + +# Type Alias: FieldGroupFieldNames\ + +```ts +type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:77](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L77) + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md new file mode 100644 index 000000000..2fe61bb81 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldSlotAllows +title: FieldGroupFieldSlotAllows +--- + +# Type Alias: FieldGroupFieldSlotAllows\ + +```ts +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:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L54) + +## Type Parameters + +### TSlot + +`TSlot` + +### TValue + +`TValue` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md new file mode 100644 index 000000000..b8f72c235 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFieldSlotMode +title: FieldGroupFieldSlotMode +--- + +# Type Alias: FieldGroupFieldSlotMode + +```ts +type FieldGroupFieldSlotMode = "strict" | "loose"; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L20) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md new file mode 100644 index 000000000..b1aaa7b96 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldSlotModeOf +title: FieldGroupFieldSlotModeOf +--- + +# Type Alias: FieldGroupFieldSlotModeOf\ + +```ts +type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L45) + +## Type Parameters + +### TSlot + +`TSlot` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md new file mode 100644 index 000000000..cab960fed --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldSlotValue +title: FieldGroupFieldSlotValue +--- + +# Type Alias: FieldGroupFieldSlotValue\ + +```ts +type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:42](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L42) + +## Type Parameters + +### TSlot + +`TSlot` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFields.md b/docs/framework/preact/reference/type-aliases/FieldGroupFields.md new file mode 100644 index 000000000..5587a6402 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFields.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFields +title: FieldGroupFields +--- + +# Type Alias: FieldGroupFields + +```ts +type FieldGroupFields = Record; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:75](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L75) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md new file mode 100644 index 000000000..fa38a9330 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldsOf +title: FieldGroupFieldsOf +--- + +# Type Alias: FieldGroupFieldsOf\ + +```ts +type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:95](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L95) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md new file mode 100644 index 000000000..28a2317df --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFieldsPropName.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldsPropName +title: FieldGroupFieldsPropName +--- + +# Type Alias: FieldGroupFieldsPropName\ + +```ts +type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:150](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L150) + +## Type Parameters + +### TProps + +`TProps` + +### TFieldGroup + +`TFieldGroup` *extends* [`FieldGroupDefinition`](FieldGroupDefinition.md)\<`any`, `any`\> diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupForm.md b/docs/framework/preact/reference/type-aliases/FieldGroupForm.md new file mode 100644 index 000000000..fd9fcc3bd --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupForm.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupForm +title: FieldGroupForm +--- + +# Type Alias: FieldGroupForm\ + +```ts +type FieldGroupForm = FormApi & PreactTanStackFormComponents; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:116](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L116) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> = `Record`\<`never`, `never`\> + +### TFormData + +`TFormData` = `any` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md b/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md new file mode 100644 index 000000000..7651f2200 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupFormState.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFormState +title: FieldGroupFormState +--- + +# Type Alias: FieldGroupFormState + +```ts +type FieldGroupFormState = FormState; +``` + +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 new file mode 100644 index 000000000..fbdbe27d7 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -0,0 +1,28 @@ +--- +id: FieldGroupSubscribeComponent +title: FieldGroupSubscribeComponent +--- + +# Type Alias: FieldGroupSubscribeComponent + +```ts +type FieldGroupSubscribeComponent = (props) => CrossVersionPreactNode; +``` + +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 + +### TSelected + +`TSelected` + +## Parameters + +### props + +[`FieldGroupSubscribeProps`](FieldGroupSubscribeProps.md)\<`TSelected`\> + +## Returns + +[`CrossVersionPreactNode`](CrossVersionPreactNode.md) diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md new file mode 100644 index 000000000..5c955b489 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupSubscribeProps.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupSubscribeProps +title: FieldGroupSubscribeProps +--- + +# Type Alias: FieldGroupSubscribeProps\ + +```ts +type FieldGroupSubscribeProps = PreactFormSubscribeProps; +``` + +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 + +### TSelected + +`TSelected` diff --git a/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md new file mode 100644 index 000000000..332126b87 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -0,0 +1,44 @@ +--- +id: FieldGroupWithFieldsFn +title: FieldGroupWithFieldsFn +--- + +# Type Alias: FieldGroupWithFieldsFn + +```ts +type FieldGroupWithFieldsFn = (fields, Component, fieldsPropName) => (props) => CrossVersionPreactNode; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:162](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L162) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` *extends* [`FieldGroupDefinition`](FieldGroupDefinition.md)\<`any`, `any`\> + +### TProps + +`TProps` *extends* `object` + +### TFieldsPropName + +`TFieldsPropName` *extends* [`FieldGroupFieldsPropName`](FieldGroupFieldsPropName.md)\<`TProps`, `TFieldGroup`\> + +## Parameters + +### fields + +`TFieldGroup` + +### Component + +(`props`) => [`CrossVersionPreactNode`](CrossVersionPreactNode.md) + +### fieldsPropName + +`TFieldsPropName` + +## Returns + +\<`TFormData`\>(`props`) => [`CrossVersionPreactNode`](CrossVersionPreactNode.md) diff --git a/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md new file mode 100644 index 000000000..f8aa3025f --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -0,0 +1,18 @@ +--- +id: LooseFieldGroupFieldSlot +title: LooseFieldGroupFieldSlot +--- + +# Type Alias: LooseFieldGroupFieldSlot\ + +```ts +type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L37) + +## Type Parameters + +### TValue + +`TValue` diff --git a/docs/framework/preact/reference/type-aliases/Observer.md b/docs/framework/preact/reference/type-aliases/Observer.md new file mode 100644 index 000000000..41f87adf3 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/Observer.md @@ -0,0 +1,72 @@ +--- +id: Observer +title: Observer +--- + +# Type Alias: Observer\ + +```ts +type Observer = object; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:8 + +## Type Parameters + +### T + +`T` + +## Properties + +### complete? + +```ts +optional complete?: () => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:11 + +#### Returns + +`void` + +*** + +### error? + +```ts +optional error?: (err) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:10 + +#### Parameters + +##### err + +`unknown` + +#### Returns + +`void` + +*** + +### next? + +```ts +optional next?: (value) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:9 + +#### Parameters + +##### value + +`T` + +#### Returns + +`void` diff --git a/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md b/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md new file mode 100644 index 000000000..088b67e22 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactAppFormApi.md @@ -0,0 +1,34 @@ +--- +id: PreactAppFormApi +title: PreactAppFormApi +--- + +# Type Alias: PreactAppFormApi\ + +```ts +type PreactAppFormApi = PreactFormApi & object; +``` + +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 + +### AppForm + +```ts +AppForm: AppFormComponent; +``` + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md) diff --git a/docs/framework/preact/reference/type-aliases/PreactFieldApi.md b/docs/framework/preact/reference/type-aliases/PreactFieldApi.md new file mode 100644 index 000000000..d55b2aade --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFieldApi.md @@ -0,0 +1,38 @@ +--- +id: PreactFieldApi +title: PreactFieldApi +--- + +# Type Alias: PreactFieldApi\ + +```ts +type PreactFieldApi = FieldApi & FieldComponentsMatchingType; +``` + +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 + +### TFieldName + +`TFieldName` + +### TFieldValue + +`TFieldValue` + +### TFieldError + +`TFieldError` + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> diff --git a/docs/framework/preact/reference/type-aliases/PreactFormApi.md b/docs/framework/preact/reference/type-aliases/PreactFormApi.md new file mode 100644 index 000000000..9c63e1c61 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormApi.md @@ -0,0 +1,26 @@ +--- +id: PreactFormApi +title: PreactFormApi +--- + +# Type Alias: PreactFormApi\ + +```ts +type PreactFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md) diff --git a/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md new file mode 100644 index 000000000..a08ea7541 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormArrayFieldComponent.md @@ -0,0 +1,46 @@ +--- +id: PreactFormArrayFieldComponent +title: PreactFormArrayFieldComponent +--- + +# Type Alias: PreactFormArrayFieldComponent\ + +```ts +type PreactFormArrayFieldComponent = (props) => ComponentChildren; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Type Parameters + +### TFieldName + +`TFieldName` *extends* `never` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>\> + +## Parameters + +### props + +[`PreactFormFieldProps`](../interfaces/PreactFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md new file mode 100644 index 000000000..157311349 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormFieldComponent.md @@ -0,0 +1,46 @@ +--- +id: PreactFormFieldComponent +title: PreactFormFieldComponent +--- + +# Type Alias: PreactFormFieldComponent\ + +```ts +type PreactFormFieldComponent = (props) => ComponentChildren; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Type Parameters + +### TFieldName + +`TFieldName` *extends* `string` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>\> + +## Parameters + +### props + +[`PreactFormFieldProps`](../interfaces/PreactFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md new file mode 100644 index 000000000..919f05df9 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupArrayFieldComponent.md @@ -0,0 +1,54 @@ +--- +id: PreactFormGroupArrayFieldComponent +title: PreactFormGroupArrayFieldComponent +--- + +# Type Alias: PreactFormGroupArrayFieldComponent\ + +```ts +type PreactFormGroupArrayFieldComponent = (props) => ComponentChildren; +``` + +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 + +### TFormData + +`TFormData` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> + +## Type Parameters + +### TFieldName + +`TFieldName` *extends* `never` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>\> + +## Parameters + +### props + +[`PreactFormFieldProps`](../interfaces/PreactFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> + +## Returns + +`ComponentChildren` diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md new file mode 100644 index 000000000..083e5e9b2 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeComponent.md @@ -0,0 +1,38 @@ +--- +id: PreactFormGroupSubscribeComponent +title: PreactFormGroupSubscribeComponent +--- + +# Type Alias: PreactFormGroupSubscribeComponent\ + +```ts +type PreactFormGroupSubscribeComponent = (props) => CrossVersionPreactNode; +``` + +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 + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +## Type Parameters + +### TSelected + +`TSelected` + +## Parameters + +### props + +[`PreactFormGroupSubscribeProps`](PreactFormGroupSubscribeProps.md)\<`TGroupValue`, `TGroupErrorTypes`, `TSelected`\> + +## Returns + +[`CrossVersionPreactNode`](CrossVersionPreactNode.md) diff --git a/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md new file mode 100644 index 000000000..e941c4003 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormGroupSubscribeProps.md @@ -0,0 +1,26 @@ +--- +id: PreactFormGroupSubscribeProps +title: PreactFormGroupSubscribeProps +--- + +# Type Alias: PreactFormGroupSubscribeProps\ + +```ts +type PreactFormGroupSubscribeProps = PreactSubscribeProps, TSelected>; +``` + +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 + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TSelected + +`TSelected` diff --git a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md new file mode 100644 index 000000000..4c15bca71 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeComponent.md @@ -0,0 +1,38 @@ +--- +id: PreactFormSubscribeComponent +title: PreactFormSubscribeComponent +--- + +# Type Alias: PreactFormSubscribeComponent\ + +```ts +type PreactFormSubscribeComponent = (props) => CrossVersionPreactNode; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +## Type Parameters + +### TSelected + +`TSelected` + +## Parameters + +### props + +[`PreactFormSubscribeProps`](PreactFormSubscribeProps.md)\<`TFormData`, `TFormErrorTypes`, `TSelected`\> + +## Returns + +[`CrossVersionPreactNode`](CrossVersionPreactNode.md) diff --git a/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md new file mode 100644 index 000000000..60dba308c --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormSubscribeProps.md @@ -0,0 +1,26 @@ +--- +id: PreactFormSubscribeProps +title: PreactFormSubscribeProps +--- + +# Type Alias: PreactFormSubscribeProps\ + +```ts +type PreactFormSubscribeProps = PreactSubscribeProps, TSelected>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TSelected + +`TSelected` diff --git a/docs/framework/preact/reference/type-aliases/PreactFormType.md b/docs/framework/preact/reference/type-aliases/PreactFormType.md new file mode 100644 index 000000000..8b90878ca --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/PreactFormType.md @@ -0,0 +1,20 @@ +--- +id: PreactFormType +title: PreactFormType +--- + +# Type Alias: PreactFormType\ + +```ts +type PreactFormType = TOptions extends AppFormOptions ? PreactFormApi, TComponents> : TOptions extends FormOptions ? PreactFormApi, DefaultPreactFormComponentMap> : never; +``` + +Defined in: [packages/preact-form/src/PreactForm/formType.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/PreactForm/formType.public.ts#L27) + +## Type Parameters + +### TOptions + +`TOptions` *extends* + \| `AnyFormOptions` + \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md)\> diff --git a/docs/framework/preact/reference/type-aliases/Selection.md b/docs/framework/preact/reference/type-aliases/Selection.md new file mode 100644 index 000000000..937a64ffd --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/Selection.md @@ -0,0 +1,18 @@ +--- +id: Selection +title: Selection +--- + +# Type Alias: Selection\ + +```ts +type Selection = Readable; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:4 + +## Type Parameters + +### TSelected + +`TSelected` diff --git a/docs/framework/preact/reference/type-aliases/StoreAction.md b/docs/framework/preact/reference/type-aliases/StoreAction.md new file mode 100644 index 000000000..19d70469a --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/StoreAction.md @@ -0,0 +1,22 @@ +--- +id: StoreAction +title: StoreAction +--- + +# Type Alias: StoreAction + +```ts +type StoreAction = (...args) => any; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:4 + +## Parameters + +### args + +...`any`[] + +## Returns + +`any` diff --git a/docs/framework/preact/reference/type-aliases/StoreActionMap.md b/docs/framework/preact/reference/type-aliases/StoreActionMap.md new file mode 100644 index 000000000..8876e2fc7 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/StoreActionMap.md @@ -0,0 +1,12 @@ +--- +id: StoreActionMap +title: StoreActionMap +--- + +# Type Alias: StoreActionMap + +```ts +type StoreActionMap = Record; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:5 diff --git a/docs/framework/preact/reference/type-aliases/StoreActionsFactory.md b/docs/framework/preact/reference/type-aliases/StoreActionsFactory.md new file mode 100644 index 000000000..ce8687604 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/StoreActionsFactory.md @@ -0,0 +1,38 @@ +--- +id: StoreActionsFactory +title: StoreActionsFactory +--- + +# Type Alias: StoreActionsFactory\ + +```ts +type StoreActionsFactory = (store) => TActions; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:6 + +## Type Parameters + +### T + +`T` + +### TActions + +`TActions` *extends* [`StoreActionMap`](StoreActionMap.md) + +## Parameters + +### store + +#### get + +[`Store`](../classes/Store.md)\<`T`\>\[`"get"`\] + +#### setState + +[`Store`](../classes/Store.md)\<`T`\>\[`"setState"`\] + +## Returns + +`TActions` diff --git a/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md new file mode 100644 index 000000000..920a097d4 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -0,0 +1,18 @@ +--- +id: StrictFieldGroupFieldSlot +title: StrictFieldGroupFieldSlot +--- + +# Type Alias: StrictFieldGroupFieldSlot\ + +```ts +type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +Defined in: [packages/preact-form/src/FieldGroup/withFields.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/preact-form/src/FieldGroup/withFields.public.ts#L32) + +## Type Parameters + +### TValue + +`TValue` diff --git a/docs/framework/preact/reference/type-aliases/SubscribeSource.md b/docs/framework/preact/reference/type-aliases/SubscribeSource.md new file mode 100644 index 000000000..afdc82127 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/SubscribeSource.md @@ -0,0 +1,22 @@ +--- +id: SubscribeSource +title: SubscribeSource +--- + +# Type Alias: SubscribeSource\ + +```ts +type SubscribeSource = + | Atom + | ReadonlyAtom + | Store +| ReadonlyStore; +``` + +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 + +### TValue + +`TValue` diff --git a/docs/framework/preact/reference/type-aliases/UseAppFormHook.md b/docs/framework/preact/reference/type-aliases/UseAppFormHook.md new file mode 100644 index 000000000..c0777e808 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/UseAppFormHook.md @@ -0,0 +1,42 @@ +--- +id: UseAppFormHook +title: UseAppFormHook +--- + +# Type Alias: UseAppFormHook\ + +```ts +type UseAppFormHook = (options) => PreactAppFormApi, TComponents>; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md) + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`PreactAppFormApi`](PreactAppFormApi.md)\<`TFormData`, `ToFormErrorTypes`\<`TFormValidators`, `TSubmitReturn`\>, `TComponents`\> diff --git a/docs/framework/preact/reference/type-aliases/UseFormHook.md b/docs/framework/preact/reference/type-aliases/UseFormHook.md new file mode 100644 index 000000000..230e5f4e5 --- /dev/null +++ b/docs/framework/preact/reference/type-aliases/UseFormHook.md @@ -0,0 +1,42 @@ +--- +id: UseFormHook +title: UseFormHook +--- + +# Type Alias: UseFormHook\ + +```ts +type UseFormHook = (options) => PreactFormApi, TComponents>; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyPreactFormComponentMap`](AnyPreactFormComponentMap.md) + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`PreactFormApi`](PreactFormApi.md)\<`TFormData`, `ToFormErrorTypes`\<`TFormValidators`, `TSubmitReturn`\>, `TComponents`\> diff --git a/docs/framework/preact/reference/variables/useForm.md b/docs/framework/preact/reference/variables/useForm.md new file mode 100644 index 000000000..737547d3e --- /dev/null +++ b/docs/framework/preact/reference/variables/useForm.md @@ -0,0 +1,12 @@ +--- +id: useForm +title: useForm +--- + +# Variable: useForm + +```ts +const useForm: UseFormHook; +``` + +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/preact/reference/variables/useStore.md b/docs/framework/preact/reference/variables/useStore.md new file mode 100644 index 000000000..95651ddf8 --- /dev/null +++ b/docs/framework/preact/reference/variables/useStore.md @@ -0,0 +1,58 @@ +--- +id: useStore +title: useStore +--- + +# ~~Variable: useStore~~ + +```ts +const useStore: (source, selector?, compare?) => TSelected; +``` + +Defined in: node\_modules/.pnpm/@tanstack+preact-store@0.13.2\_preact@10.29.8/node\_modules/@tanstack/preact-store/dist/useStore.d.ts:12 + +Deprecated alias for [useSelector](../functions/useSelector.md). + +## Type Parameters + +### TSource + +`TSource` + +### TSelected + +`TSelected` = `NoInfer`\<`TSource`\> + +## Parameters + +### source + +#### get + +() => `TSource` + +#### subscribe + +(`listener`) => `object` + +### selector? + +(`snapshot`) => `TSelected` + +### compare? + +(`a`, `b`) => `boolean` + +## Returns + +`TSelected` + +## Example + +```tsx +const count = useStore(counterStore, (state) => state.count) +``` + +## Deprecated + +Use `useSelector` instead. diff --git a/docs/framework/react/reference/functions/Subscribe.md b/docs/framework/react/reference/functions/Subscribe.md index 566747635..a097ae461 100644 --- a/docs/framework/react/reference/functions/Subscribe.md +++ b/docs/framework/react/reference/functions/Subscribe.md @@ -6,10 +6,10 @@ title: Subscribe # Function: Subscribe() ```ts -function Subscribe(props): ReactNode | Promise; +function Subscribe(props): ReactNode; ``` -Defined in: [packages/react-form/src/Subscribe.public.tsx:38](https://github.com/TanStack/form/blob/main/packages/react-form/src/Subscribe.public.tsx#L38) +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. @@ -33,4 +33,4 @@ This is useful for opting into state re-renders for specific parts of the state. ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/functions/createFormHook.md b/docs/framework/react/reference/functions/createFormHook.md index 04bdf17cf..4baab0af7 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/getFieldGroupHelpers.md b/docs/framework/react/reference/functions/getFieldGroupHelpers.md index 6abe51068..dd0e248c4 100644 --- a/docs/framework/react/reference/functions/getFieldGroupHelpers.md +++ b/docs/framework/react/reference/functions/getFieldGroupHelpers.md @@ -9,7 +9,7 @@ title: getFieldGroupHelpers function getFieldGroupHelpers(): FieldGroupHelpers>; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:217](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L217) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:216](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L216) ## Returns diff --git a/docs/framework/react/reference/functions/getFormHookHelpers.md b/docs/framework/react/reference/functions/getFormHookHelpers.md index 0fc532972..918e5f1ae 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:103](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L103) +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/index.md b/docs/framework/react/reference/index.md index ac1f35d63..97da54642 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -50,7 +50,6 @@ title: "@tanstack/react-form" - [AnyReactFormApi](type-aliases/AnyReactFormApi.md) - [AnyReactFormComponentMap](type-aliases/AnyReactFormComponentMap.md) - [AppFormComponent](type-aliases/AppFormComponent.md) -- [CrossVersionReactNode](type-aliases/CrossVersionReactNode.md) - [DefaultReactFormComponentMap](type-aliases/DefaultReactFormComponentMap.md) - [DefineFieldsFn](type-aliases/DefineFieldsFn.md) - [FieldGroupDefinition](type-aliases/FieldGroupDefinition.md) diff --git a/docs/framework/react/reference/interfaces/AppFormHookResult.md b/docs/framework/react/reference/interfaces/AppFormHookResult.md index 40787bd94..5a6e06b45 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 getAppFieldGroupHelpers: () => FieldGroupHelpers; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L29) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L29) #### Returns @@ -45,7 +45,7 @@ Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:29](h useAppForm: UseAppFormHook; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:32](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L32) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L32) *** @@ -55,7 +55,7 @@ Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:32](h useFormContext: () => ReactAppFormApi; ``` -Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:33](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L33) +Defined in: [packages/react-form/src/AppForm/createFormHookTypes.public.ts:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/AppForm/createFormHookTypes.public.ts#L33) #### Returns diff --git a/docs/framework/react/reference/interfaces/AppFormOptions.md b/docs/framework/react/reference/interfaces/AppFormOptions.md index 353888c05..c03ecad76 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 a5648f37f..039c18fb8 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 5750cc10d..b30c29f3e 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:74](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L74) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L73) ## Extends @@ -29,7 +29,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:74](http ArrayField: FieldGroupArrayFieldComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L82) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L81) *** @@ -39,7 +39,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:82](http atom: ReadonlyAtom; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:80](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L80) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:79](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L79) *** @@ -49,7 +49,7 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:80](http Field: FieldGroupFieldComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:81](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L81) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:80](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L80) *** @@ -59,4 +59,4 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:81](http Subscribe: FieldGroupSubscribeComponent; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:83](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L83) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L82) diff --git a/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md b/docs/framework/react/reference/interfaces/FieldGroupArrayFieldComponent.md index cef9ac9f4..f7f639d1e 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:42](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L42) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L41) ## Type Parameters @@ -18,10 +18,10 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:42](http `TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> ```ts -FieldGroupArrayFieldComponent(props): ReactNode | Promise; +FieldGroupArrayFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:46](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L46) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:45](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L45) ## Type Parameters @@ -37,4 +37,4 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:46](http ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md b/docs/framework/react/reference/interfaces/FieldGroupFieldComponent.md index 7f4c5ae1d..67dd7064b 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:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L20) +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 @@ -18,10 +18,10 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:20](http `TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> ```ts -FieldGroupFieldComponent(props): ReactNode | Promise; +FieldGroupFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:24](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L24) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L23) ## Type Parameters @@ -37,4 +37,4 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:24](http ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md b/docs/framework/react/reference/interfaces/FieldGroupFieldSlot.md index edc42c8db..134858656 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: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:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L21) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:22](https:/ readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -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:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L26) *** @@ -35,4 +35,4 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:27](https:/ readonly mode: TMode; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:26](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L26) +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/interfaces/FieldGroupHelper.md b/docs/framework/react/reference/interfaces/FieldGroupHelper.md index fc345a94e..b2cd28fa6 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:181](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L181) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L180) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:181](https: loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:183](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L183) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:182](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L182) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:183](https: strict: () => StrictFieldGroupFieldSlot; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:182](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L182) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:181](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L181) #### Type Parameters diff --git a/docs/framework/react/reference/interfaces/FieldGroupHelpers.md b/docs/framework/react/reference/interfaces/FieldGroupHelpers.md index a306ab626..2bcffd0d4 100644 --- a/docs/framework/react/reference/interfaces/FieldGroupHelpers.md +++ b/docs/framework/react/reference/interfaces/FieldGroupHelpers.md @@ -5,7 +5,7 @@ title: FieldGroupHelpers # Interface: FieldGroupHelpers\ -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:199](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L199) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:198](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L198) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:199](https: defineFields: DefineFieldsFn; ``` -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:202](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L202) *** @@ -31,7 +31,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:203](https: helper: FieldGroupHelper; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:202](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L202) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:201](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L201) *** @@ -41,4 +41,4 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:202](https: withFields: FieldGroupWithFieldsFn; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:204](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L204) +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) diff --git a/docs/framework/react/reference/interfaces/FormHookHelpers.md b/docs/framework/react/reference/interfaces/FormHookHelpers.md index c9947ae07..814d0bd7a 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: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: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:98](ht fieldBrand: FieldBrandHelper; ``` -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:99](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L99) +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:99](ht fieldComponent: FieldComponentHelper; ``` -Defined in: [packages/react-form/src/AppForm/getFormHookHelpers.public.ts:100](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/getFormHookHelpers.public.ts#L100) +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 d43ad0430..ee2704c9d 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 8afc71581..c72edb668 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:119](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L119) +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 @@ -50,10 +50,10 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:119](https:/ ### children ```ts -children: (fieldApi) => ReactNode | Promise; +children: (fieldApi) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:141](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L141) +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 @@ -63,4 +63,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:141](https:/ #### Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupApi.md b/docs/framework/react/reference/interfaces/ReactFormGroupApi.md index 7cb62937f..40c41009c 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:281](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L281) +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:281](https:/ ArrayField: ReactFormGroupArrayFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:302](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L302) +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:302](https:/ Field: ReactFormGroupFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:295](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L295) +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:295](https:/ Subscribe: ReactFormGroupSubscribeComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:309](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L309) +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 e6ef7ac9f..cea91df1e 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:341](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L341) +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 @@ -22,10 +22,10 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:341](https:/ `TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> ```ts -ReactFormGroupComponent(props): ReactNode | Promise; +ReactFormGroupComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:346](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L346) +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 @@ -49,4 +49,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:346](https:/ ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md b/docs/framework/react/reference/interfaces/ReactFormGroupFieldComponent.md index 6dc3e5f58..ad924c147 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:225](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L225) +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 @@ -30,10 +30,10 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:225](https:/ `TFieldComponents` *extends* `Record`\<`string`, `FunctionComponent`\<`any`\>\> ```ts -ReactFormGroupFieldComponent(props): ReactNode | Promise; +ReactFormGroupFieldComponent(props): ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:232](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L232) +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 @@ -53,4 +53,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:232](https:/ ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/ReactFormGroupProps.md b/docs/framework/react/reference/interfaces/ReactFormGroupProps.md index 5475eec19..7397c9d9a 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:312](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L312) +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 @@ -42,10 +42,10 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:312](https:/ ### children ```ts -children: (groupApi) => ReactNode | Promise; +children: (groupApi) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:329](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L329) +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 @@ -55,4 +55,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:329](https:/ #### Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md b/docs/framework/react/reference/interfaces/ReactTanStackFormComponents.md index 3653b5ea7..307eb2566 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:362](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L362) +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:362](https:/ ArrayField: ReactFormArrayFieldComponent; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:372](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L372) +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:372](https:/ Field: ReactFormFieldComponent; ``` -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: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:380](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L380) +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:380](https:/ Subscribe: ReactFormSubscribeComponent; ``` -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: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 a0ac44f4a..665fe5d69 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. @@ -25,13 +25,10 @@ FormState. ### children ```ts -children: - | ReactNode - | Promise - | ((state) => ReactNode | Promise); +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) *** @@ -41,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). @@ -64,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) *** @@ -74,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 409567bd4..335ee202d 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:86](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L86) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:85](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L85) diff --git a/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/AnyFieldGroupFieldSlot.md index 471a79b49..6bf5c9c4a 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:30](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L30) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L29) diff --git a/docs/framework/react/reference/type-aliases/AnyReactFormApi.md b/docs/framework/react/reference/type-aliases/AnyReactFormApi.md index 23bacd4ae..86e850cbd 100644 --- a/docs/framework/react/reference/type-aliases/AnyReactFormApi.md +++ b/docs/framework/react/reference/type-aliases/AnyReactFormApi.md @@ -9,4 +9,4 @@ title: AnyReactFormApi type AnyReactFormApi = AnyFormApi & ReactTanStackFormComponents; ``` -Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:26](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L26) +Defined in: [packages/react-form/src/ReactForm/formApiTypes.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/formApiTypes.public.ts#L26) diff --git a/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md b/docs/framework/react/reference/type-aliases/AnyReactFormComponentMap.md index 574ce2cf3..b8eb6b644 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 d5aa6c00d..7259412e2 100644 --- a/docs/framework/react/reference/type-aliases/AppFormComponent.md +++ b/docs/framework/react/reference/type-aliases/AppFormComponent.md @@ -7,8 +7,8 @@ title: AppFormComponent ```ts type AppFormComponent = FunctionComponent<{ - children: Exclude>; + children: Exclude>; }>; ``` -Defined in: [packages/react-form/src/AppForm/ReactAppFormApi.public.tsx:7](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L7) +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/CrossVersionReactNode.md b/docs/framework/react/reference/type-aliases/CrossVersionReactNode.md deleted file mode 100644 index b5e5a7cde..000000000 --- a/docs/framework/react/reference/type-aliases/CrossVersionReactNode.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -id: CrossVersionReactNode -title: CrossVersionReactNode ---- - -# Type Alias: CrossVersionReactNode - -```ts -type CrossVersionReactNode = ReturnType>; -``` - -Defined in: [packages/react-form/src/reactTypes.public.ts:6](https://github.com/TanStack/form/blob/main/packages/react-form/src/reactTypes.public.ts#L6) - -This type mess takes care of react 17-19 cross compatibility. diff --git a/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md b/docs/framework/react/reference/type-aliases/DefaultReactFormComponentMap.md index 586d6203a..ffa51484d 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/DefineFieldsFn.md b/docs/framework/react/reference/type-aliases/DefineFieldsFn.md index d824778f9..90cc99c82 100644 --- a/docs/framework/react/reference/type-aliases/DefineFieldsFn.md +++ b/docs/framework/react/reference/type-aliases/DefineFieldsFn.md @@ -9,7 +9,7 @@ title: DefineFieldsFn type DefineFieldsFn = (fields) => FieldGroupDefinition; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:188](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L188) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L187) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupDefinition.md b/docs/framework/react/reference/type-aliases/FieldGroupDefinition.md index 284ad5828..74e302ecf 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupDefinition.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupDefinition.md @@ -9,7 +9,7 @@ title: FieldGroupDefinition type FieldGroupDefinition = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:101](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L101) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L100) ## Type Declaration diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingForSlot.md index daba69aa8..272ac03c5 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:125](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L125) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:124](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L124) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindings.md index 2c9bb391b..69d390a1f 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:135](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L135) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:134](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L134) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldBindingsOf.md index a1fc9cf3e..2c2d5f9b3 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: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:144](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L144) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldComponentsOf.md index 2d6f71a94..a4f1993c1 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 FieldGroupDefinition ? TFieldComponents : never; ``` -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:110](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L110) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldData.md index 3c8bcbd68..a82bb459f 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:87](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L87) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L86) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldNameForSlot.md index 39b259b0d..2609af686 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:63](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L63) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L62) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldNames.md index 28a5a2c11..08991eee1 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:77](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L77) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L76) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotAllows.md index 709d8c747..6f969c497 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:54](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L54) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:53](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L53) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotMode.md index 7fedd724b..403837702 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:20](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L20) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:19](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L19) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotModeOf.md index 1ff45e463..bec4fa9f8 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:45](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L45) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:44](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L44) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldSlotValue.md index 766208a09..741a00cfa 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:42](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L42) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L41) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFields.md b/docs/framework/react/reference/type-aliases/FieldGroupFields.md index 577c1f069..f9f0b2225 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:75](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L75) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L74) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldsOf.md index f3c00f7ab..c884bdbd0 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:95](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L95) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:94](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L94) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/react/reference/type-aliases/FieldGroupFieldsPropName.md index 1b727b659..867a6ced0 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:150](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L150) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:149](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L149) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupForm.md b/docs/framework/react/reference/type-aliases/FieldGroupForm.md index fcab30a6a..02fa286b9 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:116](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L116) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:115](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L115) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupFormState.md b/docs/framework/react/reference/type-aliases/FieldGroupFormState.md index 0c4b3d64f..6bd093da8 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:91](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L91) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:90](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L90) diff --git a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md index dce3598b8..0b78d3266 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -6,10 +6,10 @@ title: FieldGroupSubscribeComponent # Type Alias: FieldGroupSubscribeComponent ```ts -type FieldGroupSubscribeComponent = (props) => CrossVersionReactNode; +type FieldGroupSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:70](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L70) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L69) ## Type Parameters @@ -25,4 +25,4 @@ Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:70](http ## Returns -[`CrossVersionReactNode`](CrossVersionReactNode.md) +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/react/reference/type-aliases/FieldGroupSubscribeProps.md index d953f3a83..339fadbe5 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:64](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L64) +Defined in: [packages/react-form/src/FieldGroup/FieldGroupApi.public.ts:63](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts#L63) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md index f4bdffce5..0df100dc2 100644 --- a/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md +++ b/docs/framework/react/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -6,10 +6,10 @@ title: FieldGroupWithFieldsFn # Type Alias: FieldGroupWithFieldsFn ```ts -type FieldGroupWithFieldsFn = (fields, Component, fieldsPropName) => (props) => CrossVersionReactNode; +type FieldGroupWithFieldsFn = (fields, Component, fieldsPropName) => (props) => ReactNode; ``` -Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:162](https://github.com/TanStack/form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L162) +Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:161](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L161) ## Type Parameters @@ -33,7 +33,7 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:162](https: ### Component -(`props`) => [`CrossVersionReactNode`](CrossVersionReactNode.md) +(`props`) => `ReactNode` ### fieldsPropName @@ -41,4 +41,4 @@ Defined in: [packages/react-form/src/FieldGroup/withFields.public.ts:162](https: ## Returns -\<`TFormData`\>(`props`) => [`CrossVersionReactNode`](CrossVersionReactNode.md) +\<`TFormData`\>(`props`) => `ReactNode` diff --git a/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/LooseFieldGroupFieldSlot.md index 179395ef7..8d78b9505 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: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:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L36) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/ReactAppFormApi.md b/docs/framework/react/reference/type-aliases/ReactAppFormApi.md index a95de030f..a3877dfb6 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:11](https://github.com/TanStack/form/blob/main/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx#L11) +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 c020cc880..af5b301c9 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/ReactFormApi.md b/docs/framework/react/reference/type-aliases/ReactFormApi.md index dca8d5be9..c24a14297 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 a5b35a651..c2f3eae84 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormArrayFieldComponent.md @@ -6,10 +6,10 @@ title: ReactFormArrayFieldComponent # Type Alias: ReactFormArrayFieldComponent\ ```ts -type ReactFormArrayFieldComponent = (props) => ReactNode | Promise; +type ReactFormArrayFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:183](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L183) +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 @@ -43,4 +43,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:183](https:/ ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md b/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md index c2e6cf652..ce1f1f3c1 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormFieldComponent.md @@ -6,10 +6,10 @@ title: ReactFormFieldComponent # Type Alias: ReactFormFieldComponent\ ```ts -type ReactFormFieldComponent = (props) => ReactNode | Promise; +type ReactFormFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:157](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L157) +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 @@ -43,4 +43,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:157](https:/ ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md b/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md index b88179874..2dd01f4bd 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormGroupArrayFieldComponent.md @@ -6,10 +6,10 @@ title: ReactFormGroupArrayFieldComponent # Type Alias: ReactFormGroupArrayFieldComponent\ ```ts -type ReactFormGroupArrayFieldComponent = (props) => ReactNode | Promise; +type ReactFormGroupArrayFieldComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:253](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L253) +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 @@ -51,4 +51,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:253](https:/ ## Returns -`ReactNode` \| `Promise`\<`ReactNode`\> +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md index 9fd82f7f6..3e551472d 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeComponent.md @@ -6,10 +6,10 @@ title: ReactFormGroupSubscribeComponent # Type Alias: ReactFormGroupSubscribeComponent\ ```ts -type ReactFormGroupSubscribeComponent = (props) => CrossVersionReactNode; +type ReactFormGroupSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:218](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L218) +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 @@ -35,4 +35,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:218](https:/ ## Returns -[`CrossVersionReactNode`](CrossVersionReactNode.md) +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md b/docs/framework/react/reference/type-aliases/ReactFormGroupSubscribeProps.md index 778250266..d2d49a572 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:209](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L209) +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 ff881538a..a0feb796a 100644 --- a/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md +++ b/docs/framework/react/reference/type-aliases/ReactFormSubscribeComponent.md @@ -6,10 +6,10 @@ title: ReactFormSubscribeComponent # Type Alias: ReactFormSubscribeComponent\ ```ts -type ReactFormSubscribeComponent = (props) => CrossVersionReactNode; +type ReactFormSubscribeComponent = (props) => ReactNode; ``` -Defined in: [packages/react-form/src/ReactForm/Components.public.ts:112](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L112) +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 @@ -35,4 +35,4 @@ Defined in: [packages/react-form/src/ReactForm/Components.public.ts:112](https:/ ## Returns -[`CrossVersionReactNode`](CrossVersionReactNode.md) +`ReactNode` diff --git a/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md b/docs/framework/react/reference/type-aliases/ReactFormSubscribeProps.md index 1a8a32a5f..acb5cfe75 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:106](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/Components.public.ts#L106) +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 dad19af1f..6de94060b 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:27](https://github.com/TanStack/form/blob/main/packages/react-form/src/ReactForm/formType.public.ts#L27) +Defined in: [packages/react-form/src/ReactForm/formType.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/ReactForm/formType.public.ts#L27) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/react/reference/type-aliases/StrictFieldGroupFieldSlot.md index 9fc471f15..60af4170e 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: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:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/react-form/src/FieldGroup/withFields.public.ts#L31) ## Type Parameters diff --git a/docs/framework/react/reference/type-aliases/SubscribeSource.md b/docs/framework/react/reference/type-aliases/SubscribeSource.md index 3d27b1f3d..c6af5d094 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 ddd6d3663..b54d7e814 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 f2ac08038..424033a8d 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/useForm.md b/docs/framework/react/reference/variables/useForm.md index 52a7cbf84..ba995c74b 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 fe87e0dca..f7de3dce2 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 cd3735514..48fc3e0ce 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/getFieldGroupHelpers.md b/docs/framework/solid/reference/functions/getFieldGroupHelpers.md index b6b1548de..d8a0b08e0 100644 --- a/docs/framework/solid/reference/functions/getFieldGroupHelpers.md +++ b/docs/framework/solid/reference/functions/getFieldGroupHelpers.md @@ -9,7 +9,7 @@ title: getFieldGroupHelpers function getFieldGroupHelpers(): FieldGroupHelpers>; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:194](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L194) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:194](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L194) ## Returns diff --git a/docs/framework/solid/reference/functions/getFormHookHelpers.md b/docs/framework/solid/reference/functions/getFormHookHelpers.md index 6b8574201..035b8dd9c 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 8095f353c..cd515183a 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 getAppFieldGroupHelpers: () => FieldGroupHelpers; ``` -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) #### Returns @@ -45,7 +45,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:31](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L31) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:31](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L31) *** @@ -55,7 +55,7 @@ Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:31](h useFormContext: () => SolidAppFormApi; ``` -Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:32](https://github.com/TanStack/form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L32) +Defined in: [packages/solid-form/src/AppForm/createFormHookTypes.public.ts:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/AppForm/createFormHookTypes.public.ts#L32) #### Returns diff --git a/docs/framework/solid/reference/interfaces/AppFormOptions.md b/docs/framework/solid/reference/interfaces/AppFormOptions.md index 4d3e23638..9b1a530f7 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 d34c80635..466b366ee 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 721419d6b..501d6b18e 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 6bfa9248e..9ca8f1c88 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/FieldGroupFieldComponent.md b/docs/framework/solid/reference/interfaces/FieldGroupFieldComponent.md index 8dcbb1cb7..376e60fcb 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 12ec96cb5..1287e2b91 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: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) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:20](https:/ readonly [fieldGroupFieldSlotValueSymbol]: TValue; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:25](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L25) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L25) *** @@ -35,4 +35,4 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:25](https:/ readonly mode: TMode; ``` -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) diff --git a/docs/framework/solid/reference/interfaces/FieldGroupHelper.md b/docs/framework/solid/reference/interfaces/FieldGroupHelper.md index 16d098a78..627f8be80 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:166](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L166) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:166](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L166) ## Properties @@ -15,7 +15,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:166](https: loose: () => LooseFieldGroupFieldSlot; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:168](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L168) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:168](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L168) #### Type Parameters @@ -35,7 +35,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:168](https: strict: () => StrictFieldGroupFieldSlot; ``` -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 diff --git a/docs/framework/solid/reference/interfaces/FieldGroupHelpers.md b/docs/framework/solid/reference/interfaces/FieldGroupHelpers.md index e49995d43..a108fdab5 100644 --- a/docs/framework/solid/reference/interfaces/FieldGroupHelpers.md +++ b/docs/framework/solid/reference/interfaces/FieldGroupHelpers.md @@ -5,7 +5,7 @@ title: FieldGroupHelpers # Interface: FieldGroupHelpers\ -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) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:180](https: defineFields: DefineFieldsFn; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:184](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L184) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:184](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L184) *** @@ -31,7 +31,7 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:184](https: helper: FieldGroupHelper; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:183](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L183) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L183) *** @@ -41,4 +41,4 @@ Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:183](https: withFields: FieldGroupWithFieldsFn; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:185](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L185) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:185](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L185) diff --git a/docs/framework/solid/reference/interfaces/FormHookHelpers.md b/docs/framework/solid/reference/interfaces/FormHookHelpers.md index 535d5725c..8599fa6b5 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 478a47224..037a6d779 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 611684749..49b5c9c1f 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 80a139fba..25488f86f 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 5e8f73015..ddca43308 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 1a20442ed..45cc13981 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 99cd0c4c5..69d2b213a 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 13c696b0b..fc06498eb 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 dec124821..5305e2c75 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 d5d66c11d..140fde016 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 a70173540..a11437daf 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 535a2d8c6..052fdef29 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 2f5519cd5..313cb068c 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 e529e9e0e..c4b87a8af 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 bfd71ea96..56694ad64 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:27](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L27) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L27) diff --git a/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md b/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md index 2917d209f..1bba3147d 100644 --- a/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md +++ b/docs/framework/solid/reference/type-aliases/AnySolidFormApi.md @@ -9,4 +9,4 @@ title: AnySolidFormApi type AnySolidFormApi = AnyFormApi & SolidTanStackFormComponents; ``` -Defined in: [packages/solid-form/src/formApiTypes.public.ts:29](https://github.com/TanStack/form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L29) +Defined in: [packages/solid-form/src/formApiTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/formApiTypes.public.ts#L29) diff --git a/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md b/docs/framework/solid/reference/type-aliases/AnySolidFormComponentMap.md index fcc3887b5..c226dba5b 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 2eaee0dd3..26ea6a70c 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 c32798808..4d7769f19 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 58c40c9ca..c3deb04ed 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/DefineFieldsFn.md b/docs/framework/solid/reference/type-aliases/DefineFieldsFn.md index e54f4a4dd..b23bc34cf 100644 --- a/docs/framework/solid/reference/type-aliases/DefineFieldsFn.md +++ b/docs/framework/solid/reference/type-aliases/DefineFieldsFn.md @@ -9,7 +9,7 @@ title: DefineFieldsFn type DefineFieldsFn = (fields) => FieldGroupDefinition; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:171](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L171) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:171](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L171) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupDefinition.md b/docs/framework/solid/reference/type-aliases/FieldGroupDefinition.md index 1c7cc68a3..0a1a241d4 100644 --- a/docs/framework/solid/reference/type-aliases/FieldGroupDefinition.md +++ b/docs/framework/solid/reference/type-aliases/FieldGroupDefinition.md @@ -9,7 +9,7 @@ title: FieldGroupDefinition type FieldGroupDefinition = FieldGroupApi, TFieldComponents> & object; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:91](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L91) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:91](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L91) ## Type Declaration diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingForSlot.md index 4d8bf83e6..72b4059b3 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:113](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L113) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:113](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L113) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindings.md index 89e86fd27..421d6d150 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:122](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L122) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:122](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L122) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldBindingsOf.md index 34b1adba6..e3d286c39 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: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/FieldGroupFieldComponentsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldComponentsOf.md index e1161b577..e314dc7ed 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 FieldGroupDefinition ? TFieldComponents : never; ``` -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/FieldGroupFieldData.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldData.md index 7c7d5f6f2..445c0415b 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:78](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L78) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:78](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L78) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNameForSlot.md index fc500b1b4..e7ac6bbdc 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:56](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L56) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:56](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L56) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldNames.md index 7c9ddee67..68a3f3877 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:69](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L69) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L69) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotAllows.md index a853229f0..309a9e443 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:47](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L47) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:47](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L47) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotMode.md index 4eaf9b9a3..7b6fffbe9 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:19](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L19) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:19](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L19) diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotModeOf.md index 2b97d2016..f353d8a2d 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:38](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L38) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L38) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldSlotValue.md index b584a0eda..178466d15 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:36](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L36) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:36](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L36) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFields.md b/docs/framework/solid/reference/type-aliases/FieldGroupFields.md index 62d783088..d9b761d71 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:68](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L68) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:68](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L68) diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsOf.md index 1d91bb75f..29751bc4a 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:85](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L85) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:85](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L85) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/solid/reference/type-aliases/FieldGroupFieldsPropName.md index ecaaa44ef..261c98ad1 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:135](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L135) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L135) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupForm.md b/docs/framework/solid/reference/type-aliases/FieldGroupForm.md index 1b4056ef4..2470f621a 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:104](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L104) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:104](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L104) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md b/docs/framework/solid/reference/type-aliases/FieldGroupFormState.md index 1fd41865f..93b593374 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 93d583436..79ec7462a 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 aba86e51c..a9a472fe0 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 4f08ed50b..1dcecfcf5 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 = (fields, Component, fieldsPropName) => (props) => JSX.Element; ``` -Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:147](https://github.com/TanStack/form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L147) +Defined in: [packages/solid-form/src/FieldGroup/withFields.public.ts:147](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/FieldGroup/withFields.public.ts#L147) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/solid/reference/type-aliases/LooseFieldGroupFieldSlot.md index c1b29e903..01b3429ed 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: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/SolidAppFormApi.md b/docs/framework/solid/reference/type-aliases/SolidAppFormApi.md index a531c4056..6d20a92e6 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 574e9df13..0b47f7401 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/SolidFormApi.md b/docs/framework/solid/reference/type-aliases/SolidFormApi.md index 0d099ac10..47ea9f16e 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 c44139c39..71c1b909f 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 40ecd83a3..0e8c4bee2 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 010c51d7b..dfefbc381 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 1e5c15f4d..f0859fa1f 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 563013877..baa938591 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 e14848998..084cedd64 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:21](https://github.com/TanStack/form/blob/main/packages/solid-form/src/formType.public.ts#L21) +Defined in: [packages/solid-form/src/formType.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/solid-form/src/formType.public.ts#L21) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/solid/reference/type-aliases/StrictFieldGroupFieldSlot.md index 154f30ae4..08cbcce13 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: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/SubscribeSource.md b/docs/framework/solid/reference/type-aliases/SubscribeSource.md index 55409ca8a..3d1f331d4 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 466a5b492..1b4fe41f0 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 ce3febf66..2d34a726a 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/vue/reference/classes/ReadonlyStore.md b/docs/framework/vue/reference/classes/ReadonlyStore.md new file mode 100644 index 000000000..3db81ebb6 --- /dev/null +++ b/docs/framework/vue/reference/classes/ReadonlyStore.md @@ -0,0 +1,124 @@ +--- +id: ReadonlyStore +title: ReadonlyStore +--- + +# Class: ReadonlyStore\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:22 + +## Type Parameters + +### T + +`T` + +## Implements + +- `Omit`\<[`Store`](Store.md)\<`T`\>, `"setState"` \| `"actions"`\> + +## Constructors + +### Constructor + +```ts +new ReadonlyStore(getValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:24 + +#### Parameters + +##### getValue + +(`prev?`) => `T` + +#### Returns + +`ReadonlyStore`\<`T`\> + +### Constructor + +```ts +new ReadonlyStore(initialValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:25 + +#### Parameters + +##### initialValue + +`T` + +#### Returns + +`ReadonlyStore`\<`T`\> + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:26 + +##### Returns + +`T` + +#### Implementation of + +```ts +Omit.state +``` + +## Methods + +### get() + +```ts +get(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:27 + +#### Returns + +`T` + +#### Implementation of + +```ts +Omit.get +``` + +*** + +### subscribe() + +```ts +subscribe(observerOrFn): Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:28 + +#### Parameters + +##### observerOrFn + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +#### Returns + +[`Subscription`](../interfaces/Subscription.md) + +#### Implementation of + +```ts +Omit.subscribe +``` diff --git a/docs/framework/vue/reference/classes/Store.md b/docs/framework/vue/reference/classes/Store.md new file mode 100644 index 000000000..9c356d4f9 --- /dev/null +++ b/docs/framework/vue/reference/classes/Store.md @@ -0,0 +1,158 @@ +--- +id: Store +title: Store +--- + +# Class: Store\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:11 + +## Type Parameters + +### T + +`T` + +### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) = `never` + +## Constructors + +### Constructor + +```ts +new Store(getValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:14 + +#### Parameters + +##### getValue + +(`prev?`) => `T` + +#### Returns + +`Store`\<`T`, `TActions`\> + +### Constructor + +```ts +new Store(initialValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:15 + +#### Parameters + +##### initialValue + +`T` + +#### Returns + +`Store`\<`T`, `TActions`\> + +### Constructor + +```ts +new Store(initialValue, actionsFactory): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:16 + +#### Parameters + +##### initialValue + +`NonFunction`\<`T`\> + +##### actionsFactory + +[`StoreActionsFactory`](../type-aliases/StoreActionsFactory.md)\<`T`, `TActions`\> + +#### Returns + +`Store`\<`T`, `TActions`\> + +## Properties + +### actions + +```ts +readonly actions: TActions; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:13 + +## Accessors + +### state + +#### Get Signature + +```ts +get state(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:18 + +##### Returns + +`T` + +## Methods + +### get() + +```ts +get(): T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:19 + +#### Returns + +`T` + +*** + +### setState() + +```ts +setState(updater): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:17 + +#### Parameters + +##### updater + +(`prev`) => `T` + +#### Returns + +`void` + +*** + +### subscribe() + +```ts +subscribe(observerOrFn): Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:20 + +#### Parameters + +##### observerOrFn + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +#### Returns + +[`Subscription`](../interfaces/Subscription.md) diff --git a/docs/framework/vue/reference/functions/batch.md b/docs/framework/vue/reference/functions/batch.md new file mode 100644 index 000000000..90a86573f --- /dev/null +++ b/docs/framework/vue/reference/functions/batch.md @@ -0,0 +1,22 @@ +--- +id: batch +title: batch +--- + +# Function: batch() + +```ts +function batch(fn): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:5 + +## Parameters + +### fn + +() => `void` + +## Returns + +`void` diff --git a/docs/framework/vue/reference/functions/createAsyncAtom.md b/docs/framework/vue/reference/functions/createAsyncAtom.md new file mode 100644 index 000000000..013b66fbf --- /dev/null +++ b/docs/framework/vue/reference/functions/createAsyncAtom.md @@ -0,0 +1,32 @@ +--- +id: createAsyncAtom +title: createAsyncAtom +--- + +# Function: createAsyncAtom() + +```ts +function createAsyncAtom(getValue, options?): ReadonlyAtom>; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:16 + +## Type Parameters + +### T + +`T` + +## Parameters + +### getValue + +() => `Promise`\<`T`\> + +### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`AsyncAtomState`\<`T`, `unknown`\>\> + +## Returns + +[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`AsyncAtomState`\<`T`, `unknown`\>\> diff --git a/docs/framework/vue/reference/functions/createAtom.md b/docs/framework/vue/reference/functions/createAtom.md new file mode 100644 index 000000000..a48f2de04 --- /dev/null +++ b/docs/framework/vue/reference/functions/createAtom.md @@ -0,0 +1,62 @@ +--- +id: createAtom +title: createAtom +--- + +# Function: createAtom() + +## Call Signature + +```ts +function createAtom(getValue, options?): ReadonlyAtom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:17 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`T`\> + +## Call Signature + +```ts +function createAtom(initialValue, options?): Atom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:18 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +#### options? + +[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\> + +### Returns + +[`Atom`](../interfaces/Atom.md)\<`T`\> diff --git a/docs/framework/vue/reference/functions/createFormHook.md b/docs/framework/vue/reference/functions/createFormHook.md new file mode 100644 index 000000000..39afe44d8 --- /dev/null +++ b/docs/framework/vue/reference/functions/createFormHook.md @@ -0,0 +1,28 @@ +--- +id: createFormHook +title: createFormHook +--- + +# Function: createFormHook() + +```ts +function createFormHook(createOptions): AppFormHookResult; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](../type-aliases/AnyVueFormComponentMap.md) + +## Parameters + +### createOptions + +`TComponents` + +## Returns + +[`AppFormHookResult`](../interfaces/AppFormHookResult.md)\<`TComponents`\> diff --git a/docs/framework/vue/reference/functions/createStore.md b/docs/framework/vue/reference/functions/createStore.md new file mode 100644 index 000000000..70e32d306 --- /dev/null +++ b/docs/framework/vue/reference/functions/createStore.md @@ -0,0 +1,86 @@ +--- +id: createStore +title: createStore +--- + +# Function: createStore() + +## Call Signature + +```ts +function createStore(getValue): ReadonlyStore; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:30 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### getValue + +(`prev?`) => `T` + +### Returns + +[`ReadonlyStore`](../classes/ReadonlyStore.md)\<`T`\> + +## Call Signature + +```ts +function createStore(initialValue): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:31 + +### Type Parameters + +#### T + +`T` + +### Parameters + +#### initialValue + +`T` + +### Returns + +[`Store`](../classes/Store.md)\<`T`\> + +## Call Signature + +```ts +function createStore(initialValue, actions): Store; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:32 + +### Type Parameters + +#### T + +`T` + +#### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) + +### Parameters + +#### initialValue + +`NonFunction`\<`T`\> + +#### actions + +[`StoreActionsFactory`](../type-aliases/StoreActionsFactory.md)\<`T`, `TActions`\> + +### Returns + +[`Store`](../classes/Store.md)\<`T`, `TActions`\> diff --git a/docs/framework/vue/reference/functions/flush.md b/docs/framework/vue/reference/functions/flush.md new file mode 100644 index 000000000..733f2da2a --- /dev/null +++ b/docs/framework/vue/reference/functions/flush.md @@ -0,0 +1,16 @@ +--- +id: flush +title: flush +--- + +# Function: flush() + +```ts +function flush(): void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:6 + +## Returns + +`void` diff --git a/docs/framework/vue/reference/functions/getFieldGroupHelpers.md b/docs/framework/vue/reference/functions/getFieldGroupHelpers.md new file mode 100644 index 000000000..72a126140 --- /dev/null +++ b/docs/framework/vue/reference/functions/getFieldGroupHelpers.md @@ -0,0 +1,16 @@ +--- +id: getFieldGroupHelpers +title: getFieldGroupHelpers +--- + +# Function: getFieldGroupHelpers() + +```ts +function getFieldGroupHelpers(): FieldGroupHelpers>; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:198](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L198) + +## Returns + +[`FieldGroupHelpers`](../interfaces/FieldGroupHelpers.md)\<`Record`\<`never`, `never`\>\> diff --git a/docs/framework/vue/reference/functions/getFormHookHelpers.md b/docs/framework/vue/reference/functions/getFormHookHelpers.md new file mode 100644 index 000000000..331e2124a --- /dev/null +++ b/docs/framework/vue/reference/functions/getFormHookHelpers.md @@ -0,0 +1,16 @@ +--- +id: getFormHookHelpers +title: getFormHookHelpers +--- + +# Function: getFormHookHelpers() + +```ts +function getFormHookHelpers(): FormHookHelpers; +``` + +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 + +[`FormHookHelpers`](../interfaces/FormHookHelpers.md) diff --git a/docs/framework/vue/reference/functions/shallow.md b/docs/framework/vue/reference/functions/shallow.md new file mode 100644 index 000000000..021c4473c --- /dev/null +++ b/docs/framework/vue/reference/functions/shallow.md @@ -0,0 +1,32 @@ +--- +id: shallow +title: shallow +--- + +# Function: shallow() + +```ts +function shallow(objA, objB): boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/shallow.d.ts:2 + +## Type Parameters + +### T + +`T` + +## Parameters + +### objA + +`T` + +### objB + +`T` + +## Returns + +`boolean` diff --git a/docs/framework/vue/reference/functions/toObserver.md b/docs/framework/vue/reference/functions/toObserver.md new file mode 100644 index 000000000..dd7bb1090 --- /dev/null +++ b/docs/framework/vue/reference/functions/toObserver.md @@ -0,0 +1,39 @@ +--- +id: toObserver +title: toObserver +--- + +# Function: toObserver() + +```ts +function toObserver( + nextHandler?, + errorHandler?, +completionHandler?): Observer; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/atom.d.ts:4 + +## Type Parameters + +### T + +`T` + +## Parameters + +### nextHandler? + +[`Observer`](../type-aliases/Observer.md)\<`T`\> \| ((`value`) => `void`) + +### errorHandler? + +(`error`) => `void` + +### completionHandler? + +() => `void` + +## Returns + +[`Observer`](../type-aliases/Observer.md)\<`T`\> diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md new file mode 100644 index 000000000..e13b9bfd9 --- /dev/null +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -0,0 +1,46 @@ +--- +id: useAtom +title: useAtom +--- + +# Function: useAtom() + +```ts +function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; +``` + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useAtom.d.ts:20 + +Returns the current atom ref together with a setter. + +Use this when a component needs to both read and update the same writable +atom. + +## Type Parameters + +### TValue + +`TValue` + +## Parameters + +### atom + +[`Atom`](../interfaces/Atom.md)\<`TValue`\> + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TValue`\> + +## Returns + +\[`Readonly`\<`Ref`\<`TValue`, `TValue`\>\>, (`fn`) => `void` & (`value`) => `void`\] + +## Example + +```ts +const [count, setCount] = useAtom(countAtom) + +setCount((prev) => prev + 1) +console.log(count.value) +``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md new file mode 100644 index 000000000..e9f5dd6f1 --- /dev/null +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -0,0 +1,62 @@ +--- +id: useSelector +title: useSelector +--- + +# Function: useSelector() + +```ts +function useSelector( + source, + selector?, +options?): Readonly>; +``` + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useSelector.d.ts:33 + +Selects a slice of state from an atom or store and subscribes the component +to that selection. + +This is the primary Vue read hook for TanStack Store. It returns a readonly +ref containing the selected value. + +Omit the selector to subscribe to the whole value. + +## Type Parameters + +### TSource + +`TSource` + +### TSelected + +`TSelected` = `NoInfer`\<`TSource`\> + +## Parameters + +### source + +`SelectionSource`\<`TSource`\> + +### selector? + +(`snapshot`) => `TSelected` + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TSelected`\> + +## Returns + +`Readonly`\<`Ref`\<`TSelected`\>\> + +## Examples + +```ts +const count = useSelector(counterStore, (state) => state.count) +console.log(count.value) +``` + +```ts +const value = useSelector(countAtom) +``` diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md new file mode 100644 index 000000000..90f6cb248 --- /dev/null +++ b/docs/framework/vue/reference/functions/useStore.md @@ -0,0 +1,65 @@ +--- +id: _useStore +title: _useStore +--- + +# Function: \_useStore() + +```ts +function _useStore( + store, + selector, + options?): [Readonly>, [TActions] extends [never] ? (updater) => void : TActions]; +``` + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/\_useStore.d.ts:24 + +Experimental combined read+write hook for stores, mirroring useAtom's tuple +pattern. + +Returns `[selected, actions]` when the store has an actions factory, or +`[selected, setState]` for plain stores. + +## Type Parameters + +### TState + +`TState` + +### TActions + +`TActions` *extends* [`StoreActionMap`](../type-aliases/StoreActionMap.md) + +### TSelected + +`TSelected` = `NoInfer`\<`TState`\> + +## Parameters + +### store + +[`Store`](../classes/Store.md)\<`TState`, `TActions`\> + +### selector + +(`state`) => `TSelected` + +### options? + +[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TSelected`\> + +## Returns + +\[`Readonly`\<`Ref`\<`TSelected`, `TSelected`\>\>, \[`TActions`\] *extends* \[`never`\] ? (`updater`) => `void` : `TActions`\] + +## Example + +```ts +// Store with actions +const [cats, { addCat }] = _useStore(petStore, (s) => s.cats) +console.log(cats.value) + +// Store without actions +const [count, setState] = _useStore(plainStore, (s) => s) +setState((prev) => prev + 1) +``` diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md new file mode 100644 index 000000000..83a6ca22b --- /dev/null +++ b/docs/framework/vue/reference/index.md @@ -0,0 +1,118 @@ +--- +id: "@tanstack/vue-form" +title: "@tanstack/vue-form" +--- + +# @tanstack/vue-form + +## Classes + +- [ReadonlyStore](classes/ReadonlyStore.md) +- [Store](classes/Store.md) + +## Interfaces + +- [AppFormHookResult](interfaces/AppFormHookResult.md) +- [AppFormOptions](interfaces/AppFormOptions.md) +- [AppFormOptionsApi](interfaces/AppFormOptionsApi.md) +- [Atom](interfaces/Atom.md) +- [AtomOptions](interfaces/AtomOptions.md) +- [BaseAtom](interfaces/BaseAtom.md) +- [FieldGroupApi](interfaces/FieldGroupApi.md) +- [FieldGroupFieldSlot](interfaces/FieldGroupFieldSlot.md) +- [FieldGroupHelper](interfaces/FieldGroupHelper.md) +- [FieldGroupHelpers](interfaces/FieldGroupHelpers.md) +- [FormHookHelpers](interfaces/FormHookHelpers.md) +- [InternalBaseAtom](interfaces/InternalBaseAtom.md) +- [InternalReadonlyAtom](interfaces/InternalReadonlyAtom.md) +- [InteropSubscribable](interfaces/InteropSubscribable.md) +- [Readable](interfaces/Readable.md) +- [ReadonlyAtom](interfaces/ReadonlyAtom.md) +- [Subscribable](interfaces/Subscribable.md) +- [SubscribeProps](interfaces/SubscribeProps.md) +- [Subscription](interfaces/Subscription.md) +- [UseSelectorOptions](interfaces/UseSelectorOptions.md) +- [VueFormComponentMap](interfaces/VueFormComponentMap.md) +- [VueFormFieldProps](interfaces/VueFormFieldProps.md) +- [VueFormGroupApi](interfaces/VueFormGroupApi.md) +- [VueFormGroupProps](interfaces/VueFormGroupProps.md) +- [VueTanStackFormComponents](interfaces/VueTanStackFormComponents.md) + +## Type Aliases + +- [AnyAtom](type-aliases/AnyAtom.md) +- [AnyFieldGroupApi](type-aliases/AnyFieldGroupApi.md) +- [AnyFieldGroupFieldSlot](type-aliases/AnyFieldGroupFieldSlot.md) +- [AnyVueFormApi](type-aliases/AnyVueFormApi.md) +- [AnyVueFormComponentMap](type-aliases/AnyVueFormComponentMap.md) +- [AppFormComponent](type-aliases/AppFormComponent.md) +- [DefaultVueFormComponentMap](type-aliases/DefaultVueFormComponentMap.md) +- [DefineFieldsFn](type-aliases/DefineFieldsFn.md) +- [FieldGroupArrayFieldComponent](type-aliases/FieldGroupArrayFieldComponent.md) +- [FieldGroupDefinition](type-aliases/FieldGroupDefinition.md) +- [FieldGroupFieldBindingForSlot](type-aliases/FieldGroupFieldBindingForSlot.md) +- [FieldGroupFieldBindings](type-aliases/FieldGroupFieldBindings.md) +- [FieldGroupFieldBindingsOf](type-aliases/FieldGroupFieldBindingsOf.md) +- [FieldGroupFieldComponent](type-aliases/FieldGroupFieldComponent.md) +- [FieldGroupFieldComponentsOf](type-aliases/FieldGroupFieldComponentsOf.md) +- [FieldGroupFieldData](type-aliases/FieldGroupFieldData.md) +- [FieldGroupFieldNameForSlot](type-aliases/FieldGroupFieldNameForSlot.md) +- [FieldGroupFieldNames](type-aliases/FieldGroupFieldNames.md) +- [FieldGroupFields](type-aliases/FieldGroupFields.md) +- [FieldGroupFieldSlotAllows](type-aliases/FieldGroupFieldSlotAllows.md) +- [FieldGroupFieldSlotMode](type-aliases/FieldGroupFieldSlotMode.md) +- [FieldGroupFieldSlotModeOf](type-aliases/FieldGroupFieldSlotModeOf.md) +- [FieldGroupFieldSlotValue](type-aliases/FieldGroupFieldSlotValue.md) +- [FieldGroupFieldsOf](type-aliases/FieldGroupFieldsOf.md) +- [FieldGroupFieldsPropName](type-aliases/FieldGroupFieldsPropName.md) +- [FieldGroupForm](type-aliases/FieldGroupForm.md) +- [FieldGroupFormState](type-aliases/FieldGroupFormState.md) +- [FieldGroupSubscribeComponent](type-aliases/FieldGroupSubscribeComponent.md) +- [FieldGroupSubscribeProps](type-aliases/FieldGroupSubscribeProps.md) +- [FieldGroupWithFieldsFn](type-aliases/FieldGroupWithFieldsFn.md) +- [LooseFieldGroupFieldSlot](type-aliases/LooseFieldGroupFieldSlot.md) +- [Observer](type-aliases/Observer.md) +- [Selection](type-aliases/Selection.md) +- [StoreAction](type-aliases/StoreAction.md) +- [StoreActionMap](type-aliases/StoreActionMap.md) +- [StoreActionsFactory](type-aliases/StoreActionsFactory.md) +- [StrictFieldGroupFieldSlot](type-aliases/StrictFieldGroupFieldSlot.md) +- [SubscribeComponent](type-aliases/SubscribeComponent.md) +- [SubscribeSource](type-aliases/SubscribeSource.md) +- [UseAppFormHook](type-aliases/UseAppFormHook.md) +- [UseFormHook](type-aliases/UseFormHook.md) +- [VueAppFormApi](type-aliases/VueAppFormApi.md) +- [VueFieldApi](type-aliases/VueFieldApi.md) +- [VueFormApi](type-aliases/VueFormApi.md) +- [VueFormArrayFieldComponent](type-aliases/VueFormArrayFieldComponent.md) +- [VueFormFieldComponent](type-aliases/VueFormFieldComponent.md) +- [VueFormGroupArrayFieldComponent](type-aliases/VueFormGroupArrayFieldComponent.md) +- [VueFormGroupComponent](type-aliases/VueFormGroupComponent.md) +- [VueFormGroupFieldComponent](type-aliases/VueFormGroupFieldComponent.md) +- [VueFormGroupSubscribeComponent](type-aliases/VueFormGroupSubscribeComponent.md) +- [VueFormGroupSubscribeProps](type-aliases/VueFormGroupSubscribeProps.md) +- [VueFormSubscribeComponent](type-aliases/VueFormSubscribeComponent.md) +- [VueFormSubscribeProps](type-aliases/VueFormSubscribeProps.md) +- [VueFormType](type-aliases/VueFormType.md) + +## Variables + +- [Subscribe](variables/Subscribe.md) +- [useForm](variables/useForm.md) +- [~~useStore~~](variables/useStore.md) + +## Functions + +- [\_useStore](functions/useStore.md) +- [batch](functions/batch.md) +- [createAsyncAtom](functions/createAsyncAtom.md) +- [createAtom](functions/createAtom.md) +- [createFormHook](functions/createFormHook.md) +- [createStore](functions/createStore.md) +- [flush](functions/flush.md) +- [getFieldGroupHelpers](functions/getFieldGroupHelpers.md) +- [getFormHookHelpers](functions/getFormHookHelpers.md) +- [shallow](functions/shallow.md) +- [toObserver](functions/toObserver.md) +- [useAtom](functions/useAtom.md) +- [useSelector](functions/useSelector.md) diff --git a/docs/framework/vue/reference/interfaces/AppFormHookResult.md b/docs/framework/vue/reference/interfaces/AppFormHookResult.md new file mode 100644 index 000000000..f7dc2c93c --- /dev/null +++ b/docs/framework/vue/reference/interfaces/AppFormHookResult.md @@ -0,0 +1,62 @@ +--- +id: AppFormHookResult +title: AppFormHookResult +--- + +# Interface: AppFormHookResult\ + +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 + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](../type-aliases/AnyVueFormComponentMap.md) + +## Properties + +### appFormOptions + +```ts +appFormOptions: AppFormOptionsApi; +``` + +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) + +*** + +### getAppFieldGroupHelpers + +```ts +getAppFieldGroupHelpers: () => FieldGroupHelpers; +``` + +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) + +#### Returns + +[`FieldGroupHelpers`](FieldGroupHelpers.md)\<`TComponents`\[`"fieldComponents"`\]\> + +*** + +### useAppForm + +```ts +useAppForm: UseAppFormHook; +``` + +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L28) + +*** + +### useFormContext + +```ts +useFormContext: () => VueAppFormApi; +``` + +Defined in: [packages/vue-form/src/AppForm/createFormHookTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/AppForm/createFormHookTypes.public.ts#L29) + +#### Returns + +[`VueAppFormApi`](../type-aliases/VueAppFormApi.md)\<`any`, `any`, `TComponents`\> diff --git a/docs/framework/vue/reference/interfaces/AppFormOptions.md b/docs/framework/vue/reference/interfaces/AppFormOptions.md new file mode 100644 index 000000000..f83e1d142 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/AppFormOptions.md @@ -0,0 +1,40 @@ +--- +id: AppFormOptions +title: AppFormOptions +--- + +# Interface: AppFormOptions\ + +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 + +- `FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](../type-aliases/AnyVueFormComponentMap.md) + +## Properties + +### \[componentsSymbol\] + +```ts +[componentsSymbol]: TComponents; +``` + +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 new file mode 100644 index 000000000..5cb9b7abf --- /dev/null +++ b/docs/framework/vue/reference/interfaces/AppFormOptionsApi.md @@ -0,0 +1,112 @@ +--- +id: AppFormOptionsApi +title: AppFormOptionsApi +--- + +# Interface: AppFormOptionsApi()\ + +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 + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](../type-aliases/AnyVueFormComponentMap.md) + +```ts +AppFormOptionsApi(options): AppFormOptions; +``` + +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 + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`AppFormOptions`](AppFormOptions.md)\<`TFormData`, `TFormValidators`, `TSubmitReturn`, `TComponents`\> + +## Properties + +### looseSchema + +```ts +looseSchema: (options) => AppFormOptions>, TFormValidators, TSubmitReturn, TComponents>; +``` + +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 + +##### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`any`\> + +##### TFormData + +`TFormData` *extends* `any` + +##### TSubmitReturn + +`TSubmitReturn` + +#### Parameters + +##### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +#### Returns + +[`AppFormOptions`](AppFormOptions.md)\<`InferUnion`\<`TFormData`, `FormValidatorData`\<`TFormValidators`\>\>, `TFormValidators`, `TSubmitReturn`, `TComponents`\> + +*** + +### strictSchema + +```ts +strictSchema: (options) => AppFormOptions, TFormValidators, TSubmitReturn, TComponents>; +``` + +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 + +##### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`any`\> + +##### TFormData + +`TFormData` *extends* `any` + +##### TSubmitReturn + +`TSubmitReturn` + +#### Parameters + +##### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +#### Returns + +[`AppFormOptions`](AppFormOptions.md)\<`FormValidatorData`\<`TFormValidators`\>, `TFormValidators`, `TSubmitReturn`, `TComponents`\> diff --git a/docs/framework/vue/reference/interfaces/Atom.md b/docs/framework/vue/reference/interfaces/Atom.md new file mode 100644 index 000000000..abee2295d --- /dev/null +++ b/docs/framework/vue/reference/interfaces/Atom.md @@ -0,0 +1,62 @@ +--- +id: Atom +title: Atom +--- + +# Interface: Atom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:29 + +## Extends + +- [`BaseAtom`](BaseAtom.md)\<`T`\> + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`get`](BaseAtom.md#get) + +*** + +### set + +```ts +set: (fn) => void & (value) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:31 + +Sets the value of the atom using a function. + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`subscribe`](BaseAtom.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/AtomOptions.md b/docs/framework/vue/reference/interfaces/AtomOptions.md new file mode 100644 index 000000000..12e6fb877 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/AtomOptions.md @@ -0,0 +1,38 @@ +--- +id: AtomOptions +title: AtomOptions +--- + +# Interface: AtomOptions\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:33 + +## Type Parameters + +### T + +`T` + +## Properties + +### compare? + +```ts +optional compare?: (prev, next) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:34 + +#### Parameters + +##### prev + +`T` + +##### next + +`T` + +#### Returns + +`boolean` diff --git a/docs/framework/vue/reference/interfaces/BaseAtom.md b/docs/framework/vue/reference/interfaces/BaseAtom.md new file mode 100644 index 000000000..ac15f7f6c --- /dev/null +++ b/docs/framework/vue/reference/interfaces/BaseAtom.md @@ -0,0 +1,55 @@ +--- +id: BaseAtom +title: BaseAtom +--- + +# Interface: BaseAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:22 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\>.[`Readable`](Readable.md)\<`T`\> + +## Extended by + +- [`Atom`](Atom.md) +- [`ReadonlyAtom`](ReadonlyAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`Readable`](Readable.md).[`get`](Readable.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/FieldGroupApi.md b/docs/framework/vue/reference/interfaces/FieldGroupApi.md new file mode 100644 index 000000000..1faca6f3d --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FieldGroupApi.md @@ -0,0 +1,62 @@ +--- +id: FieldGroupApi +title: FieldGroupApi +--- + +# Interface: FieldGroupApi\ + +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 + +- `FormApiFieldMethods`\<`TFieldData`\>.`FormApiArrayMethods`\<`TFieldData`\> + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> = `Record`\<`never`, `never`\> + +## Properties + +### ArrayField + +```ts +ArrayField: FieldGroupArrayFieldComponent; +``` + +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) + +*** + +### atom + +```ts +atom: ReadonlyAtom; +``` + +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) + +*** + +### Field + +```ts +Field: FieldGroupFieldComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: FieldGroupSubscribeComponent; +``` + +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/FieldGroupFieldSlot.md b/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md new file mode 100644 index 000000000..920cfd139 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FieldGroupFieldSlot.md @@ -0,0 +1,38 @@ +--- +id: FieldGroupFieldSlot +title: FieldGroupFieldSlot +--- + +# Interface: FieldGroupFieldSlot\ + +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) + +## Type Parameters + +### TValue + +`TValue` + +### TMode + +`TMode` *extends* [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md) = [`FieldGroupFieldSlotMode`](../type-aliases/FieldGroupFieldSlotMode.md) + +## Properties + +### \[fieldGroupFieldSlotValueSymbol\] + +```ts +readonly [fieldGroupFieldSlotValueSymbol]: TValue; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:26](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L26) + +*** + +### mode + +```ts +readonly mode: TMode; +``` + +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) diff --git a/docs/framework/vue/reference/interfaces/FieldGroupHelper.md b/docs/framework/vue/reference/interfaces/FieldGroupHelper.md new file mode 100644 index 000000000..ac5334aad --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FieldGroupHelper.md @@ -0,0 +1,48 @@ +--- +id: FieldGroupHelper +title: FieldGroupHelper +--- + +# Interface: FieldGroupHelper + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:171](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L171) + +## Properties + +### loose + +```ts +loose: () => LooseFieldGroupFieldSlot; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:173](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L173) + +#### Type Parameters + +##### TValue + +`TValue` + +#### Returns + +[`LooseFieldGroupFieldSlot`](../type-aliases/LooseFieldGroupFieldSlot.md)\<`TValue`\> + +*** + +### strict + +```ts +strict: () => StrictFieldGroupFieldSlot; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:172](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L172) + +#### Type Parameters + +##### TValue + +`TValue` + +#### Returns + +[`StrictFieldGroupFieldSlot`](../type-aliases/StrictFieldGroupFieldSlot.md)\<`TValue`\> diff --git a/docs/framework/vue/reference/interfaces/FieldGroupHelpers.md b/docs/framework/vue/reference/interfaces/FieldGroupHelpers.md new file mode 100644 index 000000000..84f58e820 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FieldGroupHelpers.md @@ -0,0 +1,44 @@ +--- +id: FieldGroupHelpers +title: FieldGroupHelpers +--- + +# Interface: FieldGroupHelpers\ + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:184](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L184) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Properties + +### defineFields + +```ts +defineFields: DefineFieldsFn; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:188](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L188) + +*** + +### helper + +```ts +helper: FieldGroupHelper; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:187](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L187) + +*** + +### withFields + +```ts +withFields: FieldGroupWithFieldsFn; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:189](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L189) diff --git a/docs/framework/vue/reference/interfaces/FormHookHelpers.md b/docs/framework/vue/reference/interfaces/FormHookHelpers.md new file mode 100644 index 000000000..dae707e14 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/FormHookHelpers.md @@ -0,0 +1,28 @@ +--- +id: FormHookHelpers +title: FormHookHelpers +--- + +# Interface: FormHookHelpers + +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 + +### fieldBrand + +```ts +fieldBrand: FieldBrandHelper; +``` + +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) + +*** + +### fieldComponent + +```ts +fieldComponent: FieldComponentHelper; +``` + +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/InternalBaseAtom.md b/docs/framework/vue/reference/interfaces/InternalBaseAtom.md new file mode 100644 index 000000000..cb05b8c49 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/InternalBaseAtom.md @@ -0,0 +1,88 @@ +--- +id: InternalBaseAtom +title: InternalBaseAtom +--- + +# Interface: InternalBaseAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:23 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\>.[`Readable`](Readable.md)\<`T`\> + +## Extended by + +- [`InternalReadonlyAtom`](InternalReadonlyAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### \_snapshot + +```ts +_snapshot: T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:25 + +**`Internal`** + +*** + +### \_update + +```ts +_update: (getValue?) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:27 + +**`Internal`** + +#### Parameters + +##### getValue? + +`T` \| ((`snapshot`) => `T`) + +#### Returns + +`boolean` + +*** + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`Readable`](Readable.md).[`get`](Readable.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/InternalReadonlyAtom.md b/docs/framework/vue/reference/interfaces/InternalReadonlyAtom.md new file mode 100644 index 000000000..a600ae031 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/InternalReadonlyAtom.md @@ -0,0 +1,172 @@ +--- +id: InternalReadonlyAtom +title: InternalReadonlyAtom +--- + +# Interface: InternalReadonlyAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:37 + +## Extends + +- [`InternalBaseAtom`](InternalBaseAtom.md)\<`T`\>.`ReactiveNode` + +## Type Parameters + +### T + +`T` + +## Properties + +### \_snapshot + +```ts +_snapshot: T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:25 + +**`Internal`** + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`_snapshot`](InternalBaseAtom.md#_snapshot) + +*** + +### \_update + +```ts +_update: (getValue?) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:27 + +**`Internal`** + +#### Parameters + +##### getValue? + +`T` \| ((`snapshot`) => `T`) + +#### Returns + +`boolean` + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`_update`](InternalBaseAtom.md#_update) + +*** + +### deps? + +```ts +optional deps?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:3 + +#### Inherited from + +```ts +ReactiveNode.deps +``` + +*** + +### depsTail? + +```ts +optional depsTail?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:4 + +#### Inherited from + +```ts +ReactiveNode.depsTail +``` + +*** + +### flags + +```ts +flags: number; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:7 + +#### Inherited from + +```ts +ReactiveNode.flags +``` + +*** + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`get`](InternalBaseAtom.md#get) + +*** + +### subs? + +```ts +optional subs?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:5 + +#### Inherited from + +```ts +ReactiveNode.subs +``` + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`InternalBaseAtom`](InternalBaseAtom.md).[`subscribe`](InternalBaseAtom.md#subscribe) + +*** + +### subsTail? + +```ts +optional subsTail?: Link; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/alien.d.ts:6 + +#### Inherited from + +```ts +ReactiveNode.subsTail +``` diff --git a/docs/framework/vue/reference/interfaces/InteropSubscribable.md b/docs/framework/vue/reference/interfaces/InteropSubscribable.md new file mode 100644 index 000000000..2d0f2130c --- /dev/null +++ b/docs/framework/vue/reference/interfaces/InteropSubscribable.md @@ -0,0 +1,38 @@ +--- +id: InteropSubscribable +title: InteropSubscribable +--- + +# Interface: InteropSubscribable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:5 + +## Extended by + +- [`Subscribable`](Subscribable.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### subscribe + +```ts +subscribe: (observer) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:6 + +#### Parameters + +##### observer + +[`Observer`](../type-aliases/Observer.md)\<`T`\> + +#### Returns + +[`Subscription`](Subscription.md) diff --git a/docs/framework/vue/reference/interfaces/Readable.md b/docs/framework/vue/reference/interfaces/Readable.md new file mode 100644 index 000000000..161714e02 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/Readable.md @@ -0,0 +1,51 @@ +--- +id: Readable +title: Readable +--- + +# Interface: Readable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:19 + +## Extends + +- [`Subscribable`](Subscribable.md)\<`T`\> + +## Extended by + +- [`BaseAtom`](BaseAtom.md) +- [`InternalBaseAtom`](InternalBaseAtom.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`Subscribable`](Subscribable.md).[`subscribe`](Subscribable.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/ReadonlyAtom.md b/docs/framework/vue/reference/interfaces/ReadonlyAtom.md new file mode 100644 index 000000000..8ebcdab4d --- /dev/null +++ b/docs/framework/vue/reference/interfaces/ReadonlyAtom.md @@ -0,0 +1,60 @@ +--- +id: ReadonlyAtom +title: ReadonlyAtom +--- + +# Interface: ReadonlyAtom\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:49 + +An atom that is read-only and cannot be set. + +## Example + +```ts +const atom = createAtom(() => 42); +// @ts-expect-error - Cannot set a readonly atom +atom.set(43); +``` + +## Extends + +- [`BaseAtom`](BaseAtom.md)\<`T`\> + +## Type Parameters + +### T + +`T` + +## Properties + +### get + +```ts +get: () => T; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:20 + +#### Returns + +`T` + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`get`](BaseAtom.md#get) + +*** + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Inherited from + +[`BaseAtom`](BaseAtom.md).[`subscribe`](BaseAtom.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/Subscribable.md b/docs/framework/vue/reference/interfaces/Subscribable.md new file mode 100644 index 000000000..415e8a400 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/Subscribable.md @@ -0,0 +1,38 @@ +--- +id: Subscribable +title: Subscribable +--- + +# Interface: Subscribable\ + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:16 + +## Extends + +- [`InteropSubscribable`](InteropSubscribable.md)\<`T`\> + +## Extended by + +- [`BaseAtom`](BaseAtom.md) +- [`InternalBaseAtom`](InternalBaseAtom.md) +- [`Readable`](Readable.md) + +## Type Parameters + +### T + +`T` + +## Properties + +### subscribe + +```ts +subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:17 + +#### Overrides + +[`InteropSubscribable`](InteropSubscribable.md).[`subscribe`](InteropSubscribable.md#subscribe) diff --git a/docs/framework/vue/reference/interfaces/SubscribeProps.md b/docs/framework/vue/reference/interfaces/SubscribeProps.md new file mode 100644 index 000000000..958181e6c --- /dev/null +++ b/docs/framework/vue/reference/interfaces/SubscribeProps.md @@ -0,0 +1,68 @@ +--- +id: SubscribeProps +title: SubscribeProps +--- + +# Interface: SubscribeProps\ + +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 + +### TSourceData + +`TSourceData` + +### TSelected + +`TSelected` + +## Properties + +### selector + +```ts +selector: (state) => TSelected; +``` + +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 + +##### state + +`TSourceData` + +#### Returns + +`TSelected` + +*** + +### source + +```ts +source: SubscribeSource; +``` + +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) + +*** + +### when? + +```ts +optional when?: (selected) => boolean; +``` + +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 + +##### selected + +`NoInfer`\<`TSelected`\> + +#### Returns + +`boolean` diff --git a/docs/framework/vue/reference/interfaces/Subscription.md b/docs/framework/vue/reference/interfaces/Subscription.md new file mode 100644 index 000000000..8ed05ffc5 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/Subscription.md @@ -0,0 +1,22 @@ +--- +id: Subscription +title: Subscription +--- + +# Interface: Subscription + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:13 + +## Properties + +### unsubscribe + +```ts +unsubscribe: () => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:14 + +#### Returns + +`void` diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md new file mode 100644 index 000000000..064f2c931 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -0,0 +1,38 @@ +--- +id: UseSelectorOptions +title: UseSelectorOptions +--- + +# Interface: UseSelectorOptions\ + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useSelector.d.ts:4 + +## Type Parameters + +### TSelected + +`TSelected` + +## Properties + +### compare? + +```ts +optional compare?: (a, b) => boolean; +``` + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useSelector.d.ts:5 + +#### Parameters + +##### a + +`TSelected` + +##### b + +`TSelected` + +#### Returns + +`boolean` diff --git a/docs/framework/vue/reference/interfaces/VueFormComponentMap.md b/docs/framework/vue/reference/interfaces/VueFormComponentMap.md new file mode 100644 index 000000000..52a5fd18e --- /dev/null +++ b/docs/framework/vue/reference/interfaces/VueFormComponentMap.md @@ -0,0 +1,38 @@ +--- +id: VueFormComponentMap +title: VueFormComponentMap +--- + +# Interface: VueFormComponentMap\ + +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 + +### TFormComponents + +`TFormComponents` *extends* `Record`\<`string`, `Component`\> + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Properties + +### fieldComponents + +```ts +fieldComponents: TFieldComponents; +``` + +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) + +*** + +### formComponents + +```ts +formComponents: TFormComponents; +``` + +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 new file mode 100644 index 000000000..c99024168 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/VueFormFieldProps.md @@ -0,0 +1,56 @@ +--- +id: VueFormFieldProps +title: VueFormFieldProps +--- + +# Interface: VueFormFieldProps\ + +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 + +- `FieldApiOptions`\<`TFieldData`, `TFieldName`, `TFieldValue`, `TFieldValidators`, `TGroupFieldError`, `TFormData`, `TFormErrorTypes`\> + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFieldName + +`TFieldName` + +### TFieldValue + +`TFieldValue` + +### TFieldValidators + +`TFieldValidators` *extends* `FieldValidators`\<`TFieldData`, `TFieldName`, `TFieldValue`\> + +### TGroupFieldError + +`TGroupFieldError` + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Properties + +### \[fieldComponentsType\]? + +```ts +readonly optional [fieldComponentsType]?: TFieldComponents; +``` + +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 new file mode 100644 index 000000000..08f6de8a8 --- /dev/null +++ b/docs/framework/vue/reference/interfaces/VueFormGroupApi.md @@ -0,0 +1,68 @@ +--- +id: VueFormGroupApi +title: VueFormGroupApi +--- + +# Interface: VueFormGroupApi\ + +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 + +- `FormGroupApi`\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupErrorTypes`, `TFormErrorTypes`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TGroupName + +`TGroupName` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Properties + +### ArrayField + +```ts +ArrayField: VueFormGroupArrayFieldComponent; +``` + +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) + +*** + +### Field + +```ts +Field: VueFormGroupFieldComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: VueFormGroupSubscribeComponent; +``` + +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 new file mode 100644 index 000000000..83e2d670f --- /dev/null +++ b/docs/framework/vue/reference/interfaces/VueFormGroupProps.md @@ -0,0 +1,48 @@ +--- +id: VueFormGroupProps +title: VueFormGroupProps +--- + +# Interface: VueFormGroupProps\ + +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 + +- `Omit`\<`FormGroupOptions`\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupValidators`, `TFormErrorTypes`\>, `"form"`\> + +## Type Parameters + +### TFormData + +`TFormData` + +### TGroupName + +`TGroupName` + +### TGroupValue + +`TGroupValue` + +### TGroupValidators + +`TGroupValidators` *extends* `FormGroupValidators`\<`TGroupValue`\> + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Properties + +### \[fieldComponentsType\]? + +```ts +readonly optional [fieldComponentsType]?: TFieldComponents; +``` + +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 new file mode 100644 index 000000000..ea0fa623d --- /dev/null +++ b/docs/framework/vue/reference/interfaces/VueTanStackFormComponents.md @@ -0,0 +1,62 @@ +--- +id: VueTanStackFormComponents +title: VueTanStackFormComponents +--- + +# Interface: VueTanStackFormComponents\ + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> = `Record`\<`never`, `never`\> + +## Properties + +### ArrayField + +```ts +ArrayField: VueFormArrayFieldComponent; +``` + +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) + +*** + +### Field + +```ts +Field: VueFormFieldComponent; +``` + +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) + +*** + +### FormGroup + +```ts +FormGroup: VueFormGroupComponent; +``` + +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) + +*** + +### Subscribe + +```ts +Subscribe: VueFormSubscribeComponent; +``` + +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/AnyAtom.md b/docs/framework/vue/reference/type-aliases/AnyAtom.md new file mode 100644 index 000000000..cced299e9 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AnyAtom.md @@ -0,0 +1,12 @@ +--- +id: AnyAtom +title: AnyAtom +--- + +# Type Alias: AnyAtom + +```ts +type AnyAtom = BaseAtom; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:36 diff --git a/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md b/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md new file mode 100644 index 000000000..d0a87d060 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AnyFieldGroupApi.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldGroupApi +title: AnyFieldGroupApi +--- + +# Type Alias: AnyFieldGroupApi + +```ts +type AnyFieldGroupApi = FieldGroupApi>; +``` + +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 new file mode 100644 index 000000000..4540b6317 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AnyFieldGroupFieldSlot.md @@ -0,0 +1,12 @@ +--- +id: AnyFieldGroupFieldSlot +title: AnyFieldGroupFieldSlot +--- + +# Type Alias: AnyFieldGroupFieldSlot + +```ts +type AnyFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L28) diff --git a/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md b/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md new file mode 100644 index 000000000..fcaa8608c --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AnyVueFormApi.md @@ -0,0 +1,12 @@ +--- +id: AnyVueFormApi +title: AnyVueFormApi +--- + +# Type Alias: AnyVueFormApi + +```ts +type AnyVueFormApi = AnyFormApi & VueTanStackFormComponents; +``` + +Defined in: [packages/vue-form/src/VueForm/formApiTypes.public.ts:29](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/formApiTypes.public.ts#L29) diff --git a/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md b/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md new file mode 100644 index 000000000..e0c4fae3f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AnyVueFormComponentMap.md @@ -0,0 +1,12 @@ +--- +id: AnyVueFormComponentMap +title: AnyVueFormComponentMap +--- + +# Type Alias: AnyVueFormComponentMap + +```ts +type AnyVueFormComponentMap = VueFormComponentMap, Record>; +``` + +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 new file mode 100644 index 000000000..bc659b8f5 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/AppFormComponent.md @@ -0,0 +1,30 @@ +--- +id: AppFormComponent +title: AppFormComponent +--- + +# Type Alias: AppFormComponent + +```ts +type AppFormComponent = (props) => VueComponentInstance<{ +}, { + default: { + }; +}>; +``` + +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 + +### props + +`PublicProps` + +## Returns + +`VueComponentInstance`\<\{ +\}, \{ + `default`: \{ + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md b/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md new file mode 100644 index 000000000..ae6e0c400 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/DefaultVueFormComponentMap.md @@ -0,0 +1,12 @@ +--- +id: DefaultVueFormComponentMap +title: DefaultVueFormComponentMap +--- + +# Type Alias: DefaultVueFormComponentMap + +```ts +type DefaultVueFormComponentMap = VueFormComponentMap, Record>; +``` + +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/DefineFieldsFn.md b/docs/framework/vue/reference/type-aliases/DefineFieldsFn.md new file mode 100644 index 000000000..d841f2002 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/DefineFieldsFn.md @@ -0,0 +1,34 @@ +--- +id: DefineFieldsFn +title: DefineFieldsFn +--- + +# Type Alias: DefineFieldsFn\ + +```ts +type DefineFieldsFn = (fields) => FieldGroupDefinition; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:176](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L176) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +## Parameters + +### fields + +`TFields` + +## Returns + +[`FieldGroupDefinition`](FieldGroupDefinition.md)\<`TFields`, `TFieldComponents`\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md new file mode 100644 index 000000000..321145910 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupArrayFieldComponent.md @@ -0,0 +1,40 @@ +--- +id: FieldGroupArrayFieldComponent +title: FieldGroupArrayFieldComponent +--- + +# Type Alias: FieldGroupArrayFieldComponent\ + +```ts +type FieldGroupArrayFieldComponent = (props) => VueComponentInstance, FieldValidators>, ValidationIssue, unknown, FormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError>, ValidationIssue, FormErrorTypes>, unknown, FormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `ToFieldError`\<`FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `FormErrorTypes`\>, `unknown`, `FormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupDefinition.md b/docs/framework/vue/reference/type-aliases/FieldGroupDefinition.md new file mode 100644 index 000000000..5ca835a53 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupDefinition.md @@ -0,0 +1,30 @@ +--- +id: FieldGroupDefinition +title: FieldGroupDefinition +--- + +# Type Alias: FieldGroupDefinition\ + +```ts +type FieldGroupDefinition = FieldGroupApi, TFieldComponents> & object; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:92](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L92) + +## Type Declaration + +### \[fieldGroupFieldsSymbol\] + +```ts +readonly [fieldGroupFieldsSymbol]: TFields; +``` + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> = `Record`\<`never`, `never`\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md new file mode 100644 index 000000000..20f948736 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingForSlot.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindingForSlot +title: FieldGroupFieldBindingForSlot +--- + +# Type Alias: FieldGroupFieldBindingForSlot\ + +```ts +type FieldGroupFieldBindingForSlot = TSlot extends FieldGroupFieldSlot ? TMode extends "strict" ? FieldGroupFieldNameForSlot : DeepKeysWhereValueIncludes : never; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:108](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L108) + +## Type Parameters + +### TFormData + +`TFormData` + +### TSlot + +`TSlot` *extends* [`AnyFieldGroupFieldSlot`](AnyFieldGroupFieldSlot.md) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md new file mode 100644 index 000000000..febcf33a7 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindings.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindings +title: FieldGroupFieldBindings +--- + +# Type Alias: FieldGroupFieldBindings\ + +```ts +type FieldGroupFieldBindings = { [TFieldName in keyof TFields]: FieldGroupFieldBindingForSlot }; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L117) + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) + +### TFormData + +`TFormData` = `any` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md new file mode 100644 index 000000000..750fcebe6 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldBindingsOf.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldBindingsOf +title: FieldGroupFieldBindingsOf +--- + +# Type Alias: FieldGroupFieldBindingsOf\ + +```ts +type FieldGroupFieldBindingsOf = FieldGroupFieldsOf extends FieldGroupFields ? FieldGroupFieldBindings, TFormData> : never; +``` + +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 + +### TFieldGroup + +`TFieldGroup` + +### TFormData + +`TFormData` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md new file mode 100644 index 000000000..923139b8c --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponent.md @@ -0,0 +1,40 @@ +--- +id: FieldGroupFieldComponent +title: FieldGroupFieldComponent +--- + +# Type Alias: FieldGroupFieldComponent\ + +```ts +type FieldGroupFieldComponent = (props) => VueComponentInstance, FieldValidators>, ValidationIssue, unknown, FormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError>, ValidationIssue, FormErrorTypes>, unknown, FormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFieldData + +`TFieldData` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `unknown`, `FormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>, `ToFieldError`\<`FieldValidators`\<`TFieldData`, `TFieldName`, `DeepValue`\<`TFieldData`, `TFieldName`\>\>, `ValidationIssue`, `FormErrorTypes`\>, `unknown`, `FormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md new file mode 100644 index 000000000..1d8d7ea46 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldComponentsOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldComponentsOf +title: FieldGroupFieldComponentsOf +--- + +# Type Alias: FieldGroupFieldComponentsOf\ + +```ts +type FieldGroupFieldComponentsOf = TFieldGroup extends FieldGroupDefinition ? TFieldComponents : never; +``` + +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 + +### TFieldGroup + +`TFieldGroup` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md new file mode 100644 index 000000000..3660f2470 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldData.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldData +title: FieldGroupFieldData +--- + +# Type Alias: FieldGroupFieldData\ + +```ts +type FieldGroupFieldData = { [TFieldName in keyof TFields]: TFields[TFieldName] extends FieldGroupFieldSlot ? TValue : never }; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:79](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L79) + +## Type Parameters + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md new file mode 100644 index 000000000..42658ac3d --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNameForSlot.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldNameForSlot +title: FieldGroupFieldNameForSlot +--- + +# Type Alias: FieldGroupFieldNameForSlot\ + +```ts +type FieldGroupFieldNameForSlot = { [TFieldName in DeepKeys]: FieldGroupFieldSlotAllows> extends true ? TFieldName : never }[DeepKeys]; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:57](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L57) + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TSlot + +`TSlot` *extends* [`AnyFieldGroupFieldSlot`](AnyFieldGroupFieldSlot.md) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md new file mode 100644 index 000000000..d63e7844e --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldNames.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldNames +title: FieldGroupFieldNames +--- + +# Type Alias: FieldGroupFieldNames\ + +```ts +type FieldGroupFieldNames = { [TFieldName in keyof TFields]: FieldGroupFieldNameForSlot }; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:70](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L70) + +## Type Parameters + +### TFieldData + +`TFieldData` + +### TFields + +`TFields` *extends* [`FieldGroupFields`](FieldGroupFields.md) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md new file mode 100644 index 000000000..a6f2e588e --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotAllows.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldSlotAllows +title: FieldGroupFieldSlotAllows +--- + +# Type Alias: FieldGroupFieldSlotAllows\ + +```ts +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:48](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L48) + +## Type Parameters + +### TSlot + +`TSlot` + +### TValue + +`TValue` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md new file mode 100644 index 000000000..f2106d5b5 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotMode.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFieldSlotMode +title: FieldGroupFieldSlotMode +--- + +# Type Alias: FieldGroupFieldSlotMode + +```ts +type FieldGroupFieldSlotMode = "strict" | "loose"; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:20](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L20) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md new file mode 100644 index 000000000..147f1dc50 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotModeOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldSlotModeOf +title: FieldGroupFieldSlotModeOf +--- + +# Type Alias: FieldGroupFieldSlotModeOf\ + +```ts +type FieldGroupFieldSlotModeOf = TSlot extends FieldGroupFieldSlot ? TMode : never; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L39) + +## Type Parameters + +### TSlot + +`TSlot` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md new file mode 100644 index 000000000..58f3e7dba --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldSlotValue.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldSlotValue +title: FieldGroupFieldSlotValue +--- + +# Type Alias: FieldGroupFieldSlotValue\ + +```ts +type FieldGroupFieldSlotValue = TSlot extends FieldGroupFieldSlot ? TValue : never; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L37) + +## Type Parameters + +### TSlot + +`TSlot` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFields.md b/docs/framework/vue/reference/type-aliases/FieldGroupFields.md new file mode 100644 index 000000000..2e3b8bb4f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFields.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFields +title: FieldGroupFields +--- + +# Type Alias: FieldGroupFields + +```ts +type FieldGroupFields = Record; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L69) diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md new file mode 100644 index 000000000..df192115e --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsOf.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupFieldsOf +title: FieldGroupFieldsOf +--- + +# Type Alias: FieldGroupFieldsOf\ + +```ts +type FieldGroupFieldsOf = TFieldGroup extends object ? TFields : never; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:86](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L86) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md new file mode 100644 index 000000000..0a021d98f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFieldsPropName.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupFieldsPropName +title: FieldGroupFieldsPropName +--- + +# Type Alias: FieldGroupFieldsPropName\ + +```ts +type FieldGroupFieldsPropName = { [TPropName in keyof TProps]-?: IsSame extends true ? TPropName : never }[keyof TProps]; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:130](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L130) + +## Type Parameters + +### TProps + +`TProps` + +### TFieldGroup + +`TFieldGroup` *extends* [`FieldGroupDefinition`](FieldGroupDefinition.md)\<`any`, `any`\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupForm.md b/docs/framework/vue/reference/type-aliases/FieldGroupForm.md new file mode 100644 index 000000000..4c868f99f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupForm.md @@ -0,0 +1,22 @@ +--- +id: FieldGroupForm +title: FieldGroupForm +--- + +# Type Alias: FieldGroupForm\ + +```ts +type FieldGroupForm = FormApi & VueTanStackFormComponents; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:102](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L102) + +## Type Parameters + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> = `Record`\<`never`, `never`\> + +### TFormData + +`TFormData` = `any` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md b/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md new file mode 100644 index 000000000..524a3e8b1 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupFormState.md @@ -0,0 +1,12 @@ +--- +id: FieldGroupFormState +title: FieldGroupFormState +--- + +# Type Alias: FieldGroupFormState + +```ts +type FieldGroupFormState = FormState; +``` + +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 new file mode 100644 index 000000000..ffb673f0f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeComponent.md @@ -0,0 +1,26 @@ +--- +id: FieldGroupSubscribeComponent +title: FieldGroupSubscribeComponent +--- + +# Type Alias: FieldGroupSubscribeComponent + +```ts +type FieldGroupSubscribeComponent = (props) => VueComponentInstance, { + default: NoInfer; +}>; +``` + +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 + +### props + +[`FieldGroupSubscribeProps`](FieldGroupSubscribeProps.md)\<`TSelected`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`FieldGroupSubscribeProps`](FieldGroupSubscribeProps.md)\<`TSelected`\>, \{ + `default`: `NoInfer`\<`TSelected`\>; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md new file mode 100644 index 000000000..b5fe8552f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupSubscribeProps.md @@ -0,0 +1,18 @@ +--- +id: FieldGroupSubscribeProps +title: FieldGroupSubscribeProps +--- + +# Type Alias: FieldGroupSubscribeProps\ + +```ts +type FieldGroupSubscribeProps = VueFormSubscribeProps; +``` + +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 + +### TSelected + +`TSelected` diff --git a/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md b/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md new file mode 100644 index 000000000..fef45a15f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/FieldGroupWithFieldsFn.md @@ -0,0 +1,46 @@ +--- +id: FieldGroupWithFieldsFn +title: FieldGroupWithFieldsFn +--- + +# Type Alias: FieldGroupWithFieldsFn + +```ts +type FieldGroupWithFieldsFn = (fields, component, fieldsPropName) => (props) => VueComponentInstance & object & { [TPropName in TFieldsPropName]: FieldGroupFieldBindingsOf } & Record, { +}>; +``` + +Defined in: [packages/vue-form/src/FieldGroup/withFields.public.ts:142](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/FieldGroup/withFields.public.ts#L142) + +## Type Parameters + +### TFieldGroup + +`TFieldGroup` *extends* [`FieldGroupDefinition`](FieldGroupDefinition.md)\<`any`, `any`\> + +### TProps + +`TProps` *extends* `object` + +### TFieldsPropName + +`TFieldsPropName` *extends* `PropertyKey` + +## Parameters + +### fields + +`TFieldGroup` + +### component + +`Component` & (`props`) => `any` + +### fieldsPropName + +`TFieldsPropName` & keyof `TProps` + +## Returns + +\<`TFormData`\>(`props`) => `VueComponentInstance`\<`Omit`\<`TProps`, `TFieldsPropName` \| `"form"`\> & `object` & `{ [TPropName in TFieldsPropName]: FieldGroupFieldBindingsOf }` & `Record`\<`string`, `any`\>, \{ +\}\> diff --git a/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md b/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md new file mode 100644 index 000000000..56ad6cb26 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/LooseFieldGroupFieldSlot.md @@ -0,0 +1,18 @@ +--- +id: LooseFieldGroupFieldSlot +title: LooseFieldGroupFieldSlot +--- + +# Type Alias: LooseFieldGroupFieldSlot\ + +```ts +type LooseFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +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 + +### TValue + +`TValue` diff --git a/docs/framework/vue/reference/type-aliases/Observer.md b/docs/framework/vue/reference/type-aliases/Observer.md new file mode 100644 index 000000000..41f87adf3 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/Observer.md @@ -0,0 +1,72 @@ +--- +id: Observer +title: Observer +--- + +# Type Alias: Observer\ + +```ts +type Observer = object; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:8 + +## Type Parameters + +### T + +`T` + +## Properties + +### complete? + +```ts +optional complete?: () => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:11 + +#### Returns + +`void` + +*** + +### error? + +```ts +optional error?: (err) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:10 + +#### Parameters + +##### err + +`unknown` + +#### Returns + +`void` + +*** + +### next? + +```ts +optional next?: (value) => void; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:9 + +#### Parameters + +##### value + +`T` + +#### Returns + +`void` diff --git a/docs/framework/vue/reference/type-aliases/Selection.md b/docs/framework/vue/reference/type-aliases/Selection.md new file mode 100644 index 000000000..937a64ffd --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/Selection.md @@ -0,0 +1,18 @@ +--- +id: Selection +title: Selection +--- + +# Type Alias: Selection\ + +```ts +type Selection = Readable; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/types.d.ts:4 + +## Type Parameters + +### TSelected + +`TSelected` diff --git a/docs/framework/vue/reference/type-aliases/StoreAction.md b/docs/framework/vue/reference/type-aliases/StoreAction.md new file mode 100644 index 000000000..19d70469a --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/StoreAction.md @@ -0,0 +1,22 @@ +--- +id: StoreAction +title: StoreAction +--- + +# Type Alias: StoreAction + +```ts +type StoreAction = (...args) => any; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:4 + +## Parameters + +### args + +...`any`[] + +## Returns + +`any` diff --git a/docs/framework/vue/reference/type-aliases/StoreActionMap.md b/docs/framework/vue/reference/type-aliases/StoreActionMap.md new file mode 100644 index 000000000..8876e2fc7 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/StoreActionMap.md @@ -0,0 +1,12 @@ +--- +id: StoreActionMap +title: StoreActionMap +--- + +# Type Alias: StoreActionMap + +```ts +type StoreActionMap = Record; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:5 diff --git a/docs/framework/vue/reference/type-aliases/StoreActionsFactory.md b/docs/framework/vue/reference/type-aliases/StoreActionsFactory.md new file mode 100644 index 000000000..ce8687604 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/StoreActionsFactory.md @@ -0,0 +1,38 @@ +--- +id: StoreActionsFactory +title: StoreActionsFactory +--- + +# Type Alias: StoreActionsFactory\ + +```ts +type StoreActionsFactory = (store) => TActions; +``` + +Defined in: node\_modules/.pnpm/@tanstack+store@0.11.1/node\_modules/@tanstack/store/dist/store.d.ts:6 + +## Type Parameters + +### T + +`T` + +### TActions + +`TActions` *extends* [`StoreActionMap`](StoreActionMap.md) + +## Parameters + +### store + +#### get + +[`Store`](../classes/Store.md)\<`T`\>\[`"get"`\] + +#### setState + +[`Store`](../classes/Store.md)\<`T`\>\[`"setState"`\] + +## Returns + +`TActions` diff --git a/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md b/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md new file mode 100644 index 000000000..51f55bcff --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/StrictFieldGroupFieldSlot.md @@ -0,0 +1,18 @@ +--- +id: StrictFieldGroupFieldSlot +title: StrictFieldGroupFieldSlot +--- + +# Type Alias: StrictFieldGroupFieldSlot\ + +```ts +type StrictFieldGroupFieldSlot = FieldGroupFieldSlot; +``` + +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 + +### TValue + +`TValue` diff --git a/docs/framework/vue/reference/type-aliases/SubscribeComponent.md b/docs/framework/vue/reference/type-aliases/SubscribeComponent.md new file mode 100644 index 000000000..61d746eed --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/SubscribeComponent.md @@ -0,0 +1,26 @@ +--- +id: SubscribeComponent +title: SubscribeComponent +--- + +# Type Alias: SubscribeComponent + +```ts +type SubscribeComponent = (props) => InstanceType, { + default: NoInfer; +}>>; +``` + +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 + +### props + +[`SubscribeProps`](../interfaces/SubscribeProps.md)\<`TSourceData`, `TSelected`\> + +## Returns + +`InstanceType`\<`VueComponentWithSlots`\<[`SubscribeProps`](../interfaces/SubscribeProps.md)\<`TSourceData`, `TSelected`\>, \{ + `default`: `NoInfer`\<`TSelected`\>; +\}\>\> diff --git a/docs/framework/vue/reference/type-aliases/SubscribeSource.md b/docs/framework/vue/reference/type-aliases/SubscribeSource.md new file mode 100644 index 000000000..219d82681 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/SubscribeSource.md @@ -0,0 +1,22 @@ +--- +id: SubscribeSource +title: SubscribeSource +--- + +# Type Alias: SubscribeSource\ + +```ts +type SubscribeSource = + | Atom + | ReadonlyAtom + | Store +| ReadonlyStore; +``` + +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 + +### TValue + +`TValue` diff --git a/docs/framework/vue/reference/type-aliases/UseAppFormHook.md b/docs/framework/vue/reference/type-aliases/UseAppFormHook.md new file mode 100644 index 000000000..32ac4b7e3 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/UseAppFormHook.md @@ -0,0 +1,42 @@ +--- +id: UseAppFormHook +title: UseAppFormHook +--- + +# Type Alias: UseAppFormHook\ + +```ts +type UseAppFormHook = (options) => VueAppFormApi, TComponents>; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md) + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`VueAppFormApi`](VueAppFormApi.md)\<`TFormData`, `ToFormErrorTypes`\<`TFormValidators`, `TSubmitReturn`\>, `TComponents`\> diff --git a/docs/framework/vue/reference/type-aliases/UseFormHook.md b/docs/framework/vue/reference/type-aliases/UseFormHook.md new file mode 100644 index 000000000..7163e06a9 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/UseFormHook.md @@ -0,0 +1,42 @@ +--- +id: UseFormHook +title: UseFormHook +--- + +# Type Alias: UseFormHook\ + +```ts +type UseFormHook = (options) => VueFormApi, TComponents>; +``` + +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 + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md) + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormValidators + +`TFormValidators` *extends* `FormValidators`\<`TFormData`\> + +### TSubmitReturn + +`TSubmitReturn` + +## Parameters + +### options + +`FormOptions`\<`TFormData`, `TFormValidators`, `TSubmitReturn`\> + +## Returns + +[`VueFormApi`](VueFormApi.md)\<`TFormData`, `ToFormErrorTypes`\<`TFormValidators`, `TSubmitReturn`\>, `TComponents`\> diff --git a/docs/framework/vue/reference/type-aliases/VueAppFormApi.md b/docs/framework/vue/reference/type-aliases/VueAppFormApi.md new file mode 100644 index 000000000..a83f7749e --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueAppFormApi.md @@ -0,0 +1,34 @@ +--- +id: VueAppFormApi +title: VueAppFormApi +--- + +# Type Alias: VueAppFormApi\ + +```ts +type VueAppFormApi = VueFormApi & object; +``` + +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 + +### AppForm + +```ts +AppForm: AppFormComponent; +``` + +## Type Parameters + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md) diff --git a/docs/framework/vue/reference/type-aliases/VueFieldApi.md b/docs/framework/vue/reference/type-aliases/VueFieldApi.md new file mode 100644 index 000000000..f1c9660ca --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFieldApi.md @@ -0,0 +1,38 @@ +--- +id: VueFieldApi +title: VueFieldApi +--- + +# Type Alias: VueFieldApi\ + +```ts +type VueFieldApi = FieldApi & FieldComponentsMatchingType; +``` + +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 + +### TFieldName + +`TFieldName` + +### TFieldValue + +`TFieldValue` + +### TFieldError + +`TFieldError` + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormApi.md b/docs/framework/vue/reference/type-aliases/VueFormApi.md new file mode 100644 index 000000000..1ff55731c --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormApi.md @@ -0,0 +1,26 @@ +--- +id: VueFormApi +title: VueFormApi +--- + +# Type Alias: VueFormApi\ + +```ts +type VueFormApi = unknown extends TComponents["formComponents"] ? ExtendedFormApi : ExtendedFormApi & TComponents["formComponents"]; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TComponents + +`TComponents` *extends* [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md) = [`DefaultVueFormComponentMap`](DefaultVueFormComponentMap.md) diff --git a/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md new file mode 100644 index 000000000..ad0c3c412 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormArrayFieldComponent.md @@ -0,0 +1,44 @@ +--- +id: VueFormArrayFieldComponent +title: VueFormArrayFieldComponent +--- + +# Type Alias: VueFormArrayFieldComponent\ + +```ts +type VueFormArrayFieldComponent = (props) => VueComponentInstance, TFieldValidators, never, TFormData, TFormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError, never, TFormErrorTypes>, TFormData, TFormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `ToFieldError`\<`NoInfer`\<`TFieldValidators`\>, `never`, `TFormErrorTypes`\>, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md new file mode 100644 index 000000000..058beca7d --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormFieldComponent.md @@ -0,0 +1,44 @@ +--- +id: VueFormFieldComponent +title: VueFormFieldComponent +--- + +# Type Alias: VueFormFieldComponent\ + +```ts +type VueFormFieldComponent = (props) => VueComponentInstance, TFieldValidators, never, TFormData, TFormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError, never, TFormErrorTypes>, TFormData, TFormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TFormData`, `TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `TFieldValidators`, `never`, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TFormData`, `TFieldName`\>, `ToFieldError`\<`NoInfer`\<`TFieldValidators`\>, `never`, `TFormErrorTypes`\>, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md new file mode 100644 index 000000000..408cd8862 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupArrayFieldComponent.md @@ -0,0 +1,52 @@ +--- +id: VueFormGroupArrayFieldComponent +title: VueFormGroupArrayFieldComponent +--- + +# Type Alias: VueFormGroupArrayFieldComponent\ + +```ts +type VueFormGroupArrayFieldComponent = (props) => VueComponentInstance, TFieldValidators, TGroupErrorTypes["fieldError"], TFormData, TFormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError, TGroupErrorTypes["fieldError"], TFormErrorTypes>, TFormData, TFormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `ToFieldError`\<`NoInfer`\<`TFieldValidators`\>, `TGroupErrorTypes`\[`"fieldError"`\], `TFormErrorTypes`\>, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md new file mode 100644 index 000000000..87f045114 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupComponent.md @@ -0,0 +1,44 @@ +--- +id: VueFormGroupComponent +title: VueFormGroupComponent +--- + +# Type Alias: VueFormGroupComponent\ + +```ts +type VueFormGroupComponent = (props) => VueComponentInstance, { + default: { + group: VueFormGroupApi>, TFormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormGroupProps`](../interfaces/VueFormGroupProps.md)\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupValidators`, `TFormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormGroupProps`](../interfaces/VueFormGroupProps.md)\<`TFormData`, `TGroupName`, `TGroupValue`, `TGroupValidators`, `TFormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `group`: [`VueFormGroupApi`](../interfaces/VueFormGroupApi.md)\<`TFormData`, `TGroupName`, `TGroupValue`, `ToFormGroupErrorTypes`\<`NoInfer`\<`TGroupValidators`\>\>, `TFormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md new file mode 100644 index 000000000..b2b5e7084 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupFieldComponent.md @@ -0,0 +1,52 @@ +--- +id: VueFormGroupFieldComponent +title: VueFormGroupFieldComponent +--- + +# Type Alias: VueFormGroupFieldComponent\ + +```ts +type VueFormGroupFieldComponent = (props) => VueComponentInstance, TFieldValidators, TGroupErrorTypes["fieldError"], TFormData, TFormErrorTypes, TFieldComponents>, { + default: { + field: VueFieldApi, ToFieldError, TGroupErrorTypes["fieldError"], TFormErrorTypes>, TFormData, TFormErrorTypes, TFieldComponents>; + }; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TFieldComponents + +`TFieldComponents` *extends* `Record`\<`string`, `Component`\> + +## Parameters + +### props + +[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormFieldProps`](../interfaces/VueFormFieldProps.md)\<`TGroupValue`, `TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `TFieldValidators`, `TGroupErrorTypes`\[`"fieldError"`\], `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>, \{ + `default`: \{ + `field`: [`VueFieldApi`](VueFieldApi.md)\<`TFieldName`, `DeepValue`\<`TGroupValue`, `TFieldName`\>, `ToFieldError`\<`NoInfer`\<`TFieldValidators`\>, `TGroupErrorTypes`\[`"fieldError"`\], `TFormErrorTypes`\>, `TFormData`, `TFormErrorTypes`, `TFieldComponents`\>; + \}; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md new file mode 100644 index 000000000..f89c5488e --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeComponent.md @@ -0,0 +1,36 @@ +--- +id: VueFormGroupSubscribeComponent +title: VueFormGroupSubscribeComponent +--- + +# Type Alias: VueFormGroupSubscribeComponent\ + +```ts +type VueFormGroupSubscribeComponent = (props) => VueComponentInstance, { + default: NoInfer; +}>; +``` + +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 + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +## Parameters + +### props + +[`VueFormGroupSubscribeProps`](VueFormGroupSubscribeProps.md)\<`TGroupValue`, `TGroupErrorTypes`, `TSelected`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormGroupSubscribeProps`](VueFormGroupSubscribeProps.md)\<`TGroupValue`, `TGroupErrorTypes`, `TSelected`\>, \{ + `default`: `NoInfer`\<`TSelected`\>; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md new file mode 100644 index 000000000..de7ff73c1 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormGroupSubscribeProps.md @@ -0,0 +1,26 @@ +--- +id: VueFormGroupSubscribeProps +title: VueFormGroupSubscribeProps +--- + +# Type Alias: VueFormGroupSubscribeProps\ + +```ts +type VueFormGroupSubscribeProps = VueSubscribeProps, TSelected>; +``` + +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 + +### TGroupValue + +`TGroupValue` + +### TGroupErrorTypes + +`TGroupErrorTypes` *extends* `FormErrorTypes` + +### TSelected + +`TSelected` diff --git a/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md b/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md new file mode 100644 index 000000000..e8928640f --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormSubscribeComponent.md @@ -0,0 +1,36 @@ +--- +id: VueFormSubscribeComponent +title: VueFormSubscribeComponent +--- + +# Type Alias: VueFormSubscribeComponent\ + +```ts +type VueFormSubscribeComponent = (props) => VueComponentInstance, { + default: NoInfer; +}>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +## Parameters + +### props + +[`VueFormSubscribeProps`](VueFormSubscribeProps.md)\<`TFormData`, `TFormErrorTypes`, `TSelected`\> & `PublicProps` + +## Returns + +`VueComponentInstance`\<[`VueFormSubscribeProps`](VueFormSubscribeProps.md)\<`TFormData`, `TFormErrorTypes`, `TSelected`\>, \{ + `default`: `NoInfer`\<`TSelected`\>; +\}\> diff --git a/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md b/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md new file mode 100644 index 000000000..83e3a9445 --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormSubscribeProps.md @@ -0,0 +1,26 @@ +--- +id: VueFormSubscribeProps +title: VueFormSubscribeProps +--- + +# Type Alias: VueFormSubscribeProps\ + +```ts +type VueFormSubscribeProps = VueSubscribeProps, TSelected>; +``` + +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 + +### TFormData + +`TFormData` + +### TFormErrorTypes + +`TFormErrorTypes` *extends* `FormErrorTypes` + +### TSelected + +`TSelected` diff --git a/docs/framework/vue/reference/type-aliases/VueFormType.md b/docs/framework/vue/reference/type-aliases/VueFormType.md new file mode 100644 index 000000000..72724b83a --- /dev/null +++ b/docs/framework/vue/reference/type-aliases/VueFormType.md @@ -0,0 +1,20 @@ +--- +id: VueFormType +title: VueFormType +--- + +# Type Alias: VueFormType\ + +```ts +type VueFormType = TOptions extends AppFormOptions ? VueFormApi, TComponents> : TOptions extends FormOptions ? VueFormApi, DefaultVueFormComponentMap> : never; +``` + +Defined in: [packages/vue-form/src/VueForm/formType.public.ts:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/vue-form/src/VueForm/formType.public.ts#L21) + +## Type Parameters + +### TOptions + +`TOptions` *extends* + \| `AnyFormOptions` + \| [`AppFormOptions`](../interfaces/AppFormOptions.md)\<`any`, `any`, `any`, [`AnyVueFormComponentMap`](AnyVueFormComponentMap.md)\> diff --git a/docs/framework/vue/reference/variables/Subscribe.md b/docs/framework/vue/reference/variables/Subscribe.md new file mode 100644 index 000000000..cafc977b6 --- /dev/null +++ b/docs/framework/vue/reference/variables/Subscribe.md @@ -0,0 +1,12 @@ +--- +id: Subscribe +title: Subscribe +--- + +# Variable: Subscribe + +```ts +const Subscribe: SubscribeComponent; +``` + +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/useForm.md b/docs/framework/vue/reference/variables/useForm.md new file mode 100644 index 000000000..e9fa0e08b --- /dev/null +++ b/docs/framework/vue/reference/variables/useForm.md @@ -0,0 +1,12 @@ +--- +id: useForm +title: useForm +--- + +# Variable: useForm + +```ts +const useForm: UseFormHook; +``` + +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/framework/vue/reference/variables/useStore.md b/docs/framework/vue/reference/variables/useStore.md new file mode 100644 index 000000000..41a13e964 --- /dev/null +++ b/docs/framework/vue/reference/variables/useStore.md @@ -0,0 +1,58 @@ +--- +id: useStore +title: useStore +--- + +# ~~Variable: useStore~~ + +```ts +const useStore: (source, selector?, compare?) => Readonly>; +``` + +Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.2\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useStore.d.ts:14 + +Deprecated alias for [useSelector](../functions/useSelector.md). + +## Type Parameters + +### TSource + +`TSource` + +### TSelected + +`TSelected` = `NoInfer`\<`TSource`\> + +## Parameters + +### source + +#### get + +() => `TSource` + +#### subscribe + +(`listener`) => `object` + +### selector? + +(`snapshot`) => `TSelected` + +### compare? + +(`a`, `b`) => `boolean` + +## Returns + +`Readonly`\<`Ref`\<`TSelected`\>\> + +## Example + +```ts +const count = useStore(counterStore, (state) => state.count) +``` + +## Deprecated + +Use `useSelector` instead. diff --git a/docs/migrate-from-v1.md b/docs/migrate-from-v1.md index 61aa11439..067be260a 100644 --- a/docs/migrate-from-v1.md +++ b/docs/migrate-from-v1.md @@ -53,6 +53,17 @@ This page is a starting checklist for migrating React apps from v1 to v2. Composition relies on behavior introduced in Vue 3.6. - Update CommonJS integrations to consume ESM. The v2 packages do not publish a CommonJS build and require Node.js 18 or newer. +- Upgrade React to version 18 or newer. The v2 React adapter no longer supports + React 17. +- Update CommonJS integrations to consume ESM. The v2 packages do not publish + a CommonJS build and require Node.js 18 or newer. + +## React version + +The v2 React adapter supports React 18 and 19. React 17 is no longer supported, +so upgrade `react`, `react-dom`, and their corresponding type packages before +migrating. If you imported `CrossVersionReactNode` from `@tanstack/react-form`, +import `ReactNode` from `react` instead. ## Vue version diff --git a/docs/reference/functions/createErrorMap.md b/docs/reference/functions/createErrorMap.md index 1c83d9180..b78cd83cb 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 9e1e8c09d..435beec43 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 63046b678..72f2dcde7 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 f6370f6cf..39a7b5548 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 a9d830aec..bd9b35082 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/interfaces/BaseFieldMeta.md b/docs/reference/interfaces/BaseFieldMeta.md index b14c351b7..9b00168c1 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 da7a662f4..4118d3c85 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 dfe754efe..7018d5dbd 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 6343b05be..62766d13c 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 0c303b380..09b5bd6d1 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 83940408a..0aed95de6 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 39a7b816d..7154c73ca 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:100](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L100) +Defined in: [FieldApi/FieldApi.public.ts:100](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L100) ## Type Parameters @@ -37,7 +37,7 @@ Defined in: [FieldApi/FieldApi.public.ts:100](https://github.com/TanStack/form/b atom: ReadonlyAtom>; ``` -Defined in: [FieldApi/FieldApi.public.ts:174](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L174) +Defined in: [FieldApi/FieldApi.public.ts:174](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L174) *** @@ -47,7 +47,7 @@ Defined in: [FieldApi/FieldApi.public.ts:174](https://github.com/TanStack/form/b clearValues: FieldClearValuesFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:156](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L156) +Defined in: [FieldApi/FieldApi.public.ts:156](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L156) 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:180](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L180) +Defined in: [FieldApi/FieldApi.public.ts:180](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L180) *** @@ -76,7 +76,7 @@ Defined in: [FieldApi/FieldApi.public.ts:180](https://github.com/TanStack/form/b filterValues: FieldFilterValuesFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:172](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L172) +Defined in: [FieldApi/FieldApi.public.ts:172](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L172) 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:110](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L110) +Defined in: [FieldApi/FieldApi.public.ts:110](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L110) The form that owns this field. @@ -113,7 +113,7 @@ The form that owns this field. handleBlur: FieldVoidFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:184](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L184) +Defined in: [FieldApi/FieldApi.public.ts:184](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L184) *** @@ -123,7 +123,7 @@ Defined in: [FieldApi/FieldApi.public.ts:184](https://github.com/TanStack/form/b handleChange: FieldHandleChangeFn; ``` -Defined in: [FieldApi/FieldApi.public.ts:182](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L182) +Defined in: [FieldApi/FieldApi.public.ts:182](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L182) *** @@ -133,7 +133,7 @@ Defined in: [FieldApi/FieldApi.public.ts:182](https://github.com/TanStack/form/b insertValue: FieldInsertValueFn; ``` -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) 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:178](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L178) +Defined in: [FieldApi/FieldApi.public.ts:178](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L178) *** @@ -174,7 +174,7 @@ Defined in: [FieldApi/FieldApi.public.ts:178](https://github.com/TanStack/form/b moveValue: FieldMoveValueFn; ``` -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) 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: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) 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:164](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L164) +Defined in: [FieldApi/FieldApi.public.ts:164](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L164) 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:186](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L186) +Defined in: [FieldApi/FieldApi.public.ts:186](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L186) *** @@ -265,7 +265,7 @@ Defined in: [FieldApi/FieldApi.public.ts:186](https://github.com/TanStack/form/b swapValues: (indexA, indexB) => void; ``` -Defined in: [FieldApi/FieldApi.public.ts:123](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L123) +Defined in: [FieldApi/FieldApi.public.ts:123](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L123) 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:176](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L176) +Defined in: [FieldApi/FieldApi.public.ts:176](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L176) ## Accessors @@ -308,7 +308,7 @@ Defined in: [FieldApi/FieldApi.public.ts:176](https://github.com/TanStack/form/b get name(): TFieldName; ``` -Defined in: [FieldApi/FieldApi.public.ts:115](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L115) +Defined in: [FieldApi/FieldApi.public.ts:115](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L115) The name of the field. diff --git a/docs/reference/interfaces/FieldApiOptions.md b/docs/reference/interfaces/FieldApiOptions.md index 8530a4cc8..a4d512aea 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: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) ## Type Parameters @@ -45,7 +45,7 @@ Defined in: [FieldApi/FieldApi.public.ts:189](https://github.com/TanStack/form/b optional errorBoundary?: boolean; ``` -Defined in: [FieldApi/FieldApi.public.ts:207](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L207) +Defined in: [FieldApi/FieldApi.public.ts:207](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L207) 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: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) *** @@ -70,7 +70,7 @@ optional listeners?: FieldListeners, TFormData, TFormErrorTypes>; ``` -Defined in: [FieldApi/FieldApi.public.ts:209](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L209) +Defined in: [FieldApi/FieldApi.public.ts:209](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L209) *** @@ -80,7 +80,7 @@ Defined in: [FieldApi/FieldApi.public.ts:209](https://github.com/TanStack/form/b name: TFieldName; ``` -Defined in: [FieldApi/FieldApi.public.ts:202](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L202) +Defined in: [FieldApi/FieldApi.public.ts:202](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L202) *** @@ -90,4 +90,4 @@ Defined in: [FieldApi/FieldApi.public.ts:202](https://github.com/TanStack/form/b optional validators?: TFieldValidators; ``` -Defined in: [FieldApi/FieldApi.public.ts:208](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L208) +Defined in: [FieldApi/FieldApi.public.ts:208](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L208) diff --git a/docs/reference/interfaces/FieldListener.md b/docs/reference/interfaces/FieldListener.md index 4eb04a347..86932d928 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:117](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L117) +Defined in: [listeners.public.ts:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L117) ## Extends @@ -45,7 +45,7 @@ Defined in: [listeners.public.ts:117](https://github.com/TanStack/form/blob/main run: FieldListenerFn; ``` -Defined in: [listeners.public.ts:125](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L125) +Defined in: [listeners.public.ts:125](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L125) *** @@ -57,7 +57,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:49](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L49) +Defined in: [listeners.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L49) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -80,7 +80,7 @@ Does not affect submit events, which always execute immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L50) +Defined in: [listeners.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L50) #### Inherited from @@ -94,4 +94,4 @@ Defined in: [listeners.public.ts:50](https://github.com/TanStack/form/blob/main/ optional watchFields?: DeepKeys[]; ``` -Defined in: [listeners.public.ts:132](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L132) +Defined in: [listeners.public.ts:132](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L132) diff --git a/docs/reference/interfaces/FieldListenerContext.md b/docs/reference/interfaces/FieldListenerContext.md index 56c30c1e2..9614b2b0f 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:81](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L81) +Defined in: [listeners.public.ts:81](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L81) ## Type Parameters @@ -37,7 +37,7 @@ Defined in: [listeners.public.ts:81](https://github.com/TanStack/form/blob/main/ fieldApi: FieldApi; ``` -Defined in: [listeners.public.ts:89](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L89) +Defined in: [listeners.public.ts:89](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L89) *** @@ -47,7 +47,7 @@ Defined in: [listeners.public.ts:89](https://github.com/TanStack/form/blob/main/ formApi: FormApi; ``` -Defined in: [listeners.public.ts:96](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L96) +Defined in: [listeners.public.ts:96](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L96) *** @@ -57,4 +57,4 @@ Defined in: [listeners.public.ts:96](https://github.com/TanStack/form/blob/main/ value: TFieldValue; ``` -Defined in: [listeners.public.ts:88](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L88) +Defined in: [listeners.public.ts:88](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L88) diff --git a/docs/reference/interfaces/FieldMeta.md b/docs/reference/interfaces/FieldMeta.md index e47d17908..117a095f5 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 720902da3..785e434ef 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 6ecf93d1d..a98852dec 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 fc852fcb1..21efc04a3 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 498fceb38..3a1a458ab 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 ae1e830f7..a47fded2f 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 cbae0b036..dff4c4de1 100644 --- a/docs/reference/interfaces/FormApi.md +++ b/docs/reference/interfaces/FormApi.md @@ -5,7 +5,7 @@ title: FormApi # Interface: FormApi\ -Defined in: [FormApi/FormApi.public.ts:304](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L304) +Defined in: [FormApi/FormApi.public.ts:304](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L304) ## Extends @@ -29,7 +29,7 @@ Defined in: [FormApi/FormApi.public.ts:304](https://github.com/TanStack/form/blo atom: ReadonlyAtom>; ``` -Defined in: [FormApi/FormApi.public.ts:309](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L309) +Defined in: [FormApi/FormApi.public.ts:309](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L309) *** @@ -39,7 +39,7 @@ Defined in: [FormApi/FormApi.public.ts:309](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:134](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L134) Clear all values from an array field. If the field is not an array, this method will be ignored. @@ -62,7 +62,7 @@ The name of the array field readonly defaultValues: TFormData; ``` -Defined in: [FormApi/FormApi.public.ts:312](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L312) +Defined in: [FormApi/FormApi.public.ts:312](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L312) The current baseline values used by `reset()` and `isDefaultValue`. @@ -74,7 +74,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:152](https://github.com/LeCarbonator/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. @@ -109,7 +109,7 @@ Optional update options including a custom `thisArg` for the predicate readonly formId: string; ``` -Defined in: [FormApi/FormApi.public.ts:313](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L313) +Defined in: [FormApi/FormApi.public.ts:313](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L313) *** @@ -119,7 +119,7 @@ Defined in: [FormApi/FormApi.public.ts:313](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:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L37) TODO @@ -141,7 +141,7 @@ TODO handleSubmit: () => Promise[]>; ``` -Defined in: [FormApi/FormApi.public.ts:330](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L330) +Defined in: [FormApi/FormApi.public.ts:330](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L330) TODO for later: submit meta @@ -157,7 +157,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:127](https://github.com/LeCarbonator/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. @@ -198,7 +198,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:108](https://github.com/LeCarbonator/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. @@ -239,7 +239,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:117](https://github.com/LeCarbonator/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. @@ -274,7 +274,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:143](https://github.com/LeCarbonator/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. @@ -309,7 +309,7 @@ Optional update options reset: (values?, opts?) => void; ``` -Defined in: [FormApi/FormApi.public.ts:342](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L342) +Defined in: [FormApi/FormApi.public.ts:342](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L342) Reset form values, metadata, validation state, and mounted fields. @@ -343,7 +343,7 @@ while preserving the previous `defaultValues` baseline. 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:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L39) #### Inherited from @@ -357,7 +357,7 @@ 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:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L30) TODO @@ -381,7 +381,7 @@ TODO readonly state: FormState; ``` -Defined in: [FormApi/FormApi.public.ts:310](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L310) +Defined in: [FormApi/FormApi.public.ts:310](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L310) *** @@ -391,7 +391,7 @@ Defined in: [FormApi/FormApi.public.ts:310](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:98](https://github.com/LeCarbonator/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. @@ -426,7 +426,7 @@ The index of the second value to swap validate: (signal) => Promise[]>; ``` -Defined in: [FormApi/FormApi.public.ts:322](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L322) +Defined in: [FormApi/FormApi.public.ts:322](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L322) TODO expand on it diff --git a/docs/reference/interfaces/FormApiArrayMethods.md b/docs/reference/interfaces/FormApiArrayMethods.md index ca0796c23..1167904a1 100644 --- a/docs/reference/interfaces/FormApiArrayMethods.md +++ b/docs/reference/interfaces/FormApiArrayMethods.md @@ -5,7 +5,7 @@ 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:90](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L90) ## Extended by @@ -25,7 +25,7 @@ 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:134](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L134) Clear all values from an array field. If the field is not an array, this method will be ignored. @@ -44,7 +44,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:152](https://github.com/LeCarbonator/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. @@ -75,7 +75,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:127](https://github.com/LeCarbonator/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. @@ -112,7 +112,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:108](https://github.com/LeCarbonator/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. @@ -149,7 +149,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:117](https://github.com/LeCarbonator/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. @@ -180,7 +180,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:143](https://github.com/LeCarbonator/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. @@ -211,7 +211,7 @@ 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) +Defined in: [FormApi/FormApiArrayMethods.types.public.ts:98](https://github.com/LeCarbonator/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. diff --git a/docs/reference/interfaces/FormApiFieldMethods.md b/docs/reference/interfaces/FormApiFieldMethods.md index 1a90bde38..5323e2144 100644 --- a/docs/reference/interfaces/FormApiFieldMethods.md +++ b/docs/reference/interfaces/FormApiFieldMethods.md @@ -5,7 +5,7 @@ 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:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L24) ## Extended by @@ -25,7 +25,7 @@ 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:37](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L37) TODO @@ -43,7 +43,7 @@ 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:39](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L39) *** @@ -53,7 +53,7 @@ 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:30](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L30) TODO diff --git a/docs/reference/interfaces/FormErrorTypes.md b/docs/reference/interfaces/FormErrorTypes.md index 04e575f45..0a8695e98 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 5e9afb136..80bd83da6 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 e7ca062eb..c82baafdf 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 ad4e7478b..9b619dc3d 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 f96c1e202..0aad72a86 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 ccb56cdf0..6f3a333bc 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 62e9cc384..fe90fd5f2 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 b22db5256..85b478aa2 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 44bab4b26..38341a122 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 f55a34b73..ed50a0dde 100644 --- a/docs/reference/interfaces/FormListener.md +++ b/docs/reference/interfaces/FormListener.md @@ -5,7 +5,7 @@ title: FormListener # Interface: FormListener\ -Defined in: [listeners.public.ts:69](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L69) +Defined in: [listeners.public.ts:69](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L69) ## Extends @@ -29,7 +29,7 @@ Defined in: [listeners.public.ts:69](https://github.com/TanStack/form/blob/main/ run: FormListenerFn; ``` -Defined in: [listeners.public.ts:73](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L73) +Defined in: [listeners.public.ts:73](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L73) *** @@ -41,7 +41,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:49](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L49) +Defined in: [listeners.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L49) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -64,7 +64,7 @@ Does not affect submit events, which always execute immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L50) +Defined in: [listeners.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L50) #### Inherited from diff --git a/docs/reference/interfaces/FormListenerContext.md b/docs/reference/interfaces/FormListenerContext.md index cf33b87a1..4ae71b828 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:53](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L53) +Defined in: [listeners.public.ts:53](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L53) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [listeners.public.ts:53](https://github.com/TanStack/form/blob/main/ formApi: FormApi; ``` -Defined in: [listeners.public.ts:58](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L58) +Defined in: [listeners.public.ts:58](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L58) *** @@ -35,7 +35,7 @@ Defined in: [listeners.public.ts:58](https://github.com/TanStack/form/blob/main/ optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [listeners.public.ts:57](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L57) +Defined in: [listeners.public.ts:57](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L57) *** @@ -45,4 +45,4 @@ Defined in: [listeners.public.ts:57](https://github.com/TanStack/form/blob/main/ value: TFormData; ``` -Defined in: [listeners.public.ts:59](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L59) +Defined in: [listeners.public.ts:59](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L59) diff --git a/docs/reference/interfaces/FormOptions.md b/docs/reference/interfaces/FormOptions.md index f25ab6c39..9cbc330f5 100644 --- a/docs/reference/interfaces/FormOptions.md +++ b/docs/reference/interfaces/FormOptions.md @@ -5,7 +5,7 @@ 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:147](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L147) ## Type Parameters @@ -29,7 +29,7 @@ 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:153](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L153) *** @@ -39,7 +39,7 @@ 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:154](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L154) *** @@ -49,7 +49,7 @@ 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:152](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L152) *** @@ -59,7 +59,7 @@ 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:159](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L159) *** @@ -69,7 +69,7 @@ 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:183](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L183) Called after submission validation succeeds. @@ -105,7 +105,7 @@ 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:206](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L206) Called when validation fails, `onSubmit` returns an error, or validation or submission throws. The callback is awaited before submission finishes. @@ -143,7 +143,7 @@ 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:163](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L163) *** @@ -153,4 +153,4 @@ 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:158](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L158) diff --git a/docs/reference/interfaces/FormOptionsApi.md b/docs/reference/interfaces/FormOptionsApi.md index c8bb89835..9b34a5fb7 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 8d0ef98fb..fa8a472d3 100644 --- a/docs/reference/interfaces/FormResetOptions.md +++ b/docs/reference/interfaces/FormResetOptions.md @@ -5,7 +5,7 @@ title: FormResetOptions # Interface: FormResetOptions -Defined in: [FormApi/FormApi.public.ts:282](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L282) +Defined in: [FormApi/FormApi.public.ts:282](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L282) ## Properties @@ -15,7 +15,7 @@ Defined in: [FormApi/FormApi.public.ts:282](https://github.com/TanStack/form/blo optional updateDefaultValues?: boolean; ``` -Defined in: [FormApi/FormApi.public.ts:301](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L301) +Defined in: [FormApi/FormApi.public.ts:301](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L301) Whether `reset(values)` should also update the form's `defaultValues` baseline. diff --git a/docs/reference/interfaces/FormState.md b/docs/reference/interfaces/FormState.md index 47c59cac5..ec2f4cfea 100644 --- a/docs/reference/interfaces/FormState.md +++ b/docs/reference/interfaces/FormState.md @@ -5,7 +5,7 @@ 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:214](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L214) ## Type Parameters @@ -25,7 +25,7 @@ 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:258](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L258) Whether the form can currently be submitted. @@ -40,7 +40,7 @@ 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:243](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L243) Array of form-level validation errors. @@ -52,7 +52,7 @@ 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:239](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L239) Whether the current form values are deeply equal to the default values. @@ -64,7 +64,7 @@ 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:231](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L231) Whether the form has been dirtied. The opposite of `isPristine`. @@ -78,7 +78,7 @@ 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:251](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L251) Whether the form currently has form-level or field-level errors. @@ -90,7 +90,7 @@ 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:235](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L235) Whether the form has not yet been dirtied. The opposite of `isDirty`. @@ -102,7 +102,7 @@ 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:267](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L267) Whether the latest submission completed without validation or submit errors. @@ -114,7 +114,7 @@ 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:263](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L263) Whether the form is currently in the process of submitting. @@ -126,7 +126,7 @@ 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:225](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L225) Whether the form has been touched. @@ -138,7 +138,7 @@ 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:247](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L247) Whether the form currently has no form-level or field-level errors. @@ -150,7 +150,7 @@ 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:271](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L271) Whether the form or any field is currently validating. @@ -162,7 +162,7 @@ Whether the form 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:277](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L277) The number of times a submission has been attempted, regardless of its success. @@ -176,6 +176,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:221](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L221) The current values of the form. diff --git a/docs/reference/interfaces/FormSubmitContext.md b/docs/reference/interfaces/FormSubmitContext.md index 5a0bb98e7..212d4cd62 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:54](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L54) Context passed to `onSubmit` after submission validation succeeds. @@ -46,7 +46,7 @@ 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:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L99) Creates a validation error that can be returned from `onSubmit`. @@ -76,7 +76,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:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L62) The form API handling this submission. @@ -88,7 +88,7 @@ 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:117](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L117) Parses Standard Schema issues into an error returnable from `onSubmit`. @@ -115,7 +115,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:78](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L78) The submit outputs produced by the form's schema validators, ordered by validator index. @@ -140,6 +140,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:60](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L60) The form values for this submission. diff --git a/docs/reference/interfaces/FormSubmitInvalidContext.md b/docs/reference/interfaces/FormSubmitInvalidContext.md index a6441e798..dc9726ab0 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:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L135) Context passed to `onSubmitInvalid` when a submission fails. @@ -40,7 +40,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:142](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L142) The form API handling the failed submission. @@ -52,6 +52,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:140](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L140) The form values for the failed submission. diff --git a/docs/reference/interfaces/FormValidationPredicateContext.md b/docs/reference/interfaces/FormValidationPredicateContext.md index 6700062cd..ebcf70442 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 d53000752..060667070 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 eac1f4d2a..f39ec770c 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 fe40d57c3..a39634204 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:38](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L38) +Defined in: [listeners.public.ts:38](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L38) ## Extended by @@ -36,7 +36,7 @@ optional triggerDebounceMs?: | ListenerDebounceFn; ``` -Defined in: [listeners.public.ts:49](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L49) +Defined in: [listeners.public.ts:49](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L49) The debounce time in milliseconds for validation triggers (change, blur). Does not affect submit events, which always execute immediately. @@ -55,4 +55,4 @@ Does not affect submit events, which always execute immediately. triggers: ListenerTriggerOption[]; ``` -Defined in: [listeners.public.ts:50](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L50) +Defined in: [listeners.public.ts:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L50) diff --git a/docs/reference/interfaces/ListenerPredicateContext.md b/docs/reference/interfaces/ListenerPredicateContext.md index 537a41527..af123fcda 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:9](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L9) +Defined in: [listeners.public.ts:9](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L9) ## Type Parameters @@ -25,7 +25,7 @@ Defined in: [listeners.public.ts:9](https://github.com/TanStack/form/blob/main/p formApi: FormApi; ``` -Defined in: [listeners.public.ts:10](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L10) +Defined in: [listeners.public.ts:10](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L10) *** @@ -35,7 +35,7 @@ Defined in: [listeners.public.ts:10](https://github.com/TanStack/form/blob/main/ optional triggerFieldApi?: AnyFieldApi; ``` -Defined in: [listeners.public.ts:11](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L11) +Defined in: [listeners.public.ts:11](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L11) *** @@ -45,4 +45,4 @@ Defined in: [listeners.public.ts:11](https://github.com/TanStack/form/blob/main/ value: TValue; ``` -Defined in: [listeners.public.ts:12](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L12) +Defined in: [listeners.public.ts:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L12) diff --git a/docs/reference/interfaces/ListenerTriggerConfig.md b/docs/reference/interfaces/ListenerTriggerConfig.md index a1399bda9..f0478c594 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:19](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L19) +Defined in: [listeners.public.ts:19](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L19) ## Type Parameters @@ -29,7 +29,7 @@ Defined in: [listeners.public.ts:19](https://github.com/TanStack/form/blob/main/ trigger: TTriggers; ``` -Defined in: [listeners.public.ts:24](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L24) +Defined in: [listeners.public.ts:24](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L24) *** @@ -41,4 +41,4 @@ optional when?: | ListenerPredicateFn; ``` -Defined in: [listeners.public.ts:25](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L25) +Defined in: [listeners.public.ts:25](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L25) diff --git a/docs/reference/interfaces/OriginalFieldMeta.md b/docs/reference/interfaces/OriginalFieldMeta.md index c5e4aed85..9240971d1 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 ebe4e85a8..d2a1bdd25 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 c120e12f5..7477f51c2 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 73361efc0..7945fa56e 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 72393982c..22219977e 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 cac93b50c..02b6c2910 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 b910721f2..e467fd817 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 6051218f0..93abae03d 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 0388875de..947a5c8a8 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 339372787..f17c304f0 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 0b1f7b95e..dfbc24d06 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 1a3b54de1..3536969fb 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 0d29da91f..fb27b3a90 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 b2c5aa4cb..c2434fb5f 100644 --- a/docs/reference/type-aliases/AnyFieldApi.md +++ b/docs/reference/type-aliases/AnyFieldApi.md @@ -9,4 +9,4 @@ title: AnyFieldApi type AnyFieldApi = FieldApi; ``` -Defined in: [FieldApi/FieldApi.public.ts:57](https://github.com/TanStack/form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L57) +Defined in: [FieldApi/FieldApi.public.ts:57](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FieldApi/FieldApi.public.ts#L57) diff --git a/docs/reference/type-aliases/AnyFieldListener.md b/docs/reference/type-aliases/AnyFieldListener.md index 072aade84..9c41b6547 100644 --- a/docs/reference/type-aliases/AnyFieldListener.md +++ b/docs/reference/type-aliases/AnyFieldListener.md @@ -9,4 +9,4 @@ title: AnyFieldListener type AnyFieldListener = FieldListener; ``` -Defined in: [listeners.public.ts:115](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L115) +Defined in: [listeners.public.ts:115](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L115) diff --git a/docs/reference/type-aliases/AnyFieldMeta.md b/docs/reference/type-aliases/AnyFieldMeta.md index 8c423f6ff..495125b88 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 3d222ddcb..129ad4fb4 100644 --- a/docs/reference/type-aliases/AnyFormApi.md +++ b/docs/reference/type-aliases/AnyFormApi.md @@ -9,4 +9,4 @@ title: AnyFormApi type AnyFormApi = FormApi; ``` -Defined in: [FormApi/FormApi.public.ts:280](https://github.com/TanStack/form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L280) +Defined in: [FormApi/FormApi.public.ts:280](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L280) diff --git a/docs/reference/type-aliases/AnyFormListener.md b/docs/reference/type-aliases/AnyFormListener.md index be1eb17f0..a4943aa1c 100644 --- a/docs/reference/type-aliases/AnyFormListener.md +++ b/docs/reference/type-aliases/AnyFormListener.md @@ -9,4 +9,4 @@ title: AnyFormListener type AnyFormListener = FormListener; ``` -Defined in: [listeners.public.ts:67](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L67) +Defined in: [listeners.public.ts:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L67) diff --git a/docs/reference/type-aliases/AnyFormOptions.md b/docs/reference/type-aliases/AnyFormOptions.md index cf49fd97f..486f7b4ce 100644 --- a/docs/reference/type-aliases/AnyFormOptions.md +++ b/docs/reference/type-aliases/AnyFormOptions.md @@ -9,4 +9,4 @@ 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:145](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L145) diff --git a/docs/reference/type-aliases/ArrayFieldElement.md b/docs/reference/type-aliases/ArrayFieldElement.md index 018730dda..18e5fb6a6 100644 --- a/docs/reference/type-aliases/ArrayFieldElement.md +++ b/docs/reference/type-aliases/ArrayFieldElement.md @@ -9,7 +9,7 @@ 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:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L18) ## Type Parameters diff --git a/docs/reference/type-aliases/ArrayFieldName.md b/docs/reference/type-aliases/ArrayFieldName.md index a6bfa5546..28d05c482 100644 --- a/docs/reference/type-aliases/ArrayFieldName.md +++ b/docs/reference/type-aliases/ArrayFieldName.md @@ -9,7 +9,7 @@ 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:8](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L8) ## Type Parameters diff --git a/docs/reference/type-aliases/ArrayFieldPredicate.md b/docs/reference/type-aliases/ArrayFieldPredicate.md index 70f288c95..492e60e21 100644 --- a/docs/reference/type-aliases/ArrayFieldPredicate.md +++ b/docs/reference/type-aliases/ArrayFieldPredicate.md @@ -9,7 +9,7 @@ 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:23](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L23) ## Type Parameters diff --git a/docs/reference/type-aliases/ArrayFieldValue.md b/docs/reference/type-aliases/ArrayFieldValue.md index 9cfc81197..1fde91afc 100644 --- a/docs/reference/type-aliases/ArrayFieldValue.md +++ b/docs/reference/type-aliases/ArrayFieldValue.md @@ -9,7 +9,7 @@ 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:13](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L13) ## Type Parameters diff --git a/docs/reference/type-aliases/BuiltInType.md b/docs/reference/type-aliases/BuiltInType.md index c48a00541..d3c2b0ed6 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 81ae547b1..50bc94fbb 100644 --- a/docs/reference/type-aliases/ClearFieldValuesFn.md +++ b/docs/reference/type-aliases/ClearFieldValuesFn.md @@ -9,7 +9,7 @@ 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:67](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L67) ## Type Parameters diff --git a/docs/reference/type-aliases/ClientValidationTrigger.md b/docs/reference/type-aliases/ClientValidationTrigger.md index ace87ad31..54d64cd10 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 210d92f86..3368317fb 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 05afa069f..bc4206ceb 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 3355528b2..fd339b8f7 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 7d6cb7b54..ef8280f9e 100644 --- a/docs/reference/type-aliases/CreateValidationErrorFn.md +++ b/docs/reference/type-aliases/CreateValidationErrorFn.md @@ -9,7 +9,7 @@ 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:27](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L27) ## Type Parameters diff --git a/docs/reference/type-aliases/DeepKeys.md b/docs/reference/type-aliases/DeepKeys.md index c8fdf4030..6e34d6983 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 ee6a4e76a..d7c924395 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 908330a07..27e9c2746 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 ce1f5cf5c..232aa25a6 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 a9ab06cd5..9c68b3d4c 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 09557fceb..6793027c6 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 ed57c32ae..4e74ab449 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:99](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L99) +Defined in: [listeners.public.ts:99](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L99) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldListenerTriggers.md b/docs/reference/type-aliases/FieldListenerTriggers.md index bd3ad1f70..72a209ffa 100644 --- a/docs/reference/type-aliases/FieldListenerTriggers.md +++ b/docs/reference/type-aliases/FieldListenerTriggers.md @@ -9,4 +9,4 @@ title: FieldListenerTriggers type FieldListenerTriggers = FormListenerTriggers | "unmount"; ``` -Defined in: [listeners.public.ts:7](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L7) +Defined in: [listeners.public.ts:7](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L7) diff --git a/docs/reference/type-aliases/FieldListeners.md b/docs/reference/type-aliases/FieldListeners.md index b651eef48..4c77ca0cf 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:135](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L135) +Defined in: [listeners.public.ts:135](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L135) ## Type Parameters diff --git a/docs/reference/type-aliases/FieldValidateResult.md b/docs/reference/type-aliases/FieldValidateResult.md index 7ff54740c..53c7f2cf7 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 527203556..f41b5a8a5 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 692d17bac..8ed2421ef 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 9ae83eca1..7a37237d6 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:35](https://github.com/TanStack/form/blob/main/packages/form-core/src/types.public.ts#L35) +Defined in: [types.public.ts:35](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/types.public.ts#L35) ## Type Parameters diff --git a/docs/reference/type-aliases/FilterFieldValuesFn.md b/docs/reference/type-aliases/FilterFieldValuesFn.md index 5b394b583..127be02e7 100644 --- a/docs/reference/type-aliases/FilterFieldValuesFn.md +++ b/docs/reference/type-aliases/FilterFieldValuesFn.md @@ -9,7 +9,7 @@ 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:82](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L82) ## Type Parameters diff --git a/docs/reference/type-aliases/FormErrors.md b/docs/reference/type-aliases/FormErrors.md index 4a4a19c95..d09caccbf 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 1b6b065c8..18a6e3a53 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 17e5dabe5..60cd888f7 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 f7bce30a4..37e56ee80 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 bff3ba68b..f3151d38d 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 7a4987163..67b9881fe 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:62](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L62) +Defined in: [listeners.public.ts:62](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L62) ## Type Parameters diff --git a/docs/reference/type-aliases/FormListenerTriggers.md b/docs/reference/type-aliases/FormListenerTriggers.md index 970ec7288..804174e33 100644 --- a/docs/reference/type-aliases/FormListenerTriggers.md +++ b/docs/reference/type-aliases/FormListenerTriggers.md @@ -9,4 +9,4 @@ title: FormListenerTriggers type FormListenerTriggers = ValidationTrigger | "mount" | "reset"; ``` -Defined in: [listeners.public.ts:6](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L6) +Defined in: [listeners.public.ts:6](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L6) diff --git a/docs/reference/type-aliases/FormListeners.md b/docs/reference/type-aliases/FormListeners.md index 76a9e394d..0a1b7dae1 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:76](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L76) +Defined in: [listeners.public.ts:76](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L76) ## Type Parameters diff --git a/docs/reference/type-aliases/FormValidateResult.md b/docs/reference/type-aliases/FormValidateResult.md index 1a5474882..9398178f3 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 c63135838..639c84015 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 25d6da6c1..70f71b638 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 76e203638..27fb98bf4 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 19388aa84..a93eaaac8 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 d51dbdc25..ef0d38b77 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 a966b0f50..1bedb60d3 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 d4602565d..f7e1e40b4 100644 --- a/docs/reference/type-aliases/GetFieldValueFn.md +++ b/docs/reference/type-aliases/GetFieldValueFn.md @@ -9,7 +9,7 @@ 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:12](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L12) ## Type Parameters diff --git a/docs/reference/type-aliases/InferUnion.md b/docs/reference/type-aliases/InferUnion.md index 4aca82721..a1ed70294 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 1848eaa62..279ea803f 100644 --- a/docs/reference/type-aliases/InsertFieldValueFn.md +++ b/docs/reference/type-aliases/InsertFieldValueFn.md @@ -9,7 +9,7 @@ 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:58](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L58) ## Type Parameters diff --git a/docs/reference/type-aliases/ListenerDebounceFn.md b/docs/reference/type-aliases/ListenerDebounceFn.md index d2ce8a4fe..3538044b0 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:34](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L34) +Defined in: [listeners.public.ts:34](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L34) ## Type Parameters diff --git a/docs/reference/type-aliases/ListenerPredicateFn.md b/docs/reference/type-aliases/ListenerPredicateFn.md index 4181bc5c2..ac42706c1 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:15](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L15) +Defined in: [listeners.public.ts:15](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L15) ## Type Parameters diff --git a/docs/reference/type-aliases/ListenerTriggerOption.md b/docs/reference/type-aliases/ListenerTriggerOption.md index dbcecc2d2..31c990422 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:28](https://github.com/TanStack/form/blob/main/packages/form-core/src/listeners.public.ts#L28) +Defined in: [listeners.public.ts:28](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/listeners.public.ts#L28) ## Type Parameters diff --git a/docs/reference/type-aliases/MoveFieldValueFn.md b/docs/reference/type-aliases/MoveFieldValueFn.md index 9aecc8e96..a9ad4130a 100644 --- a/docs/reference/type-aliases/MoveFieldValueFn.md +++ b/docs/reference/type-aliases/MoveFieldValueFn.md @@ -9,7 +9,7 @@ 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:41](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L41) ## Type Parameters diff --git a/docs/reference/type-aliases/NullableSchemaData.md b/docs/reference/type-aliases/NullableSchemaData.md index ec09d1586..44ec8a964 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 bddbb57ad..4827de7d4 100644 --- a/docs/reference/type-aliases/OnSubmitError.md +++ b/docs/reference/type-aliases/OnSubmitError.md @@ -9,7 +9,7 @@ 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:21](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L21) ## Type Declaration diff --git a/docs/reference/type-aliases/OneOrMany.md b/docs/reference/type-aliases/OneOrMany.md index 319f8d489..fb4ba5328 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 078f8e1f1..976e0e713 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 fe59e1fe2..ba78744d0 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 cc6c4e07c..86cf411e1 100644 --- a/docs/reference/type-aliases/ParseSubmitIssuesFn.md +++ b/docs/reference/type-aliases/ParseSubmitIssuesFn.md @@ -9,7 +9,7 @@ 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:33](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApi.public.ts#L33) ## Type Parameters diff --git a/docs/reference/type-aliases/PushFieldValueFn.md b/docs/reference/type-aliases/PushFieldValueFn.md index 07d801c16..14dfa3470 100644 --- a/docs/reference/type-aliases/PushFieldValueFn.md +++ b/docs/reference/type-aliases/PushFieldValueFn.md @@ -9,7 +9,7 @@ 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:50](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L50) ## Type Parameters diff --git a/docs/reference/type-aliases/RemoveFieldValueFn.md b/docs/reference/type-aliases/RemoveFieldValueFn.md index c3bd012bf..84fad75e5 100644 --- a/docs/reference/type-aliases/RemoveFieldValueFn.md +++ b/docs/reference/type-aliases/RemoveFieldValueFn.md @@ -9,7 +9,7 @@ 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:74](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L74) ## Type Parameters diff --git a/docs/reference/type-aliases/ResetFieldFn.md b/docs/reference/type-aliases/ResetFieldFn.md index 21eba3b31..2612a5863 100644 --- a/docs/reference/type-aliases/ResetFieldFn.md +++ b/docs/reference/type-aliases/ResetFieldFn.md @@ -9,7 +9,7 @@ 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:18](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L18) ## Type Parameters diff --git a/docs/reference/type-aliases/ReusableErrorVisibility.md b/docs/reference/type-aliases/ReusableErrorVisibility.md index 8018cad2c..88596182c 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 67d63edd1..5548c8e3c 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 b32172ce4..82ce54317 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 1d13e2730..23cffa621 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 0d27dd54a..96ac33ad5 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 3a30805bf..b2b276684 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 f1581df89..5ebed2bae 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 935870a3a..d2ce6b819 100644 --- a/docs/reference/type-aliases/SetFieldValueFn.md +++ b/docs/reference/type-aliases/SetFieldValueFn.md @@ -9,7 +9,7 @@ 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:4](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiFieldMethods.types.public.ts#L4) ## Type Parameters diff --git a/docs/reference/type-aliases/StandardSchemaV1.md b/docs/reference/type-aliases/StandardSchemaV1.md index a97c6afe6..f148e4621 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 98dbfad92..7b282c32c 100644 --- a/docs/reference/type-aliases/SwapFieldValuesFn.md +++ b/docs/reference/type-aliases/SwapFieldValuesFn.md @@ -9,7 +9,7 @@ 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:32](https://github.com/LeCarbonator/tanstack-form/blob/main/packages/form-core/src/FormApi/FormApiArrayMethods.types.public.ts#L32) ## Type Parameters diff --git a/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md b/docs/reference/type-aliases/TStandardSchemaValidatorIssue.md index bf8f4a3fe..9109903a7 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 36f8c7795..21a8613b8 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 7f6ba599a..dfca6ead5 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 3701cc46d..5e14e67a4 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 473c20a74..eab90a366 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 0aed089c1..67a91c212 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 5f1997d26..8d416d1e7 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 ae95ead0e..d7cda9e54 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 b483a84fe..d7adbca1d 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 8eb182cc9..d30318c20 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 573ac2203..d732fa769 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 c28c7187c..fe4853c20 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 6cd1d6f06..937b1b62c 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 e42feefc1..c724749eb 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 4bdf7e4c2..88931207f 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 5a3e7c7cb..a5aa12a47 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 7c21d93bc..ae3fa3baa 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 2ece3cd6a..9202768b9 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 3186d6dfc..e8af68230 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 f81951514..e61c0b840 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 efa9b3111..b77288d72 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 de000e088..a12c13f49 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 95c838af9..a99eded83 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 e5d40c58b..1f58346ff 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 60f2ef7f8..31adcd01a 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 b4ddb9ccd..9b4243d75 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 5f3099ce2..e4c5cdeab 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/preact-form/tsconfig.docs.json b/packages/preact-form/tsconfig.docs.json index abd079eb4..0681ef468 100644 --- a/packages/preact-form/tsconfig.docs.json +++ b/packages/preact-form/tsconfig.docs.json @@ -1,4 +1,10 @@ { "extends": "./tsconfig.json", + "compilerOptions": { + "paths": { + "@tanstack/form-core": ["../form-core/src"], + "@tanstack/form-core/internals": ["../form-core/src/internals.ts"] + } + }, "exclude": ["tests", "eslint.config.js", "vitest.config.ts"] } diff --git a/packages/react-form/package.json b/packages/react-form/package.json index 85a10d09d..2cc5c3d16 100644 --- a/packages/react-form/package.json +++ b/packages/react-form/package.json @@ -57,6 +57,6 @@ "zod": "^4.4.3" }, "peerDependencies": { - "react": "^17.0.0 || ^18.0.0 || ^19.0.0" + "react": "^18.0.0 || ^19.0.0" } } diff --git a/packages/react-form/src/AppForm/Components.lib.tsx b/packages/react-form/src/AppForm/Components.lib.tsx index bb78fdcb1..85508f7c9 100644 --- a/packages/react-form/src/AppForm/Components.lib.tsx +++ b/packages/react-form/src/AppForm/Components.lib.tsx @@ -7,13 +7,12 @@ import { useValueFieldSubscription } from '../ReactForm/fieldSubscriptions.lib' import { Subscribe } from '../Subscribe.public' import { FieldContext, FormContext } from './contexts.lib' import type { AnyInternalFormApi } from '@tanstack/form-core/internals' -import type { FunctionComponent } from 'react' +import type { FunctionComponent, ReactNode } from 'react' import type { AppFormComponent, ReactAppFormApi, } from './ReactAppFormApi.public' import type { AnyReactFormComponentMap } from './componentMap.public' -import type { CrossVersionReactNode } from '../reactTypes.public' import type { ReactFormFieldProps, ReactFormGroupProps, @@ -45,7 +44,7 @@ export function attachReactAppFormComponents( function createAppForm(form: AnyInternalFormApi): AppFormComponent { const AppForm: FunctionComponent<{ - children: Exclude> + children: Exclude> }> = function AppFormComponent(props) { // eslint-disable-next-line @eslint-react/no-context-provider return diff --git a/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx b/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx index e9603a23e..be3a02185 100644 --- a/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx +++ b/packages/react-form/src/AppForm/ReactAppFormApi.public.tsx @@ -1,11 +1,10 @@ import type { FormErrorTypes } from '@tanstack/form-core' import type { ReactFormApi } from '../ReactForm/formApiTypes.public' -import type { FunctionComponent } from 'react' -import type { CrossVersionReactNode } from '../reactTypes.public' +import type { FunctionComponent, ReactNode } from 'react' import type { AnyReactFormComponentMap } from './componentMap.public' export type AppFormComponent = FunctionComponent<{ - children: Exclude> + children: Exclude> }> export type ReactAppFormApi< diff --git a/packages/react-form/src/AppForm/getFormHookHelpers.public.ts b/packages/react-form/src/AppForm/getFormHookHelpers.public.ts index 360cc226e..7a9c9f553 100644 --- a/packages/react-form/src/AppForm/getFormHookHelpers.public.ts +++ b/packages/react-form/src/AppForm/getFormHookHelpers.public.ts @@ -1,6 +1,6 @@ import { brandComponentFactory, wrapField } from './fieldComponentHelpers.lib' -import type { CrossVersionReactNode } from '../reactTypes.public' import type { FieldWithValue } from '@tanstack/form-core' +import type { ReactNode } from 'react' type ExactFieldBrand = { readonly __tanstackFieldExactType: TValue @@ -10,11 +10,9 @@ type AcceptsFieldBrand = { readonly __tanstackFieldAcceptsType: TAcceptedValue } -type AnyFieldComponent = (props: any) => CrossVersionReactNode +type AnyFieldComponent = (props: any) => ReactNode -type PropsOf = TComponent extends ( - props: infer TProps, -) => CrossVersionReactNode +type PropsOf = TComponent extends (props: infer TProps) => ReactNode ? TProps : never diff --git a/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts b/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts index 566bfbb65..6b2d6f0b2 100644 --- a/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts +++ b/packages/react-form/src/FieldGroup/FieldGroupApi.public.ts @@ -9,8 +9,7 @@ import type { FormState, ValidationIssue, } from '@tanstack/form-core' -import type { FunctionComponent } from 'react' -import type { CrossVersionReactNode } from '../reactTypes.public' +import type { FunctionComponent, ReactNode } from 'react' import type { ReactFormFieldProps, ReactFormSubscribeProps, @@ -36,7 +35,7 @@ export interface FieldGroupFieldComponent< FormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export interface FieldGroupArrayFieldComponent< @@ -58,7 +57,7 @@ export interface FieldGroupArrayFieldComponent< FormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export type FieldGroupSubscribeProps = ReactFormSubscribeProps< @@ -69,7 +68,7 @@ export type FieldGroupSubscribeProps = ReactFormSubscribeProps< export type FieldGroupSubscribeComponent = ( props: FieldGroupSubscribeProps, -) => CrossVersionReactNode +) => ReactNode export interface FieldGroupApi< in out TFieldData, diff --git a/packages/react-form/src/FieldGroup/withFields.public.ts b/packages/react-form/src/FieldGroup/withFields.public.ts index c8ba5c5b0..6dbd6d8e6 100644 --- a/packages/react-form/src/FieldGroup/withFields.public.ts +++ b/packages/react-form/src/FieldGroup/withFields.public.ts @@ -9,8 +9,7 @@ import type { DeepValue, FormApi, } from '@tanstack/form-core' -import type { FunctionComponent } from 'react' -import type { CrossVersionReactNode } from '../reactTypes.public' +import type { FunctionComponent, ReactNode } from 'react' import type { ReactTanStackFormComponents } from '../ReactForm/Components.public' import type { FieldGroupApi } from './FieldGroupApi.public' @@ -165,7 +164,7 @@ export type FieldGroupWithFieldsFn = < TFieldsPropName extends FieldGroupFieldsPropName, >( fields: TFieldGroup, - Component: (props: TProps) => CrossVersionReactNode, + Component: (props: TProps) => ReactNode, fieldsPropName: TFieldsPropName, ) => ( props: Omit & { @@ -176,7 +175,7 @@ export type FieldGroupWithFieldsFn = < TFormData > }, -) => CrossVersionReactNode +) => ReactNode export interface FieldGroupHelper { strict: () => StrictFieldGroupFieldSlot diff --git a/packages/react-form/src/ReactForm/Components.lib.tsx b/packages/react-form/src/ReactForm/Components.lib.tsx index 628c84e2c..98744a76e 100644 --- a/packages/react-form/src/ReactForm/Components.lib.tsx +++ b/packages/react-form/src/ReactForm/Components.lib.tsx @@ -8,7 +8,7 @@ import { import { useField } from './useField.lib' import type { AnyInternalFormApi } from '@tanstack/form-core/internals' import type { InternalReactFormApi } from './ReactFormApi.lib' -import type { FunctionComponent } from 'react' +import type { FunctionComponent, ReactNode } from 'react' import type { ReactFormFieldProps, ReactFormGroupProps, @@ -53,7 +53,10 @@ function createFieldComponent( return TanStackFormField } -type AnyArrayFieldComponent = FunctionComponent +type AnyArrayFieldComponent = { + (props: any): ReactNode + displayName?: string +} function createArrayFieldComponent( form: AnyInternalFormApi, @@ -71,9 +74,10 @@ function createArrayFieldComponent( return TanStackFormArrayField } -type AnySubscribeComponent = FunctionComponent< - ReactFormSubscribeProps -> +type AnySubscribeComponent = { + (props: ReactFormSubscribeProps): ReactNode + displayName?: string +} function createSubscribeComponent( form: AnyInternalFormApi, diff --git a/packages/react-form/src/ReactForm/Components.public.ts b/packages/react-form/src/ReactForm/Components.public.ts index d9c09adf3..d5599b188 100644 --- a/packages/react-form/src/ReactForm/Components.public.ts +++ b/packages/react-form/src/ReactForm/Components.public.ts @@ -14,11 +14,11 @@ import type { ToFieldError, ToFormGroupErrorTypes, } from '@tanstack/form-core' -import type { CrossVersionReactNode } from '../reactTypes.public' import type { FunctionComponent, LazyExoticComponent, MemoExoticComponent, + ReactNode, } from 'react' type ExactFieldBrand = { @@ -98,9 +98,7 @@ export type ReactFieldApi< interface ReactSubscribeProps { selector: (state: TSourceData) => TSelected when?: (selected: NoInfer) => boolean - children: - | ((state: NoInfer) => CrossVersionReactNode) - | CrossVersionReactNode + children: ((state: NoInfer) => ReactNode) | ReactNode } export type ReactFormSubscribeProps< @@ -114,7 +112,7 @@ export type ReactFormSubscribeComponent< in out TFormErrorTypes extends FormErrorTypes, > = ( props: ReactFormSubscribeProps, -) => CrossVersionReactNode +) => ReactNode export interface ReactFormFieldProps< in out TFieldData, @@ -151,7 +149,7 @@ export interface ReactFormFieldProps< TFormErrorTypes, TFieldComponents >, - ) => CrossVersionReactNode + ) => ReactNode } export type ReactFormFieldComponent< @@ -177,7 +175,7 @@ export type ReactFormFieldComponent< TFormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export type ReactFormArrayFieldComponent< @@ -203,7 +201,7 @@ export type ReactFormArrayFieldComponent< TFormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export type ReactFormGroupSubscribeProps< @@ -220,7 +218,7 @@ export type ReactFormGroupSubscribeComponent< in out TGroupErrorTypes extends FormErrorTypes, > = ( props: ReactFormGroupSubscribeProps, -) => CrossVersionReactNode +) => ReactNode export interface ReactFormGroupFieldComponent< in out TFormData, @@ -247,7 +245,7 @@ export interface ReactFormGroupFieldComponent< TFormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export type ReactFormGroupArrayFieldComponent< @@ -275,7 +273,7 @@ export type ReactFormGroupArrayFieldComponent< TFormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export interface ReactFormGroupApi< @@ -335,7 +333,7 @@ export interface ReactFormGroupProps< TFormErrorTypes, TFieldComponents >, - ) => CrossVersionReactNode + ) => ReactNode } export interface ReactFormGroupComponent< @@ -356,7 +354,7 @@ export interface ReactFormGroupComponent< TFormErrorTypes, TFieldComponents >, - ): CrossVersionReactNode + ): ReactNode } export interface ReactTanStackFormComponents< diff --git a/packages/react-form/src/Subscribe.public.tsx b/packages/react-form/src/Subscribe.public.tsx index cf9646cdd..9589a77f9 100644 --- a/packages/react-form/src/Subscribe.public.tsx +++ b/packages/react-form/src/Subscribe.public.tsx @@ -5,7 +5,7 @@ import type { ReadonlyStore, Store, } from '@tanstack/react-store' -import type { CrossVersionReactNode } from './reactTypes.public' +import type { ReactNode } from 'react' export type SubscribeSource = Atom | ReadonlyAtom | Store | ReadonlyStore @@ -25,9 +25,7 @@ export interface SubscribeProps { * Optional. If provided, the component will only render when the `when` function returns `true`. */ when?: (selected: NoInfer) => boolean - children: - | ((state: NoInfer) => CrossVersionReactNode) - | CrossVersionReactNode + children: ((state: NoInfer) => ReactNode) | ReactNode } /** @@ -37,7 +35,7 @@ export interface SubscribeProps { */ export function Subscribe( props: SubscribeProps, -): CrossVersionReactNode { +): ReactNode { const selected = useSelector( // Atom and store share the same selection protocol; union args need a widen for TS. props.source, diff --git a/packages/react-form/src/index.ts b/packages/react-form/src/index.ts index 73513071c..e5cf30f96 100644 --- a/packages/react-form/src/index.ts +++ b/packages/react-form/src/index.ts @@ -7,7 +7,6 @@ export * from './ReactForm/formType.public' export * from './ReactForm/Components.public' export * from './FieldGroup/FieldGroupApi.public' export * from './FieldGroup/withFields.public' -export * from './reactTypes.public' export * from './types.public' export * from './Subscribe.public' export * from './AppForm/ReactAppFormApi.public' diff --git a/packages/react-form/src/reactTypes.public.ts b/packages/react-form/src/reactTypes.public.ts deleted file mode 100644 index db7ca7f8b..000000000 --- a/packages/react-form/src/reactTypes.public.ts +++ /dev/null @@ -1,6 +0,0 @@ -import type { FunctionComponent } from 'react' - -/** - * This type mess takes care of react 17-19 cross compatibility. - */ -export type CrossVersionReactNode = ReturnType> diff --git a/packages/react-form/src/types.public.ts b/packages/react-form/src/types.public.ts index 1eb6ccbfc..7ef76391d 100644 --- a/packages/react-form/src/types.public.ts +++ b/packages/react-form/src/types.public.ts @@ -1,2 +1 @@ -export type { CrossVersionReactNode } from './reactTypes.public' export type { ReactFormType } from './ReactForm/formType.public' diff --git a/packages/vue-form/tsconfig.docs.json b/packages/vue-form/tsconfig.docs.json index 0f4b4ae8e..f349e3c34 100644 --- a/packages/vue-form/tsconfig.docs.json +++ b/packages/vue-form/tsconfig.docs.json @@ -1,4 +1,10 @@ { "extends": "./tsconfig.json", + "compilerOptions": { + "paths": { + "@tanstack/form-core": ["../form-core/src"], + "@tanstack/form-core/internals": ["../form-core/src/internals.ts"] + } + }, "exclude": ["tests", "eslint.config.js", "vite.config.ts"] }