All files / src modal.js

97% Statements 162/167
85.29% Branches 58/68
100% Functions 33/33
96.96% Lines 160/165

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                                        1x 1x 1x 1x 1x   1x 1x 1x 1x 1x 1x 1x 1x 1x 1x   1x 1x 1x 1x   1x 1x 1x 1x   1x           1x                       57x   57x 57x 57x 57x 57x 57x   57x         58x       57x       103x         10x       42x 2x     40x       40x 3x     37x 37x   37x   37x   37x   37x       16x 2x     14x   14x 1x     13x 13x 13x   13x   13x       1x 2x     1x 1x 1x       1x         57x             57x             37x 1x     37x 37x 37x 37x 37x   37x 37x 1x     37x   37x   37x 37x 36x     37x 37x         37x       57x 4x 1x     3x 2x 2x 2x     1x     57x 30x 7x       57x   4x 4x 1x     3x 2x 2x     1x 1x             13x 13x 13x 13x 13x   13x 13x 13x 13x 13x         108x       3x 3x       3x 3x   3x 1x     2x 2x     2x 2x 2x 2x 2x       2x               44x 44x 44x   44x         44x             13x 13x         6x 6x   6x 4x     2x 1x     1x                 1x 8x   8x 4x     8x 8x   1x     7x 3x 2x           8x 8x 2x     8x   8x     1x           1x      
/**
 * --------------------------------------------------------------------------
 * Bootstrap (v5.2.3): modal.js
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
 * --------------------------------------------------------------------------
 */
 
import { defineJQueryPlugin, getElementFromSelector, isRTL, isVisible, reflow } from './util/index'
import EventHandler from './dom/event-handler'
import SelectorEngine from './dom/selector-engine'
import ScrollBarHelper from './util/scrollbar'
import BaseComponent from './base-component'
import Backdrop from './util/backdrop'
import FocusTrap from './util/focustrap'
import { enableDismissTrigger } from './util/component-functions'
 
/**
 * Constants
 */
 
const NAME = 'modal'
const DATA_KEY = 'bs.modal'
const EVENT_KEY = `.${DATA_KEY}`
const DATA_API_KEY = '.data-api'
const ESCAPE_KEY = 'Escape'
 
const EVENT_HIDE = `hide${EVENT_KEY}`
const EVENT_HIDE_PREVENTED = `hidePrevented${EVENT_KEY}`
const EVENT_HIDDEN = `hidden${EVENT_KEY}`
const EVENT_SHOW = `show${EVENT_KEY}`
const EVENT_SHOWN = `shown${EVENT_KEY}`
const EVENT_RESIZE = `resize${EVENT_KEY}`
const EVENT_CLICK_DISMISS = `click.dismiss${EVENT_KEY}`
const EVENT_MOUSEDOWN_DISMISS = `mousedown.dismiss${EVENT_KEY}`
const EVENT_KEYDOWN_DISMISS = `keydown.dismiss${EVENT_KEY}`
const EVENT_CLICK_DATA_API = `click${EVENT_KEY}${DATA_API_KEY}`
 
const CLASS_NAME_OPEN = 'modal-open'
const CLASS_NAME_FADE = 'fade'
const CLASS_NAME_SHOW = 'show'
const CLASS_NAME_STATIC = 'modal-static'
 
const OPEN_SELECTOR = '.modal.show'
const SELECTOR_DIALOG = '.modal-dialog'
const SELECTOR_MODAL_BODY = '.modal-body'
const SELECTOR_DATA_TOGGLE = '[data-bs-toggle="modal"]'
 
const Default = {
  backdrop: true,
  focus: true,
  keyboard: true
}
 
const DefaultType = {
  backdrop: '(boolean|string)',
  focus: 'boolean',
  keyboard: 'boolean'
}
 
/**
 * Class definition
 */
 
