@iebh/bootstrap-vue/src/mixins/listen-on-document.js

With more than 85 components, over 45 available plugins, several directives, and 1000+ icons, BootstrapVue provides one of the most comprehensive implementations of the Bootstrap v4 component and grid system available for Vue.js v2.6, complete with extens

import { Vue } from '../vue'
import { IS_BROWSER } from '../constants/env'
import { EVENT_OPTIONS_NO_CAPTURE, HOOK_EVENT_NAME_BEFORE_DESTROY } from '../constants/events'
import { arrayIncludes } from '../utils/array'
import { eventOn, eventOff } from '../utils/events'
import { isString, isFunction } from '../utils/inspect'
import { keys } from '../utils/object'

// --- Constants ---

const PROP = '$_bv_documentHandlers_'

// --- Mixin ---

// @vue/component
export const listenOnDocumentMixin = Vue.extend({
  created() {
    /* istanbul ignore next */
    if (!IS_BROWSER) {
      return
    }
    // Declare non-reactive property
    // Object of arrays, keyed by event name,
    // where value is an array of handlers
    // Prop will be defined on client only
    this[PROP] = {}
    // Set up our beforeDestroy handler (client only)
    this.$once(HOOK_EVENT_NAME_BEFORE_DESTROY, () => {
      const items = this[PROP] || {}
      // Immediately delete this[PROP] to prevent the
      // listenOn/Off methods from running (which may occur
      // due to requestAnimationFrame/transition delays)
      delete this[PROP]
      // Remove all registered event handlers
      keys(items).forEach(eventName => {
        const handlers = items[eventName] || []
        handlers.forEach(handler =>
          eventOff(document, eventName, handler, EVENT_OPTIONS_NO_CAPTURE)
        )
      })
    })
  },
  methods: {
    listenDocument(on, eventName, handler) {
      on ? this.listenOnDocument(eventName, handler) : this.listenOffDocument(eventName, handler)
    },
    listenOnDocument(eventName, handler) {
      if (this[PROP] && isString(eventName) && isFunction(handler)) {
        this[PROP][eventName] = this[PROP][eventName] || []
        if (!arrayIncludes(this[PROP][eventName], handler)) {
          this[PROP][eventName].push(handler)
          eventOn(document, eventName, handler, EVENT_OPTIONS_NO_CAPTURE)
        }
      }
    },
    listenOffDocument(eventName, handler) {
      if (this[PROP] && isString(eventName) && isFunction(handler)) {
        eventOff(document, eventName, handler, EVENT_OPTIONS_NO_CAPTURE)
        this[PROP][eventName] = (this[PROP][eventName] || []).filter(h => h !== handler)
      }
    }
  }
})