Interface: FormResetOptions#

Defined in: FormApi/FormApi.public.ts:526

Options controlling whether reset(values) replaces the default-value baseline.

Example#

formApi.reset(savedValues, { updateDefaultValues: false })

Properties#

updateDefaultValues?#

optional updateDefaultValues?: boolean;

Defined in: FormApi/FormApi.public.ts:556

Whether reset(values) should also update the form's defaultValues baseline.

By default, passing values to reset treats those values as the new reset baseline. Future reset() calls will return to those values, and state.isDefaultValue will compare against them.

Set this to false when you want reset semantics for form state (clearing touched, dirty, validation, submission state, and mounted fields) but want to keep comparing against the previous defaultValues.

With updateDefaultValues: false, state.isDirty is reset to false, but state.isDefaultValue may be false if the provided reset values do not deeply equal the preserved defaults.

This option is ignored when no reset values are provided.

Example#

const originalDefaults = formApi.defaultValues

formApi.reset(savedDraft, { updateDefaultValues: false })
// `savedDraft` is current, but `originalDefaults` remains the baseline.

formApi.reset()
// Restores `originalDefaults`, not `savedDraft`.