Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

injectForm.md

70 lines1.5 KB

function injectForm<TFormData, TFormValidators, TSubmitReturn>(options): InternalFormApi<TFormData, TFormValidators, TSubmitReturn>;

Defined in: inject-form.ts:38

Creates and mounts a form in the current Angular injection context.

defaultValues establish the initial state and inferred form value type. Form state changes notify Angular change detection, including OnPush components, and the form is cleaned up when the injection context is destroyed.

Call this in a component field initializer, constructor, provider factory, or another active injection context.

Type Parameters

TFormData

TFormData

Library-managed. Do not specify explicitly.

TFormValidators

TFormValidators extends FormValidators<TFormData>

Library-managed. Do not specify explicitly.

TSubmitReturn

TSubmitReturn

Library-managed. Do not specify explicitly.

Parameters

options

FormOptions<TFormData, TFormValidators, TSubmitReturn, unknown>

The initial form options. defaultValues drive form value inference.

Returns

InternalFormApi<TFormData, TFormValidators, TSubmitReturn>

The mounted form API registered for injection-context cleanup.

Example

@Component({
  selector: 'app-profile-form',
  template: `<form></form>`,
})
class ProfileFormComponent {
  form = injectForm({
    defaultValues: { name: '' },
    onSubmit: ({ value }) => saveProfile(value),
  })
}