API Reference

mergeForm

Function: mergeForm()

ts
function mergeForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(baseForm, state): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;

Defined in: packages/form-core/src/mergeForm.ts:77

Type Parameters

TFormData

TFormData

TOnMount

TOnMount extends FormValidateOrFn\<`TFormData`\> | undefined

TOnChange

TOnChange extends FormValidateOrFn\<`TFormData`\> | undefined

TOnChangeAsync

TOnChangeAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnBlur

TOnBlur extends FormValidateOrFn\<`TFormData`\> | undefined

TOnBlurAsync

TOnBlurAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnSubmit

TOnSubmit extends FormValidateOrFn\<`TFormData`\> | undefined

TOnSubmitAsync

TOnSubmitAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnDynamic

TOnDynamic extends FormValidateOrFn\<`TFormData`\> | undefined

TOnDynamicAsync

TOnDynamicAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnServer

TOnServer extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TSubmitMeta

TSubmitMeta = never

Parameters

baseForm

FormApi\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>

state

Partial\<[`FormApi`](../classes/FormApi.md)\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>["state"]>

Returns

FormApi\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`\>