fix(material/autocomplete): not closing when clicking outside while propagation is stopped

Fixes the autocomplete panel not closing if the user clicks outside on an element that
stops propagation of the `click` event (e.g. a `mat-chip`).

Fixes #17352.

Author: crisbeto

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

@@ -208,6 +208,20 @@ describe('MDC-based MatAutocomplete', () => {
         .toEqual('');
     }));
 
+    it('should close the panel when clicking away and propagation is stopped', fakeAsync(() => {
+      const trigger = fixture.componentInstance.trigger;
+      dispatchFakeEvent(input, 'focusin');
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(trigger.panelOpen).toBe(true, 'Expected panel to be open.');
+
+      fixture.nativeElement.querySelector('.stop-propagation').click();
+      fixture.detectChanges();
+
+      expect(trigger.panelOpen).toBe(false, 'Expected panel to be closed.');
+    }));
+
     it('should close the panel when the user taps away on a touch device', fakeAsync(() => {
       dispatchFakeEvent(input, 'focus');
       fixture.detectChanges();
@@ -3374,6 +3388,8 @@ const SIMPLE_AUTOCOMPLETE_TEMPLATE = `
       <span>{{ state.code }}: {{ state.name }}</span>
     </mat-option>
   </mat-autocomplete>
+
+  <button class="stop-propagation" (click)="$event.stopPropagation()">Click me</button>
 `;
 
 @Component({template: SIMPLE_AUTOCOMPLETE_TEMPLATE})

src/material/autocomplete/autocomplete-trigger.ts

@@ -349,10 +349,12 @@ export abstract class _MatAutocompleteTriggerBase
 
   /** Stream of clicks outside of the autocomplete panel. */
   private _getOutsideClickStream(): Observable<any> {
+    // Use capturing so we can close even if propagation is stopped.
+    const eventOptions = {capture: true};
     return merge(
-      fromEvent(this._document, 'click') as Observable<MouseEvent>,
-      fromEvent(this._document, 'auxclick') as Observable<MouseEvent>,
-      fromEvent(this._document, 'touchend') as Observable<TouchEvent>,
+      fromEvent(this._document, 'click', eventOptions) as Observable<MouseEvent>,
+      fromEvent(this._document, 'auxclick', eventOptions) as Observable<MouseEvent>,
+      fromEvent(this._document, 'touchend', eventOptions) as Observable<TouchEvent>,
     ).pipe(
       filter(event => {
         // If we're in the Shadow DOM, the event target will be the shadow root, so we have to

src/material/autocomplete/autocomplete.spec.ts

@@ -210,6 +210,20 @@ describe('MatAutocomplete', () => {
         .toEqual('');
     }));
 
+    it('should close the panel when clicking away and propagation is stopped', fakeAsync(() => {
+      const trigger = fixture.componentInstance.trigger;
+      dispatchFakeEvent(input, 'focusin');
+      fixture.detectChanges();
+      zone.simulateZoneExit();
+
+      expect(trigger.panelOpen).toBe(true, 'Expected panel to be open.');
+
+      fixture.nativeElement.querySelector('.stop-propagation').click();
+      fixture.detectChanges();
+
+      expect(trigger.panelOpen).toBe(false, 'Expected panel to be closed.');
+    }));
+
     it('should close the panel when the user taps away on a touch device', fakeAsync(() => {
       dispatchFakeEvent(input, 'focus');
       fixture.detectChanges();
@@ -3379,6 +3393,8 @@ const SIMPLE_AUTOCOMPLETE_TEMPLATE = `
       <span>{{ state.code }}: {{ state.name }}</span>
     </mat-option>
   </mat-autocomplete>
+
+  <button class="stop-propagation" (click)="$event.stopPropagation()">Click me</button>
 `;
 
 @Component({template: SIMPLE_AUTOCOMPLETE_TEMPLATE})