All files / src tooltip.js

98.28% Statements 229/233
91.33% Branches 116/127
97.95% Functions 48/49
98.26% Lines 227/231

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634                                      2x 2x   2x 2x 2x   2x 2x   2x   2x 2x 2x 2x   2x 2x 2x 2x 2x 2x 2x 2x 2x 2x   2x               2x                                             2x                                                   103x       103x     103x 103x 103x 103x 103x 103x 103x     103x   103x   103x 102x           357x       85x       746x         1x       2x       1x       8x 1x     7x 7x 2x 2x     5x       6x   6x   6x 5x     6x 6x       56x 1x     55x 2x     53x 53x 53x   53x 3x       50x   50x   50x   50x   50x 50x 50x     50x   50x           50x 42x 1509x       50x 50x   50x 6x     50x     50x       16x 2x     14x 14x 1x     13x 13x       13x 11x 394x       13x 13x 13x 13x   13x 13x 1x     12x 12x     12x 12x     13x       2x 1x           46x       172x 61x     172x       61x     61x       61x   61x   61x   61x   61x 57x     61x       12x 12x 1x 1x         61x 6x   55x                 61x       43x           114x         16x       124x       49x       50x     50x 50x       54x   54x 2x     53x 30x     51x       183x       52x                                                                   81x           52x             103x   103x 182x 23x 4x 4x   159x 158x     158x       158x 9x 9x 9x   158x 3x 3x     3x         103x           103x       102x   102x 27x     75x 58x     75x 75x       14x 2x 2x     12x   12x 12x 12x           11x 2x     9x   9x 7x 6x           21x 21x       24x       103x   103x 22x 1x       103x       103x 103x 103x 103x       103x   103x 101x           103x 1x     103x 1x     103x       16x   16x 272x 37x       16x 16x         16x       69x 17x 17x     69x 18x 18x           4x 4x   4x 2x     2x 1x     1x                 2x      
/**
 * --------------------------------------------------------------------------
 * Bootstrap (v5.2.3): tooltip.js
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
 * --------------------------------------------------------------------------
 */
 
import * as Popper from '@popperjs/core'
import { defineJQueryPlugin, findShadowRoot, getElement, getUID, isRTL, noop } from './util/index'
import { DefaultAllowlist } from './util/sanitizer'
import EventHandler from './dom/event-handler'
import Manipulator from './dom/manipulator'
import BaseComponent from './base-component'
import TemplateFactory from './util/template-factory'
 
/**
 * Constants
 */
 
const NAME = 'tooltip'
const DISALLOWED_ATTRIBUTES = new Set(['sanitize', 'allowList', 'sanitizeFn'])
 
const CLASS_NAME_FADE = 'fade'
const CLASS_NAME_MODAL = 'modal'
const CLASS_NAME_SHOW = 'show'
 
const SELECTOR_TOOLTIP_INNER = '.tooltip-inner'
const SELECTOR_MODAL = `.${CLASS_NAME_MODAL}`
 
const EVENT_MODAL_HIDE = 'hide.bs.modal'
 
const TRIGGER_HOVER = 'hover'
const TRIGGER_FOCUS = 'focus'
const TRIGGER_CLICK = 'click'
const TRIGGER_MANUAL = 'manual'
 
const EVENT_HIDE = 'hide'
const EVENT_HIDDEN = 'hidden'
const EVENT_SHOW = 'show'
const EVENT_SHOWN = 'shown'
const EVENT_INSERTED = 'inserted'
const EVENT_CLICK = 'click'
const EVENT_FOCUSIN = 'focusin'
const EVENT_FOCUSOUT = 'focusout'
const EVENT_MOUSEENTER = 'mouseenter'
const EVENT_MOUSELEAVE = 'mouseleave'
 
const AttachmentMap = {
  AUTO: 'auto',
  TOP: 'top',
  RIGHT: isRTL() ? 'left' : 'right',
  BOTTOM: 'bottom',
  LEFT: isRTL() ? 'right' : 'left'
}
 
const Default = {
  allowList: DefaultAllowlist,
  animation: true,
  boundary: 'clippingParents',
  container: false,
  customClass: '',
  delay: 0,
  fallbackPlacements: ['top', 'right', 'bottom', 'left'],
  html: false,
  offset: [0, 0],
  placement: 'top',
  popperConfig: null,
  sanitize: true,
  sanitizeFn: null,
  selector: false,
  template: '<div class="tooltip" role="tooltip">' +
            '<div class="tooltip-arrow"></div>' +
            '<div class="tooltip-inner"></div>' +
            '</div>',
  title: '',
  trigger: 'hover focus'
}
 
