Skip to content

Commit 54198d9

Browse files
🥡 feat: add resetDefaultValues API (#13427)
* Initial plan * feat: add resetDefaultValues API to update defaults without changing form values Agent-Logs-Url: https://github.com/react-hook-form/react-hook-form/sessions/1f8797d4-65d5-465e-87b5-1b099e4b4d48 * update api contract --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: bill <[email protected]>
1 parent fe8276e commit 54198d9

5 files changed

Lines changed: 301 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,4 @@ package-lock.json
4444
/cypress/parallel-weights.json
4545
/cypress/screenshots
4646
/cypress/fixtures
47+
pnpm-workspace.yaml

‎reports/api-extractor.md.api.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -775,6 +775,9 @@ export type UseFormRegisterReturn<TFieldName extends InternalFieldName = Interna
775775
// @public
776776
export type UseFormReset<TFieldValues extends FieldValues> = (values?: DefaultValues<TFieldValues> | TFieldValues | ResetAction<TFieldValues>, keepStateOptions?: KeepStateOptions) => void;
777777

778+
// @public
779+
export type UseFormResetDefaultValues<TFieldValues extends FieldValues> = (values: DefaultValues<TFieldValues> | TFieldValues, options?: Partial<Pick<KeepStateOptions, 'keepDirty' | 'keepIsValid'>>) => void;
780+
778781
// @public
779782
export type UseFormResetField<TFieldValues extends FieldValues> = <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(name: TFieldName, options?: ResetFieldConfig<TFieldValues, TFieldName>) => void;
780783

@@ -791,6 +794,7 @@ export type UseFormReturn<TFieldValues extends FieldValues = FieldValues, TConte
791794
formState: FormState<TFieldValues>;
792795
resetField: UseFormResetField<TFieldValues>;
793796
reset: UseFormReset<TFieldValues>;
797+
resetDefaultValues: UseFormResetDefaultValues<TFieldValues>;
794798
handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>;
795799
unregister: UseFormUnregister<TFieldValues>;
796800
control: Control<TFieldValues, TContext, TTransformedValues>;
Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
import React from 'react';
2+
import {
3+
act,
4+
fireEvent,
5+
render,
6+
screen,
7+
waitFor,
8+
} from '@testing-library/react';
9+
10+
import { useForm } from '../../useForm';
11+
12+
jest.useFakeTimers();
13+
14+
describe('resetDefaultValues', () => {
15+
it('should update default values and recompute dirtyFields/isDirty without changing form values', async () => {
16+
let formRef: ReturnType<
17+
typeof useForm<{ firstName: string; lastName: string }>
18+
>;
19+
20+
const App = () => {
21+
const methods = useForm({
22+
defaultValues: { firstName: 'John', lastName: 'Doe' },
23+
});
24+
formRef = methods;
25+
const {
26+
register,
27+
formState: { isDirty, dirtyFields },
28+
} = methods;
29+
return (
30+
<form>
31+
<input {...register('firstName')} placeholder="firstName" />
32+
<input {...register('lastName')} placeholder="lastName" />
33+
<p data-testid="isDirty">{isDirty ? 'dirty' : 'clean'}</p>
34+
<p data-testid="dirtyFields">{JSON.stringify(dirtyFields)}</p>
35+
</form>
36+
);
37+
};
38+
39+
render(<App />);
40+
41+
// Change firstName so it's dirty
42+
fireEvent.change(screen.getByPlaceholderText('firstName'), {
43+
target: { value: 'Jane' },
44+
});
45+
46+
expect(screen.getByTestId('isDirty').textContent).toBe('dirty');
47+
expect(screen.getByTestId('dirtyFields').textContent).toBe(
48+
'{"firstName":true}',
49+
);
50+
51+
// Reset default values to match the current "Jane" value
52+
act(() => {
53+
formRef.resetDefaultValues({ firstName: 'Jane', lastName: 'Doe' });
54+
});
55+
56+
// The input value should not change
57+
expect(
58+
(screen.getByPlaceholderText('firstName') as HTMLInputElement).value,
59+
).toBe('Jane');
60+
61+
// isDirty and dirtyFields should be recomputed: firstName is no longer dirty
62+
expect(screen.getByTestId('isDirty').textContent).toBe('clean');
63+
expect(screen.getByTestId('dirtyFields').textContent).toBe('{}');
64+
});
65+
66+
it('should keep dirty state when keepDirty option is true', async () => {
67+
let formRef: ReturnType<typeof useForm<{ firstName: string }>>;
68+
69+
const App = () => {
70+
const methods = useForm({ defaultValues: { firstName: 'John' } });
71+
formRef = methods;
72+
const {
73+
register,
74+
formState: { isDirty, dirtyFields },
75+
} = methods;
76+
return (
77+
<form>
78+
<input {...register('firstName')} placeholder="firstName" />
79+
<p data-testid="isDirty">{isDirty ? 'dirty' : 'clean'}</p>
80+
<p data-testid="dirtyFields">{JSON.stringify(dirtyFields)}</p>
81+
</form>
82+
);
83+
};
84+
85+
render(<App />);
86+
87+
fireEvent.change(screen.getByPlaceholderText('firstName'), {
88+
target: { value: 'Jane' },
89+
});
90+
91+
expect(screen.getByTestId('isDirty').textContent).toBe('dirty');
92+
93+
// Reset defaults to the new value but keep dirty state
94+
act(() => {
95+
formRef.resetDefaultValues({ firstName: 'Jane' }, { keepDirty: true });
96+
});
97+
98+
// Input value should not change
99+
expect(
100+
(screen.getByPlaceholderText('firstName') as HTMLInputElement).value,
101+
).toBe('Jane');
102+
103+
// Dirty state should be preserved because keepDirty: true
104+
expect(screen.getByTestId('isDirty').textContent).toBe('dirty');
105+
expect(screen.getByTestId('dirtyFields').textContent).toBe(
106+
'{"firstName":true}',
107+
);
108+
});
109+
110+
it('should update formState.defaultValues when resetDefaultValues is called', async () => {
111+
let formRef: ReturnType<typeof useForm<{ name: string }>>;
112+
113+
const App = () => {
114+
const methods = useForm({ defaultValues: { name: 'initial' } });
115+
formRef = methods;
116+
const {
117+
register,
118+
formState: { defaultValues },
119+
} = methods;
120+
return (
121+
<form>
122+
<input {...register('name')} />
123+
<p data-testid="defaultValues">{JSON.stringify(defaultValues)}</p>
124+
</form>
125+
);
126+
};
127+
128+
render(<App />);
129+
130+
expect(screen.getByTestId('defaultValues').textContent).toBe(
131+
'{"name":"initial"}',
132+
);
133+
134+
act(() => {
135+
formRef.resetDefaultValues({ name: 'updated' });
136+
});
137+
138+
expect(screen.getByTestId('defaultValues').textContent).toBe(
139+
'{"name":"updated"}',
140+
);
141+
});
142+
143+
it('should work with nested objects', async () => {
144+
let formRef: ReturnType<
145+
typeof useForm<{ user: { name: string; age: number } }>
146+
>;
147+
148+
const App = () => {
149+
const methods = useForm({
150+
defaultValues: { user: { name: 'John', age: 30 } },
151+
});
152+
formRef = methods;
153+
const {
154+
register,
155+
formState: { isDirty, dirtyFields },
156+
} = methods;
157+
return (
158+
<form>
159+
<input {...register('user.name')} placeholder="name" />
160+
<input {...register('user.age')} placeholder="age" type="number" />
161+
<p data-testid="isDirty">{isDirty ? 'dirty' : 'clean'}</p>
162+
<p data-testid="dirtyFields">{JSON.stringify(dirtyFields)}</p>
163+
</form>
164+
);
165+
};
166+
167+
render(<App />);
168+
169+
fireEvent.change(screen.getByPlaceholderText('name'), {
170+
target: { value: 'Jane' },
171+
});
172+
173+
expect(screen.getByTestId('dirtyFields').textContent).toContain(
174+
'"name":true',
175+
);
176+
177+
// Reset defaults to the current user value (submitted state)
178+
act(() => {
179+
formRef.resetDefaultValues({ user: { name: 'Jane', age: 30 } });
180+
});
181+
182+
expect(screen.getByTestId('isDirty').textContent).toBe('clean');
183+
expect(screen.getByTestId('dirtyFields').textContent).toBe('{}');
184+
185+
// Input values should not change
186+
expect(
187+
(screen.getByPlaceholderText('name') as HTMLInputElement).value,
188+
).toBe('Jane');
189+
});
190+
191+
it('should recompute dirty fields correctly when some fields still differ from new defaults', async () => {
192+
let formRef: ReturnType<
193+
typeof useForm<{ a: string; b: string; c: string }>
194+
>;
195+
196+
const App = () => {
197+
const methods = useForm({
198+
defaultValues: { a: '1', b: '2', c: '3' },
199+
});
200+
formRef = methods;
201+
const {
202+
register,
203+
formState: { isDirty, dirtyFields },
204+
} = methods;
205+
return (
206+
<form>
207+
<input {...register('a')} placeholder="a" />
208+
<input {...register('b')} placeholder="b" />
209+
<input {...register('c')} placeholder="c" />
210+
<p data-testid="isDirty">{isDirty ? 'dirty' : 'clean'}</p>
211+
<p data-testid="dirtyFields">{JSON.stringify(dirtyFields)}</p>
212+
</form>
213+
);
214+
};
215+
216+
render(<App />);
217+
218+
// Dirty all three fields
219+
fireEvent.change(screen.getByPlaceholderText('a'), {
220+
target: { value: 'A' },
221+
});
222+
fireEvent.change(screen.getByPlaceholderText('b'), {
223+
target: { value: 'B' },
224+
});
225+
fireEvent.change(screen.getByPlaceholderText('c'), {
226+
target: { value: 'C' },
227+
});
228+
229+
await waitFor(() =>
230+
expect(screen.getByTestId('dirtyFields').textContent).toBe(
231+
'{"a":true,"b":true,"c":true}',
232+
),
233+
);
234+
235+
// Reset defaults so that 'a' matches the current value ('A'),
236+
// but 'b' and 'c' still differ
237+
act(() => {
238+
formRef.resetDefaultValues({ a: 'A', b: '2', c: '3' });
239+
});
240+
241+
// 'a' is no longer dirty, 'b' and 'c' remain dirty
242+
expect(screen.getByTestId('isDirty').textContent).toBe('dirty');
243+
expect(JSON.parse(screen.getByTestId('dirtyFields').textContent!)).toEqual({
244+
b: true,
245+
c: true,
246+
});
247+
});
248+
});

‎src/logic/createFormControl.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import type {
3939
UseFormProps,
4040
UseFormRegister,
4141
UseFormReset,
42+
UseFormResetDefaultValues,
4243
UseFormResetField,
4344
UseFormReturn,
4445
UseFormSetError,
@@ -1815,6 +1816,28 @@ export function createFormControl<
18151816
});
18161817
});
18171818

