feat(forms): Allow to reset a form without emitting events (#60354)

JeanMeche · thePunderWoman · commit bdfbd5493240 · 2025-04-02T11:36:24.000Z
This change add an option paramter to `resetForm` that is passed to the FormGroup. fixes #60274 PR Close #60354
diff --git a/goldens/public-api/forms/index.api.md b/goldens/public-api/forms/index.api.md
@@ -502,7 +502,10 @@ export class FormGroupDirective extends ControlContainer implements Form, OnChan
     removeControl(dir: FormControlName): void;
     removeFormArray(dir: FormArrayName): void;
     removeFormGroup(dir: FormGroupName): void;
-    resetForm(value?: any): void;
+    resetForm(value?: any, options?: {
+        onlySelf?: boolean;
+        emitEvent?: boolean;
+    }): void;
     get submitted(): boolean;
     updateModel(dir: FormControlName, value: any): void;
     // (undocumented)
diff --git a/packages/forms/src/directives/reactive_directives/form_group_directive.ts b/packages/forms/src/directives/reactive_directives/form_group_directive.ts
@@ -339,12 +339,14 @@ export class FormGroupDirective extends ControlContainer implements Form, OnChan
    * @description
    * Resets the form to an initial value and resets its submitted status.
    *
-   * @param value The new value for the form.
+   * @param value The new value for the form, `undefined` by default
    */
-  resetForm(value: any = undefined): void {
-    this.form.reset(value);
+  resetForm(value: any = undefined, options: {onlySelf?: boolean; emitEvent?: boolean} = {}): void {
+    this.form.reset(value, options);
     this._submittedReactive.set(false);
-    this.form._events.next(new FormResetEvent(this.form));
+    if (options?.emitEvent !== false) {
+      this.form._events.next(new FormResetEvent(this.form));
+    }
   }
 
   /** @internal */
diff --git a/packages/forms/test/reactive_integration_spec.ts b/packages/forms/test/reactive_integration_spec.ts
@@ -1422,6 +1422,59 @@ describe('reactive forms integration tests', () => {
       expect(events[3].source).toBe(form);
     });
 
+    it('formControl should not emit an event when resetting a form with emit:false', () => {
+      const fixture = initTest(FormGroupComp);
+      const form = new FormGroup({'login': new FormControl('', Validators.required)});
+      fixture.componentInstance.form = form;
+      fixture.detectChanges();
+
+      const formGroupDir = fixture.debugElement.children[0].injector.get(FormGroupDirective);
+
+      const events: ControlEvent[] = [];
+      fixture.componentInstance.form.events.subscribe((event) => events.push(event));
+
+      formGroupDir.resetForm(undefined, {emitEvent: false});
+
+      expect(events.length).toBe(1);
+      expect(events[0]).toBeInstanceOf(TouchedChangeEvent);
+    });
+
+    it('formControl should only update self', () => {
+      const fixture = initTest(FormGroupComp);
+      const form = new FormGroup({'login': new FormControl('', Validators.required)});
+      const parentForm = new FormGroup({form});
+      fixture.componentInstance.form = form;
+      fixture.detectChanges();
+
+      const formGroupDir = fixture.debugElement.children[0].injector.get(FormGroupDirective);
+
+      const events: ControlEvent[] = [];
+      fixture.componentInstance.form.events.subscribe((event) => events.push(event));
+      const parentEvents: ControlEvent[] = [];
+      parentForm.events.subscribe((event) => parentEvents.push(event));
+
+      formGroupDir.resetForm(undefined, {onlySelf: true});
+
+      expect(events.length).toBe(4);
+      expect(events[0]).toBeInstanceOf(TouchedChangeEvent);
+      expect(events[1]).toBeInstanceOf(ValueChangeEvent);
+      expect(events[2]).toBeInstanceOf(StatusChangeEvent);
+
+      // The event that matters
+      expect(events[3]).toBeInstanceOf(FormResetEvent);
+      expect(events[3].source).toBe(form);
+
+      // Self:false = parent won't receive the events
+      expect(parentEvents.length).toBe(0);
+
+      // Not only self
+      formGroupDir.resetForm({login: 'new value'});
+      expect(parentEvents.length).toBe(3);
+      expect(parentEvents[0]).toBeInstanceOf(TouchedChangeEvent);
+      expect(parentEvents[1]).toBeInstanceOf(ValueChangeEvent);
+      expect(parentEvents[2]).toBeInstanceOf(StatusChangeEvent);
+    });
+
     it('formControl should emit an event when submitting a form', () => {
       const fixture = initTest(FormGroupComp);
       const form = new FormGroup({'login': new FormControl('', Validators.required)});
