dropdown.js 8.53 KB
Newer Older
fat's avatar
fat committed
1
2
3
4
5
import Util from './util'


/**
 * --------------------------------------------------------------------------
Mark Otto's avatar
Mark Otto committed
6
 * Bootstrap (v4.0.0-alpha.6): dropdown.js
fat's avatar
fat committed
7
8
9
10
11
12
13
14
15
16
17
18
19
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */

const Dropdown = (($) => {


  /**
   * ------------------------------------------------------------------------
   * Constants
   * ------------------------------------------------------------------------
   */

20
  const NAME                     = 'dropdown'
Mark Otto's avatar
Mark Otto committed
21
  const VERSION                  = '4.0.0-alpha.6'
22
23
24
25
26
  const DATA_KEY                 = 'bs.dropdown'
  const EVENT_KEY                = `.${DATA_KEY}`
  const DATA_API_KEY             = '.data-api'
  const JQUERY_NO_CONFLICT       = $.fn[NAME]
  const ESCAPE_KEYCODE           = 27 // KeyboardEvent.which value for Escape (Esc) key
27
  const SPACE_KEYCODE            = 32 // KeyboardEvent.which value for space key
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
28
  const TAB_KEYCODE              = 9 // KeyboardEvent.which value for tab key
29
30
31
  const ARROW_UP_KEYCODE         = 38 // KeyboardEvent.which value for up arrow key
  const ARROW_DOWN_KEYCODE       = 40 // KeyboardEvent.which value for down arrow key
  const RIGHT_MOUSE_BUTTON_WHICH = 3 // MouseEvent.which value for the right button (assuming a right-handed mouse)
Pierre-Denis Vanduynslager's avatar
Indent    
Pierre-Denis Vanduynslager committed
32
  const REGEXP_KEYDOWN           = new RegExp(`${ARROW_UP_KEYCODE}|${ARROW_DOWN_KEYCODE}|${ESCAPE_KEYCODE}`)
fat's avatar
fat committed
33
34

  const Event = {
XhmikosR's avatar
XhmikosR committed
35
36
37
38
39
    HIDE             : `hide${EVENT_KEY}`,
    HIDDEN           : `hidden${EVENT_KEY}`,
    SHOW             : `show${EVENT_KEY}`,
    SHOWN            : `shown${EVENT_KEY}`,
    CLICK            : `click${EVENT_KEY}`,
fat's avatar
fat committed
40
    CLICK_DATA_API   : `click${EVENT_KEY}${DATA_API_KEY}`,
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
41
42
    KEYDOWN_DATA_API : `keydown${EVENT_KEY}${DATA_API_KEY}`,
    KEYUP_DATA_API   : `keyup${EVENT_KEY}${DATA_API_KEY}`
fat's avatar
fat committed
43
44
45
46
47
  }

  const ClassName = {
    BACKDROP : 'dropdown-backdrop',
    DISABLED : 'disabled',
Starsam80's avatar
Starsam80 committed
48
    SHOW     : 'show'
fat's avatar
fat committed
49
50
51
52
53
54
  }

  const Selector = {
    BACKDROP      : '.dropdown-backdrop',
    DATA_TOGGLE   : '[data-toggle="dropdown"]',
    FORM_CHILD    : '.dropdown form',
55
    MENU          : '.dropdown-menu',
fat's avatar
fat committed
56
    NAVBAR_NAV    : '.navbar-nav',
57
    VISIBLE_ITEMS : '.dropdown-menu .dropdown-item:not(.disabled)'
fat's avatar
fat committed
58
59
60
61
62
63
64
65
66
67
68
69
  }


  /**
   * ------------------------------------------------------------------------
   * Class Definition
   * ------------------------------------------------------------------------
   */

  class Dropdown {

    constructor(element) {
fat's avatar
fat committed
70
71
72
      this._element = element

      this._addEventListeners()
fat's avatar
fat committed
73
74
    }

75
76
77
78
79
80
81
82

    // getters

    static get VERSION() {
      return VERSION
    }


fat's avatar
fat committed
83
84
85
86
    // public

    toggle() {
      if (this.disabled || $(this).hasClass(ClassName.DISABLED)) {
Jacob Thornton's avatar
Jacob Thornton committed
87
        return false
fat's avatar
fat committed
88
89
      }

90
      const parent   = Dropdown._getParentFromElement(this)
Starsam80's avatar
Starsam80 committed
91
      const isActive = $(parent).hasClass(ClassName.SHOW)
fat's avatar
fat committed
92
93
94
95
96
97
98

      Dropdown._clearMenus()

      if (isActive) {
        return false
      }

99
100
101
102
      const relatedTarget = {
        relatedTarget : this
      }
      const showEvent     = $.Event(Event.SHOW, relatedTarget)
fat's avatar
fat committed
103
104
105
106

      $(parent).trigger(showEvent)

      if (showEvent.isDefaultPrevented()) {
Jacob Thornton's avatar
Jacob Thornton committed
107
        return false
fat's avatar
fat committed
108
109
      }

110
111
112
113
      // set the backdrop only if the dropdown menu will be opened
      if ('ontouchstart' in document.documentElement &&
         !$(parent).closest(Selector.NAVBAR_NAV).length) {

114
115
116
117
118
119
        // if touch-enabled device we use a backdrop because click events
        // don't delegate on iOS - see https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html
        const backdrop     = document.createElement('div')
        backdrop.className = ClassName.BACKDROP
        $(backdrop).insertBefore(this)
        $(backdrop).on('click', Dropdown._clearMenus)
120
121
      }

fat's avatar
fat committed
122
      this.focus()
123
      this.setAttribute('aria-expanded', true)
fat's avatar
fat committed
124

Starsam80's avatar
Starsam80 committed
125
      $(parent).toggleClass(ClassName.SHOW)
Jacob Thornton's avatar
Jacob Thornton committed
126
      $(parent).trigger($.Event(Event.SHOWN, relatedTarget))
fat's avatar
fat committed
127
128
129
130

      return false
    }

fat's avatar
fat committed
131
132
133
134
135
136
137
138
139
140
141
142
143
    dispose() {
      $.removeData(this._element, DATA_KEY)
      $(this._element).off(EVENT_KEY)
      this._element = null
    }


    // private

    _addEventListeners() {
      $(this._element).on(Event.CLICK, this.toggle)
    }

fat's avatar
fat committed
144
145
146
147
148

    // static

    static _jQueryInterface(config) {
      return this.each(function () {
149
        let data = $(this).data(DATA_KEY)
fat's avatar
fat committed
150
151

        if (!data) {
152
153
          data = new Dropdown(this)
          $(this).data(DATA_KEY, data)
fat's avatar
fat committed
154
155
156
        }

        if (typeof config === 'string') {
157
158
159
          if (data[config] === undefined) {
            throw new Error(`No method named "${config}"`)
          }
fat's avatar
fat committed
160
161
162
163
164
165
          data[config].call(this)
        }
      })
    }

    static _clearMenus(event) {
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
166
167
      if (event && (event.which === RIGHT_MOUSE_BUTTON_WHICH ||
        event.type === 'keyup' && event.which !== TAB_KEYCODE)) {
fat's avatar
fat committed
168
169
170
        return
      }

171
      const toggles = $.makeArray($(Selector.DATA_TOGGLE))
fat's avatar
fat committed
172
173

      for (let i = 0; i < toggles.length; i++) {
174
175
176
177
        const parent        = Dropdown._getParentFromElement(toggles[i])
        const relatedTarget = {
          relatedTarget : toggles[i]
        }
fat's avatar
fat committed
178

Starsam80's avatar
Starsam80 committed
179
        if (!$(parent).hasClass(ClassName.SHOW)) {
fat's avatar
fat committed
180
181
182
          continue
        }

183
        if (event && (event.type === 'click' &&
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
184
            /input|textarea/i.test(event.target.tagName) || event.type === 'keyup' && event.which === TAB_KEYCODE)
185
            && $.contains(parent, event.target)) {
fat's avatar
fat committed
186
187
188
          continue
        }

189
        const hideEvent = $.Event(Event.HIDE, relatedTarget)
fat's avatar
fat committed
190
191
192
193
194
        $(parent).trigger(hideEvent)
        if (hideEvent.isDefaultPrevented()) {
          continue
        }

195
196
197
198
199
200
        // remove backdrop only if the dropdown menu will be hidden
        const backdrop = $(parent).find(Selector.BACKDROP)[0]
        if (backdrop) {
          backdrop.parentNode.removeChild(backdrop)
        }

fat's avatar
fat committed
201
202
203
        toggles[i].setAttribute('aria-expanded', 'false')

        $(parent)
Starsam80's avatar
Starsam80 committed
204
          .removeClass(ClassName.SHOW)
Jacob Thornton's avatar
Jacob Thornton committed
205
          .trigger($.Event(Event.HIDDEN, relatedTarget))
fat's avatar
fat committed
206
207
208
209
210
      }
    }

    static _getParentFromElement(element) {
      let parent
211
      const selector = Util.getSelectorFromElement(element)
fat's avatar
fat committed
212
213
214
215
216
217
218
219
220

      if (selector) {
        parent = $(selector)[0]
      }

      return parent || element.parentNode
    }

    static _dataApiKeydownHandler(event) {
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
221
      if (!REGEXP_KEYDOWN.test(event.which) || /button/i.test(event.target.tagName) && event.which === SPACE_KEYCODE ||
fat's avatar
fat committed
222
223
224
225
226
227
228
229
230
231
232
         /input|textarea/i.test(event.target.tagName)) {
        return
      }

      event.preventDefault()
      event.stopPropagation()

      if (this.disabled || $(this).hasClass(ClassName.DISABLED)) {
        return
      }

233
      const parent   = Dropdown._getParentFromElement(this)
Starsam80's avatar
Starsam80 committed
234
      const isActive = $(parent).hasClass(ClassName.SHOW)
fat's avatar
fat committed
235

236
237
      if (!isActive && (event.which !== ESCAPE_KEYCODE || event.which !== SPACE_KEYCODE) ||
           isActive && (event.which === ESCAPE_KEYCODE || event.which === SPACE_KEYCODE)) {
fat's avatar
fat committed
238

239
        if (event.which === ESCAPE_KEYCODE) {
240
          const toggle = $(parent).find(Selector.DATA_TOGGLE)[0]
fat's avatar
fat committed
241
242
243
244
245
246
247
          $(toggle).trigger('focus')
        }

        $(this).trigger('click')
        return
      }

248
      const items = $(parent).find(Selector.VISIBLE_ITEMS).get()
fat's avatar
fat committed
249
250
251
252
253
254
255

      if (!items.length) {
        return
      }

      let index = items.indexOf(event.target)

256
      if (event.which === ARROW_UP_KEYCODE && index > 0) { // up
Jacob Thornton's avatar
Jacob Thornton committed
257
258
259
        index--
      }

260
      if (event.which === ARROW_DOWN_KEYCODE && index < items.length - 1) { // down
Jacob Thornton's avatar
Jacob Thornton committed
261
262
263
        index++
      }

264
      if (index < 0) {
Jacob Thornton's avatar
Jacob Thornton committed
265
266
        index = 0
      }
fat's avatar
fat committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280

      items[index].focus()
    }

  }


  /**
   * ------------------------------------------------------------------------
   * Data Api implementation
   * ------------------------------------------------------------------------
   */

  $(document)
fat's avatar
fat committed
281
    .on(Event.KEYDOWN_DATA_API, Selector.DATA_TOGGLE,  Dropdown._dataApiKeydownHandler)
282
    .on(Event.KEYDOWN_DATA_API, Selector.MENU, Dropdown._dataApiKeydownHandler)
Pierre-Denis Vanduynslager's avatar
Pierre-Denis Vanduynslager committed
283
    .on(`${Event.CLICK_DATA_API} ${Event.KEYUP_DATA_API}`, Dropdown._clearMenus)
fat's avatar
fat committed
284
    .on(Event.CLICK_DATA_API, Selector.DATA_TOGGLE, Dropdown.prototype.toggle)
Jacob Thornton's avatar
Jacob Thornton committed
285
286
287
    .on(Event.CLICK_DATA_API, Selector.FORM_CHILD, (e) => {
      e.stopPropagation()
    })
fat's avatar
fat committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307


  /**
   * ------------------------------------------------------------------------
   * jQuery
   * ------------------------------------------------------------------------
   */

  $.fn[NAME]             = Dropdown._jQueryInterface
  $.fn[NAME].Constructor = Dropdown
  $.fn[NAME].noConflict  = function () {
    $.fn[NAME] = JQUERY_NO_CONFLICT
    return Dropdown._jQueryInterface
  }

  return Dropdown

})(jQuery)

export default Dropdown