class Modal extends BaseComponent {
  constructor(element, config) {
    super(element, config)
 
    this._dialog = SelectorEngine.findOne(SELECTOR_DIALOG, this._element)
    this._backdrop = this._initializeBackDrop()
    this._focustrap = this._initializeFocusTrap()
    this._isShown = false
    this._isTransitioning = false
    this._scrollBar = new ScrollBarHelper()
 
    this._addEventListeners()
  }
 
  // Getters
  static get Default() {
    return Default
  }
 
  static get DefaultType() {
    return DefaultType
  }
 
  static get NAME() {
    return NAME
  }
 
  // Public
  toggle(relatedTarget) {
    return this._isShown ? this.hide() : this.show(relatedTarget)
  }
 
  show(relatedTarget) {
    if (this._isShown || this._isTransitioning) {
      return
    }
 
    const showEvent = EventHandler.trigger(this._element, EVENT_SHOW, {
      relatedTarget
    })
 
    if (showEvent.defaultPrevented) {
      return
    }
 
    this._isShown = true
    this._isTransitioning = true
 
    this._scrollBar.hide()
 
    document.body.classList.add(CLASS_NAME_OPEN)
 
    this._adjustDialog()
 
    this._backdrop.show(() => this._showElement(relatedTarget))
  }
 
  hide() {
    if (!this._isShown || this._isTransitioning) {
      return
    }
 
    const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE)
 
    if (hideEvent.defaultPrevented) {
      return
    }
 
    this._isShown = false
    this._isTransitioning = true
    this._focustrap.deactivate()
 
    this._element.classList.remove(CLASS_NAME_SHOW)
 
