Skip to content

fix(dialog): backdrop not being removed if it doesn't have transitions #1716

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

Merged
merged 2 commits into from
Nov 11, 2016
Merged

fix(dialog): backdrop not being removed if it doesn't have transitions #1716

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
714a91a
fix(dialog): backdrop not being removed if it doesn't have transitions
crisbeto Nov 3, 2016
236abc3
Add a unit test for the `pointer-events` behavior and rename the deta…
crisbeto Nov 11, 2016
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
24 changes: 18 additions & 6 deletions src/lib/core/overlay/overlay-ref.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ export class OverlayRef implements PortalHost {

// Add class to fade-in the backdrop after one frame.
requestAnimationFrame(() => {
this._backdropElement.classList.add('md-overlay-backdrop-showing');
if (this._backdropElement) {
this._backdropElement.classList.add('md-overlay-backdrop-showing');
}
});
}

Expand All @@ -101,18 +103,28 @@ export class OverlayRef implements PortalHost {
let backdropToDetach = this._backdropElement;

if (backdropToDetach) {
backdropToDetach.classList.remove('md-overlay-backdrop-showing');
backdropToDetach.classList.remove(this._state.backdropClass);
backdropToDetach.addEventListener('transitionend', () => {
backdropToDetach.parentNode.removeChild(backdropToDetach);
let onTransitionEnd = () => {
Copy link
Member

@jelbourn jelbourn Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this can be used in two ways now, we should rename it to something like finishDetach

// It may not be attached to anything in certain cases (e.g. unit tests).
if (backdropToDetach && backdropToDetach.parentNode) {
backdropToDetach.parentNode.removeChild(backdropToDetach);
}

// It is possible that a new portal has been attached to this overlay since we started
// removing the backdrop. If that is the case, only clear the backdrop reference if it
// is still the same instance that we started to remove.
if (this._backdropElement == backdropToDetach) {
this._backdropElement = null;
}
});
};

backdropToDetach.classList.remove('md-overlay-backdrop-showing');
backdropToDetach.classList.remove(this._state.backdropClass);
Copy link
Member

@jelbourn jelbourn Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to remove the backdropClass? Wouldn't this potentially cause the backdrop to appear in cases where we use the class to hide it?

Copy link
Member Author

@crisbeto crisbeto Nov 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's the custom class that can be added to the backdrop. It has been handled like that since 0b54668, I only moved it around.

backdropToDetach.addEventListener('transitionend', onTransitionEnd);

// If the backdrop doesn't have a transition, the `transitionend` event won't fire.
// In this case we make it unclickable and we try to remove it after a delay.
backdropToDetach.style.pointerEvents = 'none';
Copy link
Member

@jelbourn jelbourn Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need unit test to assert that pointerEvents is set.

setTimeout(onTransitionEnd, 500);
Copy link

@rolandjitsu rolandjitsu Nov 10, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if timeouts are reliable. What if at some point the transition timing is changed?

Copy link
Member Author

@crisbeto crisbeto Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I initially opened the PR, it was using getComputedStyle, however it can cause performance issues in some slower browsers.

Copy link
Member Author

@crisbeto crisbeto Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, forgot to mention that it would probably make more sense to switch this over to Angular's animation API. This fix should suffice for now, though.

Copy link

@rolandjitsu rolandjitsu Nov 10, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wanted to point out that there might be a better way of handling this, but if this can make it to the next alpha I guess it works 👍

}
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/lib/dialog/dialog.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
flushMicrotasks,
ComponentFixture,
TestBed,
tick,
} from '@angular/core/testing';
import {By} from '@angular/platform-browser';
import {NgModule, Component, Directive, ViewChild, ViewContainerRef} from '@angular/core';
Expand Down Expand Up @@ -207,6 +208,7 @@ describe('MdDialog', () => {
.not.toBe('dialog-trigger', 'Expected the focus to change when dialog was opened.');

dialogRef.close();
tick(500);
viewContainerFixture.detectChanges();
flushMicrotasks();

Expand Down