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.

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

fix(tooltip): wrong position when using OnPush change detection #3671

Merged
merged 3 commits into from
Apr 11, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 11 additions & 2 deletions src/lib/tooltip/tooltip.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ describe('MdTooltip', () => {
imports: [MdTooltipModule.forRoot(), OverlayModule],
declarations: [BasicTooltipDemo, ScrollableTooltipDemo, OnPushTooltipDemo],
providers: [
Platform,
{provide: Platform, useValue: {IOS: false}},
{provide: OverlayContainer, useFactory: () => {
overlayContainerElement = document.createElement('div');
document.body.appendChild(overlayContainerElement);
Expand Down Expand Up @@ -410,7 +410,7 @@ describe('MdTooltip', () => {

fixture.detectChanges();

// wait till animation has finished
// wait until animation has finished
tick(500);

// Make sure tooltip is shown to the user and animation has finished
Expand All @@ -432,6 +432,15 @@ describe('MdTooltip', () => {
flushMicrotasks();
expect(tooltipDirective._tooltipInstance).toBeNull();
}));

it('should have rendered the tooltip text on init', fakeAsync(() => {
dispatchFakeEvent(buttonElement, 'mouseenter');
fixture.detectChanges();
tick(0);

const tooltipElement = overlayContainerElement.querySelector('.mat-tooltip') as HTMLElement;
expect(tooltipElement.textContent).toContain('initial tooltip message');
}));
Copy link
Member

Choose a reason for hiding this comment

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

Does there need to be a test component w/ OnPush that would have exhibited the original behavior?

Copy link
Member Author

@crisbeto crisbeto Mar 25, 2017

Choose a reason for hiding this comment

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

});

describe('destroy', () => {
Expand Down
25 changes: 18 additions & 7 deletions src/lib/tooltip/tooltip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
OnDestroy,
Renderer,
OnInit,
ChangeDetectorRef
ChangeDetectorRef,
} from '@angular/core';
import {
Overlay,
Expand Down Expand Up @@ -155,7 +155,7 @@ export class MdTooltip implements OnInit, OnDestroy {
@Optional() private _dir: Dir) {

// The mouse events shouldn't be bound on iOS devices, because
// they can prevent the first tap from firing it's click event.
// they can prevent the first tap from firing its click event.
if (!_platform.IOS) {
_renderer.listen(_elementRef.nativeElement, 'mouseenter', () => this.show());
_renderer.listen(_elementRef.nativeElement, 'mouseleave', () => this.hide());
Expand Down Expand Up @@ -311,6 +311,8 @@ export class MdTooltip implements OnInit, OnDestroy {
// Must wait for the message to be painted to the tooltip so that the overlay can properly
// calculate the correct positioning based on the size of the text.
this._tooltipInstance.message = message;
this._tooltipInstance._markForCheck();

this._ngZone.onMicrotaskEmpty.first().subscribe(() => {
if (this._tooltipInstance) {
this._overlayRef.updatePosition();
Expand Down Expand Up @@ -392,8 +394,8 @@ export class TooltipComponent {

// Mark for check so if any parent component has set the
// ChangeDetectionStrategy to OnPush it will be checked anyways
this._changeDetectorRef.markForCheck();
setTimeout(() => { this._closeOnInteraction = true; }, 0);
this._markForCheck();
setTimeout(() => this._closeOnInteraction = true, 0);
}, delay);
}

Expand All @@ -413,7 +415,7 @@ export class TooltipComponent {

// Mark for check so if any parent component has set the
// ChangeDetectionStrategy to OnPush it will be checked anyways
this._changeDetectorRef.markForCheck();
this._markForCheck();
}, delay);
}

Expand All @@ -439,8 +441,8 @@ export class TooltipComponent {
case 'after': this._transformOrigin = isLtr ? 'left' : 'right'; break;
case 'left': this._transformOrigin = 'right'; break;
case 'right': this._transformOrigin = 'left'; break;
case 'above': this._transformOrigin = 'bottom'; break;
case 'below': this._transformOrigin = 'top'; break;
case 'above': this._transformOrigin = 'bottom'; break;
case 'below': this._transformOrigin = 'top'; break;
default: throw new MdTooltipInvalidPositionError(value);
}
}
Expand All @@ -461,4 +463,13 @@ export class TooltipComponent {
this.hide(0);
}
}

/**
* Marks that the tooltip needs to be checked in the next change detection run.
* Mainly used for rendering the initial text before positioning a tooltip, which
* can be problematic in components with OnPush change detection.
*/
_markForCheck(): void {
this._changeDetectorRef.markForCheck();
}
}