eventHandler.js 9.38 KB
Newer Older
1
import Polyfill from './polyfill'
Johann-S's avatar
Johann-S committed
2
3
import Util from '../util'

Johann-S's avatar
Johann-S committed
4
5
/**
 * --------------------------------------------------------------------------
XhmikosR's avatar
4.3.1.    
XhmikosR committed
6
 * Bootstrap (v4.3.1): dom/eventHandler.js
Johann-S's avatar
Johann-S committed
7
8
9
10
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */

11
12
13
14
15
/**
 * ------------------------------------------------------------------------
 * Constants
 * ------------------------------------------------------------------------
 */
Johann-S's avatar
Johann-S committed
16

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
const namespaceRegex = /[^.]*(?=\..*)\.|.*/
const stripNameRegex = /\..*/
const keyEventRegex  = /^key/
const stripUidRegex  = /::\d+$/
const eventRegistry  = {}   // Events storage
let uidEvent         = 1
const customEvents   = {
  mouseenter: 'mouseover',
  mouseleave: 'mouseout'
}
const nativeEvents   = [
  'click', 'dblclick', 'mouseup', 'mousedown', 'contextmenu',
  'mousewheel', 'DOMMouseScroll',
  'mouseover', 'mouseout', 'mousemove', 'selectstart', 'selectend',
  'keydown', 'keypress', 'keyup',
  'orientationchange',
  'touchstart', 'touchmove', 'touchend', 'touchcancel',
  'pointerdown', 'pointermove', 'pointerup', 'pointerleave', 'pointercancel',
  'gesturestart', 'gesturechange', 'gestureend',
  'focus', 'blur', 'change', 'reset', 'select', 'submit', 'focusin', 'focusout',
  'load', 'unload', 'beforeunload', 'resize', 'move', 'DOMContentLoaded', 'readystatechange',
  'error', 'abort', 'scroll'
]
40

41
42
43
44
45
/**
 * ------------------------------------------------------------------------
 * Private methods
 * ------------------------------------------------------------------------
 */
Johann-S's avatar
Johann-S committed
46

47
48
49
50
51
52
53
54
55
56
function getUidEvent(element, uid) {
  return uid && `${uid}::${uidEvent++}` || element.uidEvent || uidEvent++
}

function getEvent(element) {
  const uid = getUidEvent(element)
  element.uidEvent = uid

  return eventRegistry[uid] = eventRegistry[uid] || {}
}
57

58
59
60
61
function fixEvent(event, element) {
  // Add which for key events
  if (event.which === null && keyEventRegex.test(event.type)) {
    event.which = event.charCode !== null ? event.charCode : event.keyCode
Johann-S's avatar
Johann-S committed
62
63
  }

64
65
  event.delegateTarget = element
}
66

67
68
69
70
71
function bootstrapHandler(element, fn) {
  return function handler(event) {
    fixEvent(event, element)
    if (handler.oneOff) {
      EventHandler.off(element, event.type, fn)
Johann-S's avatar
Johann-S committed
72
    }
Johann-S's avatar
Johann-S committed
73

74
75
76
    return fn.apply(element, [event])
  }
}
77

78
79
80
81
82
83
84
85
86
function bootstrapDelegationHandler(element, selector, fn) {
  return function handler(event) {
    const domElements = element.querySelectorAll(selector)
    for (let target = event.target; target && target !== this; target = target.parentNode) {
      for (let i = domElements.length; i--;) {
        if (domElements[i] === target) {
          fixEvent(event, target)
          if (handler.oneOff) {
            EventHandler.off(element, event.type, fn)
Johann-S's avatar
Johann-S committed
87
          }
88
89

          return fn.apply(target, [event])
90
91
92
93
        }
      }
    }

94
95
96
97
    // To please ESLint
    return null
  }
}
98

99
100
101
102
function findHandler(events, handler, delegationSelector = null) {
  for (const uid in events) {
    if (!Object.prototype.hasOwnProperty.call(events, uid)) {
      continue
103
104
    }

105
106
107
108
    const event = events[uid]
    if (event.originalHandler === handler && event.delegationSelector === delegationSelector) {
      return events[uid]
    }
109
110
  }

111
112
  return null
}
113

