Add Octane adapter for TanStack Form v1

README.md

@@ -43,8 +43,9 @@
 </div>
 
 <div align="center">
-  
+
 ### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
+
 </div>
 
 # TanStack Form

docs/config.json

@@ -54,6 +54,15 @@
             }
           ]
         },
+        {
+          "label": "octane",
+          "children": [
+            {
+              "label": "Quick Start",
+              "to": "framework/octane/quick-start"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -247,6 +256,63 @@
             }
           ]
         },
+        {
+          "label": "octane",
+          "children": [
+            {
+              "label": "Basic Concepts",
+              "to": "framework/octane/guides/basic-concepts"
+            },
+            {
+              "label": "Form Validation",
+              "to": "framework/octane/guides/validation"
+            },
+            {
+              "label": "Dynamic Validation",
+              "to": "framework/octane/guides/dynamic-validation"
+            },
+            {
+              "label": "Arrays",
+              "to": "framework/octane/guides/arrays"
+            },
+            {
+              "label": "Form Groups",
+              "to": "framework/octane/guides/form-groups"
+            },
+            {
+              "label": "Linked Fields",
+              "to": "framework/octane/guides/linked-fields"
+            },
+            {
+              "label": "Reactivity",
+              "to": "framework/octane/guides/reactivity"
+            },
+            {
+              "label": "Listeners",
+              "to": "framework/octane/guides/listeners"
+            },
+            {
+              "label": "Custom Errors",
+              "to": "framework/octane/guides/custom-errors"
+            },
+            {
+              "label": "Submission Handling",
+              "to": "framework/octane/guides/submission-handling"
+            },
+            {
+              "label": "Focus Management",
+              "to": "framework/octane/guides/focus-management"
+            },
+            {
+              "label": "Form Composition",
+              "to": "framework/octane/guides/form-composition"
+            },
+            {
+              "label": "Debugging",
+              "to": "framework/octane/guides/debugging"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -555,6 +621,111 @@
             }
           ]
         },
+        {
+          "label": "octane",
+          "children": [
+            {
+              "label": "Octane Reference",
+              "to": "framework/octane/reference/index"
+            },
+            {
+              "label": "Variables / Field",
+              "to": "framework/octane/reference/variables/Field"
+            },
+            {
+              "label": "Variables / FormGroup",
+              "to": "framework/octane/reference/variables/FormGroup"
+            },
+            {
+              "label": "Variables / useIsomorphicLayoutEffect",
+              "to": "framework/octane/reference/variables/useIsomorphicLayoutEffect"
+            },
+            {
+              "label": "Functions / createFormHook",
+              "to": "framework/octane/reference/functions/createFormHook"
+            },
+            {
+              "label": "Functions / createFormHookContexts",
+              "to": "framework/octane/reference/functions/createFormHookContexts"
+            },
+            {
+              "label": "Functions / useField",
+              "to": "framework/octane/reference/functions/useField"
+            },
+            {
+              "label": "Functions / useFieldGroup",
+              "to": "framework/octane/reference/functions/useFieldGroup"
+            },
+            {
+              "label": "Functions / useForm",
+              "to": "framework/octane/reference/functions/useForm"
+            },
+            {
+              "label": "Functions / useFormGroup",
+              "to": "framework/octane/reference/functions/useFormGroup"
+            },
+            {
+              "label": "Functions / useSelector",
+              "to": "framework/octane/reference/functions/useSelector"
+            },
+            {
+              "label": "Interfaces / CreateFormHookReturn",
+              "to": "framework/octane/reference/interfaces/CreateFormHookReturn"
+            },
+            {
+              "label": "Interfaces / OctaneFormApi",
+              "to": "framework/octane/reference/interfaces/OctaneFormApi"
+            },
+            {
+              "label": "Interfaces / SubscribeComponent",
+              "to": "framework/octane/reference/interfaces/SubscribeComponent"
+            },
+            {
+              "label": "Interfaces / UseFieldOptions",
+              "to": "framework/octane/reference/interfaces/UseFieldOptions"
+            },
+            {
+              "label": "Interfaces / UseFieldOptionsBound",
+              "to": "framework/octane/reference/interfaces/UseFieldOptionsBound"
+            },
+            {
+              "label": "Interfaces / WithFieldGroupProps",
+              "to": "framework/octane/reference/interfaces/WithFieldGroupProps"
+            },
+            {
+              "label": "Interfaces / WithFormProps",
+              "to": "framework/octane/reference/interfaces/WithFormProps"
+            },
+            {
+              "label": "Types / FieldComponent",
+              "to": "framework/octane/reference/type-aliases/FieldComponent"
+            },
+            {
+              "label": "Types / FormGroupComponent",
+              "to": "framework/octane/reference/type-aliases/FormGroupComponent"
+            },
+            {
+              "label": "Types / LensFieldComponent",
+              "to": "framework/octane/reference/type-aliases/LensFieldComponent"
+            },
+            {
+              "label": "Types / OctaneFormExtendedApi",
+              "to": "framework/octane/reference/type-aliases/OctaneFormExtendedApi"
+            },
+            {
+              "label": "Types / ServerFormState",
+              "to": "framework/octane/reference/type-aliases/ServerFormState"
+            },
+            {
+              "label": "Types / UseField",
+              "to": "framework/octane/reference/type-aliases/UseField"
+            },
+            {
+              "label": "Types / UseFormGroup",
+              "to": "framework/octane/reference/type-aliases/UseFormGroup"
+            }
+          ]
+        },
         {
           "label": "vue",
           "children": [
@@ -811,6 +982,19 @@
             }
           ]
         },
