Skip to content

Clear timeout before showing the toast #31155

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

Merged
merged 5 commits into from
Jul 11, 2020
Merged

Clear timeout before showing the toast #31155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a8edb3
clear timeout before showing the toast
rohit2sharma95 Jun 23, 2020
a4489f4
Add unit test
rohit2sharma95 Jun 23, 2020
3a6ba3a
Merge branch 'main' into toast-timeout
XhmikosR Jul 3, 2020
a48507b
Remove the check for timeout
rohit2sharma95 Jul 7, 2020
616dc15
Check for clearTimeout to have been called
rohit2sharma95 Jul 7, 2020
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
10 changes: 8 additions & 2 deletions js/src/toast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ class Toast {
return
}

this._clearTimeout()

if (this._config.animation) {
this._element.classList.add(CLASS_NAME_FADE)
}
Expand Down Expand Up @@ -149,8 +151,7 @@ class Toast {
}

dispose() {
clearTimeout(this._timeout)
this._timeout = null
this._clearTimeout()

if (this._element.classList.contains(CLASS_NAME_SHOW)) {
this._element.classList.remove(CLASS_NAME_SHOW)
Expand Down Expand Up @@ -186,6 +187,11 @@ class Toast {
)
}

_clearTimeout() {
clearTimeout(this._timeout)
this._timeout = null
}

// Static

static jQueryInterface(config) {
Expand Down
27 changes: 27 additions & 0 deletions js/tests/unit/toast.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,33 @@ describe('Toast', () => {

toast.show()
})

it('should clear timeout if toast is shown again before it is hidden', done => {
fixtureEl.innerHTML = [
'<div class="toast">',
' <div class="toast-body">',
' a simple toast',
' </div>',
'</div>'
].join('')

const toastEl = fixtureEl.querySelector('.toast')
const toast = new Toast(toastEl)

setTimeout(() => {
toast._config.autohide = false
toastEl.addEventListener('shown.bs.toast', () => {
expect(toast._clearTimeout).toHaveBeenCalled()
expect(toast._timeout).toBeNull()
done()
})
toast.show()
}, toast._config.delay / 2)

spyOn(toast, '_clearTimeout').and.callThrough()

toast.show()
})
})

describe('hide', () => {
Expand Down