const DefaultType = {
  allowList: 'object',
  animation: 'boolean',
  boundary: '(string|element)',
  container: '(string|element|boolean)',
  customClass: '(string|function)',
  delay: '(number|object)',
  fallbackPlacements: 'array',
  html: 'boolean',
  offset: '(array|string|function)',
  placement: '(string|function)',
  popperConfig: '(null|object|function)',
  sanitize: 'boolean',
  sanitizeFn: '(null|function)',
  selector: '(string|boolean)',
  template: 'string',
  title: '(string|element|function)',
  trigger: 'string'
}
 
/**
 * Class definition
 */
 
class Tooltip extends BaseComponent {
  constructor(element, config) {
    Iif (typeof Popper === 'undefined') {
      throw new TypeError('Bootstrap\'s tooltips require Popper (https://popper.js.org)')
    }
 
    super(element, config)
 
    // Private
    this._isEnabled = true
    this._timeout = 0
    this._isHovered = null
    this._activeTrigger = {}
    this._popper = null
    this._templateFactory = null
    this._newContent = null
 
    // Protected
    this.tip = null
 
    this._setListeners()
 
    if (!this._config.selector) {
      this._fixTitle()
    }
  }
 
  // Getters
  static get Default() {
    return Default
  }
 
  static get DefaultType() {
    return DefaultType
  }
 
  static get NAME() {
    return NAME
  }
 
  // Public
  enable() {
    this._isEnabled = true
  }
 
  disable() {
    this._isEnabled = false
  }
 
  toggleEnabled() {
    this._isEnabled = !this._isEnabled
  }
 
  toggle() {
    if (!this._isEnabled) {
      return
    }
 
    this._activeTrigger.click = !this._activeTrigger.click
    if (this._isShown()) {
      this._leave()
      return
    }
 
    this._enter()
  }
 
  dispose() {
    clearTimeout(this._timeout)
 
    EventHandler.off(this._element.closest(SELECTOR_MODAL), EVENT_MODAL_HIDE, this._hideModalHandler)
 
    if (this._element.getAttribute('data-bs-original-title')) {
      this._element.setAttribute('title', this._element.getAttribute('data-bs-original-title'))
    }
 
    this._disposePopper()
    super.dispose()
  }
 
  show() {
    if (this._element.style.display === 'none') {
      throw new Error('Please use show on visible elements')
    }
 
    if (!(this._isWithContent() && this._isEnabled)) {
      return
    }
 
    const showEvent = EventHandler.trigger(this._element, this.constructor.eventName(EVENT_SHOW))
    const shadowRoot = findShadowRoot(this._element)
    const isInTheDom = (shadowRoot || this._element.ownerDocument.documentElement).contains(this._element)
 
    if (showEvent.defaultPrevented || !isInTheDom) {
      return
    }
 
    // todo v6 remove this OR make it optional
    this._disposePopper()
 
    const tip = this._getTipElement()
 
    this._element.setAttribute('aria-describedby', tip.getAttribute('id'))
 
    const { container } = this._config
 
    Eif (!this._element.ownerDocument.documentElement.contains(this.tip)) {
      container.append(tip)
      EventHandler.trigger(this._element, this.constructor.eventName(EVENT_INSERTED))
    }
 
    this._popper = this._createPopper(tip)
 
    tip.classList.add(CLASS_NAME_SHOW)
 
    // If this is a touch-enabled device we add extra
    // empty mouseover listeners to the body's immediate children;
    // only needed because of broken event delegation on iOS
    // https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html
    if ('ontouchstart' in document.documentElement) {
      for (const element of [].concat(...document.body.children)) {
        EventHandler.on(element, 'mouseover', noop)
      }
    }
 
    const complete = () => {
      EventHandler.trigger(this._element, this.constructor.eventName(EVENT_SHOWN))
 
      if (this._isHovered === false) {
        this._leave()
      }
 
      this._isHovered = false
    }
 
    this._queueCallback(complete, this.tip, this._isAnimated())
  }
 
  hide() {
    if (!this._isShown()) {
      return
    }
 
    const hideEvent = EventHandler.trigger(this._element, this.constructor.eventName(EVENT_HIDE))
    if (hideEvent.defaultPrevented) {
      return
    }
 
    const tip = this._getTipElement()
    tip.classList.remove(CLASS_NAME_SHOW)
 
    // If this is a touch-enabled device we remove the extra
    // empty mouseover listeners we added for iOS support
    if ('ontouchstart' in document.documentElement) {
      for (const element of [].concat(...document.body.children)) {
        EventHandler.off(element, 'mouseover', noop)
      }
    }
 
    this._activeTrigger[TRIGGER_CLICK] = false
    this._activeTrigger[TRIGGER_FOCUS] = false
    this._activeTrigger[TRIGGER_HOVER] = false
    this._isHovered = null // it is a trick to support manual triggering
 
    const complete = () => {
      if (this._isWithActiveTrigger()) {
        return
      }
 
      Eif (!this._isHovered) {
        this._disposePopper()
      }
 
      this._element.removeAttribute('aria-describedby')
      EventHandler.trigger(this._element, this.constructor.eventName(EVENT_HIDDEN))
    }
 
    this._queueCallback(complete, this.tip, this._isAnimated())
  }
 