    this._queueCallback(() => this._hideModal(), this._element, this._isAnimated())
  }
 
  dispose() {
    for (const htmlElement of [window, this._dialog]) {
      EventHandler.off(htmlElement, EVENT_KEY)
    }
 
    this._backdrop.dispose()
    this._focustrap.deactivate()
    super.dispose()
  }
 
  handleUpdate() {
    this._adjustDialog()
  }
 
  // Private
  _initializeBackDrop() {
    return new Backdrop({
      isVisible: Boolean(this._config.backdrop), // 'static' option will be translated to true, and booleans will keep their value,
      isAnimated: this._isAnimated()
    })
  }
 
  _initializeFocusTrap() {
    return new FocusTrap({
      trapElement: this._element
    })
  }
 
  _showElement(relatedTarget) {
    // try to append dynamic modal
    if (!document.body.contains(this._element)) {
      document.body.append(this._element)
    }
 
    this._element.style.display = 'block'
    this._element.removeAttribute('aria-hidden')
    this._element.setAttribute('aria-modal', true)
    this._element.setAttribute('role', 'dialog')
    this._element.scrollTop = 0
 
    const modalBody = SelectorEngine.findOne(SELECTOR_MODAL_BODY, this._dialog)
    if (modalBody) {
      modalBody.scrollTop = 0
    }
 
    reflow(this._element)
 
    this._element.classList.add(CLASS_NAME_SHOW)
 
    const transitionComplete = () => {
      if (this._config.focus) {
        this._focustrap.activate()
      }
 
      this._isTransitioning = false
      EventHandler.trigger(this._element, EVENT_SHOWN, {
        relatedTarget
      })
    }
 
    this._queueCallback(transitionComplete, this._dialog, this._isAnimated())
  }
 
  _addEventListeners() {
    EventHandler.on(this._element, EVENT_KEYDOWN_DISMISS, event => {
      if (event.key !== ESCAPE_KEY) {
        return
      }
 
      if (this._config.keyboard) {
        event.preventDefault()
        this.hide()
        return
      }
 
      this._triggerBackdropTransition()
    })
 
    EventHandler.on(window, EVENT_RESIZE, () => {
      if (this._isShown && !this._isTransitioning) {
        this._adjustDialog()
      }
    })
 
    EventHandler.on(this._element, EVENT_MOUSEDOWN_DISMISS, event => {
      // a bad trick to segregate clicks that may start inside dialog but end outside, and avoid listen to scrollbar clicks
      EventHandler.one(this._element, EVENT_CLICK_DISMISS, event2 => {
        if (this._element !== event.target || this._element !== event2.target) {
          return
        }
 
        if (this._config.backdrop === 'static') {
          this._triggerBackdropTransition()
          return
        }
 
        Eif (this._config.backdrop) {
          this.hide()
        }
      })
    })
  }
 
  _hideModal() {
    this._element.style.display = 'none'
    this._element.setAttribute('aria-hidden', true)
    this._element.removeAttribute('aria-modal')
    this._element.removeAttribute('role')
    this._isTransitioning = false
 
    this._backdrop.hide(() => {
      document.body.classList.remove(CLASS_NAME_OPEN)
      this._resetAdjustments()
      this._scrollBar.reset()
      EventHandler.trigger(this._element, EVENT_HIDDEN)
    })
  }
 
  _isAnimated() {
    return this._element.classList.contains(CLASS_NAME_FADE)
  }
 
  _triggerBackdropTransition() {
    const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE_PREVENTED)
    Iif (hideEvent.defaultPrevented) {
      return
    }
 
    const isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight
    const initialOverflowY = this._element.style.overflowY
    // return if the following background transition hasn't yet completed
    if (initialOverflowY === 'hidden' || this._element.classList.contains(CLASS_NAME_STATIC)) {
      return
    }
 
    Eif (!isModalOverflowing) {
      this._element.style.overflowY = 'hidden'
    }
 
    this._element.classList.add(CLASS_NAME_STATIC)
    this._queueCallback(() => {
      this._element.classList.remove(CLASS_NAME_STATIC)
      this._queueCallback(() => {
        this._element.style.overflowY = initialOverflowY
      }, this._dialog)
    }, this._dialog)
 
    this._element.focus()
  }
 
  /**
   * The following methods are used to handle overflowing modals
   */
 
  _adjustDialog() {
    const isModalOverflowing = this._element.scrollHeight > document.documentElement.clientHeight
    const scrollbarWidth = this._scrollBar.getWidth()
    const isBodyOverflowing = scrollbarWidth > 0
 
    Iif (isBodyOverflowing && !isModalOverflowing) {
      const property = isRTL() ? 'paddingLeft' : 'paddingRight'
      this._element.style[property] = `${scrollbarWidth}px`
    }
 
    Iif (!isBodyOverflowing && isModalOverflowing) {
      const property = isRTL() ? 'paddingRight' : 'paddingLeft'
      this._element.style[property] = `${scrollbarWidth}px`
    }
  }
 
  _resetAdjustments() {
    this._element.style.paddingLeft = ''
    this._element.style.paddingRight = ''
  }
 
  // Static
  static jQueryInterface(config, relatedTarget) {
    return this.each(function () {
      const data = Modal.getOrCreateInstance(this, config)
 
      if (typeof config !== 'string') {
        return
      }
 
      if (typeof data[config] === 'undefined') {
        throw new TypeError(`No method named "${config}"`)
      }
 
      data[config](relatedTarget)
    })
  }
}
 
/**
 * Data API implementation
 */
 
EventHandler.on(document, EVENT_CLICK_DATA_API, SELECTOR_DATA_TOGGLE, function (event) {
  const target = getElementFromSelector(this)
 
  if (['A', 'AREA'].includes(this.tagName)) {
    event.preventDefault()
  }
 
  EventHandler.one(target, EVENT_SHOW, showEvent => {
    if (showEvent.defaultPrevented) {
      // only register focus restorer if modal will actually get shown
      return
    }
 
    EventHandler.one(target, EVENT_HIDDEN, () => {
      if (isVisible(this)) {
        this.focus()
      }
    })
  })
 
  // avoid conflict when clicking modal toggler while another one is open
  const alreadyOpen = SelectorEngine.findOne(OPEN_SELECTOR)
  if (alreadyOpen) {
    Modal.getInstance(alreadyOpen).hide()
  }
 
  const data = Modal.getOrCreateInstance(target)
 
  data.toggle(this)
})
 
enableDismissTrigger(Modal)
 
/**
 * jQuery
 */
 
defineJQueryPlugin(Modal)
 
export default Modal