Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FormOptions<TFormValues>

See the FormConfig documentation.

This interface is not necessary to be implemented because it covers only the one case when all your properties are string and you do not plan to use specific property names.

Type parameters

  • TFormValues

Hierarchy

  • Config<TFormValues>
    • FormOptions

Index

Properties

Optional debug

debug: DebugFunction<TFormValues>

Optional destroyOnUnregister

destroyOnUnregister: undefined | false | true

Optional initialValues

initialValues: FormValues

Optional keepDirtyOnReinitialize

keepDirtyOnReinitialize: undefined | false | true

Optional mutators

mutators: undefined | object

onSubmit

onSubmit: function

Type declaration

    • (values: TFormValues, form: FormApi<TFormValues>, callback?: undefined | function): SubmissionErrors | Promise<SubmissionErrors | undefined> | undefined | void
    • Parameters

      • values: TFormValues
      • form: FormApi<TFormValues>
      • Optional callback: undefined | function

      Returns SubmissionErrors | Promise<SubmissionErrors | undefined> | undefined | void

Optional validate

validate: undefined | function

Optional validateOnBlur

validateOnBlur: undefined | false | true

Methods

Optional compareInitialValues

  • compareInitialValues(prevInitialValues: object, nextInitialValues: object): boolean

Generated using TypeDoc