Skip to content
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.

Sign up for GitHub

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

Refactor Modal.dispose and add test #27455

Merged
merged 2 commits into from
Oct 30, 2018
+47 −4
Merged

Refactor Modal.dispose and add test #27455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a00aca2
refactor(Modal): add `_isTransitioning` default value
iamandrewluca Oct 16, 2018
9a41a95
test(Modal): check if modal is disposed
iamandrewluca Oct 18, 2018
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
18 changes: 14 additions & 4 deletions js/src/modal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ class Modal {
this._isShown = false
this._isBodyOverflowing = false
this._ignoreBackdropClick = false
this._isTransitioning = false
this._scrollbarWidth = 0
}

Expand All @@ -101,7 +102,7 @@ class Modal {
}

show(relatedTarget) {
if (this._isTransitioning || this._isShown) {
if (this._isShown || this._isTransitioning) {
return
}

Expand Down Expand Up @@ -153,7 +154,7 @@ class Modal {
event.preventDefault()
}

if (this._isTransitioning || !this._isShown) {
if (!this._isShown || this._isTransitioning) {
return
}

Expand Down Expand Up @@ -195,9 +196,17 @@ class Modal {
}

dispose() {
$.removeData(this._element, DATA_KEY)
[window, this._element, this._dialog]
.forEach((htmlElement) => $(htmlElement).off(EVENT_KEY))

/**
* `document` has 2 events `Event.FOCUSIN` and `Event.CLICK_DATA_API`
* Do not move `document` in `htmlElements` array
* It will remove `Event.CLICK_DATA_API` event that should remain
*/
$(document).off(Event.FOCUSIN)

$(window, document, this._element, this._backdrop).off(EVENT_KEY)
$.removeData(this._element, DATA_KEY)

this._config = null
this._element = null
Expand All @@ -206,6 +215,7 @@ class Modal {
this._isShown = null
this._isBodyOverflowing = null
this._ignoreBackdropClick = null
this._isTransitioning = null
this._scrollbarWidth = null
}

Expand Down
33 changes: 33 additions & 0 deletions js/tests/unit/modal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -697,4 +697,37 @@ $(function () {

beginTimestamp = Date.now()
})

QUnit.test('should dispose modal', function (assert) {
assert.expect(3)
var done = assert.async()

var $modal = $([
'<div id="modal-test">',
' <div class="modal-dialog">',
' <div class="modal-content">',
' <div class="modal-body" />',
' </div>',
' </div>',
'</div>'
].join('')).appendTo('#qunit-fixture')

$modal.on('shown.bs.modal', function () {
var spy = sinon.spy($.fn, 'off')

$(this).bootstrapModal('dispose')

const modalDataApiEvent = $._data(document, 'events').click
.find((e) => e.namespace === 'bs.data-api.modal')

assert.ok(typeof $(this).data('bs.modal') === 'undefined', 'modal data object was disposed')

assert.ok(spy.callCount === 4, '`jQuery.off` was called')

assert.ok(typeof modalDataApiEvent !== 'undefined', '`Event.CLICK_DATA_API` on `document` was not removed')

$.fn.off.restore()
done()
}).bootstrapModal('show')
})
})