Skip to content

Make MutationObserver-based removal tracking #278

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 7 commits into from
Mar 28, 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
44 changes: 44 additions & 0 deletions src/decorators/trackRemoval.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/**
* Tracking target removing from DOM.
* It's nessesary to hide tooltip when it's target disappears.
* Otherwise, the tooltip would be shown forever until another target
* is triggered.
*
* If MutationObserver is not available, this feature just doesn't work.
*/

// https://hacks.mozilla.org/2012/05/dom-mutationobserver-reacting-to-dom-changes-without-killing-browser-performance/
const getMutationObserverClass = () => {
return window.MutationObserver ||
window.WebKitMutationObserver ||
window.MozMutationObserver
}

export default function (target) {
target.prototype.bindRemovalTracker = function () {
const MutationObserver = getMutationObserverClass()
if (MutationObserver == null) return

const observer = new MutationObserver((mutations) => {
for (const mutation of mutations) {
for (const element of mutation.removedNodes) {
if (element === this.state.currentTarget) {
this.hideTooltip()
return
}
}
}
})

observer.observe(window.document, { childList: true, subtree: true })

this.removalTracker = observer
}

target.prototype.unbindRemovalTracker = function () {
if (this.removalTracker) {
this.removalTracker.disconnect()
this.removalTracker = null
}
}
}
21 changes: 11 additions & 10 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import windowListener from './decorators/windowListener'
import customEvent from './decorators/customEvent'
import isCapture from './decorators/isCapture'
import getEffect from './decorators/getEffect'
import trackRemoval from './decorators/trackRemoval'

/* Utils */
import getPosition from './utils/getPosition'
Expand All @@ -20,7 +21,12 @@ import nodeListToArray from './utils/nodeListToArray'
/* CSS */
import cssStyle from './style'

@staticMethods @windowListener @customEvent @isCapture @getEffect
@staticMethods
@windowListener
@customEvent
@isCapture
@getEffect
@trackRemoval
class ReactTooltip extends Component {

static propTypes = {
Expand Down Expand Up @@ -86,7 +92,6 @@ class ReactTooltip extends Component {
this.bind([
'showTooltip',
'updateTooltip',
'checkSameTarget',
'hideTooltip',
'globalRebuild',
'globalShow',
Expand Down Expand Up @@ -181,14 +186,16 @@ class ReactTooltip extends Component {
target.addEventListener('mousemove', this.updateTooltip, isCaptureMode)
}
target.addEventListener('mouseleave', this.hideTooltip, isCaptureMode)
target.addEventListener('DOMNodeRemovedFromDocument', this.checkSameTarget, isCaptureMode)
})

// Global event to hide tooltip
if (globalEventOff) {
window.removeEventListener(globalEventOff, this.hideTooltip)
window.addEventListener(globalEventOff, this.hideTooltip, false)
}

// Track removal of targetArray elements from DOM
this.bindRemovalTracker()
}

/**
Expand All @@ -203,6 +210,7 @@ class ReactTooltip extends Component {
})

if (globalEventOff) window.removeEventListener(globalEventOff, this.hideTooltip)
this.unbindRemovalTracker()
}

/**
Expand All @@ -215,7 +223,6 @@ class ReactTooltip extends Component {
target.removeEventListener('mouseenter', this.showTooltip, isCaptureMode)
target.removeEventListener('mousemove', this.updateTooltip, isCaptureMode)
target.removeEventListener('mouseleave', this.hideTooltip, isCaptureMode)
target.removeEventListener('DOMNodeRemovedFromDocument', this.checkSameTarget, isCaptureMode)
}

/**
Expand Down Expand Up @@ -332,12 +339,6 @@ class ReactTooltip extends Component {
}
}

checkSameTarget (e) {
if (this.state.currentTarget === e.currentTarget) {
this.hideTooltip(e)
}
}

/**
* When mouse leave, hide tooltip
*/
Expand Down