All files / src tooltip.js

1.07% Statements 2/187
0.88% Branches 1/113
0% Functions 0/30
1.16% Lines 2/173
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598                                    1x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   1x                                                                                                  
/* Forked from https://github.com/FezVrasta/popper.js/blob/master/packages/tooltip/src/index.js */
 
import Popper from 'popper.js'
import { getOptions, directive } from './v-tooltip'
import { addClasses, supportsPassive } from './utils'
 
const DEFAULT_OPTIONS = {
	container: false,
	delay: 0,
	html: false,
	placement: 'top',
	title: '',
	template:
				'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>',
	trigger: 'hover focus',
	offset: 0,
}
 
const openTooltips = []
 
export default class Tooltip {
	/**
	 * Create a new Tooltip.js instance
	 * @class Tooltip
	 * @param {HTMLElement} reference - The DOM node used as reference of the tooltip (it can be a jQuery element).
	 * @param {Object} options
	 * @param {String} options.placement=bottom
	 *			Placement of the popper accepted values: `top(-start, -end), right(-start, -end), bottom(-start, -end),
	 *			left(-start, -end)`
	 * @param {HTMLElement|String|false} options.container=false - Append the tooltip to a specific element.
	 * @param {Number|Object} options.delay=0
	 *			Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type.
	 *			If a number is supplied, delay is applied to both hide/show.
	 *			Object structure is: `{ show: 500, hide: 100 }`
	 * @param {Boolean} options.html=false - Insert HTML into the tooltip. If false, the content will inserted with `innerText`.
	 * @param {String|PlacementFunction} options.placement='top' - One of the allowed placements, or a function returning one of them.
	 * @param {String} [options.template='<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>']
	 *			Base HTML to used when creating the tooltip.
	 *			The tooltip's `title` will be injected into the `.tooltip-inner` or `.tooltip__inner`.
	 *			`.tooltip-arrow` or `.tooltip__arrow` will become the tooltip's arrow.
	 *			The outermost wrapper element should have the `.tooltip` class.
	 * @param {String|HTMLElement|TitleFunction} options.title='' - Default title value if `title` attribute isn't present.
	 * @param {String} [options.trigger='hover focus']
	 *			How tooltip is triggered - click, hover, focus, manual.
	 *			You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
	 * @param {HTMLElement} options.boundariesElement
	 *			The element used as boundaries for the tooltip. For more information refer to Popper.js'
	 *			[boundariesElement docs](https://popper.js.org/popper-documentation.html)
	 * @param {Number|String} options.offset=0 - Offset of the tooltip relative to its reference. For more information refer to Popper.js'
	 *			[offset docs](https://popper.js.org/popper-documentation.html)
	 * @param {Object} options.popperOptions={} - Popper options, will be passed directly to popper instance. For more information refer to Popper.js'
	 *			[options docs](https://popper.js.org/popper-documentation.html)
	 * @return {Object} instance - The generated tooltip instance
	 */
	constructor (reference, options) {
		// apply user options over default ones
		options = { ...DEFAULT_OPTIONS, ...options }
 
		reference.jquery && (reference = reference[0])
 
		// cache reference and options
		this.reference = reference
		this.options = options
 
		// set initial state
		this._isOpen = false
 
		this._init()
	}
 
	//
	// Public methods
	//
 
	/**
	 * Reveals an element's tooltip. This is considered a "manual" triggering of the tooltip.
	 * Tooltips with zero-length titles are never displayed.
	 * @method Tooltip#show
	 * @memberof Tooltip
	 */
	show = () => {
		this._show(this.reference, this.options)
	}
 
	/**
	 * Hides an element’s tooltip. This is considered a “manual” triggering of the tooltip.
	 * @method Tooltip#hide
	 * @memberof Tooltip
	 */
	hide = () => {
		this._hide()
	}
 
	/**
	 * Hides and destroys an element’s tooltip.
	 * @method Tooltip#dispose
	 * @memberof Tooltip
	 */
	dispose = () => {
		this._dispose()
	}
 
	/**
	 * Toggles an element’s tooltip. This is considered a “manual” triggering of the tooltip.
	 * @method Tooltip#toggle
	 * @memberof Tooltip
	 */
	toggle = () => {
		if (this._isOpen) {
			return this.hide()
		} else {
			return this.show()
		}
	};
 
