modal.js 16.4 KB
Newer Older
1
import $ from 'jquery'
2
3
4
5
import Util from './util'

/**
 * --------------------------------------------------------------------------
Mark Otto's avatar
Mark Otto committed
6
 * Bootstrap (v4.0.0): modal.js
7
8
9
10
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */

11
const Modal = (($) => {
12
13
14
15
16
17
18
  /**
   * ------------------------------------------------------------------------
   * Constants
   * ------------------------------------------------------------------------
   */

  const NAME                         = 'modal'
Mark Otto's avatar
Mark Otto committed
19
  const VERSION                      = '4.0.0'
20
  const DATA_KEY                     = 'bs.modal'
fat's avatar
fat committed
21
22
  const EVENT_KEY                    = `.${DATA_KEY}`
  const DATA_API_KEY                 = '.data-api'
23
24
25
  const JQUERY_NO_CONFLICT           = $.fn[NAME]
  const TRANSITION_DURATION          = 300
  const BACKDROP_TRANSITION_DURATION = 150
26
  const ESCAPE_KEYCODE               = 27 // KeyboardEvent.which value for Escape (Esc) key
27
28
29
30

  const Default = {
    backdrop : true,
    keyboard : true,
31
    focus    : true,
32
33
34
    show     : true
  }

fat's avatar
fat committed
35
36
37
38
39
40
41
  const DefaultType = {
    backdrop : '(boolean|string)',
    keyboard : 'boolean',
    focus    : 'boolean',
    show     : 'boolean'
  }

42
  const Event = {
XhmikosR's avatar
XhmikosR committed
43
44
45
46
    HIDE              : `hide${EVENT_KEY}`,
    HIDDEN            : `hidden${EVENT_KEY}`,
    SHOW              : `show${EVENT_KEY}`,
    SHOWN             : `shown${EVENT_KEY}`,
fat's avatar
fat committed
47
48
49
50
51
52
53
    FOCUSIN           : `focusin${EVENT_KEY}`,
    RESIZE            : `resize${EVENT_KEY}`,
    CLICK_DISMISS     : `click.dismiss${EVENT_KEY}`,
    KEYDOWN_DISMISS   : `keydown.dismiss${EVENT_KEY}`,
    MOUSEUP_DISMISS   : `mouseup.dismiss${EVENT_KEY}`,
    MOUSEDOWN_DISMISS : `mousedown.dismiss${EVENT_KEY}`,
    CLICK_DATA_API    : `click${EVENT_KEY}${DATA_API_KEY}`
54
55
56
  }

  const ClassName = {
57
58
59
60
    SCROLLBAR_MEASURER : 'modal-scrollbar-measure',
    BACKDROP           : 'modal-backdrop',
    OPEN               : 'modal-open',
    FADE               : 'fade',
Starsam80's avatar
Starsam80 committed
61
    SHOW               : 'show'
62
63
64
65
66
67
  }

  const Selector = {
    DIALOG             : '.modal-dialog',
    DATA_TOGGLE        : '[data-toggle="modal"]',
    DATA_DISMISS       : '[data-dismiss="modal"]',
68
    FIXED_CONTENT      : '.fixed-top, .fixed-bottom, .is-fixed, .sticky-top',
69
    STICKY_CONTENT     : '.sticky-top',
70
    NAVBAR_TOGGLER     : '.navbar-toggler'
71
72
73
74
75
76
77
78
79
80
  }

  /**
   * ------------------------------------------------------------------------
   * Class Definition
   * ------------------------------------------------------------------------
   */

  class Modal {
    constructor(element, config) {
fat's avatar
fat committed
81
      this._config              = this._getConfig(config)
82
83
84
85
86
87
88
89
90
      this._element             = element
      this._dialog              = $(element).find(Selector.DIALOG)[0]
      this._backdrop            = null
      this._isShown             = false
      this._isBodyOverflowing   = false
      this._ignoreBackdropClick = false
      this._scrollbarWidth      = 0
    }

XhmikosR's avatar
XhmikosR committed
91
    // Getters
92
93
94
95
96
97
98
99
100

    static get VERSION() {
      return VERSION
    }

    static get Default() {
      return Default
    }

XhmikosR's avatar
XhmikosR committed
101
    // Public
102
103
104
105
106
107

    toggle(relatedTarget) {
      return this._isShown ? this.hide() : this.show(relatedTarget)
    }

    show(relatedTarget) {
lucascono's avatar
lucascono committed
108
      if (this._isTransitioning || this._isShown) {
109
        return
110
111
      }

112
      if (Util.supportsTransitionEnd() && $(this._element).hasClass(ClassName.FADE)) {
113
114
        this._isTransitioning = true
      }
115

116
      const showEvent = $.Event(Event.SHOW, {
Jacob Thornton's avatar
Jacob Thornton committed
117
        relatedTarget
118
119
120
121
122
123
124
125
126
127
128
129
130
      })

      $(this._element).trigger(showEvent)

      if (this._isShown || showEvent.isDefaultPrevented()) {
        return
      }

      this._isShown = true

      this._checkScrollbar()
      this._setScrollbar()

David Bailey's avatar
David Bailey committed
131
132
      this._adjustDialog()

133
134
135
136
137
138
      $(document.body).addClass(ClassName.OPEN)

      this._setEscapeEvent()
      this._setResizeEvent()

      $(this._element).on(
fat's avatar
fat committed
139
        Event.CLICK_DISMISS,
140
        Selector.DATA_DISMISS,
141
        (event) => this.hide(event)
142
143
      )

fat's avatar
fat committed
144
145
      $(this._dialog).on(Event.MOUSEDOWN_DISMISS, () => {
        $(this._element).one(Event.MOUSEUP_DISMISS, (event) => {
146
          if ($(event.target).is(this._element)) {
147
            this._ignoreBackdropClick = true
148
149
150
151
          }
        })
      })

152
      this._showBackdrop(() => this._showElement(relatedTarget))
153
154
155
156
157
158
159
    }

    hide(event) {
      if (event) {
        event.preventDefault()
      }

160
161
      if (this._isTransitioning || !this._isShown) {
        return
162
      }
163

164
      const hideEvent = $.Event(Event.HIDE)
165

166
167
168
169
170
171
172
173
      $(this._element).trigger(hideEvent)

      if (!this._isShown || hideEvent.isDefaultPrevented()) {
        return
      }

      this._isShown = false

174
175
176
177
178
179
      const transition = Util.supportsTransitionEnd() && $(this._element).hasClass(ClassName.FADE)

      if (transition) {
        this._isTransitioning = true
      }

180
181
182
183
184
      this._setEscapeEvent()
      this._setResizeEvent()

      $(document).off(Event.FOCUSIN)

Starsam80's avatar
Starsam80 committed
185
      $(this._element).removeClass(ClassName.SHOW)
186

fat's avatar
fat committed
187
188
      $(this._element).off(Event.CLICK_DISMISS)
      $(this._dialog).off(Event.MOUSEDOWN_DISMISS)
189

190
      if (transition) {
191
        $(this._element)
192
          .one(Util.TRANSITION_END, (event) => this._hideModal(event))
193
194
195
196
197
198
          .emulateTransitionEnd(TRANSITION_DURATION)
      } else {
        this._hideModal()
      }
    }

fat's avatar
fat committed
199
200
201
    dispose() {
      $.removeData(this._element, DATA_KEY)

202
      $(window, document, this._element, this._backdrop).off(EVENT_KEY)
fat's avatar
fat committed
203
204
205
206
207
208
209
210
211
212
213

      this._config              = null
      this._element             = null
      this._dialog              = null
      this._backdrop            = null
      this._isShown             = null
      this._isBodyOverflowing   = null
      this._ignoreBackdropClick = null
      this._scrollbarWidth      = null
    }

214
215
216
    handleUpdate() {
      this._adjustDialog()
    }
217

XhmikosR's avatar
XhmikosR committed
218
    // Private
219

fat's avatar
fat committed
220
    _getConfig(config) {
221
222
223
224
      config = {
        ...Default,
        ...config
      }
fat's avatar
fat committed
225
226
227
228
      Util.typeCheckConfig(NAME, config, DefaultType)
      return config
    }

229
    _showElement(relatedTarget) {
230
      const transition = Util.supportsTransitionEnd() &&
231
232
233
        $(this._element).hasClass(ClassName.FADE)

      if (!this._element.parentNode ||
234
         this._element.parentNode.nodeType !== Node.ELEMENT_NODE) {
XhmikosR's avatar
XhmikosR committed
235
        // Don't move modal's DOM position
236
237
238
239
        document.body.appendChild(this._element)
      }

      this._element.style.display = 'block'
240
      this._element.removeAttribute('aria-hidden')
241
242
243
244
245
246
      this._element.scrollTop = 0

      if (transition) {
        Util.reflow(this._element)
      }

Starsam80's avatar
Starsam80 committed
247
      $(this._element).addClass(ClassName.SHOW)
248

Jacob Thornton's avatar
Jacob Thornton committed
249
250
251
      if (this._config.focus) {
        this._enforceFocus()
      }
252

253
      const shownEvent = $.Event(Event.SHOWN, {
Jacob Thornton's avatar
Jacob Thornton committed
254
        relatedTarget
255
256
      })

257
      const transitionComplete = () => {
Jacob Thornton's avatar
Jacob Thornton committed
258
259
260
        if (this._config.focus) {
          this._element.focus()
        }
261
        this._isTransitioning = false
262
263
264
265
266
267
268
269
270
271
272
273
274
275
        $(this._element).trigger(shownEvent)
      }

      if (transition) {
        $(this._dialog)
          .one(Util.TRANSITION_END, transitionComplete)
          .emulateTransitionEnd(TRANSITION_DURATION)
      } else {
        transitionComplete()
      }
    }

    _enforceFocus() {
      $(document)
XhmikosR's avatar
XhmikosR committed
276
        .off(Event.FOCUSIN) // Guard against infinite focus loop
277
        .on(Event.FOCUSIN, (event) => {
278
279
          if (document !== event.target &&
              this._element !== event.target &&
XhmikosR's avatar
XhmikosR committed
280
              $(this._element).has(event.target).length === 0) {
281
282
283
284
285
286
287
            this._element.focus()
          }
        })
    }

    _setEscapeEvent() {
      if (this._isShown && this._config.keyboard) {
fat's avatar
fat committed
288
        $(this._element).on(Event.KEYDOWN_DISMISS, (event) => {
289
          if (event.which === ESCAPE_KEYCODE) {
290
            event.preventDefault()
291
292
293
294
            this.hide()
          }
        })
      } else if (!this._isShown) {
fat's avatar
fat committed
295
        $(this._element).off(Event.KEYDOWN_DISMISS)
296
297
298
299
300
      }
    }

    _setResizeEvent() {
      if (this._isShown) {
301
        $(window).on(Event.RESIZE, (event) => this.handleUpdate(event))
302
303
304
305
306
307
308
      } else {
        $(window).off(Event.RESIZE)
      }
    }

    _hideModal() {
      this._element.style.display = 'none'
309
      this._element.setAttribute('aria-hidden', true)
310
      this._isTransitioning = false
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
      this._showBackdrop(() => {
        $(document.body).removeClass(ClassName.OPEN)
        this._resetAdjustments()
        this._resetScrollbar()
        $(this._element).trigger(Event.HIDDEN)
      })
    }

    _removeBackdrop() {
      if (this._backdrop) {
        $(this._backdrop).remove()
        this._backdrop = null
      }
    }

    _showBackdrop(callback) {
XhmikosR's avatar
XhmikosR committed
327
328
      const animate = $(this._element).hasClass(ClassName.FADE)
        ? ClassName.FADE : ''
329
330

      if (this._isShown && this._config.backdrop) {
331
        const doAnimate = Util.supportsTransitionEnd() && animate
332
333
334
335
336
337
338
339

        this._backdrop = document.createElement('div')
        this._backdrop.className = ClassName.BACKDROP

        if (animate) {
          $(this._backdrop).addClass(animate)
        }

Jacob Thornton's avatar
Jacob Thornton committed
340
        $(this._backdrop).appendTo(document.body)
341

fat's avatar
fat committed
342
        $(this._element).on(Event.CLICK_DISMISS, (event) => {
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
          if (this._ignoreBackdropClick) {
            this._ignoreBackdropClick = false
            return
          }
          if (event.target !== event.currentTarget) {
            return
          }
          if (this._config.backdrop === 'static') {
            this._element.focus()
          } else {
            this.hide()
          }
        })

        if (doAnimate) {
          Util.reflow(this._backdrop)
        }

Starsam80's avatar
Starsam80 committed
361
        $(this._backdrop).addClass(ClassName.SHOW)
362
363
364
365
366
367
368
369
370
371
372
373
374
375

        if (!callback) {
          return
        }

        if (!doAnimate) {
          callback()
          return
        }

        $(this._backdrop)
          .one(Util.TRANSITION_END, callback)
          .emulateTransitionEnd(BACKDROP_TRANSITION_DURATION)
      } else if (!this._isShown && this._backdrop) {
Starsam80's avatar
Starsam80 committed
376
        $(this._backdrop).removeClass(ClassName.SHOW)
377

378
        const callbackRemove = () => {
379
380
381
382
383
384
385
          this._removeBackdrop()
          if (callback) {
            callback()
          }
        }

        if (Util.supportsTransitionEnd() &&
386
           $(this._element).hasClass(ClassName.FADE)) {
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
          $(this._backdrop)
            .one(Util.TRANSITION_END, callbackRemove)
            .emulateTransitionEnd(BACKDROP_TRANSITION_DURATION)
        } else {
          callbackRemove()
        }
      } else if (callback) {
        callback()
      }
    }

    // ----------------------------------------------------------------------
    // the following methods are used to handle overflowing modals
    // todo (fat): these should probably be refactored out of modal.js
    // ----------------------------------------------------------------------

    _adjustDialog() {
404
      const isModalOverflowing =
405
406
407
        this._element.scrollHeight > document.documentElement.clientHeight

      if (!this._isBodyOverflowing && isModalOverflowing) {
Jacob Thornton's avatar
Jacob Thornton committed
408
        this._element.style.paddingLeft = `${this._scrollbarWidth}px`
409
410
411
      }

      if (this._isBodyOverflowing && !isModalOverflowing) {
412
        this._element.style.paddingRight = `${this._scrollbarWidth}px`
413
414
415
416
417
418
419
420
421
      }
    }

    _resetAdjustments() {
      this._element.style.paddingLeft = ''
      this._element.style.paddingRight = ''
    }

    _checkScrollbar() {
422
423
      const rect = document.body.getBoundingClientRect()
      this._isBodyOverflowing = rect.left + rect.right < window.innerWidth
424
425
426
427
      this._scrollbarWidth = this._getScrollbarWidth()
    }

    _setScrollbar() {
428
429
430
431
432
433
434
435
436
437
      if (this._isBodyOverflowing) {
        // Note: DOMNode.style.paddingRight returns the actual value or '' if not set
        //   while $(DOMNode).css('padding-right') returns the calculated value or 0 if not set

        // Adjust fixed content padding
        $(Selector.FIXED_CONTENT).each((index, element) => {
          const actualPadding = $(element)[0].style.paddingRight
          const calculatedPadding = $(element).css('padding-right')
          $(element).data('padding-right', actualPadding).css('padding-right', `${parseFloat(calculatedPadding) + this._scrollbarWidth}px`)
        })
438

439
440
441
442
443
444
445
        // Adjust sticky content margin
        $(Selector.STICKY_CONTENT).each((index, element) => {
          const actualMargin = $(element)[0].style.marginRight
          const calculatedMargin = $(element).css('margin-right')
          $(element).data('margin-right', actualMargin).css('margin-right', `${parseFloat(calculatedMargin) - this._scrollbarWidth}px`)
        })

446
447
448
449
450
451
        // Adjust navbar-toggler margin
        $(Selector.NAVBAR_TOGGLER).each((index, element) => {
          const actualMargin = $(element)[0].style.marginRight
          const calculatedMargin = $(element).css('margin-right')
          $(element).data('margin-right', actualMargin).css('margin-right', `${parseFloat(calculatedMargin) + this._scrollbarWidth}px`)
        })
452

453
454
        // Adjust body padding
        const actualPadding = document.body.style.paddingRight
455
456
        const calculatedPadding = $(document.body).css('padding-right')
        $(document.body).data('padding-right', actualPadding).css('padding-right', `${parseFloat(calculatedPadding) + this._scrollbarWidth}px`)
457
458
459
460
      }
    }

    _resetScrollbar() {
461
462
463
464
465
466
467
468
      // Restore fixed content padding
      $(Selector.FIXED_CONTENT).each((index, element) => {
        const padding = $(element).data('padding-right')
        if (typeof padding !== 'undefined') {
          $(element).css('padding-right', padding).removeData('padding-right')
        }
      })

469
470
      // Restore sticky content and navbar-toggler margin
      $(`${Selector.STICKY_CONTENT}, ${Selector.NAVBAR_TOGGLER}`).each((index, element) => {
471
472
473
474
475
476
477
        const margin = $(element).data('margin-right')
        if (typeof margin !== 'undefined') {
          $(element).css('margin-right', margin).removeData('margin-right')
        }
      })

      // Restore body padding
478
      const padding = $(document.body).data('padding-right')
479
      if (typeof padding !== 'undefined') {
480
        $(document.body).css('padding-right', padding).removeData('padding-right')
481
      }
482
483
484
    }

    _getScrollbarWidth() { // thx d.walsh
485
      const scrollDiv = document.createElement('div')
486
      scrollDiv.className = ClassName.SCROLLBAR_MEASURER
487
      document.body.appendChild(scrollDiv)
488
      const scrollbarWidth = scrollDiv.getBoundingClientRect().width - scrollDiv.clientWidth
489
490
491
492
      document.body.removeChild(scrollDiv)
      return scrollbarWidth
    }

XhmikosR's avatar
XhmikosR committed
493
    // Static
494
495
496

    static _jQueryInterface(config, relatedTarget) {
      return this.each(function () {
XhmikosR's avatar
XhmikosR committed
497
        let data = $(this).data(DATA_KEY)
498
499
500
501
502
        const _config = {
          ...Modal.Default,
          ...$(this).data(),
          ...typeof config === 'object' && config
        }
503
504
505
506
507
508
509

        if (!data) {
          data = new Modal(this, _config)
          $(this).data(DATA_KEY, data)
        }

        if (typeof config === 'string') {
XhmikosR's avatar
XhmikosR committed
510
          if (typeof data[config] === 'undefined') {
XhmikosR's avatar
XhmikosR committed
511
            throw new TypeError(`No method named "${config}"`)
512
          }
513
514
515
516
517
518
519
520
521
522
523
524
525
526
          data[config](relatedTarget)
        } else if (_config.show) {
          data.show(relatedTarget)
        }
      })
    }
  }

  /**
   * ------------------------------------------------------------------------
   * Data Api implementation
   * ------------------------------------------------------------------------
   */

fat's avatar
fat committed
527
  $(document).on(Event.CLICK_DATA_API, Selector.DATA_TOGGLE, function (event) {
528
    let target
529
    const selector = Util.getSelectorFromElement(this)
530
531
532
533
534

    if (selector) {
      target = $(selector)[0]
    }

XhmikosR's avatar
XhmikosR committed
535
536
    const config = $(target).data(DATA_KEY)
      ? 'toggle' : {
537
538
539
        ...$(target).data(),
        ...$(this).data()
      }
540

541
    if (this.tagName === 'A' || this.tagName === 'AREA') {
542
543
544
      event.preventDefault()
    }

545
    const $target = $(target).one(Event.SHOW, (showEvent) => {
546
      if (showEvent.isDefaultPrevented()) {
XhmikosR's avatar
XhmikosR committed
547
        // Only register focus restorer if modal will actually get shown
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
        return
      }

      $target.one(Event.HIDDEN, () => {
        if ($(this).is(':visible')) {
          this.focus()
        }
      })
    })

    Modal._jQueryInterface.call($(target), config, this)
  })

  /**
   * ------------------------------------------------------------------------
   * jQuery
   * ------------------------------------------------------------------------
   */

XhmikosR's avatar
XhmikosR committed
567
  $.fn[NAME] = Modal._jQueryInterface
568
  $.fn[NAME].Constructor = Modal
XhmikosR's avatar
XhmikosR committed
569
  $.fn[NAME].noConflict = function () {
570
571
572
573
574
    $.fn[NAME] = JQUERY_NO_CONFLICT
    return Modal._jQueryInterface
  }

  return Modal
575
})($)
576
577

export default Modal