Skip to content

fix: stops custom tooltip from flickering when hovered, fixes #2206 #2207

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix: stops custom tooltip from flickering when hovered, fixes #2206 #2207

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
61 changes: 57 additions & 4 deletions packages/custom-tooltip-plugin/src/slickCustomTooltip.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ export class SlickCustomTooltip {
} as CustomTooltipOption;
protected _grid!: SlickGrid;
protected _eventHandler: SlickEventHandler;
protected _hideTooltipTimeout?: NodeJS.Timeout;
protected _autoHideTimeout?: NodeJS.Timeout;
protected _isMouseOverTooltip = false;

constructor() {
this._eventHandler = new SlickEventHandler();
Expand Down Expand Up @@ -150,17 +153,38 @@ export class SlickCustomTooltip {
.subscribe(grid.onHeaderMouseOver, (e, args) => this.handleOnHeaderMouseOverByType(e, args, 'slick-header-column'))
.subscribe(grid.onHeaderRowMouseEnter, (e, args) => this.handleOnHeaderMouseOverByType(e, args, 'slick-headerrow-column'))
.subscribe(grid.onHeaderRowMouseOver, (e, args) => this.handleOnHeaderMouseOverByType(e, args, 'slick-headerrow-column'))
.subscribe(grid.onMouseLeave, this.hideTooltip.bind(this))
.subscribe(grid.onHeaderMouseOut, this.hideTooltip.bind(this))
.subscribe(grid.onHeaderRowMouseLeave, this.hideTooltip.bind(this))
.subscribe(grid.onHeaderRowMouseOut, this.hideTooltip.bind(this));
.subscribe(grid.onMouseLeave, this.handleOnMouseLeave.bind(this))
.subscribe(grid.onHeaderMouseOut, this.handleOnMouseLeave.bind(this))
.subscribe(grid.onHeaderRowMouseLeave, this.handleOnMouseLeave.bind(this))
.subscribe(grid.onHeaderRowMouseOut, this.handleOnMouseLeave.bind(this));
}

dispose(): void {
// hide (remove) any tooltip and unsubscribe from all events
this.hideTooltip();
this._cancellablePromise = undefined;
this._eventHandler.unsubscribeAll();

if (this._hideTooltipTimeout) {
clearTimeout(this._hideTooltipTimeout);
this._hideTooltipTimeout = undefined;
}
if (this._autoHideTimeout) {
clearTimeout(this._autoHideTimeout);
this._autoHideTimeout = undefined;
}
}

protected handleOnMouseLeave(): void {
if (this._hideTooltipTimeout) {
clearTimeout(this._hideTooltipTimeout);
}

this._hideTooltipTimeout = setTimeout(() => {
if (!this._isMouseOverTooltip) {
this.hideTooltip();
}
}, 100);
}

/**
Expand All @@ -170,9 +194,20 @@ export class SlickCustomTooltip {
hideTooltip(): void {
this._cancellablePromise?.cancel();
this._observable$?.unsubscribe();

if (this._hideTooltipTimeout) {
clearTimeout(this._hideTooltipTimeout);
this._hideTooltipTimeout = undefined;
}
if (this._autoHideTimeout) {
clearTimeout(this._autoHideTimeout);
this._autoHideTimeout = undefined;
}

const cssClasses = classNameToList(this.className).join('.');
const prevTooltip = document.body.querySelector(`.${cssClasses}${this.gridUidSelector}`);
prevTooltip?.remove();
this._isMouseOverTooltip = false;
}

getOptions(): CustomTooltipOption | undefined {
Expand Down Expand Up @@ -484,6 +519,24 @@ export class SlickCustomTooltip {
if (finalOutputText.toString()) {
document.body.appendChild(this._tooltipElm);

this._tooltipElm.addEventListener('mouseenter', () => {
this._isMouseOverTooltip = true;
if (this._hideTooltipTimeout) {
clearTimeout(this._hideTooltipTimeout);
this._hideTooltipTimeout = undefined;
}
});

this._tooltipElm.addEventListener('mouseleave', () => {
this._isMouseOverTooltip = false;
this.hideTooltip();
});

// Auto-hide tooltip after 3 seconds regardless of mouse position
this._autoHideTimeout = setTimeout(() => {
this.hideTooltip();
}, 3000);

// reposition the tooltip on top of the cell that triggered the mouse over event
this.reposition(cell);

Expand Down
Loading