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

313 lines
10 KiB
JavaScript
Raw Normal View History

2018-11-13 07:41:12 +01:00
/*!
* Bootstrap scrollspy.js v5.2.2 (https://getbootstrap.com/)
2022-05-13 08:07:23 +02:00
* Copyright 2011-2022 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) {
2022-05-13 08:07:23 +02:00
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('./util/index'), require('./dom/event-handler'), require('./dom/selector-engine'), require('./base-component')) :
typeof define === 'function' && define.amd ? define(['./util/index', './dom/event-handler', './dom/selector-engine', './base-component'], factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.Scrollspy = factory(global.Index, global.EventHandler, global.SelectorEngine, global.BaseComponent));
})(this, (function (index, EventHandler, SelectorEngine, BaseComponent) { 'use strict';
2018-07-24 02:51:14 +02:00
2021-10-05 17:50:18 +02:00
const _interopDefaultLegacy = e => e && typeof e === 'object' && 'default' in e ? e : { default: e };
2020-09-14 17:12:06 +02:00
2021-10-05 17:50:18 +02:00
const EventHandler__default = /*#__PURE__*/_interopDefaultLegacy(EventHandler);
const SelectorEngine__default = /*#__PURE__*/_interopDefaultLegacy(SelectorEngine);
const BaseComponent__default = /*#__PURE__*/_interopDefaultLegacy(BaseComponent);
2019-03-01 17:31:34 +01:00
/**
* --------------------------------------------------------------------------
* Bootstrap (v5.2.2): scrollspy.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
* --------------------------------------------------------------------------
*/
2021-03-23 17:26:54 +01:00
/**
2020-12-03 15:18:59 +01:00
* Constants
*/
2021-03-23 17:26:54 +01:00
const NAME = 'scrollspy';
const DATA_KEY = 'bs.scrollspy';
const EVENT_KEY = `.${DATA_KEY}`;
const DATA_API_KEY = '.data-api';
const EVENT_ACTIVATE = `activate${EVENT_KEY}`;
2022-05-13 08:07:23 +02:00
const EVENT_CLICK = `click${EVENT_KEY}`;
2021-03-23 17:26:54 +01:00
const EVENT_LOAD_DATA_API = `load${EVENT_KEY}${DATA_API_KEY}`;
const CLASS_NAME_DROPDOWN_ITEM = 'dropdown-item';
const CLASS_NAME_ACTIVE = 'active';
const SELECTOR_DATA_SPY = '[data-bs-spy="scroll"]';
2022-05-13 08:07:23 +02:00
const SELECTOR_TARGET_LINKS = '[href]';
2021-03-23 17:26:54 +01:00
const SELECTOR_NAV_LIST_GROUP = '.nav, .list-group';
const SELECTOR_NAV_LINKS = '.nav-link';
const SELECTOR_NAV_ITEMS = '.nav-item';
const SELECTOR_LIST_ITEMS = '.list-group-item';
2022-05-13 08:07:23 +02:00
const SELECTOR_LINK_ITEMS = `${SELECTOR_NAV_LINKS}, ${SELECTOR_NAV_ITEMS} > ${SELECTOR_NAV_LINKS}, ${SELECTOR_LIST_ITEMS}`;
2021-03-23 17:26:54 +01:00
const SELECTOR_DROPDOWN = '.dropdown';
const SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle';
2022-05-13 08:07:23 +02:00
const Default = {
offset: null,
// TODO: v6 @deprecated, keep it for backwards compatibility reasons
rootMargin: '0px 0px -25%',
smoothScroll: false,
target: null,
threshold: [0.1, 0.5, 1]
2022-05-13 08:07:23 +02:00
};
const DefaultType = {
offset: '(number|null)',
// TODO v6 @deprecated, keep it for backwards compatibility reasons
rootMargin: 'string',
smoothScroll: 'boolean',
target: 'element',
threshold: 'array'
2022-05-13 08:07:23 +02:00
};
2019-10-08 08:39:10 +02:00
/**
2022-05-13 08:07:23 +02:00
* Class definition
2019-10-08 08:39:10 +02:00
*/
2018-11-13 07:41:12 +01:00
2021-10-05 17:50:18 +02:00
class ScrollSpy extends BaseComponent__default.default {
2021-03-23 17:26:54 +01:00
constructor(element, config) {
2022-05-13 08:07:23 +02:00
super(element, config); // this._element is the observablesContainer and config.target the menu links wrapper
2019-03-01 17:31:34 +01:00
2022-05-13 08:07:23 +02:00
this._targetLinks = new Map();
this._observableSections = new Map();
this._rootElement = getComputedStyle(this._element).overflowY === 'visible' ? null : this._element;
this._activeTarget = null;
this._observer = null;
this._previousScrollData = {
visibleEntryTop: 0,
parentScrollTop: 0
};
this.refresh(); // initialize
2018-11-13 07:41:12 +01:00
} // Getters
2015-05-11 21:05:35 +02:00
2021-03-23 17:26:54 +01:00
static get Default() {
return Default;
}
2022-05-13 08:07:23 +02:00
static get DefaultType() {
return DefaultType;
}
static get NAME() {
return NAME;
2021-03-23 17:26:54 +01:00
} // Public
2015-05-11 21:05:35 +02:00
2017-09-30 23:28:03 +02:00
2021-03-23 17:26:54 +01:00
refresh() {
2022-05-13 08:07:23 +02:00
this._initializeTargetsAndObservables();
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
this._maybeEnableSmoothScroll();
2016-10-10 02:26:51 +02:00
2022-05-13 08:07:23 +02:00
if (this._observer) {
this._observer.disconnect();
} else {
this._observer = this._getNewObserver();
}
for (const section of this._observableSections.values()) {
this._observer.observe(section);
}
2021-03-23 17:26:54 +01:00
}
2020-12-03 15:18:59 +01:00
2021-03-23 17:26:54 +01:00
dispose() {
2022-05-13 08:07:23 +02:00
this._observer.disconnect();
super.dispose();
2019-01-04 17:29:45 +01:00
} // Private
2018-11-13 07:41:12 +01:00
2021-03-23 17:26:54 +01:00
2022-05-13 08:07:23 +02:00
_configAfterMerge(config) {
// TODO: on v6 target should be given explicitly & remove the {target: 'ss-target'} case
config.target = index.getElement(config.target) || document.body; // TODO: v6 Only for backwards compatibility reasons. Use rootMargin only
config.rootMargin = config.offset ? `${config.offset}px 0px -30%` : config.rootMargin;
if (typeof config.threshold === 'string') {
config.threshold = config.threshold.split(',').map(value => Number.parseFloat(value));
}
2018-11-13 07:41:12 +01:00
return config;
2021-03-23 17:26:54 +01:00
}
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
_maybeEnableSmoothScroll() {
if (!this._config.smoothScroll) {
return;
} // unregister any previous listeners
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
EventHandler__default.default.off(this._config.target, EVENT_CLICK);
EventHandler__default.default.on(this._config.target, EVENT_CLICK, SELECTOR_TARGET_LINKS, event => {
const observableSection = this._observableSections.get(event.target.hash);
if (observableSection) {
event.preventDefault();
const root = this._rootElement || window;
const height = observableSection.offsetTop - this._element.offsetTop;
if (root.scrollTo) {
root.scrollTo({
top: height,
behavior: 'smooth'
2022-05-13 08:07:23 +02:00
});
return;
} // Chrome 60 doesn't support `scrollTo`
root.scrollTop = height;
}
});
2021-03-23 17:26:54 +01:00
}
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
_getNewObserver() {
const options = {
root: this._rootElement,
threshold: this._config.threshold,
rootMargin: this._config.rootMargin
2022-05-13 08:07:23 +02:00
};
return new IntersectionObserver(entries => this._observerCallback(entries), options);
} // The logic of selection
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
_observerCallback(entries) {
const targetElement = entry => this._targetLinks.get(`#${entry.target.id}`);
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
const activate = entry => {
this._previousScrollData.visibleEntryTop = entry.target.offsetTop;
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
this._process(targetElement(entry));
};
const parentScrollTop = (this._rootElement || document.documentElement).scrollTop;
const userScrollsDown = parentScrollTop >= this._previousScrollData.parentScrollTop;
this._previousScrollData.parentScrollTop = parentScrollTop;
for (const entry of entries) {
if (!entry.isIntersecting) {
this._activeTarget = null;
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
this._clearActiveClass(targetElement(entry));
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
continue;
2018-07-24 02:51:14 +02:00
}
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
const entryIsLowerThanPrevious = entry.target.offsetTop >= this._previousScrollData.visibleEntryTop; // if we are scrolling down, pick the bigger offsetTop
2018-07-24 02:51:14 +02:00
2022-05-13 08:07:23 +02:00
if (userScrollsDown && entryIsLowerThanPrevious) {
activate(entry); // if parent isn't scrolled, let's keep the first visible item, breaking the iteration
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
if (!parentScrollTop) {
return;
}
2018-06-22 07:55:23 +02:00
2022-05-13 08:07:23 +02:00
continue;
} // if we are scrolling up, pick the smallest offsetTop
2015-05-11 21:05:35 +02:00
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
if (!userScrollsDown && !entryIsLowerThanPrevious) {
activate(entry);
2018-11-13 07:41:12 +01:00
}
}
2021-03-23 17:26:54 +01:00
}
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
_initializeTargetsAndObservables() {
this._targetLinks = new Map();
this._observableSections = new Map();
const targetLinks = SelectorEngine__default.default.find(SELECTOR_TARGET_LINKS, this._config.target);
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
for (const anchor of targetLinks) {
// ensure that the anchor has an id and is not disabled
if (!anchor.hash || index.isDisabled(anchor)) {
continue;
}
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
const observableSection = SelectorEngine__default.default.findOne(anchor.hash, this._element); // ensure that the observableSection exists & is visible
2017-09-30 23:28:03 +02:00
2022-05-13 08:07:23 +02:00
if (index.isVisible(observableSection)) {
this._targetLinks.set(anchor.hash, anchor);
this._observableSections.set(anchor.hash, observableSection);
}
}
}
_process(target) {
if (this._activeTarget === target) {
return;
2018-11-13 07:41:12 +01:00
}
2016-10-10 02:26:51 +02:00
2022-05-13 08:07:23 +02:00
this._clearActiveClass(this._config.target);
this._activeTarget = target;
target.classList.add(CLASS_NAME_ACTIVE);
this._activateParents(target);
EventHandler__default.default.trigger(this._element, EVENT_ACTIVATE, {
2018-11-13 07:41:12 +01:00
relatedTarget: target
});
2021-03-23 17:26:54 +01:00
}
2016-10-10 02:26:51 +02:00
2022-05-13 08:07:23 +02:00
_activateParents(target) {
// Activate dropdown parents
if (target.classList.contains(CLASS_NAME_DROPDOWN_ITEM)) {
SelectorEngine__default.default.findOne(SELECTOR_DROPDOWN_TOGGLE, target.closest(SELECTOR_DROPDOWN)).classList.add(CLASS_NAME_ACTIVE);
return;
}
for (const listGroup of SelectorEngine__default.default.parents(target, SELECTOR_NAV_LIST_GROUP)) {
// Set triggered links parents as active
// With both <ul> and <nav> markup a parent is the previous sibling of any nav ancestor
for (const item of SelectorEngine__default.default.prev(listGroup, SELECTOR_LINK_ITEMS)) {
item.classList.add(CLASS_NAME_ACTIVE);
}
}
}
_clearActiveClass(parent) {
parent.classList.remove(CLASS_NAME_ACTIVE);
const activeNodes = SelectorEngine__default.default.find(`${SELECTOR_TARGET_LINKS}.${CLASS_NAME_ACTIVE}`, parent);
for (const node of activeNodes) {
node.classList.remove(CLASS_NAME_ACTIVE);
}
2019-01-04 17:29:45 +01:00
} // Static
2017-09-30 23:28:03 +02:00
2021-03-23 17:26:54 +01:00
static jQueryInterface(config) {
2018-11-13 07:41:12 +01:00
return this.each(function () {
const data = ScrollSpy.getOrCreateInstance(this, config);
2017-09-30 23:28:03 +02:00
if (typeof config !== 'string') {
return;
2018-11-13 07:41:12 +01:00
}
2018-07-24 02:51:14 +02:00
2022-05-13 08:07:23 +02:00
if (data[config] === undefined || config.startsWith('_') || config === 'constructor') {
throw new TypeError(`No method named "${config}"`);
2017-09-30 23:28:03 +02:00
}
data[config]();
2018-11-13 07:41:12 +01:00
});
2021-03-23 17:26:54 +01:00
}
2015-05-11 21:05:35 +02:00
2021-03-23 17:26:54 +01:00
}
2018-11-13 07:41:12 +01:00
/**
2022-05-13 08:07:23 +02:00
* Data API implementation
2018-11-13 07:41:12 +01:00
*/
2015-05-11 21:05:35 +02:00
2017-09-30 23:28:03 +02:00
2021-10-05 17:50:18 +02:00
EventHandler__default.default.on(window, EVENT_LOAD_DATA_API, () => {
2022-05-13 08:07:23 +02:00
for (const spy of SelectorEngine__default.default.find(SELECTOR_DATA_SPY)) {
ScrollSpy.getOrCreateInstance(spy);
}
2018-11-13 07:41:12 +01:00
});
/**
* jQuery
*/
2015-05-11 21:05:35 +02:00
2022-05-13 08:07:23 +02:00
index.defineJQueryPlugin(ScrollSpy);
2015-05-11 21:05:35 +02:00
return ScrollSpy;
2018-07-24 02:51:14 +02:00
2021-10-05 17:50:18 +02:00
}));
2018-07-24 02:51:14 +02:00
//# sourceMappingURL=scrollspy.js.map