TanStack · lachlancollins · Dec 6, 2024 · Dec 6, 2024
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-20.15.1
+22.12.0
diff --git a/docs/framework/angular/reference/functions/injectform.md b/docs/framework/angular/reference/functions/injectform.md
@@ -17,7 +17,9 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV
 
 ## Parameters
 
-• **opts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>
+### opts?
+
+`FormOptions`\<`TFormData`, `TFormValidator`\>
 
 ## Returns
 

diff --git a/docs/framework/angular/reference/functions/injectstore.md b/docs/framework/angular/reference/functions/injectstore.md
@@ -19,9 +19,13 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig
 
 ## Parameters
 
-• **form**: `FormApi`\<`TFormData`, `TFormValidator`\>
+### form
 
-• **selector?**
+`FormApi`\<`TFormData`, `TFormValidator`\>
+
+### selector?
+
+(`state`) => `TSelected`
 
 ## Returns
 

diff --git a/docs/framework/lit/reference/classes/tanstackformcontroller.md b/docs/framework/lit/reference/classes/tanstackformcontroller.md
@@ -25,9 +25,13 @@ new TanStackFormController<TParentData, TFormValidator>(host, config?): TanStack
 
 #### Parameters
 
-• **host**: `ReactiveControllerHost`
+##### host
 
-• **config?**: `FormOptions`\<`TParentData`, `TFormValidator`\>
+`ReactiveControllerHost`
+
+##### config?
+
+`FormOptions`\<`TParentData`, `TFormValidator`\>
 
 #### Returns
 
@@ -67,9 +71,13 @@ field<TName, TFieldValidator, TData>(fieldConfig, render): object
 
 #### Parameters
 
-• **fieldConfig**: `FieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+##### fieldConfig
+
+`FieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+
+##### render
 
-• **render**: `renderCallback`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+`renderCallback`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 #### Returns
 
@@ -81,19 +89,19 @@ field<TName, TFieldValidator, TData>(fieldConfig, render): object
 values: object;
 ```
 
-##### values.form
+###### values.form
 
 ```ts
 form: FormApi<TParentData, TFormValidator>;
 ```
 
-##### values.options
+###### values.options
 
 ```ts
 options: FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
 ```
 
-##### values.render
+###### values.render
 
 ```ts
 render: renderCallback<TParentData, TName, TFieldValidator, TFormValidator, TData>;

diff --git a/docs/framework/react/reference/functions/field.md b/docs/framework/react/reference/functions/field.md
@@ -27,7 +27,9 @@ The `Field` component uses the `useField` hook internally to manage the field in
 
 ## Parameters
 
-• **\_\_namedParameters**: `FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+### \_\_namedParameters
+
+`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 ## Returns
 

diff --git a/docs/framework/react/reference/functions/usefield.md b/docs/framework/react/reference/functions/usefield.md
@@ -25,7 +25,9 @@ A hook for managing a field in a form.
 
 ## Parameters
 
-• **opts**: `UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+### opts
+
+`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 An object with field options.
 

diff --git a/docs/framework/react/reference/functions/useform.md b/docs/framework/react/reference/functions/useform.md
@@ -21,7 +21,9 @@ This API encapsulates all the necessary functionalities related to the form. It
 
 ## Parameters
 
-• **opts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>
+### opts?
+
+`FormOptions`\<`TFormData`, `TFormValidator`\>
 
 ## Returns
 

diff --git a/docs/framework/react/reference/functions/usetransform.md b/docs/framework/react/reference/functions/usetransform.md
@@ -17,9 +17,13 @@ function useTransform<TFormData, TFormValidator>(fn, deps): FormTransform<TFormD
 
 ## Parameters
 
-• **fn**
+### fn
 
-• **deps**: `unknown`[]
+(`formBase`) => `FormApi`\<`TFormData`, `TFormValidator`\>
+
+### deps
+
+`unknown`[]
 
 ## Returns
 

diff --git a/docs/framework/react/reference/interfaces/reactformapi.md b/docs/framework/react/reference/interfaces/reactformapi.md
@@ -43,11 +43,15 @@ A `Subscribe` function that allows you to listen and react to changes in the for
 
 #### Parameters
 
-• **props**
+##### props
 
-• **props.children**: `ReactNode` \| (`state`) => `ReactNode`
+###### children
 
-• **props.selector?**
+`ReactNode` \| (`state`) => `ReactNode`
+
+###### selector
+
+(`state`) => `TSelected`
 
 #### Returns
 