1819+
const resetDefaultValues: UseFormResetDefaultValues<TFieldValues> = (
1820+
values,
1821+
options = {},
1822+
) => {
1823+
_defaultValues = cloneObject(values) as Partial<typeof _defaultValues>;
1824+
1825+
if (!options.keepDirty) {
1826+
const newDirtyFields = getDirtyFields(_defaultValues, _formValues);
1827+
_formState.dirtyFields = newDirtyFields as typeof _formState.dirtyFields;
1828+
_formState.isDirty = !isEmptyObject(newDirtyFields);
1829+
}
1830+
1831+
if (!options.keepIsValid) {
1832+
_setValid();
1833+
}
1834+
1835+
_subjects.state.next({
1836+
..._formState,
1837+
defaultValues: _defaultValues as FormState<TFieldValues>['defaultValues'],
1838+
});
1839+
};
1840+
18181841
const methods = {
18191842
control: {
18201843
register,
@@ -1883,6 +1906,7 @@ export function createFormControl<
18831906
getValues,
18841907
reset,
18851908
resetField,
1909+
resetDefaultValues,
18861910
clearErrors,
18871911
unregister,
18881912
setError,

‎src/types/form.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -774,6 +774,29 @@ export type UseFormReset<TFieldValues extends FieldValues> = (
774774
keepStateOptions?: KeepStateOptions,
775775
) => void;
776776

777+
/**
778+
* Reset the default values of the form and recompute `dirtyFields`/`isDirty` without changing user values.
779+
*
780+
* @remarks
781+
* [API](https://react-hook-form.com/docs/useform/resetdefaultvalues)
782+
*
783+
* @param values - the new default values
784+
* @param options - options to keep dirty or isValid state
785+
*
786+
* @example
787+
* ```tsx
788+
* // After a successful submission, update defaults to the submitted values
789+
* // so that dirtyFields/isDirty reflect changes made after that point.
790+
* const onSuccess = () => {
791+
* resetDefaultValues(submittedValues);
792+
* };
793+
* ```
794+
*/
795+
export type UseFormResetDefaultValues<TFieldValues extends FieldValues> = (
796+
values: DefaultValues<TFieldValues> | TFieldValues,
797+
options?: Partial<Pick<KeepStateOptions, 'keepDirty' | 'keepIsValid'>>,
798+
) => void;
799+
777800
export type WatchInternal<TFieldValues> = (
778801
fieldNames?: InternalFieldName | InternalFieldName[],
779802
defaultValue?: DeepPartial<TFieldValues>,
@@ -922,6 +945,7 @@ export type UseFormReturn<
922945
formState: FormState<TFieldValues>;
923946
resetField: UseFormResetField<TFieldValues>;
924947
reset: UseFormReset<TFieldValues>;
948+
resetDefaultValues: UseFormResetDefaultValues<TFieldValues>;
925949
handleSubmit: UseFormHandleSubmit<TFieldValues, TTransformedValues>;
926950
unregister: UseFormUnregister<TFieldValues>;
927951
control: Control<TFieldValues, TContext, TTransformedValues>;

0 commit comments

Comments
 (0)