0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-12-05 17:24:20 +01:00
Bootstrap/js/dist/scrollspy.js

462 lines
16 KiB
JavaScript
Raw Normal View History

2018-11-13 07:41:12 +01:00
/*!
2020-12-07 16:50:24 +01:00
* Bootstrap scrollspy.js v5.0.0-beta1 (https://getbootstrap.com/)
2020-03-28 11:29:08 +01:00
* Copyright 2011-2020 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)
2020-06-16 20:50:01 +02:00
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
2018-11-13 07:41:12 +01:00
*/
2018-07-24 02:51:14 +02:00
(function (global, factory) {
2019-10-08 08:39:10 +02:00
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('./dom/data.js'), require('./dom/event-handler.js'), require('./dom/manipulator.js'), require('./dom/selector-engine.js')) :
2020-12-03 15:18:59 +01:00
typeof define === 'function' && define.amd ? define(['./dom/data', './dom/event-handler', './dom/manipulator', './dom/selector-engine'], factory) :
2020-09-14 17:12:06 +02:00
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ScrollSpy = factory(global.Data, global.EventHandler, global.Manipulator, global.SelectorEngine));
2019-11-08 09:11:23 +01:00
}(this, (function (Data, EventHandler, Manipulator, SelectorEngine) { 'use strict';
2018-07-24 02:51:14 +02:00
2020-09-14 17:12:06 +02:00
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
var Data__default = /*#__PURE__*/_interopDefaultLegacy(Data);
var EventHandler__default = /*#__PURE__*/_interopDefaultLegacy(EventHandler);
var Manipulator__default = /*#__PURE__*/_interopDefaultLegacy(Manipulator);
var SelectorEngine__default = /*#__PURE__*/_interopDefaultLegacy(SelectorEngine);
2018-07-24 02:51:14 +02:00
2019-03-01 17:31:34 +01:00
/**
* --------------------------------------------------------------------------
2020-12-07 16:50:24 +01:00
* Bootstrap (v5.0.0-beta1): util/index.js
2020-06-16 20:50:01 +02:00
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
2019-03-01 17:31:34 +01:00
* --------------------------------------------------------------------------
*/
var MAX_UID = 1000000;
var toType = function toType(obj) {
2020-03-28 11:29:08 +01:00
if (obj === null || obj === undefined) {
return "" + obj;
}
2019-03-01 17:31:34 +01:00
return {}.toString.call(obj).match(/\s([a-z]+)/i)[1].toLowerCase();
};
/**
* --------------------------------------------------------------------------
* Public Util Api
* --------------------------------------------------------------------------
*/
var getUID = function getUID(prefix) {
do {
2020-06-14 00:40:28 +02:00
prefix += Math.floor(Math.random() * MAX_UID);
2019-03-01 17:31:34 +01:00
} while (document.getElementById(prefix));
return prefix;
};
2019-08-27 15:03:21 +02:00
var getSelector = function getSelector(element) {
2020-11-23 14:17:16 +01:00
var selector = element.getAttribute('data-bs-target');
2019-03-01 17:31:34 +01:00
if (!selector || selector === '#') {
var hrefAttr = element.getAttribute('href');
2019-08-27 15:03:21 +02:00
selector = hrefAttr && hrefAttr !== '#' ? hrefAttr.trim() : null;
2019-03-01 17:31:34 +01:00
}
2019-08-27 15:03:21 +02:00
return selector;
};
var getSelectorFromElement = function getSelectorFromElement(element) {
var selector = getSelector(element);
if (selector) {
2019-03-01 17:31:34 +01:00
return document.querySelector(selector) ? selector : null;
}
2019-08-27 15:03:21 +02:00
return null;
2019-03-01 17:31:34 +01:00
};
var isElement = function isElement(obj) {
return (obj[0] || obj).nodeType;
};
var typeCheckConfig = function typeCheckConfig(componentName, config, configTypes) {
Object.keys(configTypes).forEach(function (property) {
var expectedTypes = configTypes[property];
var value = config[property];
var valueType = value && isElement(value) ? 'element' : toType(value);
if (!new RegExp(expectedTypes).test(valueType)) {
throw new Error(componentName.toUpperCase() + ": " + ("Option \"" + property + "\" provided type \"" + valueType + "\" ") + ("but expected type \"" + expectedTypes + "\"."));
}
});
};
2019-08-27 15:03:21 +02:00
var getjQuery = function getjQuery() {
var _window = window,
jQuery = _window.jQuery;
2020-11-23 14:17:16 +01:00
if (jQuery && !document.body.hasAttribute('data-bs-no-jquery')) {
2019-08-27 15:03:21 +02:00
return jQuery;
}
return null;
};
2020-11-11 18:07:37 +01:00
var onDOMContentLoaded = function onDOMContentLoaded(callback) {
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', callback);
} else {
callback();
}
};
2020-12-03 14:08:31 +01:00
var isRTL = document.documentElement.dir === 'rtl';
2020-06-14 00:40:28 +02:00
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
2018-11-13 07:41:12 +01:00
/**
* ------------------------------------------------------------------------
* Constants
* ------------------------------------------------------------------------
*/
2020-12-07 16:50:24 +01:00
var VERSION = '5.0.0-beta1';
2020-12-03 15:18:59 +01:00
var BaseComponent = /*#__PURE__*/function () {
function BaseComponent(element) {
if (!element) {
return;
}
this._element = element;
Data__default['default'].setData(element, this.constructor.DATA_KEY, this);
}
var _proto = BaseComponent.prototype;
_proto.dispose = function dispose() {
Data__default['default'].removeData(this._element, this.constructor.DATA_KEY);
this._element = null;
}
/** Static */
;
BaseComponent.getInstance = function getInstance(element) {
return Data__default['default'].getData(element, this.DATA_KEY);
};
_createClass(BaseComponent, null, [{
key: "VERSION",
get: function get() {
return VERSION;
}
}]);
return BaseComponent;
}();
function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
function _defineProperties$1(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
function _createClass$1(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties$1(Constructor.prototype, protoProps); if (staticProps) _defineProperties$1(Constructor, staticProps); return Constructor; }
function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; subClass.__proto__ = superClass; }
/**
* ------------------------------------------------------------------------
* Constants
* ------------------------------------------------------------------------
*/
var NAME = 'scrollspy';
2018-11-13 07:41:12 +01:00
var DATA_KEY = 'bs.scrollspy';
var EVENT_KEY = "." + DATA_KEY;
var DATA_API_KEY = '.data-api';
var Default = {
offset: 10,
method: 'auto',
target: ''
};
var DefaultType = {
offset: 'number',
method: 'string',
target: '(string|element)'
};
2020-03-28 11:29:08 +01:00
var EVENT_ACTIVATE = "activate" + EVENT_KEY;
var EVENT_SCROLL = "scroll" + EVENT_KEY;
var EVENT_LOAD_DATA_API = "load" + EVENT_KEY + DATA_API_KEY;
var CLASS_NAME_DROPDOWN_ITEM = 'dropdown-item';
var CLASS_NAME_ACTIVE = 'active';
2020-11-23 14:17:16 +01:00
var SELECTOR_DATA_SPY = '[data-bs-spy="scroll"]';
2020-03-28 11:29:08 +01:00
var SELECTOR_NAV_LIST_GROUP = '.nav, .list-group';
var SELECTOR_NAV_LINKS = '.nav-link';
var SELECTOR_NAV_ITEMS = '.nav-item';
var SELECTOR_LIST_ITEMS = '.list-group-item';
var SELECTOR_DROPDOWN = '.dropdown';
var SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle';
var METHOD_OFFSET = 'offset';
var METHOD_POSITION = 'position';
2019-10-08 08:39:10 +02:00
/**
* ------------------------------------------------------------------------
* Class Definition
* ------------------------------------------------------------------------
*/
2018-11-13 07:41:12 +01:00
2020-12-03 15:18:59 +01:00
var ScrollSpy = /*#__PURE__*/function (_BaseComponent) {
_inheritsLoose(ScrollSpy, _BaseComponent);
2018-11-13 07:41:12 +01:00
2020-12-03 15:18:59 +01:00
function ScrollSpy(element, config) {
var _this;
_this = _BaseComponent.call(this, element) || this;
_this._scrollElement = element.tagName === 'BODY' ? window : element;
_this._config = _this._getConfig(config);
_this._selector = _this._config.target + " " + SELECTOR_NAV_LINKS + ", " + _this._config.target + " " + SELECTOR_LIST_ITEMS + ", " + _this._config.target + " ." + CLASS_NAME_DROPDOWN_ITEM;
_this._offsets = [];
_this._targets = [];
_this._activeTarget = null;
_this._scrollHeight = 0;
EventHandler__default['default'].on(_this._scrollElement, EVENT_SCROLL, function (event) {
2018-11-13 07:41:12 +01:00
return _this._process(event);
});
2015-08-13 06:12:03 +02:00
2020-12-03 15:18:59 +01:00
_this.refresh();
_this._process();
2019-03-01 17:31:34 +01:00
2020-12-03 15:18:59 +01:00
return _this;
2018-11-13 07:41:12 +01:00
} // Getters
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
var _proto = ScrollSpy.prototype;
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
// Public
_proto.refresh = function refresh() {
var _this2 = this;
2017-09-30 23:28:03 +02:00
2020-03-28 11:29:08 +01:00
var autoMethod = this._scrollElement === this._scrollElement.window ? METHOD_OFFSET : METHOD_POSITION;
2018-11-13 07:41:12 +01:00
var offsetMethod = this._config.method === 'auto' ? autoMethod : this._config.method;
2020-03-28 11:29:08 +01:00
var offsetBase = offsetMethod === METHOD_POSITION ? this._getScrollTop() : 0;
2018-11-13 07:41:12 +01:00
this._offsets = [];
this._targets = [];
this._scrollHeight = this._getScrollHeight();
2020-09-14 17:12:06 +02:00
var targets = SelectorEngine__default['default'].find(this._selector);
2018-11-13 07:41:12 +01:00
targets.map(function (element) {
2019-03-01 17:31:34 +01:00
var targetSelector = getSelectorFromElement(element);
2020-09-14 17:12:06 +02:00
var target = targetSelector ? SelectorEngine__default['default'].findOne(targetSelector) : null;
2018-11-13 07:41:12 +01:00
if (target) {
var targetBCR = target.getBoundingClientRect();
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
if (targetBCR.width || targetBCR.height) {
2020-09-14 17:12:06 +02:00
return [Manipulator__default['default'][offsetMethod](target).top + offsetBase, targetSelector];
2017-09-30 23:28:03 +02:00
}
2018-11-13 07:41:12 +01:00
}
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
return null;
}).filter(function (item) {
return item;
}).sort(function (a, b) {
return a[0] - b[0];
}).forEach(function (item) {
_this2._offsets.push(item[0]);
2015-05-13 22:43:56 +02:00
2018-11-13 07:41:12 +01:00
_this2._targets.push(item[1]);
});
};
2016-10-10 02:26:51 +02:00
2018-11-13 07:41:12 +01:00
_proto.dispose = function dispose() {
2020-12-03 15:18:59 +01:00
_BaseComponent.prototype.dispose.call(this);
2020-09-14 17:12:06 +02:00
EventHandler__default['default'].off(this._scrollElement, EVENT_KEY);
2018-11-13 07:41:12 +01:00
this._scrollElement = null;
this._config = null;
this._selector = null;
this._offsets = null;
this._targets = null;
this._activeTarget = null;
this._scrollHeight = null;
2019-01-04 17:29:45 +01:00
} // Private
;
2018-11-13 07:41:12 +01:00
_proto._getConfig = function _getConfig(config) {
2020-09-14 17:12:06 +02:00
config = _extends({}, Default, typeof config === 'object' && config ? config : {});
2018-11-13 07:41:12 +01:00
2020-05-13 20:53:43 +02:00
if (typeof config.target !== 'string' && isElement(config.target)) {
2019-03-01 17:31:34 +01:00
var id = config.target.id;
2018-11-13 07:41:12 +01:00
if (!id) {
2019-03-01 17:31:34 +01:00
id = getUID(NAME);
config.target.id = id;
2018-07-24 02:51:14 +02:00
}
2016-01-09 09:40:51 +01:00
2018-11-13 07:41:12 +01:00
config.target = "#" + id;
}
2016-10-10 02:26:51 +02:00
2019-03-01 17:31:34 +01:00
typeCheckConfig(NAME, config, DefaultType);
2018-11-13 07:41:12 +01:00
return config;
};
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
_proto._getScrollTop = function _getScrollTop() {
return this._scrollElement === window ? this._scrollElement.pageYOffset : this._scrollElement.scrollTop;
};
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
_proto._getScrollHeight = function _getScrollHeight() {
return this._scrollElement.scrollHeight || Math.max(document.body.scrollHeight, document.documentElement.scrollHeight);
};
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
_proto._getOffsetHeight = function _getOffsetHeight() {
return this._scrollElement === window ? window.innerHeight : this._scrollElement.getBoundingClientRect().height;
};
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
_proto._process = function _process() {
var scrollTop = this._getScrollTop() + this._config.offset;
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
var scrollHeight = this._getScrollHeight();
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
var maxScroll = this._config.offset + scrollHeight - this._getOffsetHeight();
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
if (this._scrollHeight !== scrollHeight) {
this.refresh();
}
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
if (scrollTop >= maxScroll) {
var target = this._targets[this._targets.length - 1];
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
if (this._activeTarget !== target) {
this._activate(target);
2018-07-24 02:51:14 +02:00
}
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
return;
}
2018-07-24 02:51:14 +02:00
2018-11-13 07:41:12 +01:00
if (this._activeTarget && scrollTop < this._offsets[0] && this._offsets[0] > 0) {
this._activeTarget = null;
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
this._clear();
2018-06-22 07:55:23 +02:00
2018-11-13 07:41:12 +01:00
return;
}
2015-05-11 21:05:35 +02:00
2020-05-13 20:53:43 +02:00
for (var i = this._offsets.length; i--;) {
2018-11-13 07:41:12 +01:00
var isActiveTarget = this._activeTarget !== this._targets[i] && scrollTop >= this._offsets[i] && (typeof this._offsets[i + 1] === 'undefined' || scrollTop < this._offsets[i + 1]);
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
if (isActiveTarget) {
this._activate(this._targets[i]);
}
}
};
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
_proto._activate = function _activate(target) {
this._activeTarget = target;
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
this._clear();
2017-09-30 23:28:03 +02:00
2018-11-24 17:22:59 +01:00
var queries = this._selector.split(',').map(function (selector) {
2020-11-23 14:17:16 +01:00
return selector + "[data-bs-target=\"" + target + "\"]," + selector + "[href=\"" + target + "\"]";
2018-11-13 07:41:12 +01:00
});
2018-11-24 17:22:59 +01:00
2020-09-14 17:12:06 +02:00
var link = SelectorEngine__default['default'].findOne(queries.join(','));
2017-09-30 23:28:03 +02:00
2020-03-28 11:29:08 +01:00
if (link.classList.contains(CLASS_NAME_DROPDOWN_ITEM)) {
2020-09-14 17:12:06 +02:00
SelectorEngine__default['default'].findOne(SELECTOR_DROPDOWN_TOGGLE, link.closest(SELECTOR_DROPDOWN)).classList.add(CLASS_NAME_ACTIVE);
2020-03-28 11:29:08 +01:00
link.classList.add(CLASS_NAME_ACTIVE);
2018-11-13 07:41:12 +01:00
} else {
// Set triggered link as active
2020-03-28 11:29:08 +01:00
link.classList.add(CLASS_NAME_ACTIVE);
2020-09-14 17:12:06 +02:00
SelectorEngine__default['default'].parents(link, SELECTOR_NAV_LIST_GROUP).forEach(function (listGroup) {
2019-03-01 17:31:34 +01:00
// Set triggered links parents as active
// With both <ul> and <nav> markup a parent is the previous sibling of any nav ancestor
2020-09-14 17:12:06 +02:00
SelectorEngine__default['default'].prev(listGroup, SELECTOR_NAV_LINKS + ", " + SELECTOR_LIST_ITEMS).forEach(function (item) {
2020-03-28 11:29:08 +01:00
return item.classList.add(CLASS_NAME_ACTIVE);
2019-03-01 17:31:34 +01:00
}); // Handle special case when .nav-link is inside .nav-item
2020-09-14 17:12:06 +02:00
SelectorEngine__default['default'].prev(listGroup, SELECTOR_NAV_ITEMS).forEach(function (navItem) {
SelectorEngine__default['default'].children(navItem, SELECTOR_NAV_LINKS).forEach(function (item) {
2020-03-28 11:29:08 +01:00
return item.classList.add(CLASS_NAME_ACTIVE);
2019-03-01 17:31:34 +01:00
});
});
});
2018-11-13 07:41:12 +01:00
}
2016-10-10 02:26:51 +02:00
2020-09-14 17:12:06 +02:00
EventHandler__default['default'].trigger(this._scrollElement, EVENT_ACTIVATE, {
2018-11-13 07:41:12 +01:00
relatedTarget: target
});
};
2016-10-10 02:26:51 +02:00
2018-11-13 07:41:12 +01:00
_proto._clear = function _clear() {
2020-09-14 17:12:06 +02:00
SelectorEngine__default['default'].find(this._selector).filter(function (node) {
2020-03-28 11:29:08 +01:00
return node.classList.contains(CLASS_NAME_ACTIVE);
2018-11-24 17:22:59 +01:00
}).forEach(function (node) {
2020-03-28 11:29:08 +01:00
return node.classList.remove(CLASS_NAME_ACTIVE);
2018-11-24 17:22:59 +01:00
});
2019-01-04 17:29:45 +01:00
} // Static
;
2017-09-30 23:28:03 +02:00
2019-08-27 15:03:21 +02:00
ScrollSpy.jQueryInterface = function jQueryInterface(config) {
2018-11-13 07:41:12 +01:00
return this.each(function () {
2020-09-14 17:12:06 +02:00
var data = Data__default['default'].getData(this, DATA_KEY);
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
var _config = typeof config === 'object' && config;
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
if (!data) {
data = new ScrollSpy(this, _config);
}
2018-07-24 02:51:14 +02:00
2018-11-13 07:41:12 +01:00
if (typeof config === 'string') {
if (typeof data[config] === 'undefined') {
throw new TypeError("No method named \"" + config + "\"");
2017-09-06 06:05:12 +02:00
}
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
data[config]();
2017-09-30 23:28:03 +02:00
}
2018-11-13 07:41:12 +01:00
});
};
2017-09-30 23:28:03 +02:00
2020-12-03 15:18:59 +01:00
_createClass$1(ScrollSpy, null, [{
key: "Default",
2018-11-13 07:41:12 +01:00
get: function get() {
2020-12-03 15:18:59 +01:00
return Default;
2018-11-13 07:41:12 +01:00
}
}, {
2020-12-03 15:18:59 +01:00
key: "DATA_KEY",
2018-11-13 07:41:12 +01:00
get: function get() {
2020-12-03 15:18:59 +01:00
return DATA_KEY;
2018-11-13 07:41:12 +01:00
}
}]);
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
return ScrollSpy;
2020-12-03 15:18:59 +01:00
}(BaseComponent);
2018-11-13 07:41:12 +01:00
/**
* ------------------------------------------------------------------------
* Data Api implementation
* ------------------------------------------------------------------------
*/
2015-05-11 21:05:35 +02:00
2017-09-30 23:28:03 +02:00
2020-09-14 17:12:06 +02:00
EventHandler__default['default'].on(window, EVENT_LOAD_DATA_API, function () {
SelectorEngine__default['default'].find(SELECTOR_DATA_SPY).forEach(function (spy) {
return new ScrollSpy(spy, Manipulator__default['default'].getDataAttributes(spy));
2019-03-01 17:31:34 +01:00
});
2018-11-13 07:41:12 +01:00
});
/**
* ------------------------------------------------------------------------
* jQuery
* ------------------------------------------------------------------------
2020-11-11 18:07:37 +01:00
* add .ScrollSpy to jQuery only if jQuery is present
2018-11-13 07:41:12 +01:00
*/
2015-05-11 21:05:35 +02:00
2020-11-11 18:07:37 +01:00
onDOMContentLoaded(function () {
var $ = getjQuery();
/* istanbul ignore if */
2020-11-11 18:07:37 +01:00
if ($) {
var JQUERY_NO_CONFLICT = $.fn[NAME];
$.fn[NAME] = ScrollSpy.jQueryInterface;
$.fn[NAME].Constructor = ScrollSpy;
2017-09-30 23:28:03 +02:00
2020-11-11 18:07:37 +01:00
$.fn[NAME].noConflict = function () {
$.fn[NAME] = JQUERY_NO_CONFLICT;
return ScrollSpy.jQueryInterface;
};
}
});
2015-05-11 21:05:35 +02:00
return ScrollSpy;
2018-07-24 02:51:14 +02:00
2019-11-08 09:11:23 +01:00
})));
2018-07-24 02:51:14 +02:00
//# sourceMappingURL=scrollspy.js.map