114
115
116
function normalizeParams(originalTypeEvent, handler, delegationFn) {
  const delegation      = typeof handler === 'string'
  const originalHandler = delegation ? delegationFn : handler
117

118
119
  // allow to get the native events from namespaced events ('click.bs.button' --> 'click')
  let typeEvent = originalTypeEvent.replace(stripNameRegex, '')
120

121
122
123
124
  const custom = customEvents[typeEvent]
  if (custom) {
    typeEvent = custom
  }
125

126
127
128
  const isNative = nativeEvents.indexOf(typeEvent) > -1
  if (!isNative) {
    typeEvent = originalTypeEvent
129
130
  }

131
132
  return [delegation, originalHandler, typeEvent]
}
133

134
function addHandler(element, originalTypeEvent, handler, delegationFn, oneOff) {
XhmikosR's avatar
XhmikosR committed
135
  if (typeof originalTypeEvent !== 'string' || !element) {
136
137
    return
  }
138

139
140
141
142
  if (!handler) {
    handler = delegationFn
    delegationFn = null
  }
143

144
  const [delegation, originalHandler, typeEvent] = normalizeParams(originalTypeEvent, handler, delegationFn)
145

146
147
148
  const events     = getEvent(element)
  const handlers   = events[typeEvent] || (events[typeEvent] = {})
  const previousFn = findHandler(handlers, originalHandler, delegation ? handler : null)
149

150
151
152
153
  if (previousFn) {
    previousFn.oneOff = previousFn.oneOff && oneOff
    return
  }
154

155
156
  const uid = getUidEvent(originalHandler, originalTypeEvent.replace(namespaceRegex, ''))
  const fn  = !delegation ? bootstrapHandler(element, handler) : bootstrapDelegationHandler(element, handler, delegationFn)
157

158
159
160
161
162
  fn.delegationSelector = delegation ? handler : null
  fn.originalHandler = originalHandler
  fn.oneOff = oneOff
  fn.uidEvent = uid
  handlers[uid] = fn
163

164
165
  element.addEventListener(typeEvent, fn, delegation)
}
166

167
168
169
170
function removeHandler(element, events, typeEvent, handler, delegationSelector) {
  const fn = findHandler(events[typeEvent], handler, delegationSelector)
  if (fn === null) {
    return
Johann-S's avatar
Johann-S committed
171
  }
172

173
174
175
  element.removeEventListener(typeEvent, fn, Boolean(delegationSelector))
  delete events[typeEvent][fn.uidEvent]
}
176

177
178
179
180
181
function removeNamespacedHandlers(element, events, typeEvent, namespace) {
  const storeElementEvent = events[typeEvent] || {}
  for (const handlerKey in storeElementEvent) {
    if (!Object.prototype.hasOwnProperty.call(storeElementEvent, handlerKey)) {
      continue
182
183
    }

184
185
186
187
188
189
    if (handlerKey.indexOf(namespace) > -1) {
      const event = storeElementEvent[handlerKey]
      removeHandler(element, events, typeEvent, event.originalHandler, event.delegationSelector)
    }
  }
}
Johann-S's avatar
Johann-S committed
190

