Skip to content

fix(tooltip): not working properly with ChangeDetectionStrategy.OnPush #2721

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

Merged
merged 4 commits into from
Jan 31, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
3 changes: 2 additions & 1 deletion src/demo-app/tooltip/tooltip-demo.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {Component} from '@angular/core';
import {Component, ChangeDetectionStrategy} from '@angular/core';
import {TooltipPosition} from '@angular/material';


Expand All @@ -7,6 +7,7 @@ import {TooltipPosition} from '@angular/material';
selector: 'tooltip-demo',
templateUrl: 'tooltip-demo.html',
styleUrls: ['tooltip-demo.css'],
changeDetection: ChangeDetectionStrategy.OnPush // make sure tooltip also works OnPush
})
export class TooltipDemo {
position: TooltipPosition = 'below';
Expand Down
13 changes: 11 additions & 2 deletions src/lib/tooltip/tooltip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import {
AnimationTransitionEvent,
NgZone,
Optional,
OnDestroy
OnDestroy,
ChangeDetectorRef
} from '@angular/core';
import {
Overlay,
Expand Down Expand Up @@ -286,7 +287,7 @@ export class TooltipComponent {
/** Subject for notifying that the tooltip has been hidden from the view */
private _onHide: Subject<any> = new Subject();

constructor(@Optional() private _dir: Dir) {}
constructor(@Optional() private _dir: Dir, private _ref: ChangeDetectorRef) {}
Copy link
Member

Choose a reason for hiding this comment

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

_ref is not very precise. It should be _changeDetectorRef


/**
* Shows the tooltip with an animation originating from the provided origin
Expand All @@ -309,6 +310,10 @@ export class TooltipComponent {
// If this was set to true immediately, then a body click that triggers show() would
// trigger interaction and close the tooltip right after it was displayed.
this._closeOnInteraction = false;

// Call change detection manually so tooltip will also work
// if any parent component has set the ChangeDetectionStrategy to OnPush
this._ref.detectChanges();
Copy link
Member

Choose a reason for hiding this comment

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

I think rather than always triggering a ChangeDetection we should just mark for a new check.

We are doing this in other components as well.

https://angular.io/docs/js/latest/api/core/index/ChangeDetectorRef-class.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jelbourn is there a way to find out if a parent component has set the ChangeDetectionStrategy to OnPush or not so we can skip this line?

setTimeout(() => { this._closeOnInteraction = true; }, 0);
}, delay);
}
Expand All @@ -326,6 +331,10 @@ export class TooltipComponent {
this._hideTimeoutId = setTimeout(() => {
this._visibility = 'hidden';
this._closeOnInteraction = false;

// Call change detection manually so tooltip will also work
// if any parent component has set the ChangeDetectionStrategy to OnPush
this._ref.detectChanges();
}, delay);
}

Expand Down