2.4 KiB
| id | title |
|---|---|
| injectWithForm | injectWithForm |
function injectWithForm<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(_opts?): TanStackWithFormRef<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
Defined in: angular-form/src/with-form-injectable.ts:59
Injects the form provided by an ancestor [tanstack-with-form] directive.
Pass form options (typically the same options used to create the form) so
the returned form is typed correctly without needing to specify generics:
const withForm = injectWithForm({ ...peopleFormOpts })
withForm.form // FormApi<PeopleFormData, ...>
The options are only used for type inference and are not read at runtime.
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
Parameters
_opts?
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Returns
TanStackWithFormRef<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>