8000 feat(module:overlay): directive support disposeOnNavigation by wzhudev · Pull Request #18394 · angular/components · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat(module:overlay): directive support disposeOnNavigation #18394

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

Closed
wants to merge 1 commit into from
Closed

feat(module:overlay): directive support disposeOnNavigation #18394

Show file tree
Hide file tree
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
37 changes: 32 additions & 5 deletions src/cdk/overlay/overlay-directives.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import {Component, ElementRef, ViewChild} from '@angular/core';
import {Location} from '@angular/common';
import {SpyLocation} from '@angular/common/testing';
import {By} from '@angular/platform-browser';
import {
ComponentFixture,
Expand Down Expand Up @@ -36,6 +38,7 @@ describe('Overlay directives', () => {
let fixture: ComponentFixture<ConnectedOverlayDirectiveTest>;
let dir: {value: string};
let scrolledSubject = new Subject();
let mockLocation: SpyLocation;

beforeEach(() => {
TestBed.configureTestingModule({
Expand All @@ -49,6 +52,10 @@ describe('Overlay directives', () => {
scrolled: () => scrolledSubject,
}),
},
{
provide: Location,
useClass: SpyLocation,
},
],
});
});
Expand All @@ -58,10 +65,14 @@ describe('Overlay directives', () => {
fixture.detectChanges();
});

beforeEach(inject([OverlayContainer, Overlay], (oc: OverlayContainer, o: Overlay) => {
overlay = o;
overlayContainerElement = oc.getContainerElement();
}));
beforeEach(inject(
[OverlayContainer, Overlay, Location],
(oc: OverlayContainer, o: Overlay, l: Location) => {
overlay = o;
overlayContainerElement = oc.getContainerElement();
mockLocation = l as SpyLocation;
},
));

/** Returns the current open overlay pane element. */
function getPaneElement() {
Expand Down Expand Up @@ -383,6 +394,20 @@ describe('Overlay directives', () => {
expect(pane.style.transform).toContain('translateY(55px)');
});

it('should support dispose on navigation', () => {
const testComponent = fixture.componentInstance;

fixture.componentInstance.isOpen = true;
testComponent.disposeOnNavigation = true;
fixture.detectChanges();

expect(overlayContainerElement.textContent).toContain('Menu content');

mockLocation.simulateUrlPop('');
expect(overlayContainerElement.childNodes.length).toBe(0);
expect(overlayContainerElement.textContent).toBe('');
});

it('should be able to update the origin after init', () => {
const testComponent = fixture.componentInstance; 8000

Expand Down Expand Up @@ -723,7 +748,8 @@ describe('Overlay directives', () => {
[cdkConnectedOverlayMinWidth]="minWidth"
[cdkConnectedOverlayMinHeight]="minHeight"
[cdkConnectedOverlayPositions]="positionOverrides"
[cdkConnectedOverlayTransformOriginOn]="transformOriginSelector">
[cdkConnectedOverlayTransformOriginOn]="transformOriginSelector"
[cdkConnectedOverlayDisposeOnNavigation]="disposeOnNavigation">
<p>Menu content</p>
</ng-template>`,
})
Expand Down Expand Up @@ -760,6 +786,7 @@ class ConnectedOverlayDirectiveTest {
detachHandler = jasmine.createSpy('detachHandler');
attachResult: HTMLElement;
transformOriginSelector: string;
disposeOnNavigation = false;
}

@Component({
Expand Down
13 changes: 13 additions & 0 deletions src/cdk/overlay/overlay-directives.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ export class CdkConnectedOverlay implements OnDestroy, OnChanges {
private _offsetY: number;
private _position: FlexibleConnectedPositionStrategy;
private _scrollStrategyFactory: () => ScrollStrategy;
private _disposeOnNavigation = false;

/** Origin for the connected overlay. */
@Input('cdkConnectedOverlayOrigin')
Expand Down Expand Up @@ -228,6 +229,17 @@ export class CdkConnectedOverlay implements OnDestroy, OnChanges {
this._push = coerceBooleanProperty(value);
}

/**
* Whether the overlay should be disposed of when the user goes backwards/forwards in history.
*/
@Input('cdkConnectedOverlayDisposeOnNavigation')
get disposeOnNavigation(): boolean {
return this._disposeOnNavigation;
}
set disposeOnNavigation(value: boolean) {
this._disposeOnNavigation = coerceBooleanProperty(value);
}

/** Event emitted when the backdrop is clicked. */
@Output() readonly backdropClick = new EventEmitter<MouseEvent>();

Expand Down Expand Up @@ -333,6 +345,7 @@ export class CdkConnectedOverlay implements OnDestroy, OnChanges {
positionStrategy,
scrollStrategy: this.scrollStrategy,
hasBackdrop: this.hasBackdrop,
disposeOnNavigation: this.disposeOnNavigation,
});

if (this.width || this.width === 0) {
Expand Down
4 changes: 3 additions & 1 deletion tools/public_api_guard/cdk/overlay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ export class CdkConnectedOverlay implements OnDestroy, OnChanges {
readonly detach: EventEmitter<void>;
get dir(): Direction;
disableClose: boolean;
get disposeOnNavigation(): boolean;
set disposeOnNavigation(value: boolean);
get flexibleDimensions(): boolean;
set flexibleDimensions(value: BooleanInput);
get growAfterOpen(): boolean;
Expand Down Expand Up @@ -102,7 +104,7 @@ export class CdkConnectedOverlay implements OnDestroy, OnChanges {
viewportMargin: number;
width: number | string;
// (undocumented)
static ɵdir: i0.ɵɵDirectiveDeclaration<CdkConnectedOverlay, "[cdk-connected-overlay], [connected-overlay], [cdkConnectedOverlay]", ["cdkConnectedOverlay"], { "origin": "cdkConnectedOverlayOrigin"; "positions": "cdkConnectedOverlayPositions"; "positionStrategy": "cdkConnectedOverlayPositionStrategy"; "offsetX": "cdkConnectedOverlayOffsetX"; "offsetY": "cdkConnectedOverlayOffsetY"; "width": "cdkConnectedOverlayWidth"; "height": "cdkConnectedOverlayHeight"; "minWidth": "cdkConnectedOverlayMinWidth"; "minHeight": "cdkConnectedOverlayMinHeight"; "backdropClass": "cdkConnectedOverlayBackdropClass"; "panelClass": "cdkConnectedOverlayPanelClass"; "viewportMargin": "cdkConnectedOverlayViewportMargin"; "scrollStrategy": "cdkConnectedOverlayScrollStrategy"; "open": "cdkConnectedOverlayOpen"; "disableClose": "cdkConnectedOverlayDisableClose"; "transformOriginSelector": "cdkConnectedOverlayTransformOriginOn"; "hasBackdrop": "cdkConnectedOverlayHasBackdrop"; "lockPosition": "cdkConnectedOverlayLockPosition"; "flexibleDimensions": "cdkConnectedOverlayFlexibleDimensions"; "growAfterOpen": "cdkConnectedOverlayGrowAfterOpen"; "push": "cdkConnectedOverlayPush"; }, { "backdropClick": "backdropClick"; "positionChange": "positionChange"; "attach": "attach"; "detach": "detach"; "overlayKeydown": "overlayKeydown"; "overlayOutsideClick": "overlayOutsideClick"; }, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<CdkConnectedOverlay, "[cdk-connected-overlay], [connected-overlay], [cdkConnectedOverlay]", ["cdkConnectedOverlay"], { "origin": "cdkConnectedOverlayOrigin"; "positions": "cdkConnectedOverlayPositions"; "positionStrategy": "cdkConnectedOverlayPositionStrategy"; "offsetX": "cdkConnectedOverlayOffsetX"; "offsetY": "cdkConnectedOverlayOffsetY"; "width": "cdkConnectedOverlayWidth"; "height": "cdkConnectedOverlayHeight"; "minWidth": "cdkConnectedOverlayMinWidth"; "minHeight": "cdkConnectedOverlayMinHeight"; "backdropClass": "cdkConnectedOverlayBackdropClass"; "panelClass": "cdkConnectedOverlayPanelClass"; "viewportMargin": "cdkConnectedOverlayViewportMargin"; "scrollStrategy": "cdkConnectedOverlayScrollStrategy"; "open": "cdkConnectedOverlayOpen"; "disableClose": "cdkConnectedOverlayDisableClose"; "transformOriginSelector": "cdkConnectedOverlayTransformOriginOn"; "hasBackdrop": "cdkConnectedOverlayHasBackdrop"; "lockPosition": "cdkConnectedOverlayLockPosition"; "flexibleDimensions": "cdkConnectedOverlayFlexibleDimensions"; "growAfterOpen": "cdkConnectedOverlayGrowAfterOpen"; "push": "cdkConnectedOverlayPush"; "disposeOnNavigation": "cdkConnectedOverlayDisposeOnNavigation"; }, { "backdropClick": "backdropClick"; "positionChange": "positionChange"; "attach": "attach"; "detach": "detach"; "overlayKeydown": "overlayKeydown"; "overlayOutsideClick": "overlayOutsideClick"; }, never>;
// (undocumented)
static ɵfac: i0.ɵɵFactoryDeclaration<CdkConnectedOverlay, [null, null, null, null, { optional: true; }]>;
}
Expand Down
0