	setClasses (classes) {
		this._classes = classes
	}
 
	setContent (content) {
		this.options.title = content
		if (this._tooltipNode) {
			const el = this._tooltipNode.querySelector(this.options.innerSelector)
 
			if (el) {
				if (!content) {
					el.innerHTML = ''
				} else {
					el.innerHTML = content
				}
 
				this.popperInstance.update()
			}
		}
	}
 
	setOptions (options) {
		let classesUpdated = false
		const classes = (options && options.classes) || directive.options.defaultClass
		if (this._classes !== classes) {
			this.setClasses(classes)
			classesUpdated = true
		}
 
		options = getOptions(options)
 
		let needPopperUpdate = false
		let needRestart = false
 
		if (
			this.options.offset !== options.offset ||
						this.options.placement !== options.placement
		) {
			needPopperUpdate = true
		}
 
		if (
			this.options.template !== options.template ||
			this.options.trigger !== options.trigger ||
			this.options.container !== options.container ||
			classesUpdated
		) {
			needRestart = true
		}
 
		for (const key in options) {
			this.options[key] = options[key]
		}
 
		if (this._tooltipNode) {
			if (needRestart) {
				const isOpen = this._isOpen
 
				this.dispose()
				this._init()
 
				if (isOpen) {
					this.show()
				}
			} else if (needPopperUpdate) {
				this.popperInstance.update()
			}
		}
	}
 
	//
	// Private methods
	//
 
	_events = [];
 
	_init () {
		// get events list
		const events = typeof this.options.trigger === 'string'
			? this.options.trigger
				.split(' ')
				.filter(
					trigger => ['click', 'hover', 'focus'].indexOf(trigger) !== -1
				)
			: []
		this._isDisposed = false
		this._enableDocumentTouch = events.indexOf('manual') === -1
 
		// set event listeners
		this._setEventListeners(this.reference, events, this.options)
	}
 
	/**
	 * Creates a new tooltip node
	 * @memberof Tooltip
	 * @private
	 * @param {HTMLElement} reference
	 * @param {String} template
	 * @param {String|HTMLElement|TitleFunction} title
	 * @param {Boolean} allowHtml
	 * @return {HTMLelement} tooltipNode
	 */
	_create (reference, template, title, allowHtml) {
		// create tooltip element
		const tooltipGenerator = window.document.createElement('div')
		tooltipGenerator.innerHTML = template.trim()
		const tooltipNode = tooltipGenerator.childNodes[0]
 
		// add unique ID to our tooltip (needed for accessibility reasons)
		tooltipNode.id = `tooltip_${Math.random().toString(36).substr(2, 10)}`
 
		// Initially hide the tooltip
		// The attribute will be switched in a next frame so
		// CSS transitions can play
		tooltipNode.setAttribute('aria-hidden', 'true')
 
		// add title to tooltip
		const titleNode = tooltipGenerator.querySelector(this.options.innerSelector)
		if (title.nodeType === 1) {
			// if title is a node, append it only if allowHtml is true
			allowHtml && titleNode.appendChild(title)
		} else if (typeof title === 'function') {
			// if title is a function, call it and set innerText or innerHtml depending by `allowHtml` value
			const titleText = title.call(reference)
			allowHtml
				? (titleNode.innerHTML = titleText)
				: (titleNode.innerText = titleText)
		} else {
			// if it's just a simple text, set innerText or innerHtml depending by `allowHtml` value
			allowHtml ? (titleNode.innerHTML = title) : (titleNode.innerText = title)
		}
 
		if (directive.options.autoHide && this.options.trigger.indexOf('hover') !== -1) {
			tooltipNode.addEventListener('mouseenter', this.hide)
			tooltipNode.addEventListener('click', this.hide)
		}
 
		// return the generated tooltip node
		return tooltipNode
	}
 
	_show (reference, options) {
		if (options && typeof options.container === 'string') {
			const container = document.querySelector(options.container)
			if (!container) return
		}
 
		clearTimeout(this._disposeTimer)
 
		options = Object.assign({}, options)
		delete options.offset
 
		let updateClasses = true
		if (this._tooltipNode) {
			addClasses(this._tooltipNode, this._classes)
			updateClasses = false
		}
 
		const result = this._ensureShown(reference, options)
 
		if (updateClasses && this._tooltipNode) {
			addClasses(this._tooltipNode, this._classes)
		}
 
		return result
	}
 
