Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(material/snack-bar): switch from afterRender to afterNextRender #30711

Merged
merged 1 commit into from
Mar 27, 2025
Merged

refactor(material/snack-bar): switch from afterRender to afterNextRender #30711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 27 additions & 30 deletions src/material/snack-bar/snack-bar-container.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,34 @@
* found in the LICENSE file at https://angular.dev/license
*/

import {_IdGenerator, AriaLivePoliteness} from '@angular/cdk/a11y';
import {Platform} from '@angular/cdk/platform';
import {
BasePortalOutlet,
CdkPortalOutlet,
ComponentPortal,
DomPortal,
TemplatePortal,
} from '@angular/cdk/portal';
import {DOCUMENT} from '@angular/common';
import {
afterRender,
AfterRenderRef,
afterNextRender,
ChangeDetectionStrategy,
ChangeDetectorRef,
Component,
ComponentRef,
ElementRef,
EmbeddedViewRef,
inject,
Injector,
NgZone,
OnDestroy,
ViewChild,
ViewEncapsulation,
} from '@angular/core';
import {DOCUMENT} from '@angular/common';
import {
BasePortalOutlet,
CdkPortalOutlet,
ComponentPortal,
DomPortal,
TemplatePortal,
} from '@angular/cdk/portal';
import {Observable, Subject, of} from 'rxjs';
import {_IdGenerator, AriaLivePoliteness} from '@angular/cdk/a11y';
import {Platform} from '@angular/cdk/platform';
import {MatSnackBarConfig} from './snack-bar-config';
import {take} from 'rxjs/operators';
import {Observable, of, Subject} from 'rxjs';
import {_animationsDisabled} from '../core';
import {MatSnackBarConfig} from './snack-bar-config';

const ENTER_ANIMATION = '_mat-snack-bar-enter';
const EXIT_ANIMATION = '_mat-snack-bar-exit';
Expand Down Expand Up @@ -68,15 +67,14 @@ export class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy
private _elementRef = inject<ElementRef<HTMLElement>>(ElementRef);
private _changeDetectorRef = inject(ChangeDetectorRef);
private _platform = inject(Platform);
private _rendersRef: AfterRenderRef;
protected _animationsDisabled = _animationsDisabled();
snackBarConfig = inject(MatSnackBarConfig);

private _document = inject(DOCUMENT);
private _trackedModals = new Set<Element>();
private _enterFallback: ReturnType<typeof setTimeout> | undefined;
private _exitFallback: ReturnType<typeof setTimeout> | undefined;
private _renders = new Subject<void>();
private _injector = inject(Injector);

/** The number of milliseconds to wait before announcing the snack bar's content. */
private readonly _announceDelay: number = 150;
Expand Down Expand Up @@ -147,11 +145,6 @@ export class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy
this._role = 'alert';
}
}

// Note: ideally we'd just do an `afterNextRender` in the places where we need to delay
// something, however in some cases (TestBed teardown) the injector can be destroyed at an
// unexpected time, causing the `afterRender` to fail.
this._rendersRef = afterRender(() => this._renders.next(), {manualCleanup: true});
}

/** Attach a component portal as content to this snack bar container. */
Expand Down Expand Up @@ -206,9 +199,12 @@ export class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy
this._screenReaderAnnounce();

if (this._animationsDisabled) {
this._renders.pipe(take(1)).subscribe(() => {
this._ngZone.run(() => queueMicrotask(() => this.onAnimationEnd(ENTER_ANIMATION)));
});
afterNextRender(
() => {
this._ngZone.run(() => queueMicrotask(() => this.onAnimationEnd(ENTER_ANIMATION)));
},
{injector: this._injector},
);
} else {
clearTimeout(this._enterFallback);
this._enterFallback = setTimeout(() => {
Expand Down Expand Up @@ -246,9 +242,12 @@ export class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy
clearTimeout(this._announceTimeoutId);

if (this._animationsDisabled) {
this._renders.pipe(take(1)).subscribe(() => {
this._ngZone.run(() => queueMicrotask(() => this.onAnimationEnd(EXIT_ANIMATION)));
});
afterNextRender(
() => {
this._ngZone.run(() => queueMicrotask(() => this.onAnimationEnd(EXIT_ANIMATION)));
},
{injector: this._injector},
);
} else {
clearTimeout(this._exitFallback);
this._exitFallback = setTimeout(() => this.onAnimationEnd(EXIT_ANIMATION), 200);
Expand All @@ -263,8 +262,6 @@ export class MatSnackBarContainer extends BasePortalOutlet implements OnDestroy
this._destroyed = true;
this._clearFromModals();
this._completeExit();
this._renders.complete();
this._rendersRef.destroy();
}

private _completeExit() {
Expand Down
Loading