@@ -87,7 +91,9 @@ A `useStore` hook that connects to the internal store of the form. It can be use
 
 #### Parameters
 
-• **selector?**
+##### selector?
+
+(`state`) => `TSelected`
 
 #### Returns
 

diff --git a/docs/framework/react/reference/type-aliases/fieldcomponent.md b/docs/framework/react/reference/type-aliases/fieldcomponent.md
@@ -30,10 +30,12 @@ A type alias representing a field component for a specific form data type.
 
 ## Parameters
 
-• **\{
+### \{
   children,
   ...fieldOptions
-\}**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+\}
+
+`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
 
 ## Returns
 

diff --git a/docs/framework/react/reference/type-aliases/usefield.md b/docs/framework/react/reference/type-aliases/usefield.md
@@ -29,7 +29,9 @@ A function that takes an optional object with a `name` property and field option
 
 ## Parameters
 
-• **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+### opts
+
+`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
 
 ## Returns
 

diff --git a/docs/framework/solid/reference/functions/createfield.md b/docs/framework/solid/reference/functions/createfield.md
@@ -23,7 +23,9 @@ function createField<TParentData, TName, TFieldValidator, TFormValidator, TData>
 
 ## Parameters
 
-• **opts**
+### opts
+
+() => `CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 ## Returns
 

diff --git a/docs/framework/solid/reference/functions/createform.md b/docs/framework/solid/reference/functions/createform.md
@@ -17,7 +17,9 @@ function createForm<TParentData, TFormValidator>(opts?): FormApi<TParentData, TF
 
 ## Parameters
 
-• **opts?**
+### opts?
+
+() => `FormOptions`\<`TParentData`, `TFormValidator`\>
 
 ## Returns
 

diff --git a/docs/framework/solid/reference/functions/field.md b/docs/framework/solid/reference/functions/field.md
@@ -23,7 +23,9 @@ function Field<TParentData, TName, TFieldValidator, TFormValidator, TData>(props
 
 ## Parameters
 
-• **props**: `object` & `FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object`
+### props
+
+`object` & `FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object`
 
 ## Returns
 

diff --git a/docs/framework/solid/reference/interfaces/solidformapi.md b/docs/framework/solid/reference/interfaces/solidformapi.md
@@ -49,11 +49,15 @@ Subscribe: <TSelected>(props) => Element;
 
 #### Parameters
 
-• **props**
+##### props
 
-• **props.children**: `Element` \| (`state`) => `Element`
+###### children
 
-• **props.selector?**
+`Element` \| (`state`) => `Element`
+
+###### selector
+
+(`state`) => `TSelected`
 
 #### Returns
 
@@ -77,7 +81,9 @@ useStore: <TSelected>(selector?) => () => TSelected;
 
 #### Parameters
 
-• **selector?**
+##### selector?
+
+(`state`) => `TSelected`
 
 #### Returns
 

diff --git a/docs/framework/solid/reference/type-aliases/createfield.md b/docs/framework/solid/reference/type-aliases/createfield.md
@@ -25,7 +25,9 @@ type CreateField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(o
 
 ## Parameters
 
-• **opts**
+### opts
+
+() => `object` & `Omit`\<`CreateFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
 
 ## Returns
 

diff --git a/docs/framework/solid/reference/type-aliases/fieldcomponent.md b/docs/framework/solid/reference/type-aliases/fieldcomponent.md
@@ -28,10 +28,12 @@ type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData
 
 ## Parameters
 
