/** * -------------------------------------------------------------------------- * Bootstrap (v5.0.0-beta3): offcanvas.js * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) * -------------------------------------------------------------------------- */ import { defineJQueryPlugin, getElementFromSelector, getSelectorFromElement, getTransitionDurationFromElement, isDisabled, isVisible, typeCheckConfig } from './util/index' import { hide as scrollBarHide, reset as scrollBarReset } from './util/scrollbar' import Data from './dom/data' import EventHandler from './dom/event-handler' import BaseComponent from './base-component' import SelectorEngine from './dom/selector-engine' import Manipulator from './dom/manipulator' /** * ------------------------------------------------------------------------ * Constants * ------------------------------------------------------------------------ */ const NAME = 'offcanvas' const DATA_KEY = 'bs.offcanvas' const EVENT_KEY = `.${DATA_KEY}` const DATA_API_KEY = '.data-api' const EVENT_LOAD_DATA_API = `load${EVENT_KEY}${DATA_API_KEY}` const ESCAPE_KEY = 'Escape' const Default = { backdrop: true, keyboard: true, scroll: false } const DefaultType = { backdrop: 'boolean', keyboard: 'boolean', scroll: 'boolean' } const CLASS_NAME_BACKDROP_BODY = 'offcanvas-backdrop' const CLASS_NAME_SHOW = 'show' const CLASS_NAME_TOGGLING = 'offcanvas-toggling' const OPEN_SELECTOR = '.offcanvas.show' const ACTIVE_SELECTOR = `${OPEN_SELECTOR}, .${CLASS_NAME_TOGGLING}` const EVENT_SHOW = `show${EVENT_KEY}` const EVENT_SHOWN = `shown${EVENT_KEY}` const EVENT_HIDE = `hide${EVENT_KEY}` const EVENT_HIDDEN = `hidden${EVENT_KEY}` const EVENT_FOCUSIN = `focusin${EVENT_KEY}` const EVENT_CLICK_DATA_API = `click${EVENT_KEY}${DATA_API_KEY}` const EVENT_CLICK_DISMISS = `click.dismiss${EVENT_KEY}` const SELECTOR_DATA_DISMISS = '[data-bs-dismiss="offcanvas"]' const SELECTOR_DATA_TOGGLE = '[data-bs-toggle="offcanvas"]' /** * ------------------------------------------------------------------------ * Class Definition * ------------------------------------------------------------------------ */ class Offcanvas extends BaseComponent { constructor(element, config) { super(element) this._config = this._getConfig(config) this._isShown = false this._addEventListeners() } // Getters static get Default() { return Default } static get DATA_KEY() { return DATA_KEY } // Public toggle(relatedTarget) { return this._isShown ? this.hide() : this.show(relatedTarget) } show(relatedTarget) { if (this._isShown) { return } const showEvent = EventHandler.trigger(this._element, EVENT_SHOW, { relatedTarget }) if (showEvent.defaultPrevented) { return } this._isShown = true this._element.style.visibility = 'visible' if (this._config.backdrop) { document.body.classList.add(CLASS_NAME_BACKDROP_BODY) } if (!this._config.scroll) { scrollBarHide() } this._element.classList.add(CLASS_NAME_TOGGLING) this._element.removeAttribute('aria-hidden') this._element.setAttribute('aria-modal', true) this._element.setAttribute('role', 'dialog') this._element.classList.add(CLASS_NAME_SHOW) const completeCallBack = () => { this._element.classList.remove(CLASS_NAME_TOGGLING) EventHandler.trigger(this._element, EVENT_SHOWN, { relatedTarget }) this._enforceFocusOnElement(this._element) } setTimeout(completeCallBack, getTransitionDurationFromElement(this._element)) } hide() { if (!this._isShown) { return } const hideEvent = EventHandler.trigger(this._element, EVENT_HIDE) if (hideEvent.defaultPrevented) { return } this._element.classList.add(CLASS_NAME_TOGGLING) EventHandler.off(document, EVENT_FOCUSIN) this._element.blur() this._isShown = false this._element.classList.remove(CLASS_NAME_SHOW) const completeCallback = () => { this._element.setAttribute('aria-hidden', true) this._element.removeAttribute('aria-modal') this._element.removeAttribute('role') this._element.style.visibility = 'hidden' if (this._config.backdrop) { document.body.classList.remove(CLASS_NAME_BACKDROP_BODY) } if (!this._config.scroll) { scrollBarReset() } EventHandler.trigger(this._element, EVENT_HIDDEN) this._element.classList.remove(CLASS_NAME_TOGGLING) } setTimeout(completeCallback, getTransitionDurationFromElement(this._element)) } // Private _getConfig(config) { config = { ...Default, ...Manipulator.getDataAttributes(this._element), ...(typeof config === 'object' ? config : {}) } typeCheckConfig(NAME, config, DefaultType) return config } _enforceFocusOnElement(element) { EventHandler.off(document, EVENT_FOCUSIN) // guard against infinite focus loop EventHandler.on(document, EVENT_FOCUSIN, event => { if (document !== event.target && element !== event.target && !element.contains(event.target)) { element.focus() } }) element.focus() } _addEventListeners() { EventHandler.on(this._element, EVENT_CLICK_DISMISS, SELECTOR_DATA_DISMISS, () => this.hide()) EventHandler.on(document, 'keydown', event => { if (this._config.keyboard && event.key === ESCAPE_KEY) { this.hide() } }) EventHandler.on(document, EVENT_CLICK_DATA_API, event => { const target = SelectorEngine.findOne(getSelectorFromElement(event.target)) if (!this._element.contains(event.target) && target !== this._element) { this.hide() } }) } // Static static jQueryInterface(config) { return this.each(function () { const data = Data.get(this, DATA_KEY) || new Offcanvas(this, typeof config === 'object' ? config : {}) if (typeof config !== 'string') { return } if (data[config] === undefined || config.startsWith('_') || config === 'constructor') { throw new TypeError(`No method named "${config}"`) } data[config](this) }) } } /** * ------------------------------------------------------------------------ * Data Api implementation * ------------------------------------------------------------------------ */ EventHandler.on(document, EVENT_CLICK_DATA_API, SELECTOR_DATA_TOGGLE, function (event) { const target = getElementFromSelector(this) if (['A', 'AREA'].includes(this.tagName)) { event.preventDefault() } if (isDisabled(this)) { return } EventHandler.one(target, EVENT_HIDDEN, () => { // focus on trigger when it is closed if (isVisible(this)) { this.focus() } }) // avoid conflict when clicking a toggler of an offcanvas, while another is open const allReadyOpen = SelectorEngine.findOne(ACTIVE_SELECTOR) if (allReadyOpen && allReadyOpen !== target) { return } const data = Data.get(target, DATA_KEY) || new Offcanvas(target) data.toggle(this) }) EventHandler.on(window, EVENT_LOAD_DATA_API, () => { SelectorEngine.find(OPEN_SELECTOR).forEach(el => (Data.get(el, DATA_KEY) || new Offcanvas(el)).show()) }) /** * ------------------------------------------------------------------------ * jQuery * ------------------------------------------------------------------------ */ defineJQueryPlugin(NAME, Offcanvas) export default Offcanvas