bug(overlay): backdrop click and `open` input stop closing cdkConnectedOverlay once the host view is detached (only Escape still works)
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 48/100
- Issue-Typ
- Bug
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- angular, typescript
- Bereich
- frontend
Rechercherichtung
Beginne mit der verknüpften StackBlitz-Reproduktion und konzentriere dich auf den Ablauf von RouteReuseStrategy und ViewContainerRef.detach(). Untersuche anschließend CdkConnectedOverlay in @angular/cdk, einschließlich des in dem Bericht beschriebenen Verhaltens von _overlay-module-chunk.mjs; abgeschlossen ist die Aufgabe, wenn Klicks auf den Hintergrund und die Eingabe open das Overlay schließen, nachdem die Host-View getrennt wurde, wie es bei Escape bereits der Fall ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Is this a regression?
- Yes, this behavior used to work in the previous version
The previous version in which this bug was not present was
No response
Description
When a component that hosts a cdkConnectedOverlay is detached (not destroyed) from the view tree while its overlay is open — for example via ViewContainerRef.detach(), which is exactly what RouterOutlet.detach() does when a RouteReuseStrategy.shouldDetach() returns true — the overlay becomes permanently stuck open and unresponsive to two of the three interactions users expect to close it with:
- Clicking the backdrop does not close the overlay.
- Programmatically setting the bound
[cdkConnectedOverlayOpen]input back tofalse(through any means — a signal, anasyncpipe, an explicitChangeDetectorRef.detectChanges()call) does not close the overlay. - Only pressing Escape closes the overlay.
Reading @angular/cdk source (_overlay-module-chunk.mjs), CdkConnectedOverlay only reacts to its [cdkConnectedOverlayOpen] input through the ngOnChanges lifecycle hook:
// CdkConnectedOverlay
ngOnChanges(changes) {
...
if (changes['open']) {
this.open ? this.attachOverlay() : this.detachOverlay();
}
}
ngOnChanges only runs when Angular's change detector actually visits the component's view. If that view has been detached from its view container (ViewContainerRef.detach()), Angular's CD walk no longer reaches it — so ngOnChanges never fires again, no matter how the open input is set afterward, including explicit, direct ChangeDetectorRef.detectChanges() calls on that specific component instance.
Meanwhile, the overlay's DOM (backdrop + panel) is portaled into a global overlay container appended to <body>, entirely outside the detached view's own DOM subtree. So the rendered overlay persists on screen even though the logical component that owns it is no longer part of the CD tree.
By contrast, the Escape key path bypasses the open input entirely:
// CdkConnectedOverlay._createOverlay()
overlayRef.keydownEvents().subscribe(event => {
this.overlayKeydown.next(event);
if (event.keyCode === ESCAPE && !this.disableClose && !hasModifierKey(event)) {
event.preventDefault();
this.detachOverlay(); // called directly on the OverlayRef/directive, not through the `open` input
}
});
This is a plain RxJS subscription held by the OverlayRef/CdkConnectedOverlay instance, so it keeps firing and calling detachOverlay() imperatively regardless of whether the host view is currently attached to the CD tree. This is why Escape is the only interaction that still works — it is the only one that doesn't route through ngOnChanges.
The backdrop-click path (OverlayOutsideClickDispatcher) is architecturally similar to Escape — it's a global document-level listener, independent of CD — but it only emits an outsidePointerEvents/backdropClick event. It is the consuming component's responsibility to react to that event by flipping its own open state, and that round-trip through the open input is exactly the mechanism that silently no-ops once the host view is detached. So backdrop click is detected, but has no observable effect.
RouteReuseStrategy and ViewContainerRef.detach() are public, documented Angular Router APIs — not an edge case or misuse. Any component built the idiomatic Angular way — driving overlay visibility through a bound @Input/signal rather than imperative OverlayRef calls — is exposed to this the moment it's used on a route that gets detached rather than destroyed. This affects CdkConnectedOverlay directly, and by extension anything built on top of it that follows the same input-driven-open pattern (custom menus, custom autocompletes, custom popovers, etc.).
The fact that Escape already has a CD-independent close path, while backdrop click and the open input do not, suggests this asymmetry is an oversight rather than an intentional design choice.
Suggested directions (not prescriptive):
- Give
CdkConnectedOverlay/OverlayRefa way to close in response to the host view being detached from change detection, mirroring the existingngOnDestroyhandling — e.g. reacting toViewRefdetachment, not onlyngOnChanges. - At minimum, make backdrop click behave like Escape: call
detachOverlay()directly on theOverlayRefinstance when a backdrop click is detected, rather than only emitting an event and relying on the host'sopeninput to round-trip back throughngOnChanges. - Document explicitly that
CdkConnectedOverlay-based components must not be detached (only destroyed) while their overlay is open, if a code-level fix is not pursued.
Reproduction
StackBlitz link: CDK overlay
Steps to reproduce:
- Open the StackBlitz above. It's a routed app with two routes,
/aand/b, using aRouteReuseStrategywhoseshouldDetach()always returnstrue(i.e.ViewContainerRef.detach()is called on navigation instead of destroying the component — a supported, documented use ofRouteReuseStrategy, commonly used to preserve scroll position, form state, or tab state across navigations). - On Page A, click "Go to Page B (in 5s)". This intentionally delays the actual navigation by 5 seconds (
setTimeout) — a test aid, not part of the bug — so there's a window to still interact with Page A before it's detached. - During that 5-second window, while still on Page A, click "Open overlay". A panel with a backdrop appears.
- Wait for the 5 seconds to elapse. Navigation to Page B happens and Page A's view is detached (kept alive, not destroyed) with the overlay still open.
- Try clicking the backdrop, or the "Close" button inside the overlay panel.
- Observe: nothing happens — the backdrop and panel are still visible on top of Page B and still block interaction with it.
- Press Escape: the overlay closes immediately.
Steps 5–6 are the bug: backdrop click and the in-app "Close" button (both driven by the same open input) silently do nothing once Page A's view has been detached, while Escape (step 7) still works.
Expected Behavior
The overlay should close consistently regardless of which interaction is used, and regardless of whether the host component's view happens to currently be receiving change detection.
Actual Behavior
Backdrop click and the open input binding silently do nothing once the host view is detached from the CD tree. Escape is the only interaction that still closes the overlay.
Environment
- Angular: 22.0.8
- CDK/Material: 22.0.2
- Browser(s): Chrome (latest)
- Operating System: macOS
- Vorherrschende Sprache
- TypeScript
- Sterne
- 25k
- Forks
- 6.8k
- Ø Merge
- 1 T. 1 Std.
- Gemergte PRs (30 T.)
- 84
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus angular/components
-
area: material/tree docs gemini-triaged needs triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
angular/components#33832 ·
-
area: material/datepicker gemini-triaged P4
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
angular/components#33763 · 2 Kommentare · 3 Reaktionen ·
-
area: material/table gemini-triaged P4
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
angular/components#33709 · 1 Kommentar ·
-
area: material/table docs gemini-triaged P4
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
angular/components#33455 ·
-
area: material/core gemini-triaged P3
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
angular/components#33059 · 2 Kommentare ·
Alle Issues in angular/components
Ähnliche Issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
-
Crush Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
ElementsProject/cln-application#167 · 1 Kommentar · 1 Reaktion ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Quantco/pnpm-licenses#17 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100