0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-01 13:24:25 +01:00
Bootstrap/js/src/dropdown.js

303 lines
8.4 KiB
JavaScript
Raw Normal View History

2015-05-10 22:47:11 +02:00
import Util from './util'
/**
* --------------------------------------------------------------------------
2017-01-06 17:38:04 +01:00
* Bootstrap (v4.0.0-alpha.6): dropdown.js
2015-05-10 22:47:11 +02:00
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
* --------------------------------------------------------------------------
*/
const Dropdown = (($) => {
/**
* ------------------------------------------------------------------------
* Constants
* ------------------------------------------------------------------------
*/
const NAME = 'dropdown'
2017-01-06 17:38:04 +01:00
const VERSION = '4.0.0-alpha.6'
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
const SPACE_KEYCODE = 32 // KeyboardEvent.which value for space key
2017-02-09 00:51:50 +01:00
const TAB_KEYCODE = 9 // KeyboardEvent.which value for tab key
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)
2017-04-12 15:41:27 +02:00
const REGEXP_KEYDOWN = new RegExp(`${ARROW_UP_KEYCODE}|${ARROW_DOWN_KEYCODE}|${ESCAPE_KEYCODE}`)
2015-05-10 22:47:11 +02:00
const Event = {
2015-11-12 20:21:32 +01:00
HIDE : `hide${EVENT_KEY}`,
HIDDEN : `hidden${EVENT_KEY}`,
SHOW : `show${EVENT_KEY}`,
SHOWN : `shown${EVENT_KEY}`,
CLICK : `click${EVENT_KEY}`,
2015-05-13 21:48:34 +02:00
CLICK_DATA_API : `click${EVENT_KEY}${DATA_API_KEY}`,
2017-02-09 00:51:50 +01:00
KEYDOWN_DATA_API : `keydown${EVENT_KEY}${DATA_API_KEY}`,
KEYUP_DATA_API : `keyup${EVENT_KEY}${DATA_API_KEY}`
2015-05-10 22:47:11 +02:00
}
const ClassName = {
DISABLED : 'disabled',
2016-10-28 00:13:17 +02:00
SHOW : 'show'
2015-05-10 22:47:11 +02:00
}
const Selector = {
DATA_TOGGLE : '[data-toggle="dropdown"]',
FORM_CHILD : '.dropdown form',
MENU : '.dropdown-menu',
2015-05-10 22:47:11 +02:00
NAVBAR_NAV : '.navbar-nav',
VISIBLE_ITEMS : '.dropdown-menu .dropdown-item:not(.disabled)'
2015-05-10 22:47:11 +02:00
}
/**
* ------------------------------------------------------------------------
* Class Definition
* ------------------------------------------------------------------------
*/
class Dropdown {
constructor(element) {
2015-05-13 21:48:34 +02:00
this._element = element
this._addEventListeners()
2015-05-10 22:47:11 +02:00
}
// getters
static get VERSION() {
return VERSION
}
2015-05-10 22:47:11 +02:00
// public
toggle() {
if (this.disabled || $(this).hasClass(ClassName.DISABLED)) {
2015-08-19 04:22:46 +02:00
return false
2015-05-10 22:47:11 +02:00
}
const parent = Dropdown._getParentFromElement(this)
2016-10-28 00:13:17 +02:00
const isActive = $(parent).hasClass(ClassName.SHOW)
2015-05-10 22:47:11 +02:00
Dropdown._clearMenus()
if (isActive) {
return false
}
const relatedTarget = {
relatedTarget : this
}
const showEvent = $.Event(Event.SHOW, relatedTarget)
2015-05-10 22:47:11 +02:00
$(parent).trigger(showEvent)
if (showEvent.isDefaultPrevented()) {
2015-08-19 04:22:46 +02:00
return false
2015-05-10 22:47:11 +02:00
}
Replace dropdown backdrop hack with cleaner JS-only hack * Replace backdrop with simple noop mouse listener As discussed in https://github.com/twbs/bootstrap/pull/22422 the current approach of injecting a backdrop (to work around iOS' broken event delegation for the `click` event) has annoying consequences on touch-enabled laptop/desktop devices. Instead of a backdrop `<div>`, here we simply add extra empty/noop mouse listeners to the immediate children of `<body>` (and remove them when the dropdown is closed) in order to force iOS to properly bubble a `click` resulting from a tap (essentially, method 2 from https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html) This is sufficient (except in rare cases where the user does manage to tap on the body itself, rather than any child elements of body - which is not very likely in an iOS phone/tablet scenario for most layouts) to get iOS to get a grip and do the correct event bubbling/delegation, meaning the regular "click" event will bubble back to the `<body>` when tapping outside of the dropdown, and the dropdown will close properly (just like it already does, even without this fix, in non-iOS touchscreen devices/browsers, like Chrome/Android and Windows on a touch laptop). This approach, though a bit hacky, has no impact on the DOM structure, and has no unforeseen side effects on touch-enabled laptops/desktops. And crucially, it works just fine in iOS. * Remove dropdown backdrop styles * Update doc for dropdowns and touch-enabled devices
2017-04-14 10:19:00 +02:00
// if this is a touch-enabled device we add extra
// empty mouseover listeners to the body's immediate children;
// only needed because of broken event delegation on iOS
// https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html
if ('ontouchstart' in document.documentElement &&
!$(parent).closest(Selector.NAVBAR_NAV).length) {
$('body').children().on('mouseover', null, $.noop)
}
2015-05-10 22:47:11 +02:00
this.focus()
this.setAttribute('aria-expanded', true)
2015-05-10 22:47:11 +02:00
2016-10-28 00:13:17 +02:00
$(parent).toggleClass(ClassName.SHOW)
2015-08-15 21:17:13 +02:00
$(parent).trigger($.Event(Event.SHOWN, relatedTarget))
2015-05-10 22:47:11 +02:00
return false
}
2015-05-13 21:48:34 +02:00
dispose() {
$.removeData(this._element, DATA_KEY)
$(this._element).off(EVENT_KEY)
this._element = null
}
// private
_addEventListeners() {
$(this._element).on(Event.CLICK, this.toggle)
}
2015-05-10 22:47:11 +02:00
// static
static _jQueryInterface(config) {
return this.each(function () {
let data = $(this).data(DATA_KEY)
2015-05-10 22:47:11 +02:00
if (!data) {
data = new Dropdown(this)
$(this).data(DATA_KEY, data)
2015-05-10 22:47:11 +02:00
}
if (typeof config === 'string') {
if (data[config] === undefined) {
throw new Error(`No method named "${config}"`)
}
2015-05-10 22:47:11 +02:00
data[config].call(this)
}
})
}
static _clearMenus(event) {
2017-02-09 00:51:50 +01:00
if (event && (event.which === RIGHT_MOUSE_BUTTON_WHICH ||
event.type === 'keyup' && event.which !== TAB_KEYCODE)) {
2015-05-10 22:47:11 +02:00
return
}
const toggles = $.makeArray($(Selector.DATA_TOGGLE))
2015-05-10 22:47:11 +02:00
for (let i = 0; i < toggles.length; i++) {
const parent = Dropdown._getParentFromElement(toggles[i])
const relatedTarget = {
relatedTarget : toggles[i]
}
2015-05-10 22:47:11 +02:00
2016-10-28 00:13:17 +02:00
if (!$(parent).hasClass(ClassName.SHOW)) {
2015-05-10 22:47:11 +02:00
continue
}
if (event && (event.type === 'click' &&
2017-02-09 00:51:50 +01:00
/input|textarea/i.test(event.target.tagName) || event.type === 'keyup' && event.which === TAB_KEYCODE)
&& $.contains(parent, event.target)) {
2015-05-10 22:47:11 +02:00
continue
}
const hideEvent = $.Event(Event.HIDE, relatedTarget)
2015-05-10 22:47:11 +02:00
$(parent).trigger(hideEvent)
if (hideEvent.isDefaultPrevented()) {
continue
}
Replace dropdown backdrop hack with cleaner JS-only hack * Replace backdrop with simple noop mouse listener As discussed in https://github.com/twbs/bootstrap/pull/22422 the current approach of injecting a backdrop (to work around iOS' broken event delegation for the `click` event) has annoying consequences on touch-enabled laptop/desktop devices. Instead of a backdrop `<div>`, here we simply add extra empty/noop mouse listeners to the immediate children of `<body>` (and remove them when the dropdown is closed) in order to force iOS to properly bubble a `click` resulting from a tap (essentially, method 2 from https://www.quirksmode.org/blog/archives/2014/02/mouse_event_bub.html) This is sufficient (except in rare cases where the user does manage to tap on the body itself, rather than any child elements of body - which is not very likely in an iOS phone/tablet scenario for most layouts) to get iOS to get a grip and do the correct event bubbling/delegation, meaning the regular "click" event will bubble back to the `<body>` when tapping outside of the dropdown, and the dropdown will close properly (just like it already does, even without this fix, in non-iOS touchscreen devices/browsers, like Chrome/Android and Windows on a touch laptop). This approach, though a bit hacky, has no impact on the DOM structure, and has no unforeseen side effects on touch-enabled laptops/desktops. And crucially, it works just fine in iOS. * Remove dropdown backdrop styles * Update doc for dropdowns and touch-enabled devices
2017-04-14 10:19:00 +02:00
// if this is a touch-enabled device we remove the extra
// empty mouseover listeners we added for iOS support
if ('ontouchstart' in document.documentElement) {
$('body').children().off('mouseover', null, $.noop)
}
2015-05-10 22:47:11 +02:00
toggles[i].setAttribute('aria-expanded', 'false')
$(parent)
2016-10-28 00:13:17 +02:00
.removeClass(ClassName.SHOW)
2015-08-15 21:17:13 +02:00
.trigger($.Event(Event.HIDDEN, relatedTarget))
2015-05-10 22:47:11 +02:00
}
}
static _getParentFromElement(element) {
let parent
const selector = Util.getSelectorFromElement(element)
2015-05-10 22:47:11 +02:00
if (selector) {
parent = $(selector)[0]
}
return parent || element.parentNode
}
static _dataApiKeydownHandler(event) {
2017-02-09 00:51:50 +01:00
if (!REGEXP_KEYDOWN.test(event.which) || /button/i.test(event.target.tagName) && event.which === SPACE_KEYCODE ||
2015-05-10 22:47:11 +02:00
/input|textarea/i.test(event.target.tagName)) {
return
}
event.preventDefault()
event.stopPropagation()
if (this.disabled || $(this).hasClass(ClassName.DISABLED)) {
return
}
const parent = Dropdown._getParentFromElement(this)
2016-10-28 00:13:17 +02:00
const isActive = $(parent).hasClass(ClassName.SHOW)
2015-05-10 22:47:11 +02:00
if (!isActive && (event.which !== ESCAPE_KEYCODE || event.which !== SPACE_KEYCODE) ||
isActive && (event.which === ESCAPE_KEYCODE || event.which === SPACE_KEYCODE)) {
2015-05-10 22:47:11 +02:00
if (event.which === ESCAPE_KEYCODE) {
const toggle = $(parent).find(Selector.DATA_TOGGLE)[0]
2015-05-10 22:47:11 +02:00
$(toggle).trigger('focus')
}
$(this).trigger('click')
return
}
const items = $(parent).find(Selector.VISIBLE_ITEMS).get()
2015-05-10 22:47:11 +02:00
if (!items.length) {
return
}
let index = items.indexOf(event.target)
if (event.which === ARROW_UP_KEYCODE && index > 0) { // up
2015-08-19 04:22:46 +02:00
index--
}
if (event.which === ARROW_DOWN_KEYCODE && index < items.length - 1) { // down
2015-08-19 04:22:46 +02:00
index++
}
if (index < 0) {
2015-08-19 04:22:46 +02:00
index = 0
}
2015-05-10 22:47:11 +02:00
items[index].focus()
}
}
/**
* ------------------------------------------------------------------------
* Data Api implementation
* ------------------------------------------------------------------------
*/
$(document)
2015-05-13 21:48:34 +02:00
.on(Event.KEYDOWN_DATA_API, Selector.DATA_TOGGLE, Dropdown._dataApiKeydownHandler)
.on(Event.KEYDOWN_DATA_API, Selector.MENU, Dropdown._dataApiKeydownHandler)
2017-02-09 00:51:50 +01:00
.on(`${Event.CLICK_DATA_API} ${Event.KEYUP_DATA_API}`, Dropdown._clearMenus)
2015-05-13 21:48:34 +02:00
.on(Event.CLICK_DATA_API, Selector.DATA_TOGGLE, Dropdown.prototype.toggle)
2015-08-19 04:22:46 +02:00
.on(Event.CLICK_DATA_API, Selector.FORM_CHILD, (e) => {
e.stopPropagation()
})
2015-05-10 22:47:11 +02:00
/**
* ------------------------------------------------------------------------
* 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