  update() {
    if (this._popper) {
      this._popper.update()
    }
  }
 
  // Protected
  _isWithContent() {
    return Boolean(this._getTitle())
  }
 
  _getTipElement() {
    if (!this.tip) {
      this.tip = this._createTipElement(this._newContent || this._getContentForTemplate())
    }
 
    return this.tip
  }
 
  _createTipElement(content) {
    const tip = this._getTemplateFactory(content).toHtml()
 
    // todo: remove this check on v6
    Iif (!tip) {
      return null
    }
 
    tip.classList.remove(CLASS_NAME_FADE, CLASS_NAME_SHOW)
    // todo: on v6 the following can be achieved with CSS only
    tip.classList.add(`bs-${this.constructor.NAME}-auto`)
 
    const tipId = getUID(this.constructor.NAME).toString()
 
    tip.setAttribute('id', tipId)
 
    if (this._isAnimated()) {
      tip.classList.add(CLASS_NAME_FADE)
    }
 
    return tip
  }
 
  setContent(content) {
    this._newContent = content
    if (this._isShown()) {
      this._disposePopper()
      this.show()
    }
  }
 
  _getTemplateFactory(content) {
    if (this._templateFactory) {
      this._templateFactory.changeContent(content)
    } else {
      this._templateFactory = new TemplateFactory({
        ...this._config,
        // the `content` var has to be after `this._config`
        // to override config.content in case of popover
        content,
        extraClass: this._resolvePossibleFunction(this._config.customClass)
      })
    }
 
    return this._templateFactory
  }
 
  _getContentForTemplate() {
    return {
      [SELECTOR_TOOLTIP_INNER]: this._getTitle()
    }
  }
 
  _getTitle() {
    return this._resolvePossibleFunction(this._config.title) || this._element.getAttribute('data-bs-original-title')
  }
 
  // Private
  _initializeOnDelegatedTarget(event) {
    return this.constructor.getOrCreateInstance(event.delegateTarget, this._getDelegateConfig())
  }
 
  _isAnimated() {
    return this._config.animation || (this.tip && this.tip.classList.contains(CLASS_NAME_FADE))
  }
 
  _isShown() {
    return this.tip && this.tip.classList.contains(CLASS_NAME_SHOW)
  }
 
  _createPopper(tip) {
    const placement = typeof this._config.placement === 'function' ?
      this._config.placement.call(this, tip, this._element) :
      this._config.placement
    const attachment = AttachmentMap[placement.toUpperCase()]
    return Popper.createPopper(this._element, tip, this._getPopperConfig(attachment))
  }
 
  _getOffset() {
    const { offset } = this._config
 
    if (typeof offset === 'string') {
      return offset.split(',').map(value => Number.parseInt(value, 10))
    }
 
    if (typeof offset === 'function') {
      return popperData => offset(popperData, this._element)
    }
 
    return offset
  }
 
  _resolvePossibleFunction(arg) {
    return typeof arg === 'function' ? arg.call(this._element) : arg
  }
 
  _getPopperConfig(attachment) {
    const defaultBsPopperConfig = {
      placement: attachment,
      modifiers: [
        {
          name: 'flip',
          options: {
            fallbackPlacements: this._config.fallbackPlacements
          }
        },
        {
          name: 'offset',
          options: {
            offset: this._getOffset()
          }
        },
        {
          name: 'preventOverflow',
          options: {
            boundary: this._config.boundary
          }
        },
        {
          name: 'arrow',
          options: {
            element: `.${this.constructor.NAME}-arrow`
          }
        },
        {
          name: 'preSetPlacement',
          enabled: true,
          phase: 'beforeMain',
          fn: data => {
            // Pre-set Popper's placement attribute in order to read the arrow sizes properly.
            // Otherwise, Popper mixes up the width and height dimensions since the initial arrow style is for top placement
            this._getTipElement().setAttribute('data-popper-placement', data.state.placement)
          }
        }
      ]
    }
 
    return {
      ...defaultBsPopperConfig,
      ...(typeof this._config.popperConfig === 'function' ? this._config.popperConfig(defaultBsPopperConfig) : this._config.popperConfig)
    }
  }
 
