mirror of
https://github.com/twbs/bootstrap.git
synced 2024-11-29 11:24:18 +01:00
195440f2fb
* Add responsive offcanvas classes - Updates navbar-expand classes to de-dupe some styles—these shouldn't interfere now. - Adds some JS to the offcanvas component to help with responsiveness Co-Authored-By: GeoSot <geo.sotis@gmail.com> * Redesign homepage, docs, and examples Homepage: - New Bootstrap purple navbar - Redesigned masthead - Rewrote and redesigned homepage content - Replace Copy text with icons like Bootstrap Icons site across all ClipboardJS instances - Fixed padding issues in site footer - Match homepage button styles to examples page, use gap instead of tons of responsive margin utils Docs: - New navbar, no more subnav. Migrated search and version picker into the main navbar and refreshed the design of it all, including the responsive toggles. - New sidebar navigation is always expanded, and now features Bootstrap Icons alongside section headings - Sidebar navigation autoscrolls to active link for better usability - Subnav and navbar padding issues ironed out - Enhanced the version picker in anticipation of v5.2: we can now link right to the same page in the previous version. - Redesign callouts to add more color to our pages - Collapse table of contents on mobile - Cleanup and redesign button styles with CSS variables - Update design for subnav version dropdown - Update highlight and example to be full-width until md - Improve the Added In badges - Turn the ToC into a well on mobile - Redesign code snippets to better house two action buttons Examples: - Redesign Examples page layout - Add new example for responsive offcanvases in navbars * Convert offcanvas to CSS vars * Feat: add resize handler to Offcanvas.js. If we could use as default the `.offcanvas` class without modifiers, we then, could add a simplified selector The selector itself, ignores the .offcanvas class as it doesn't have any responsive behavior The `aria-modal` addon is to protect us, selection backdrop elements * Separate examples code, Add some selectors, fix stackblitz btn Co-authored-by: GeoSot <geo.sotis@gmail.com>
893 lines
29 KiB
JavaScript
893 lines
29 KiB
JavaScript
import Offcanvas from '../../src/offcanvas'
|
|
import EventHandler from '../../src/dom/event-handler'
|
|
import { clearBodyAndDocument, clearFixture, createEvent, getFixture, jQueryMock } from '../helpers/fixture'
|
|
import { isVisible } from '../../src/util/index'
|
|
import ScrollBarHelper from '../../src/util/scrollbar'
|
|
|
|
describe('Offcanvas', () => {
|
|
let fixtureEl
|
|
|
|
beforeAll(() => {
|
|
fixtureEl = getFixture()
|
|
})
|
|
|
|
afterEach(() => {
|
|
clearFixture()
|
|
document.body.classList.remove('offcanvas-open')
|
|
clearBodyAndDocument()
|
|
})
|
|
|
|
beforeEach(() => {
|
|
clearBodyAndDocument()
|
|
})
|
|
|
|
describe('VERSION', () => {
|
|
it('should return plugin version', () => {
|
|
expect(Offcanvas.VERSION).toEqual(jasmine.any(String))
|
|
})
|
|
})
|
|
|
|
describe('Default', () => {
|
|
it('should return plugin default config', () => {
|
|
expect(Offcanvas.Default).toEqual(jasmine.any(Object))
|
|
})
|
|
})
|
|
|
|
describe('DATA_KEY', () => {
|
|
it('should return plugin data key', () => {
|
|
expect(Offcanvas.DATA_KEY).toEqual('bs.offcanvas')
|
|
})
|
|
})
|
|
|
|
describe('constructor', () => {
|
|
it('should call hide when a element with data-bs-dismiss="offcanvas" is clicked', () => {
|
|
fixtureEl.innerHTML = [
|
|
'<div class="offcanvas">',
|
|
' <a href="#" data-bs-dismiss="offcanvas">Close</a>',
|
|
'</div>'
|
|
].join('')
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const closeEl = fixtureEl.querySelector('a')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
spyOn(offCanvas, 'hide')
|
|
|
|
closeEl.click()
|
|
|
|
expect(offCanvas._config.keyboard).toBeTrue()
|
|
expect(offCanvas.hide).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should hide if esc is pressed', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
const keyDownEsc = createEvent('keydown')
|
|
keyDownEsc.key = 'Escape'
|
|
|
|
spyOn(offCanvas, 'hide')
|
|
|
|
offCanvasEl.dispatchEvent(keyDownEsc)
|
|
|
|
expect(offCanvas.hide).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should hide if esc is pressed and backdrop is static', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { backdrop: 'static' })
|
|
const keyDownEsc = createEvent('keydown')
|
|
keyDownEsc.key = 'Escape'
|
|
|
|
spyOn(offCanvas, 'hide')
|
|
|
|
offCanvasEl.dispatchEvent(keyDownEsc)
|
|
|
|
expect(offCanvas.hide).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not hide if esc is not pressed', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
const keydownTab = createEvent('keydown')
|
|
keydownTab.key = 'Tab'
|
|
|
|
spyOn(offCanvas, 'hide')
|
|
|
|
offCanvasEl.dispatchEvent(keydownTab)
|
|
|
|
expect(offCanvas.hide).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should not hide if esc is pressed but with keyboard = false', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { keyboard: false })
|
|
const keyDownEsc = createEvent('keydown')
|
|
keyDownEsc.key = 'Escape'
|
|
|
|
spyOn(offCanvas, 'hide')
|
|
const hidePreventedSpy = jasmine.createSpy('hidePrevented')
|
|
offCanvasEl.addEventListener('hidePrevented.bs.offcanvas', hidePreventedSpy)
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvas._config.keyboard).toBeFalse()
|
|
offCanvasEl.dispatchEvent(keyDownEsc)
|
|
|
|
expect(hidePreventedSpy).toHaveBeenCalled()
|
|
expect(offCanvas.hide).not.toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('should not hide if user clicks on static backdrop', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { backdrop: 'static' })
|
|
|
|
const clickEvent = new Event('mousedown', { bubbles: true, cancelable: true })
|
|
spyOn(offCanvas._backdrop._config, 'clickCallback').and.callThrough()
|
|
spyOn(offCanvas._backdrop, 'hide').and.callThrough()
|
|
const hidePreventedSpy = jasmine.createSpy('hidePrevented')
|
|
offCanvasEl.addEventListener('hidePrevented.bs.offcanvas', hidePreventedSpy)
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvas._backdrop._config.clickCallback).toEqual(jasmine.any(Function))
|
|
|
|
offCanvas._backdrop._getElement().dispatchEvent(clickEvent)
|
|
expect(hidePreventedSpy).toHaveBeenCalled()
|
|
expect(offCanvas._backdrop.hide).not.toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('should call `hide` on resize, if element\'s position is not fixed any more', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas-lg"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
spyOn(offCanvas, 'hide').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
const resizeEvent = createEvent('resize')
|
|
offCanvasEl.style.removeProperty('position')
|
|
|
|
window.dispatchEvent(resizeEvent)
|
|
expect(offCanvas.hide).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('config', () => {
|
|
it('should have default values', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
expect(offCanvas._config.backdrop).toBeTrue()
|
|
expect(offCanvas._backdrop._config.isVisible).toBeTrue()
|
|
expect(offCanvas._config.keyboard).toBeTrue()
|
|
expect(offCanvas._config.scroll).toBeFalse()
|
|
})
|
|
|
|
it('should read data attributes and override default config', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas" data-bs-scroll="true" data-bs-backdrop="false" data-bs-keyboard="false"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
expect(offCanvas._config.backdrop).toBeFalse()
|
|
expect(offCanvas._backdrop._config.isVisible).toBeFalse()
|
|
expect(offCanvas._config.keyboard).toBeFalse()
|
|
expect(offCanvas._config.scroll).toBeTrue()
|
|
})
|
|
|
|
it('given a config object must override data attributes', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas" data-bs-scroll="true" data-bs-backdrop="false" data-bs-keyboard="false"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, {
|
|
backdrop: true,
|
|
keyboard: true,
|
|
scroll: false
|
|
})
|
|
expect(offCanvas._config.backdrop).toBeTrue()
|
|
expect(offCanvas._config.keyboard).toBeTrue()
|
|
expect(offCanvas._config.scroll).toBeFalse()
|
|
})
|
|
})
|
|
|
|
describe('options', () => {
|
|
it('if scroll is enabled, should allow body to scroll while offcanvas is open', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
spyOn(ScrollBarHelper.prototype, 'hide').and.callThrough()
|
|
spyOn(ScrollBarHelper.prototype, 'reset').and.callThrough()
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { scroll: true })
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(ScrollBarHelper.prototype.hide).not.toHaveBeenCalled()
|
|
offCanvas.hide()
|
|
})
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(ScrollBarHelper.prototype.reset).not.toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('if scroll is disabled, should call ScrollBarHelper to handle scrollBar on body', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
spyOn(ScrollBarHelper.prototype, 'hide').and.callThrough()
|
|
spyOn(ScrollBarHelper.prototype, 'reset').and.callThrough()
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { scroll: false })
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(ScrollBarHelper.prototype.hide).toHaveBeenCalled()
|
|
offCanvas.hide()
|
|
})
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(ScrollBarHelper.prototype.reset).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('should hide a shown element if user click on backdrop', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl, { backdrop: true })
|
|
|
|
const clickEvent = new Event('mousedown', { bubbles: true, cancelable: true })
|
|
spyOn(offCanvas._backdrop._config, 'clickCallback').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvas._backdrop._config.clickCallback).toEqual(jasmine.any(Function))
|
|
|
|
offCanvas._backdrop._getElement().dispatchEvent(clickEvent)
|
|
})
|
|
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(offCanvas._backdrop._config.clickCallback).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('should not trap focus if scroll is allowed', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl, {
|
|
scroll: true
|
|
})
|
|
|
|
spyOn(offCanvas._focustrap, 'activate').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvas._focustrap.activate).not.toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('toggle', () => {
|
|
it('should call show method if show class is not present', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
spyOn(offCanvas, 'show')
|
|
|
|
offCanvas.toggle()
|
|
|
|
expect(offCanvas.show).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should call hide method if show class is present', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
spyOn(offCanvas, 'hide')
|
|
|
|
offCanvas.toggle()
|
|
|
|
expect(offCanvas.hide).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('show', () => {
|
|
it('should add `showing` class during opening and `show` class on end', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
offCanvasEl.addEventListener('show.bs.offcanvas', () => {
|
|
expect(offCanvasEl).not.toHaveClass('show')
|
|
})
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvasEl).not.toHaveClass('showing')
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
expect(offCanvasEl).toHaveClass('showing')
|
|
})
|
|
})
|
|
|
|
it('should do nothing if already shown', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas show"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
offCanvas.show()
|
|
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
|
|
spyOn(offCanvas._backdrop, 'show').and.callThrough()
|
|
spyOn(EventHandler, 'trigger').and.callThrough()
|
|
offCanvas.show()
|
|
|
|
expect(EventHandler.trigger).not.toHaveBeenCalled()
|
|
expect(offCanvas._backdrop.show).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should show a hidden element', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._backdrop, 'show').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
expect(offCanvas._backdrop.show).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('should not fire shown when show is prevented', () => {
|
|
return new Promise((resolve, reject) => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._backdrop, 'show').and.callThrough()
|
|
|
|
const expectEnd = () => {
|
|
setTimeout(() => {
|
|
expect(offCanvas._backdrop.show).not.toHaveBeenCalled()
|
|
resolve()
|
|
}, 10)
|
|
}
|
|
|
|
offCanvasEl.addEventListener('show.bs.offcanvas', event => {
|
|
event.preventDefault()
|
|
expectEnd()
|
|
})
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
reject(new Error('should not fire shown event'))
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
|
|
it('on window load, should make visible an offcanvas element, if its markup contains class "show"', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas show"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
spyOn(Offcanvas.prototype, 'show').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
resolve()
|
|
})
|
|
|
|
window.dispatchEvent(createEvent('load'))
|
|
|
|
const instance = Offcanvas.getInstance(offCanvasEl)
|
|
expect(instance).not.toBeNull()
|
|
expect(Offcanvas.prototype.show).toHaveBeenCalled()
|
|
})
|
|
})
|
|
|
|
it('should trap focus', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
spyOn(offCanvas._focustrap, 'activate').and.callThrough()
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvas._focustrap.activate).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('hide', () => {
|
|
it('should add `hiding` class during closing and remover `show` & `hiding` classes on end', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
const offCanvasEl = fixtureEl.querySelector('.offcanvas')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
|
|
offCanvasEl.addEventListener('hide.bs.offcanvas', () => {
|
|
expect(offCanvasEl).not.toHaveClass('showing')
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
})
|
|
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(offCanvasEl).not.toHaveClass('hiding')
|
|
expect(offCanvasEl).not.toHaveClass('show')
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.show()
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
offCanvas.hide()
|
|
expect(offCanvasEl).not.toHaveClass('showing')
|
|
expect(offCanvasEl).toHaveClass('hiding')
|
|
})
|
|
})
|
|
})
|
|
|
|
it('should do nothing if already shown', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
spyOn(EventHandler, 'trigger').and.callThrough()
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._backdrop, 'hide').and.callThrough()
|
|
|
|
offCanvas.hide()
|
|
expect(offCanvas._backdrop.hide).not.toHaveBeenCalled()
|
|
expect(EventHandler.trigger).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should hide a shown element', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._backdrop, 'hide').and.callThrough()
|
|
offCanvas.show()
|
|
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(offCanvasEl).not.toHaveClass('show')
|
|
expect(offCanvas._backdrop.hide).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.hide()
|
|
})
|
|
})
|
|
|
|
it('should not fire hidden when hide is prevented', () => {
|
|
return new Promise((resolve, reject) => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._backdrop, 'hide').and.callThrough()
|
|
|
|
offCanvas.show()
|
|
|
|
const expectEnd = () => {
|
|
setTimeout(() => {
|
|
expect(offCanvas._backdrop.hide).not.toHaveBeenCalled()
|
|
resolve()
|
|
}, 10)
|
|
}
|
|
|
|
offCanvasEl.addEventListener('hide.bs.offcanvas', event => {
|
|
event.preventDefault()
|
|
expectEnd()
|
|
})
|
|
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
reject(new Error('should not fire hidden event'))
|
|
})
|
|
|
|
offCanvas.hide()
|
|
})
|
|
})
|
|
|
|
it('should release focus trap', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
spyOn(offCanvas._focustrap, 'deactivate').and.callThrough()
|
|
offCanvas.show()
|
|
|
|
offCanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(offCanvas._focustrap.deactivate).toHaveBeenCalled()
|
|
resolve()
|
|
})
|
|
|
|
offCanvas.hide()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('dispose', () => {
|
|
it('should dispose an offcanvas', () => {
|
|
fixtureEl.innerHTML = '<div class="offcanvas"></div>'
|
|
|
|
const offCanvasEl = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(offCanvasEl)
|
|
const backdrop = offCanvas._backdrop
|
|
spyOn(backdrop, 'dispose').and.callThrough()
|
|
const focustrap = offCanvas._focustrap
|
|
spyOn(focustrap, 'deactivate').and.callThrough()
|
|
|
|
expect(Offcanvas.getInstance(offCanvasEl)).toEqual(offCanvas)
|
|
|
|
spyOn(EventHandler, 'off')
|
|
|
|
offCanvas.dispose()
|
|
|
|
expect(backdrop.dispose).toHaveBeenCalled()
|
|
expect(offCanvas._backdrop).toBeNull()
|
|
expect(focustrap.deactivate).toHaveBeenCalled()
|
|
expect(offCanvas._focustrap).toBeNull()
|
|
expect(Offcanvas.getInstance(offCanvasEl)).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe('data-api', () => {
|
|
it('should not prevent event for input', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = [
|
|
'<input type="checkbox" data-bs-toggle="offcanvas" data-bs-target="#offcanvasdiv1" />',
|
|
'<div id="offcanvasdiv1" class="offcanvas"></div>'
|
|
].join('')
|
|
|
|
const target = fixtureEl.querySelector('input')
|
|
const offCanvasEl = fixtureEl.querySelector('#offcanvasdiv1')
|
|
|
|
offCanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
expect(offCanvasEl).toHaveClass('show')
|
|
expect(target.checked).toBeTrue()
|
|
resolve()
|
|
})
|
|
|
|
target.click()
|
|
})
|
|
})
|
|
|
|
it('should not call toggle on disabled elements', () => {
|
|
fixtureEl.innerHTML = [
|
|
'<a href="#" data-bs-toggle="offcanvas" data-bs-target="#offcanvasdiv1" class="disabled"></a>',
|
|
'<div id="offcanvasdiv1" class="offcanvas"></div>'
|
|
].join('')
|
|
|
|
const target = fixtureEl.querySelector('a')
|
|
|
|
spyOn(Offcanvas.prototype, 'toggle')
|
|
|
|
target.click()
|
|
|
|
expect(Offcanvas.prototype.toggle).not.toHaveBeenCalled()
|
|
})
|
|
|
|
it('should call hide first, if another offcanvas is open', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = [
|
|
'<button id="btn2" data-bs-toggle="offcanvas" data-bs-target="#offcanvas2"></button>',
|
|
'<div id="offcanvas1" class="offcanvas"></div>',
|
|
'<div id="offcanvas2" class="offcanvas"></div>'
|
|
].join('')
|
|
|
|
const trigger2 = fixtureEl.querySelector('#btn2')
|
|
const offcanvasEl1 = document.querySelector('#offcanvas1')
|
|
const offcanvasEl2 = document.querySelector('#offcanvas2')
|
|
const offcanvas1 = new Offcanvas(offcanvasEl1)
|
|
|
|
offcanvasEl1.addEventListener('shown.bs.offcanvas', () => {
|
|
trigger2.click()
|
|
})
|
|
offcanvasEl1.addEventListener('hidden.bs.offcanvas', () => {
|
|
expect(Offcanvas.getInstance(offcanvasEl2)).not.toBeNull()
|
|
resolve()
|
|
})
|
|
offcanvas1.show()
|
|
})
|
|
})
|
|
|
|
it('should focus on trigger element after closing offcanvas', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = [
|
|
'<button id="btn" data-bs-toggle="offcanvas" data-bs-target="#offcanvas"></button>',
|
|
'<div id="offcanvas" class="offcanvas"></div>'
|
|
].join('')
|
|
|
|
const trigger = fixtureEl.querySelector('#btn')
|
|
const offcanvasEl = fixtureEl.querySelector('#offcanvas')
|
|
const offcanvas = new Offcanvas(offcanvasEl)
|
|
spyOn(trigger, 'focus')
|
|
|
|
offcanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
offcanvas.hide()
|
|
})
|
|
offcanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
setTimeout(() => {
|
|
expect(trigger.focus).toHaveBeenCalled()
|
|
resolve()
|
|
}, 5)
|
|
})
|
|
|
|
trigger.click()
|
|
})
|
|
})
|
|
|
|
it('should not focus on trigger element after closing offcanvas, if it is not visible', () => {
|
|
return new Promise(resolve => {
|
|
fixtureEl.innerHTML = [
|
|
'<button id="btn" data-bs-toggle="offcanvas" data-bs-target="#offcanvas"></button>',
|
|
'<div id="offcanvas" class="offcanvas"></div>'
|
|
].join('')
|
|
|
|
const trigger = fixtureEl.querySelector('#btn')
|
|
const offcanvasEl = fixtureEl.querySelector('#offcanvas')
|
|
const offcanvas = new Offcanvas(offcanvasEl)
|
|
spyOn(trigger, 'focus')
|
|
|
|
offcanvasEl.addEventListener('shown.bs.offcanvas', () => {
|
|
trigger.style.display = 'none'
|
|
offcanvas.hide()
|
|
})
|
|
offcanvasEl.addEventListener('hidden.bs.offcanvas', () => {
|
|
setTimeout(() => {
|
|
expect(isVisible(trigger)).toBeFalse()
|
|
expect(trigger.focus).not.toHaveBeenCalled()
|
|
resolve()
|
|
}, 5)
|
|
})
|
|
|
|
trigger.click()
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('jQueryInterface', () => {
|
|
it('should create an offcanvas', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
jQueryMock.fn.offcanvas.call(jQueryMock)
|
|
|
|
expect(Offcanvas.getInstance(div)).not.toBeNull()
|
|
})
|
|
|
|
it('should not re create an offcanvas', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(div)
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
jQueryMock.fn.offcanvas.call(jQueryMock)
|
|
|
|
expect(Offcanvas.getInstance(div)).toEqual(offCanvas)
|
|
})
|
|
|
|
it('should throw error on undefined method', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const action = 'undefinedMethod'
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
expect(() => {
|
|
jQueryMock.fn.offcanvas.call(jQueryMock, action)
|
|
}).toThrowError(TypeError, `No method named "${action}"`)
|
|
})
|
|
|
|
it('should throw error on protected method', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const action = '_getConfig'
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
expect(() => {
|
|
jQueryMock.fn.offcanvas.call(jQueryMock, action)
|
|
}).toThrowError(TypeError, `No method named "${action}"`)
|
|
})
|
|
|
|
it('should throw error if method "constructor" is being called', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const action = 'constructor'
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
expect(() => {
|
|
jQueryMock.fn.offcanvas.call(jQueryMock, action)
|
|
}).toThrowError(TypeError, `No method named "${action}"`)
|
|
})
|
|
|
|
it('should call offcanvas method', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
spyOn(Offcanvas.prototype, 'show')
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
jQueryMock.fn.offcanvas.call(jQueryMock, 'show')
|
|
expect(Offcanvas.prototype.show).toHaveBeenCalled()
|
|
})
|
|
|
|
it('should create a offcanvas with given config', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
jQueryMock.fn.offcanvas = Offcanvas.jQueryInterface
|
|
jQueryMock.elements = [div]
|
|
|
|
jQueryMock.fn.offcanvas.call(jQueryMock, { scroll: true })
|
|
|
|
const offcanvas = Offcanvas.getInstance(div)
|
|
expect(offcanvas).not.toBeNull()
|
|
expect(offcanvas._config.scroll).toBeTrue()
|
|
})
|
|
})
|
|
|
|
describe('getInstance', () => {
|
|
it('should return offcanvas instance', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const offCanvas = new Offcanvas(div)
|
|
|
|
expect(Offcanvas.getInstance(div)).toEqual(offCanvas)
|
|
expect(Offcanvas.getInstance(div)).toBeInstanceOf(Offcanvas)
|
|
})
|
|
|
|
it('should return null when there is no offcanvas instance', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
expect(Offcanvas.getInstance(div)).toBeNull()
|
|
})
|
|
})
|
|
|
|
describe('getOrCreateInstance', () => {
|
|
it('should return offcanvas instance', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const offcanvas = new Offcanvas(div)
|
|
|
|
expect(Offcanvas.getOrCreateInstance(div)).toEqual(offcanvas)
|
|
expect(Offcanvas.getInstance(div)).toEqual(Offcanvas.getOrCreateInstance(div, {}))
|
|
expect(Offcanvas.getOrCreateInstance(div)).toBeInstanceOf(Offcanvas)
|
|
})
|
|
|
|
it('should return new instance when there is no Offcanvas instance', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
expect(Offcanvas.getInstance(div)).toBeNull()
|
|
expect(Offcanvas.getOrCreateInstance(div)).toBeInstanceOf(Offcanvas)
|
|
})
|
|
|
|
it('should return new instance when there is no offcanvas instance with given configuration', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
|
|
expect(Offcanvas.getInstance(div)).toBeNull()
|
|
const offcanvas = Offcanvas.getOrCreateInstance(div, {
|
|
scroll: true
|
|
})
|
|
expect(offcanvas).toBeInstanceOf(Offcanvas)
|
|
|
|
expect(offcanvas._config.scroll).toBeTrue()
|
|
})
|
|
|
|
it('should return the instance when exists without given configuration', () => {
|
|
fixtureEl.innerHTML = '<div></div>'
|
|
|
|
const div = fixtureEl.querySelector('div')
|
|
const offcanvas = new Offcanvas(div, {
|
|
scroll: true
|
|
})
|
|
expect(Offcanvas.getInstance(div)).toEqual(offcanvas)
|
|
|
|
const offcanvas2 = Offcanvas.getOrCreateInstance(div, {
|
|
scroll: false
|
|
})
|
|
expect(offcanvas).toBeInstanceOf(Offcanvas)
|
|
expect(offcanvas2).toEqual(offcanvas)
|
|
|
|
expect(offcanvas2._config.scroll).toBeTrue()
|
|
})
|
|
})
|
|
})
|