import Offcanvas from '../../src/offcanvas' import EventHandler from '../../src/dom/event-handler' /** Test helpers */ import { clearBodyAndDocument, clearFixture, createEvent, getFixture, jQueryMock } from '../helpers/fixture' import { isVisible } from '../../src/util' 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 = [ '
', ' Close', '
' ].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).toBe(true) expect(offCanvas.hide).toHaveBeenCalled() }) it('should hide if esc is pressed', () => { fixtureEl.innerHTML = '
' 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 not hide if esc is not pressed', () => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl) const keydownTab = createEvent('keydown') keydownTab.key = 'Tab' spyOn(offCanvas, 'hide') document.dispatchEvent(keydownTab) expect(offCanvas.hide).not.toHaveBeenCalled() }) it('should not hide if esc is pressed but with keyboard = false', () => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl, { keyboard: false }) const keyDownEsc = createEvent('keydown') keyDownEsc.key = 'Escape' spyOn(offCanvas, 'hide') document.dispatchEvent(keyDownEsc) expect(offCanvas._config.keyboard).toBe(false) expect(offCanvas.hide).not.toHaveBeenCalled() }) }) describe('config', () => { it('should have default values', () => { fixtureEl.innerHTML = [ '
', '
' ].join('') const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl) expect(offCanvas._config.backdrop).toEqual(true) expect(offCanvas._backdrop._config.isVisible).toEqual(true) expect(offCanvas._config.keyboard).toEqual(true) expect(offCanvas._config.scroll).toEqual(false) }) it('should read data attributes and override default config', () => { fixtureEl.innerHTML = [ '
', '
' ].join('') const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl) expect(offCanvas._config.backdrop).toEqual(false) expect(offCanvas._backdrop._config.isVisible).toEqual(false) expect(offCanvas._config.keyboard).toEqual(false) expect(offCanvas._config.scroll).toEqual(true) }) it('given a config object must override data attributes', () => { fixtureEl.innerHTML = [ '
', '
' ].join('') const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl, { backdrop: true, keyboard: true, scroll: false }) expect(offCanvas._config.backdrop).toEqual(true) expect(offCanvas._config.keyboard).toEqual(true) expect(offCanvas._config.scroll).toEqual(false) }) }) describe('options', () => { it('if scroll is enabled, should allow body to scroll while offcanvas is open', done => { fixtureEl.innerHTML = '
' 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() done() }) offCanvas.show() }) it('if scroll is disabled, should call ScrollBarHelper to handle scrollBar on body', done => { fixtureEl.innerHTML = '
' 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() done() }) offCanvas.show() }) it('should hide a shown element if user click on backdrop', done => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('div') const offCanvas = new Offcanvas(offCanvasEl, { backdrop: true }) const clickEvent = document.createEvent('MouseEvents') clickEvent.initEvent('mousedown', true, true) spyOn(offCanvas._backdrop._config, 'clickCallback').and.callThrough() offCanvasEl.addEventListener('shown.bs.offcanvas', () => { expect(typeof offCanvas._backdrop._config.clickCallback).toBe('function') offCanvas._backdrop._getElement().dispatchEvent(clickEvent) }) offCanvasEl.addEventListener('hidden.bs.offcanvas', () => { expect(offCanvas._backdrop._config.clickCallback).toHaveBeenCalled() done() }) offCanvas.show() }) it('should not trap focus if scroll is allowed', done => { fixtureEl.innerHTML = '
' 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() done() }) offCanvas.show() }) }) describe('toggle', () => { it('should call show method if show class is not present', () => { fixtureEl.innerHTML = '
' 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', () => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('.offcanvas') const offCanvas = new Offcanvas(offCanvasEl) offCanvas.show() expect(offCanvasEl.classList.contains('show')).toBe(true) spyOn(offCanvas, 'hide') offCanvas.toggle() expect(offCanvas.hide).toHaveBeenCalled() }) }) describe('show', () => { it('should do nothing if already shown', () => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('div') const offCanvas = new Offcanvas(offCanvasEl) offCanvas.show() expect(offCanvasEl.classList.contains('show')).toBe(true) 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', done => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('div') const offCanvas = new Offcanvas(offCanvasEl) spyOn(offCanvas._backdrop, 'show').and.callThrough() offCanvasEl.addEventListener('shown.bs.offcanvas', () => { expect(offCanvasEl.classList.contains('show')).toEqual(true) expect(offCanvas._backdrop.show).toHaveBeenCalled() done() }) offCanvas.show() }) it('should not fire shown when show is prevented', done => { fixtureEl.innerHTML = '
' 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() done() }, 10) } offCanvasEl.addEventListener('show.bs.offcanvas', e => { e.preventDefault() expectEnd() }) offCanvasEl.addEventListener('shown.bs.offcanvas', () => { throw 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"', done => { fixtureEl.innerHTML = '
' const offCanvasEl = fixtureEl.querySelector('div') spyOn(Offcanvas.prototype, 'show').and.callThrough() offCanvasEl.addEventListener('shown.bs.offcanvas', () => { done() }) window.dispatchEvent(createEvent('load')) const instance = Offcanvas.getInstance(offCanvasEl) expect(instance).not.toBeNull() expect(Offcanvas.prototype.show).toHaveBeenCalled() }) it('should trap focus', done => { fixtureEl.innerHTML = '
' 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() done() }) offCanvas.show() }) }) describe('hide', () => { it('should do nothing if already shown', () => { fixtureEl.innerHTML = '
' 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', done => { fixtureEl.innerHTML = '
' 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.classList.contains('show')).toEqual(false) expect(offCanvas._backdrop.hide).toHaveBeenCalled() done() }) offCanvas.hide() }) it('should not fire hidden when hide is prevented', done => { fixtureEl.innerHTML = '
' 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() done() }, 10) } offCanvasEl.addEventListener('hide.bs.offcanvas', e => { e.preventDefault() expectEnd() }) offCanvasEl.addEventListener('hidden.bs.offcanvas', () => { throw new Error('should not fire hidden event') }) offCanvas.hide() }) it('should release focus trap', done => { fixtureEl.innerHTML = '
' 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() done() }) offCanvas.hide() }) }) describe('dispose', () => { it('should dispose an offcanvas', () => { fixtureEl.innerHTML = '
' 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)).toEqual(null) }) }) describe('data-api', () => { it('should not prevent event for input', done => { fixtureEl.innerHTML = [ '', '
' ].join('') const target = fixtureEl.querySelector('input') const offCanvasEl = fixtureEl.querySelector('#offcanvasdiv1') offCanvasEl.addEventListener('shown.bs.offcanvas', () => { expect(offCanvasEl.classList.contains('show')).toEqual(true) expect(target.checked).toEqual(true) done() }) target.click() }) it('should not call toggle on disabled elements', () => { fixtureEl.innerHTML = [ '', '
' ].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', done => { fixtureEl.innerHTML = [ '', '
', '
' ].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() done() }) offcanvas1.show() }) it('should focus on trigger element after closing offcanvas', done => { fixtureEl.innerHTML = [ '', '
' ].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() done() }, 5) }) trigger.click() }) it('should not focus on trigger element after closing offcanvas, if it is not visible', done => { fixtureEl.innerHTML = [ '', '
' ].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)).toBe(false) expect(trigger.focus).not.toHaveBeenCalled() done() }, 5) }) trigger.click() }) }) describe('jQueryInterface', () => { it('should create an offcanvas', () => { fixtureEl.innerHTML = '
' 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 = '
' 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 = '
' 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 = '
' 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 = '
' 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 = '
' 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 = '
' 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).toBe(true) }) }) describe('getInstance', () => { it('should return offcanvas instance', () => { fixtureEl.innerHTML = '
' 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 = '
' const div = fixtureEl.querySelector('div') expect(Offcanvas.getInstance(div)).toBeNull() }) }) describe('getOrCreateInstance', () => { it('should return offcanvas instance', () => { fixtureEl.innerHTML = '
' 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 = '
' const div = fixtureEl.querySelector('div') expect(Offcanvas.getInstance(div)).toEqual(null) expect(Offcanvas.getOrCreateInstance(div)).toBeInstanceOf(Offcanvas) }) it('should return new instance when there is no offcanvas instance with given configuration', () => { fixtureEl.innerHTML = '
' const div = fixtureEl.querySelector('div') expect(Offcanvas.getInstance(div)).toEqual(null) const offcanvas = Offcanvas.getOrCreateInstance(div, { scroll: true }) expect(offcanvas).toBeInstanceOf(Offcanvas) expect(offcanvas._config.scroll).toEqual(true) }) it('should return the instance when exists without given configuration', () => { fixtureEl.innerHTML = '
' 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).toEqual(true) }) }) })