  _setListeners() {
    const triggers = this._config.trigger.split(' ')
 
    for (const trigger of triggers) {
      if (trigger === 'click') {
        EventHandler.on(this._element, this.constructor.eventName(EVENT_CLICK), this._config.selector, event => {
          const context = this._initializeOnDelegatedTarget(event)
          context.toggle()
        })
      } else if (trigger !== TRIGGER_MANUAL) {
        const eventIn = trigger === TRIGGER_HOVER ?
          this.constructor.eventName(EVENT_MOUSEENTER) :
          this.constructor.eventName(EVENT_FOCUSIN)
        const eventOut = trigger === TRIGGER_HOVER ?
          this.constructor.eventName(EVENT_MOUSELEAVE) :
          this.constructor.eventName(EVENT_FOCUSOUT)
 
        EventHandler.on(this._element, eventIn, this._config.selector, event => {
          const context = this._initializeOnDelegatedTarget(event)
          context._activeTrigger[event.type === 'focusin' ? TRIGGER_FOCUS : TRIGGER_HOVER] = true
          context._enter()
        })
        EventHandler.on(this._element, eventOut, this._config.selector, event => {
          const context = this._initializeOnDelegatedTarget(event)
          context._activeTrigger[event.type === 'focusout' ? TRIGGER_FOCUS : TRIGGER_HOVER] =
            context._element.contains(event.relatedTarget)
 
          context._leave()
        })
      }
    }
 
    this._hideModalHandler = () => {
      if (this._element) {
        this.hide()
      }
    }
 
    EventHandler.on(this._element.closest(SELECTOR_MODAL), EVENT_MODAL_HIDE, this._hideModalHandler)
  }
 
  _fixTitle() {
    const title = this._element.getAttribute('title')
 
    if (!title) {
      return
    }
 
    if (!this._element.getAttribute('aria-label') && !this._element.textContent.trim()) {
      this._element.setAttribute('aria-label', title)
    }
 
    this._element.setAttribute('data-bs-original-title', title) // DO NOT USE IT. Is only for backwards compatibility
    this._element.removeAttribute('title')
  }
 
  _enter() {
    if (this._isShown() || this._isHovered) {
      this._isHovered = true
      return
    }
 
    this._isHovered = true
 
    this._setTimeout(() => {
      Eif (this._isHovered) {
        this.show()
      }
    }, this._config.delay.show)
  }
 
  _leave() {
    if (this._isWithActiveTrigger()) {
      return
    }
 
    this._isHovered = false
 
    this._setTimeout(() => {
      if (!this._isHovered) {
        this.hide()
      }
    }, this._config.delay.hide)
  }
 
  _setTimeout(handler, timeout) {
    clearTimeout(this._timeout)
    this._timeout = setTimeout(handler, timeout)
  }
 
  _isWithActiveTrigger() {
    return Object.values(this._activeTrigger).includes(true)
  }
 
  _getConfig(config) {
    const dataAttributes = Manipulator.getDataAttributes(this._element)
 
    for (const dataAttribute of Object.keys(dataAttributes)) {
      if (DISALLOWED_ATTRIBUTES.has(dataAttribute)) {
        delete dataAttributes[dataAttribute]
      }
    }
 
    config = {
      ...dataAttributes,
      ...(typeof config === 'object' && config ? config : {})
    }
    config = this._mergeConfigObj(config)
    config = this._configAfterMerge(config)
    this._typeCheckConfig(config)
    return config
  }
 
  _configAfterMerge(config) {
    config.container = config.container === false ? document.body : getElement(config.container)
 
    if (typeof config.delay === 'number') {
      config.delay = {
        show: config.delay,
        hide: config.delay
      }
    }
 
    if (typeof config.title === 'number') {
      config.title = config.title.toString()
    }
 
    if (typeof config.content === 'number') {
      config.content = config.content.toString()
    }
 
    return config
  }
 
  _getDelegateConfig() {
    const config = {}
 
    for (const key in this._config) {
      if (this.constructor.Default[key] !== this._config[key]) {
        config[key] = this._config[key]
      }
    }
 
    config.selector = false
    config.trigger = 'manual'
 
    // In the future can be replaced with:
    // const keysWithDifferentValues = Object.entries(this._config).filter(entry => this.constructor.Default[entry[0]] !== this._config[entry[0]])
    // `Object.fromEntries(keysWithDifferentValues)`
    return config
  }
 
  _disposePopper() {
    if (this._popper) {
      this._popper.destroy()
      this._popper = null
    }
 
    if (this.tip) {
      this.tip.remove()
      this.tip = null
    }
  }
 
  // Static
  static jQueryInterface(config) {
    return this.each(function () {
      const data = Tooltip.getOrCreateInstance(this, config)
 
      if (typeof config !== 'string') {
        return
      }
 
      if (typeof data[config] === 'undefined') {
        throw new TypeError(`No method named "${config}"`)
      }
 
      data[config]()
    })
  }
}
 
/**
 * jQuery
 */
 
defineJQueryPlugin(Tooltip)
 
export default Tooltip