	_ensureShown (reference, options) {
		// don't show if it's already visible
		if (this._isOpen) {
			return this
		}
		this._isOpen = true
 
		openTooltips.push(this)
 
		// if the tooltipNode already exists, just show it
		if (this._tooltipNode) {
			this._tooltipNode.style.display = ''
			this._tooltipNode.setAttribute('aria-hidden', 'false')
			this.popperInstance.enableEventListeners()
			this.popperInstance.update()
			return this
		}
 
		// get title
		const title = reference.getAttribute('title') || options.title
 
		// don't show tooltip if no title is defined
		if (!title) {
			return this
		}
 
		// create tooltip node
		const tooltipNode = this._create(
			reference,
			options.template,
			title,
			options.html
		)
 
		// Add `aria-describedby` to our reference element for accessibility reasons
		reference.setAttribute('aria-describedby', tooltipNode.id)
 
		// append tooltip to container
		const container = this._findContainer(options.container, reference)
 
		this._append(tooltipNode, container)
 
		const popperOptions = {
			...options.popperOptions,
			placement: options.placement,
		}
 
		popperOptions.modifiers = {
			...popperOptions.modifiers,
			arrow: {
				element: this.options.arrowSelector,
			},
		}
 
		if (options.boundariesElement) {
			popperOptions.modifiers.preventOverflow = {
				boundariesElement: options.boundariesElement,
			}
		}
 
		this.popperInstance = new Popper(reference, tooltipNode, popperOptions)
 
		this._tooltipNode = tooltipNode
 
		// Fix position
		requestAnimationFrame(() => {
			if (!this._isDisposed && this.popperInstance) {
				this.popperInstance.update()
 
				// Show the tooltip
				requestAnimationFrame(() => {
					if (!this._isDisposed) {
						this._isOpen && tooltipNode.setAttribute('aria-hidden', 'false')
					} else {
						this.dispose()
					}
				})
			} else {
				this.dispose()
			}
		})
 
		return this
	}
 
	_noLongerOpen () {
		const index = openTooltips.indexOf(this)
		if (index !== -1) {
			openTooltips.splice(index, 1)
		}
	}
 
	_hide (/* reference, options */) {
		// don't hide if it's already hidden
		if (!this._isOpen) {
			return this
		}
 
		this._isOpen = false
		this._noLongerOpen()
 
		// hide tooltipNode
		this._tooltipNode.style.display = 'none'
		this._tooltipNode.setAttribute('aria-hidden', 'true')
 
		this.popperInstance.disableEventListeners()
 
		clearTimeout(this._disposeTimer)
		const disposeTime = directive.options.disposeTimeout
		if (disposeTime !== null) {
			this._disposeTimer = setTimeout(() => {
				if (this._tooltipNode) {
					this._tooltipNode.removeEventListener('mouseenter', this.hide)
					this._tooltipNode.removeEventListener('click', this.hide)
					// Don't remove popper instance, just the HTML element
					this._tooltipNode.parentNode.removeChild(this._tooltipNode)
					this._tooltipNode = null
				}
			}, disposeTime)
		}
 
		return this
	}
 
	_dispose () {
		this._isDisposed = true
 
		// remove event listeners first to prevent any unexpected behaviour
		this._events.forEach(({ func, event }) => {
			this.reference.removeEventListener(event, func)
		})
		this._events = []
 
		if (this._tooltipNode) {
			this._hide()
 
			this._tooltipNode.removeEventListener('mouseenter', this.hide)
			this._tooltipNode.removeEventListener('click', this.hide)
 
			// destroy instance
			this.popperInstance.destroy()
 
			// destroy tooltipNode if removeOnDestroy is not set, as popperInstance.destroy() already removes the element
			if (!this.popperInstance.options.removeOnDestroy) {
				this._tooltipNode.parentNode.removeChild(this._tooltipNode)
				this._tooltipNode = null
			}
		} else {
			this._noLongerOpen()
		}
		return this
	}
 
	_findContainer (container, reference) {
		// if container is a query, get the relative element
		if (typeof container === 'string') {
			container = window.document.querySelector(container)
		} else if (container === false) {
			// if container is `false`, set it to reference parent
			container = reference.parentNode
		}
		return container
	}
 
