fix(material/autocomplete): mark control as touched once panel is closed

Currently we mark the autocomplete control as touched on `blur`. The problem is that the `blur` event happens a split second before the panel is closed which can cause the error styling to show up and disappear quickly which looks glitchy. These changes change it so that the control is marked as touched once the panel is closed.

Also makes a couple of underscored properties private since they weren't used anywhere in the view.

Fixes #18313.

Author: crisbeto

src/material-experimental/mdc-autocomplete/autocomplete-trigger.ts

@@ -38,7 +38,7 @@ export const MAT_AUTOCOMPLETE_VALUE_ACCESSOR: any = {
     // Note: we use `focusin`, as opposed to `focus`, in order to open the panel
     // a little earlier. This avoids issues where IE delays the focusing of the input.
     '(focusin)': '_handleFocus()',
-    '(blur)': '_onTouched()',
+    '(blur)': '_handleBlur()',
     '(input)': '_handleInput($event)',
     '(keydown)': '_handleKeydown($event)',
   },

src/material-experimental/mdc-autocomplete/autocomplete.spec.ts

@@ -892,8 +892,6 @@ describe('MDC-based MatAutocomplete', () => {
     });
 
     it('should mark the autocomplete control as touched on blur', () => {
-      fixture.componentInstance.trigger.openPanel();
-      fixture.detectChanges();
       expect(fixture.componentInstance.stateCtrl.touched)
         .withContext(`Expected control to start out untouched.`)
         .toBe(false);
@@ -906,6 +904,67 @@ describe('MDC-based MatAutocomplete', () => {
         .toBe(true);
     });
 
+    it('should mark the autocomplete control as touched when the panel is closed via the keyboard', fakeAsync(() => {
+      fixture.componentInstance.trigger.openPanel();
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(fixture.componentInstance.stateCtrl.touched).toBe(
+        false,
+        `Expected control to start out untouched.`,
+      );
+
+      dispatchKeyboardEvent(input, 'keydown', TAB);
+      fixture.detectChanges();
+
+      expect(fixture.componentInstance.stateCtrl.touched).toBe(
+        true,
+        `Expected control to become touched on blur.`,
+      );
+    }));
+
+    it('should mark the autocomplete control as touched when the panel is closed by clicking away', fakeAsync(() => {
+      fixture.componentInstance.trigger.openPanel();
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(fixture.componentInstance.stateCtrl.touched).toBe(
+        false,
+        `Expected control to start out untouched.`,
+      );
+
+      dispatchFakeEvent(document, 'click');
+      fixture.detectChanges();
+
+      expect(fixture.componentInstance.stateCtrl.touched).toBe(
+        true,
+        `Expected control to become touched on blur.`,
+      );
+    }));
+
+    it(
+      'should not mark the autocomplete control as touched when the panel is closed ' +
+        'programmatically',
+      fakeAsync(() => {
+        fixture.componentInstance.trigger.openPanel();
+        fixture.detectChanges();
+        zone.simulateZoneExit();
+
+        expect(fixture.componentInstance.stateCtrl.touched).toBe(
+          false,
+          `Expected control to start out untouched.`,
+        );
+
+        fixture.componentInstance.trigger.closePanel();
+        fixture.detectChanges();
+
+        expect(fixture.componentInstance.stateCtrl.touched).toBe(
+          false,
+          `Expected control to stay untouched.`,
+        );
+      }),
+    );
+
     it('should disable the input when used with a value accessor and without `matInput`', () => {
       fixture.destroy();
       TestBed.resetTestingModule();

src/material/autocomplete/autocomplete-trigger.ts

@@ -454,6 +454,12 @@ export abstract class _MatAutocompleteTriggerBase
     }
   }
 
+  _handleBlur() {
+    if (!this.panelOpen) {
+      this._onTouched();
+    }
+  }
+
   /**
    * In "auto" mode, the label will animate down as soon as focus is lost.
    * This causes the value to jump when selecting an option with the mouse.
@@ -573,6 +579,7 @@ export abstract class _MatAutocompleteTriggerBase
     }
 
     this.closePanel();
+    this._onTouched();
   }
 
   /**
@@ -797,8 +804,8 @@ export abstract class _MatAutocompleteTriggerBase
     // Note: we use `focusin`, as opposed to `focus`, in order to open the panel
     // a little earlier. This avoids issues where IE delays the focusing of the input.
     '(focusin)': '_handleFocus()',
-    '(blur)': '_onTouched()',
     '(input)': '_handleInput($event)',
+    '(blur)': '_handleBlur()',
     '(keydown)': '_handleKeydown($event)',
   },
   exportAs: 'matAutocompleteTrigger',

src/material/autocomplete/autocomplete.spec.ts

@@ -887,8 +887,6 @@ describe('MatAutocomplete', () => {
     });
 
     it('should mark the autocomplete control as touched on blur', () => {
-      fixture.componentInstance.trigger.openPanel();
-      fixture.detectChanges();
       expect(fixture.componentInstance.stateCtrl.touched)
         .withContext(`Expected control to start out untouched.`)
         .toBe(false);
@@ -901,6 +899,63 @@ describe('MatAutocomplete', () => {
         .toBe(true);
     });
 
+    it('should mark the autocomplete control as touched when the panel is closed via the keyboard', fakeAsync(() => {
+      fixture.componentInstance.trigger.openPanel();
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(fixture.componentInstance.stateCtrl.touched)
+        .withContext(`Expected control to start out untouched.`)
+        .toBe(false);
+
+      dispatchKeyboardEvent(input, 'keydown', TAB);
+      fixture.detectChanges();
+
+      expect(fixture.componentInstance.stateCtrl.touched)
+        .withContext(`Expected control to become touched on blur.`)
+        .toBe(true);
+    }));
+
+    it('should mark the autocomplete control as touched when the panel is closed by clicking away', fakeAsync(() => {
+      fixture.componentInstance.trigger.openPanel();
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(fixture.componentInstance.stateCtrl.touched)
+        .withContext(`Expected control to start out untouched.`)
+        .toBe(false);
+
+      dispatchFakeEvent(document, 'click');
+      fixture.detectChanges();
+
+      expect(fixture.componentInstance.stateCtrl.touched)
+        .withContext(`Expected control to become touched on blur.`)
+        .toBe(true);
+    }));
+
+    it(
+      'should not mark the autocomplete control as touched when the panel is closed ' +
+        'programmatically',
+      fakeAsync(() => {
+        fixture.componentInstance.trigger.openPanel();
+        fixture.detectChanges();
+        zone.simulateZoneExit();
+
+        expect(fixture.componentInstance.stateCtrl.touched).toBe(
+          false,
+          `Expected control to start out untouched.`,
+        );
+
+        fixture.componentInstance.trigger.closePanel();
+        fixture.detectChanges();
+
+        expect(fixture.componentInstance.stateCtrl.touched).toBe(
+          false,
+          `Expected control to stay untouched.`,
+        );
+      }),
+    );
+
     it('should disable the input when used with a value accessor and without `matInput`', () => {
       overlayContainer.ngOnDestroy();
       fixture.destroy();

tools/public_api_guard/material/autocomplete.md

@@ -198,6 +198,8 @@ export abstract class _MatAutocompleteTriggerBase implements ControlValueAccesso
     closePanel(): void;
     connectedTo: _MatAutocompleteOriginBase;
     // (undocumented)
+    _handleBlur(): void;
+    // (undocumented)
     _handleFocus(): void;
     // (undocumented)
     _handleInput(event: KeyboardEvent): void;