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

376 lines
12 KiB
JavaScript
Raw Normal View History

2018-11-13 07:41:12 +01:00
/*!
2020-05-12 18:53:07 +02:00
* Bootstrap scrollspy.js v4.5.0 (https://getbootstrap.com/)
* Copyright 2011-2020 The Bootstrap Authors (https://github.com/twbs/bootstrap/graphs/contributors)
2018-11-13 07:41:12 +01:00
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
*/
2018-07-24 02:51:14 +02:00
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('jquery'), require('./util.js')) :
typeof define === 'function' && define.amd ? define(['jquery', './util.js'], factory) :
2019-01-04 17:29:45 +01:00
(global = global || self, global.ScrollSpy = factory(global.jQuery, global.Util));
2019-11-26 18:12:00 +01:00
}(this, (function ($, Util) { 'use strict';
2018-07-24 02:51:14 +02:00
2020-05-12 18:53:07 +02:00
$ = $ && Object.prototype.hasOwnProperty.call($, 'default') ? $['default'] : $;
Util = Util && Object.prototype.hasOwnProperty.call(Util, 'default') ? Util['default'] : Util;
2018-07-24 02:51:14 +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;
}
function _defineProperty(obj, key, value) {
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
2019-11-26 18:12:00 +01:00
function ownKeys(object, enumerableOnly) {
var keys = Object.keys(object);
if (Object.getOwnPropertySymbols) {
var symbols = Object.getOwnPropertySymbols(object);
if (enumerableOnly) symbols = symbols.filter(function (sym) {
return Object.getOwnPropertyDescriptor(object, sym).enumerable;
});
keys.push.apply(keys, symbols);
}
return keys;
}
function _objectSpread2(target) {
2018-07-24 02:51:14 +02:00
for (var i = 1; i < arguments.length; i++) {
var source = arguments[i] != null ? arguments[i] : {};
2018-03-31 22:59:37 +02:00
2019-11-26 18:12:00 +01:00
if (i % 2) {
ownKeys(Object(source), true).forEach(function (key) {
_defineProperty(target, key, source[key]);
});
} else if (Object.getOwnPropertyDescriptors) {
Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
} else {
ownKeys(Object(source)).forEach(function (key) {
Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
});
2018-07-24 02:51:14 +02:00
}
}
2017-09-06 06:05:12 +02:00
2018-07-24 02:51:14 +02:00
return target;
}
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
/**
* ------------------------------------------------------------------------
* Constants
* ------------------------------------------------------------------------
*/
var NAME = 'scrollspy';
2020-05-12 18:53:07 +02:00
var VERSION = '4.5.0';
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 JQUERY_NO_CONFLICT = $.fn[NAME];
var Default = {
offset: 10,
method: 'auto',
target: ''
};
var DefaultType = {
offset: 'number',
method: 'string',
target: '(string|element)'
};
2020-05-12 18:53:07 +02: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';
var SELECTOR_DATA_SPY = '[data-spy="scroll"]';
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_ITEMS = '.dropdown-item';
var SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle';
var METHOD_OFFSET = 'offset';
var METHOD_POSITION = 'position';
2019-11-26 18:12:00 +01:00
/**
* ------------------------------------------------------------------------
* Class Definition
* ------------------------------------------------------------------------
*/
2018-11-13 07:41:12 +01:00
2020-05-12 18:53:07 +02:00
var ScrollSpy = /*#__PURE__*/function () {
2018-11-13 07:41:12 +01:00
function ScrollSpy(element, config) {
var _this = this;
this._element = element;
this._scrollElement = element.tagName === 'BODY' ? window : element;
this._config = this._getConfig(config);
2020-05-12 18:53:07 +02:00
this._selector = this._config.target + " " + SELECTOR_NAV_LINKS + "," + (this._config.target + " " + SELECTOR_LIST_ITEMS + ",") + (this._config.target + " " + SELECTOR_DROPDOWN_ITEMS);
2018-11-13 07:41:12 +01:00
this._offsets = [];
this._targets = [];
this._activeTarget = null;
this._scrollHeight = 0;
2020-05-12 18:53:07 +02:00
$(this._scrollElement).on(EVENT_SCROLL, function (event) {
2018-11-13 07:41:12 +01:00
return _this._process(event);
});
this.refresh();
2015-08-13 06:12:03 +02:00
2018-11-13 07:41:12 +01:00
this._process();
} // 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-05-12 18:53:07 +02: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-05-12 18:53:07 +02: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();
var targets = [].slice.call(document.querySelectorAll(this._selector));
targets.map(function (element) {
var target;
var targetSelector = Util.getSelectorFromElement(element);
2018-07-24 02:51:14 +02:00
2018-11-13 07:41:12 +01:00
if (targetSelector) {
target = document.querySelector(targetSelector);
}
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) {
// TODO (fat): remove sketch reliance on jQuery position/offset
return [$(target)[offsetMethod]().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() {
$.removeData(this._element, DATA_KEY);
$(this._scrollElement).off(EVENT_KEY);
this._element = null;
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-05-12 18:53:07 +02:00
config = _objectSpread2(_objectSpread2({}, Default), typeof config === 'object' && config ? config : {});
2018-11-13 07:41:12 +01:00
2020-05-12 18:53:07 +02:00
if (typeof config.target !== 'string' && Util.isElement(config.target)) {
2018-11-13 07:41:12 +01:00
var id = $(config.target).attr('id');
if (!id) {
id = Util.getUID(NAME);
$(config.target).attr('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
2018-11-13 07:41:12 +01:00
Util.typeCheckConfig(NAME, config, DefaultType);
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-12 18:53:07 +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) {
return selector + "[data-target=\"" + target + "\"]," + selector + "[href=\"" + target + "\"]";
2018-11-13 07:41:12 +01:00
});
2018-11-24 17:22:59 +01:00
2018-11-13 07:41:12 +01:00
var $link = $([].slice.call(document.querySelectorAll(queries.join(','))));
2017-09-30 23:28:03 +02:00
2020-05-12 18:53:07 +02:00
if ($link.hasClass(CLASS_NAME_DROPDOWN_ITEM)) {
$link.closest(SELECTOR_DROPDOWN).find(SELECTOR_DROPDOWN_TOGGLE).addClass(CLASS_NAME_ACTIVE);
$link.addClass(CLASS_NAME_ACTIVE);
2018-11-13 07:41:12 +01:00
} else {
// Set triggered link as active
2020-05-12 18:53:07 +02:00
$link.addClass(CLASS_NAME_ACTIVE); // Set triggered links parents as active
2018-11-13 07:41:12 +01:00
// With both <ul> and <nav> markup a parent is the previous sibling of any nav ancestor
2017-09-30 23:28:03 +02:00
2020-05-12 18:53:07 +02:00
$link.parents(SELECTOR_NAV_LIST_GROUP).prev(SELECTOR_NAV_LINKS + ", " + SELECTOR_LIST_ITEMS).addClass(CLASS_NAME_ACTIVE); // Handle special case when .nav-link is inside .nav-item
2015-05-11 21:05:35 +02:00
2020-05-12 18:53:07 +02:00
$link.parents(SELECTOR_NAV_LIST_GROUP).prev(SELECTOR_NAV_ITEMS).children(SELECTOR_NAV_LINKS).addClass(CLASS_NAME_ACTIVE);
2018-11-13 07:41:12 +01:00
}
2016-10-10 02:26:51 +02:00
2020-05-12 18:53:07 +02:00
$(this._scrollElement).trigger(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() {
2018-11-24 17:22:59 +01:00
[].slice.call(document.querySelectorAll(this._selector)).filter(function (node) {
2020-05-12 18:53:07 +02:00
return node.classList.contains(CLASS_NAME_ACTIVE);
2018-11-24 17:22:59 +01:00
}).forEach(function (node) {
2020-05-12 18:53:07 +02: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
2018-11-13 07:41:12 +01:00
ScrollSpy._jQueryInterface = function _jQueryInterface(config) {
return this.each(function () {
var data = $(this).data(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);
$(this).data(DATA_KEY, data);
}
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
2018-11-13 07:41:12 +01:00
_createClass(ScrollSpy, null, [{
key: "VERSION",
get: function get() {
return VERSION;
}
}, {
key: "Default",
get: function get() {
return Default;
}
}]);
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
return ScrollSpy;
}();
/**
* ------------------------------------------------------------------------
* Data Api implementation
* ------------------------------------------------------------------------
*/
2015-05-11 21:05:35 +02:00
2017-09-30 23:28:03 +02:00
2020-05-12 18:53:07 +02:00
$(window).on(EVENT_LOAD_DATA_API, function () {
var scrollSpys = [].slice.call(document.querySelectorAll(SELECTOR_DATA_SPY));
2018-11-13 07:41:12 +01:00
var scrollSpysLength = scrollSpys.length;
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
for (var i = scrollSpysLength; i--;) {
var $spy = $(scrollSpys[i]);
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +01:00
ScrollSpy._jQueryInterface.call($spy, $spy.data());
}
});
/**
* ------------------------------------------------------------------------
* jQuery
* ------------------------------------------------------------------------
*/
2015-05-11 21:05:35 +02:00
2018-11-13 07:41:12 +01:00
$.fn[NAME] = ScrollSpy._jQueryInterface;
$.fn[NAME].Constructor = ScrollSpy;
2017-09-30 23:28:03 +02:00
2018-11-13 07:41:12 +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-26 18:12:00 +01:00
})));
2018-07-24 02:51:14 +02:00
//# sourceMappingURL=scrollspy.js.map