	/**
	 * Append tooltip to container
	 * @memberof Tooltip
	 * @private
	 * @param {HTMLElement} tooltip
	 * @param {HTMLElement|String|false} container
	 */
	_append (tooltipNode, container) {
		container.appendChild(tooltipNode)
	}
 
	_setEventListeners (reference, events, options) {
		const directEvents = []
		const oppositeEvents = []
 
		events.forEach(event => {
			switch (event) {
			case 'hover':
				directEvents.push('mouseenter')
				oppositeEvents.push('mouseleave')
				break
			case 'focus':
				directEvents.push('focus')
				oppositeEvents.push('blur')
				break
			case 'click':
				directEvents.push('click')
				oppositeEvents.push('click')
				break
			}
		})
 
		// schedule show tooltip
		directEvents.forEach(event => {
			const func = evt => {
				if (this._isOpen === true) {
					return
				}
				evt.usedByTooltip = true
				this._scheduleShow(reference, options.delay, options, evt)
			}
			this._events.push({ event, func })
			reference.addEventListener(event, func)
		})
 
		// schedule hide tooltip
		oppositeEvents.forEach(event => {
			const func = evt => {
				if (evt.usedByTooltip === true) {
					return
				}
				this._scheduleHide(reference, options.delay, options, evt)
			}
			this._events.push({ event, func })
			reference.addEventListener(event, func)
		})
	}
 
	_onDocumentTouch (event) {
		if (this._enableDocumentTouch) {
			this._scheduleHide(this.reference, this.options.delay, this.options, event)
		}
	}
 
	_scheduleShow (reference, delay, options /*, evt */) {
		// defaults to 0
		const computedDelay = (delay && delay.show) || delay || 0
		clearTimeout(this._scheduleTimer)
		this._scheduleTimer = window.setTimeout(() => this._show(reference, options), computedDelay)
	}
 
	_scheduleHide (reference, delay, options, evt) {
		// defaults to 0
		const computedDelay = (delay && delay.hide) || delay || 0
		clearTimeout(this._scheduleTimer)
		this._scheduleTimer = window.setTimeout(() => {
			if (this._isOpen === false) {
				return
			}
			if (!document.body.contains(this._tooltipNode)) {
				return
			}
 
			// if we are hiding because of a mouseleave, we must check that the new
			// reference isn't the tooltip, because in this case we don't want to hide it
			if (evt.type === 'mouseleave') {
				const isSet = this._setTooltipNodeEvent(evt, reference, delay, options)
 
				// if we set the new event, don't hide the tooltip yet
				// the new event will take care to hide it if necessary
				if (isSet) {
					return
				}
			}
 
			this._hide(reference, options)
		}, computedDelay)
	}
 
		_setTooltipNodeEvent = (evt, reference, delay, options) => {
			const relatedreference = evt.relatedreference || evt.toElement
 
			const callback = evt2 => {
				const relatedreference2 = evt2.relatedreference || evt2.toElement
 
				// Remove event listener after call
				this._tooltipNode.removeEventListener(evt.type, callback)
 
				// If the new reference is not the reference element
				if (!reference.contains(relatedreference2)) {
					// Schedule to hide tooltip
					this._scheduleHide(reference, options.delay, options, evt2)
				}
			}
 
			if (this._tooltipNode.contains(relatedreference)) {
				// listen to mouseleave on the tooltip element to be able to hide the tooltip
				this._tooltipNode.addEventListener(evt.type, callback)
				return true
			}
 
			return false
		};
}
 
// Hide tooltips on touch devices
if (typeof document !== 'undefined') {
	document.addEventListener('touchstart', event => {
		for (let i = 0; i < openTooltips.length; i++) {
			openTooltips[i]._onDocumentTouch(event)
		}
	}, supportsPassive ? {
		passive: true,
	} : false)
}
 
/**
 * Placement function, its context is the Tooltip instance.
 * @memberof Tooltip
 * @callback PlacementFunction
 * @param {HTMLElement} tooltip - tooltip DOM node.
 * @param {HTMLElement} reference - reference DOM node.
 * @return {String} placement - One of the allowed placement options.
 */
 
/**
 * Title function, its context is the Tooltip instance.
 * @memberof Tooltip
 * @callback TitleFunction
 * @return {String} placement - The desired title.
 */