191
192
193
194
const EventHandler = {
  on(element, event, handler, delegationFn) {
    addHandler(element, event, handler, delegationFn, false)
  },
Johann-S's avatar
Johann-S committed
195

196
197
198
  one(element, event, handler, delegationFn) {
    addHandler(element, event, handler, delegationFn, true)
  },
Johann-S's avatar
Johann-S committed
199

200
  off(element, originalTypeEvent, handler, delegationFn) {
XhmikosR's avatar
XhmikosR committed
201
    if (typeof originalTypeEvent !== 'string' || !element) {
202
203
      return
    }
204

205
    const [delegation, originalHandler, typeEvent] = normalizeParams(originalTypeEvent, handler, delegationFn)
Johann-S's avatar
Johann-S committed
206

207
208
    const inNamespace = typeEvent !== originalTypeEvent
    const events = getEvent(element)
209

210
211
212
    if (typeof originalHandler !== 'undefined') {
      // Simplest case: handler is passed, remove that listener ONLY.
      if (!events || !events[typeEvent]) {
213
214
215
        return
      }

216
217
218
      removeHandler(element, events, typeEvent, originalHandler, delegation ? handler : null)
      return
    }
219

220
221
222
223
    const isNamespace = originalTypeEvent.charAt(0) === '.'
    if (isNamespace) {
      for (const elementEvent in events) {
        if (!Object.prototype.hasOwnProperty.call(events, elementEvent)) {
Johann-S's avatar
Johann-S committed
224
225
226
          continue
        }

227
        removeNamespacedHandlers(element, events, elementEvent, originalTypeEvent.substr(1))
Johann-S's avatar
Johann-S committed
228
      }
229
    }
Johann-S's avatar
Johann-S committed
230

231
232
233
234
    const storeElementEvent = events[typeEvent] || {}
    for (const keyHandlers in storeElementEvent) {
      if (!Object.prototype.hasOwnProperty.call(storeElementEvent, keyHandlers)) {
        continue
235
      }
Johann-S's avatar
Johann-S committed
236

237
238
239
240
241
242
243
      const handlerKey = keyHandlers.replace(stripUidRegex, '')
      if (!inNamespace || originalTypeEvent.indexOf(handlerKey) > -1) {
        const event = storeElementEvent[keyHandlers]
        removeHandler(element, events, typeEvent, event.originalHandler, event.delegationSelector)
      }
    }
  },
Johann-S's avatar
Johann-S committed
244

245
  trigger(element, event, args) {
XhmikosR's avatar
XhmikosR committed
246
    if (typeof event !== 'string' || !element) {
247
248
      return null
    }
249

250
251
252
    const typeEvent   = event.replace(stripNameRegex, '')
    const inNamespace = event !== typeEvent
    const isNative    = nativeEvents.indexOf(typeEvent) > -1
253

254
255
    const $ = Util.jQuery
    let jQueryEvent
256

257
258
259
    let bubbles = true
    let nativeDispatch = true
    let defaultPrevented = false
260

261
262
    if (inNamespace && typeof $ !== 'undefined') {
      jQueryEvent = $.Event(event, args)
Johann-S's avatar
Johann-S committed
263

264
265
266
267
268
      $(element).trigger(jQueryEvent)
      bubbles = !jQueryEvent.isPropagationStopped()
      nativeDispatch = !jQueryEvent.isImmediatePropagationStopped()
      defaultPrevented = jQueryEvent.isDefaultPrevented()
    }
Johann-S's avatar
Johann-S committed
269

270
271
272
273
274
275
276
277
278
279
    let evt = null
    if (isNative) {
      evt = document.createEvent('HTMLEvents')
      evt.initEvent(typeEvent, bubbles, true)
    } else {
      evt = new CustomEvent(event, {
        bubbles,
        cancelable: true
      })
    }
280

281
282
283
284
285
286
287
288
    // merge custom informations in our event
    if (typeof args !== 'undefined') {
      Object.keys(args)
        .forEach((key) => {
          Object.defineProperty(evt, key, {
            get() {
              return args[key]
            }
Johann-S's avatar
Johann-S committed
289
          })
290
291
        })
    }
292

293
294
    if (defaultPrevented) {
      evt.preventDefault()
295

296
297
298
299
      if (!Polyfill.defaultPreventedPreservedOnDispatch) {
        Object.defineProperty(evt, 'defaultPrevented', {
          get: () => true
        })
Johann-S's avatar
Johann-S committed
300
      }
301
302
303
304
305
    }

    if (nativeDispatch) {
      element.dispatchEvent(evt)
    }
306

307
308
    if (evt.defaultPrevented && typeof jQueryEvent !== 'undefined') {
      jQueryEvent.preventDefault()
309
    }
310
311

    return evt
Johann-S's avatar
Johann-S committed
312
  }
313
}
Johann-S's avatar
Johann-S committed
314

Johann-S's avatar
Johann-S committed
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/* istanbul ignore next */
// focusin and focusout polyfill
if (Polyfill.focusIn) {
  (() => {
    function listenerFocus(event) {
      EventHandler.trigger(event.target, 'focusin')
    }
    function listenerBlur(event) {
      EventHandler.trigger(event.target, 'focusout')
    }
    EventHandler.on(document, 'focus', 'input', listenerFocus)
    EventHandler.on(document, 'blur', 'input', listenerBlur)
  })()
}

Johann-S's avatar
Johann-S committed
330
export default EventHandler