-• **\{
+### \{
   children,
   ...fieldOptions
-\}**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+\}
+
+`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
 
 ## Returns
 

diff --git a/docs/framework/vue/reference/functions/usefield.md b/docs/framework/vue/reference/functions/usefield.md
@@ -23,7 +23,9 @@ function useField<TParentData, TName, TFieldValidator, TFormValidator, TData>(op
 
 ## Parameters
 
-• **opts**: `UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+### opts
+
+`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 ## Returns
 

diff --git a/docs/framework/vue/reference/functions/useform.md b/docs/framework/vue/reference/functions/useform.md
@@ -17,7 +17,9 @@ function useForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormVali
 
 ## Parameters
 
-• **opts?**: `FormOptions`\<`TFormData`, `TFormValidator`\>
+### opts?
+
+`FormOptions`\<`TFormData`, `TFormValidator`\>
 
 ## Returns
 

diff --git a/docs/framework/vue/reference/interfaces/vueformapi.md b/docs/framework/vue/reference/interfaces/vueformapi.md
@@ -37,11 +37,15 @@ Subscribe: <TSelected>(props, context) => any;
 
 #### Parameters
 
-• **props**
+##### props
 
-• **props.selector?**
+###### selector
 
-• **context**: `SetupContext`\<`EmitsOptions`, `SlotsType`\<`object`\>\>
+(`state`) => `TSelected`
+
+##### context
+
+`SetupContext`\<`EmitsOptions`, `SlotsType`\<`object`\>\>
 
 #### Returns
 
@@ -77,7 +81,9 @@ useStore: <TSelected>(selector?) => Readonly<Ref<TSelected, TSelected>>;
 
 #### Parameters
 
-• **selector?**
+##### selector?
+
+(`state`) => `TSelected`
 
 #### Returns
 

diff --git a/docs/framework/vue/reference/type-aliases/fieldcomponent.md b/docs/framework/vue/reference/type-aliases/fieldcomponent.md
@@ -25,9 +25,13 @@ type FieldComponent<TParentData, TFormValidator>: <TName, TFieldValidator, TData
 
 ## Parameters
 
-• **fieldOptions**: `Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+### fieldOptions
 
-• **context**: `SetupContext`\<`object`, `SlotsType`\<`object`\>\>
+`Omit`\<`FieldComponentProps`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+
+### context
+
+`SetupContext`\<`object`, `SlotsType`\<`object`\>\>
 
 ## Returns
 

diff --git a/docs/framework/vue/reference/type-aliases/usefield.md b/docs/framework/vue/reference/type-aliases/usefield.md
@@ -25,7 +25,9 @@ type UseField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(opts
 
 ## Parameters
 
-• **opts**: `Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
+### opts
+
+`Omit`\<`UseFieldOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>, `"form"`\>
 
 ## Returns
 

diff --git a/docs/framework/vue/reference/variables/field.md b/docs/framework/vue/reference/variables/field.md
@@ -6,16 +6,18 @@ title: Field
 # Variable: Field()
 
 ```ts
-const Field: <TParentData, TName, TFieldValidator, TFormValidator, TData>(props) => CreateComponentPublicInstanceWithMixins<FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & object & object | object, object, object, object, object, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, object, false, object, object, object, object, string, object, any, ComponentProvideOptions, OptionTypesType<object, object, object, object, object, object>, object & FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & { mode?: "value" | ... 1 more ... | undefined; } & ({ ...; } | { ...; }), object, object, object, object, object>;
+const Field: <TParentData, TName, TFieldValidator, TFormValidator, TData>(props) => CreateComponentPublicInstanceWithMixins<FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & object & {} | {}, object, object, object, object, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, object, false, object, object, object, object, string, object, any, ComponentProvideOptions, OptionTypesType<object, object, object, object, object, object>, object & FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> & { mode?: "value" | ... 1 more ... | undefined; } & ({ ...; } | { ...; }), object, object, object, object, object>;
 ```
 
 ## Parameters
 
-• **props**: FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps`
+### props
+
+FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}) & `VNodeProps` & `AllowedComponentProps` & `ComponentCustomProps`
 
 ## Returns
 
-`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` & `object` \| `object`, `object`, `object`, `object`, `object`, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, `object`, `false`, `object`, `object`, `object`, `object`, `string`, `object`, `any`, `ComponentProvideOptions`, `OptionTypesType`\<`object`, `object`, `object`, `object`, `object`, `object`\>, `object` & FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}), `object`, `object`, `object`, `object`, `object`\>
+`CreateComponentPublicInstanceWithMixins`\<`FieldApiOptions`\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\> & `object` & \{\} \| \{\}, `object`, `object`, `object`, `object`, `ComponentOptionsMixin`, `ComponentOptionsMixin`, `EmitsOptions`, `PublicProps`, `object`, `false`, `object`, `object`, `object`, `object`, `string`, `object`, `any`, `ComponentProvideOptions`, `OptionTypesType`\<`object`, `object`, `object`, `object`, `object`, `object`\>, `object` & FieldApiOptions\<TParentData, TName, TFieldValidator, TFormValidator, TData\> & \{ mode?: "value" \| ... 1 more ... \| undefined; \} & (\{ ...; \} \| \{ ...; \}), `object`, `object`, `object`, `object`, `object`\>
 
 ## Defined in