+        {
+          "label": "octane",
+          "children": [
+            {
+              "label": "Simple",
+              "to": "framework/octane/examples/simple"
+            },
+            {
+              "label": "Multi-Step Wizard",
+              "to": "framework/octane/examples/multi-step-wizard"
+            }
+          ]
+        },
         {
           "label": "svelte",
           "children": [

docs/framework/angular/reference/classes/TanStackAppField.md

@@ -111,7 +111,7 @@ Defined in: [angular-form/src/app-field.ts:20](https://github.com/TanStack/form/
 new TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>(): TanStackAppField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
 ```
 
-Defined in: [angular-form/src/app-field.ts:79](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L79)
+Defined in: [angular-form/src/app-field.ts:75](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L75)
 
 #### Returns
 
@@ -129,7 +129,7 @@ Defined in: [angular-form/src/app-field.ts:79](https://github.com/TanStack/form/
 _api: Signal<FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:150](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L150)
+Defined in: [angular-form/src/tanstack-field.ts:146](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L146)
 
 #### Inherited from
 
@@ -143,7 +143,7 @@ Defined in: [angular-form/src/tanstack-field.ts:150](https://github.com/TanStack
 asyncAlways: InputSignalWithTransform<boolean, unknown>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:75](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L75)
+Defined in: [angular-form/src/tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L71)
 
 #### Inherited from
 
@@ -157,7 +157,7 @@ Defined in: [angular-form/src/tanstack-field.ts:75](https://github.com/TanStack/
 asyncDebounceMs: InputSignalWithTransform<number, unknown>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:72](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L72)
+Defined in: [angular-form/src/tanstack-field.ts:68](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L68)
 
 #### Inherited from
 
@@ -171,7 +171,7 @@ Defined in: [angular-form/src/tanstack-field.ts:72](https://github.com/TanStack/
 base: TanStackFieldInjectable<any>;
 ```
 
-Defined in: [angular-form/src/app-field.ts:77](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L77)
+Defined in: [angular-form/src/app-field.ts:73](https://github.com/TanStack/form/blob/main/packages/angular-form/src/app-field.ts#L73)
 
 ***
 
@@ -181,7 +181,7 @@ Defined in: [angular-form/src/app-field.ts:77](https://github.com/TanStack/form/
 cd: ChangeDetectorRef;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:237](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L237)
+Defined in: [angular-form/src/tanstack-field.ts:233](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L233)
 
 #### Inherited from
 
@@ -197,7 +197,7 @@ defaultMeta: InputSignal<
 | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:117](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L117)
+Defined in: [angular-form/src/tanstack-field.ts:113](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L113)
 
 #### Inherited from
 
@@ -211,7 +211,7 @@ Defined in: [angular-form/src/tanstack-field.ts:117](https://github.com/TanStack
 defaultValue: InputSignal<NoInfer<TData> | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:71](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L71)
+Defined in: [angular-form/src/tanstack-field.ts:67](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L67)
 
 #### Inherited from
 
@@ -225,7 +225,7 @@ Defined in: [angular-form/src/tanstack-field.ts:71](https://github.com/TanStack/
 disableErrorFlat: InputSignal<boolean | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:148](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L148)
+Defined in: [angular-form/src/tanstack-field.ts:144](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L144)
 
 #### Inherited from
 
@@ -239,7 +239,7 @@ Defined in: [angular-form/src/tanstack-field.ts:148](https://github.com/TanStack
 injector: Injector;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:221](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L221)
+Defined in: [angular-form/src/tanstack-field.ts:217](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L217)
 
 #### Inherited from
 
@@ -255,7 +255,7 @@ listeners: InputSignal<
 | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:116](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L116)
+Defined in: [angular-form/src/tanstack-field.ts:112](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L112)
 
 #### Inherited from
 
@@ -269,7 +269,7 @@ Defined in: [angular-form/src/tanstack-field.ts:116](https://github.com/TanStack
 mode: InputSignal<"value" | "array" | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:146](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L146)
+Defined in: [angular-form/src/tanstack-field.ts:142](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L142)
 
 #### Inherited from
 
@@ -283,7 +283,7 @@ Defined in: [angular-form/src/tanstack-field.ts:146](https://github.com/TanStack
 name: InputSignal<TName>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:70](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L70)
+Defined in: [angular-form/src/tanstack-field.ts:66](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L66)
 
 #### Inherited from
 
@@ -297,7 +297,7 @@ Defined in: [angular-form/src/tanstack-field.ts:70](https://github.com/TanStack/
 options: Signal<FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:182](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L182)
+Defined in: [angular-form/src/tanstack-field.ts:178](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L178)
 
 #### Inherited from
 
@@ -311,7 +311,7 @@ Defined in: [angular-form/src/tanstack-field.ts:182](https://github.com/TanStack
 tanstackField: InputSignal<FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:78](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L78)
+Defined in: [angular-form/src/tanstack-field.ts:74](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L74)
 
 #### Inherited from
 
@@ -327,7 +327,7 @@ validators: InputSignal<
 | undefined>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:96](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L96)
+Defined in: [angular-form/src/tanstack-field.ts:92](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L92)
 
 #### Inherited from
 
@@ -343,7 +343,7 @@ Defined in: [angular-form/src/tanstack-field.ts:96](https://github.com/TanStack/
 get api(): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TSubmitMeta>;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:154](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L154)
+Defined in: [angular-form/src/tanstack-field.ts:150](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L150)
 
 ##### Returns
 
@@ -361,7 +361,7 @@ Defined in: [angular-form/src/tanstack-field.ts:154](https://github.com/TanStack
 ngOnInit(): void;
 ```
 
-Defined in: [angular-form/src/tanstack-field.ts:239](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L239)
+Defined in: [angular-form/src/tanstack-field.ts:235](https://github.com/TanStack/form/blob/main/packages/angular-form/src/tanstack-field.ts#L235)
 
 A callback method that is invoked immediately after the
 default change detector has checked the directive's