scrollspy.js 8.46 KiB
import Util from './util'
/**
 * --------------------------------------------------------------------------
 * Bootstrap (v4.0.0-alpha.5): scrollspy.js
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */
const ScrollSpy = (($) => {
  /**
   * ------------------------------------------------------------------------
   * Constants
   * ------------------------------------------------------------------------
  const NAME               = 'scrollspy'
  const VERSION            = '4.0.0-alpha.5'
  const DATA_KEY           = 'bs.scrollspy'
  const EVENT_KEY          = `.${DATA_KEY}`
  const DATA_API_KEY       = '.data-api'
  const JQUERY_NO_CONFLICT = $.fn[NAME]
  const Default = {
    offset : 10,
    method : 'auto',
    target : ''
  const DefaultType = {
    offset : 'number',
    method : 'string',
    target : '(string|element)'
  const Event = {
    ACTIVATE      : `activate${EVENT_KEY}`,
    SCROLL        : `scroll${EVENT_KEY}`,
    LOAD_DATA_API : `load${EVENT_KEY}${DATA_API_KEY}`
  const ClassName = {
    DROPDOWN_ITEM : 'dropdown-item',
    DROPDOWN_MENU : 'dropdown-menu',
    NAV_LINK      : 'nav-link',
    NAV           : 'nav',
    ACTIVE        : 'active'
  const Selector = {
    DATA_SPY        : '[data-spy="scroll"]',
    ACTIVE          : '.active',
    LIST_ITEM       : '.list-item',
    LI              : 'li',
    LI_DROPDOWN     : 'li.dropdown',
    NAV_LINKS       : '.nav-link',
    DROPDOWN        : '.dropdown',
    DROPDOWN_ITEMS  : '.dropdown-item',
    DROPDOWN_TOGGLE : '.dropdown-toggle'
  const OffsetMethod = {
    OFFSET   : 'offset',
    POSITION : 'position'
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
/** * ------------------------------------------------------------------------ * Class Definition * ------------------------------------------------------------------------ */ class ScrollSpy { constructor(element, config) { this._element = element this._scrollElement = element.tagName === 'BODY' ? window : element this._config = this._getConfig(config) this._selector = `${this._config.target} ${Selector.NAV_LINKS},` + `${this._config.target} ${Selector.DROPDOWN_ITEMS}` this._offsets = [] this._targets = [] this._activeTarget = null this._scrollHeight = 0 $(this._scrollElement).on(Event.SCROLL, (event) => this._process(event)) this.refresh() this._process() } // getters static get VERSION() { return VERSION } static get Default() { return Default } // public refresh() { const autoMethod = this._scrollElement !== this._scrollElement.window ? OffsetMethod.POSITION : OffsetMethod.OFFSET const offsetMethod = this._config.method === 'auto' ? autoMethod : this._config.method const offsetBase = offsetMethod === OffsetMethod.POSITION ? this._getScrollTop() : 0 this._offsets = [] this._targets = [] this._scrollHeight = this._getScrollHeight() const targets = $.makeArray($(this._selector)) targets .map((element) => { let target const targetSelector = Util.getSelectorFromElement(element) if (targetSelector) { target = $(targetSelector)[0] } if (target && (target.offsetWidth || target.offsetHeight)) { // todo (fat): remove sketch reliance on jQuery position/offset return [ $(target)[offsetMethod]().top + offsetBase, targetSelector
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
] } return null }) .filter((item) => item) .sort((a, b) => a[0] - b[0]) .forEach((item) => { this._offsets.push(item[0]) this._targets.push(item[1]) }) } 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 } // private _getConfig(config) { config = $.extend({}, Default, config) if (typeof config.target !== 'string') { let id = $(config.target).attr('id') if (!id) { id = Util.getUID(NAME) $(config.target).attr('id', id) } config.target = `#${id}` } Util.typeCheckConfig(NAME, config, DefaultType) return config } _getScrollTop() { return this._scrollElement === window ? this._scrollElement.pageYOffset : this._scrollElement.scrollTop } _getScrollHeight() { return this._scrollElement.scrollHeight || Math.max( document.body.scrollHeight, document.documentElement.scrollHeight ) } _getOffsetHeight() { return this._scrollElement === window ? window.innerHeight : this._scrollElement.offsetHeight } _process() { const scrollTop = this._getScrollTop() + this._config.offset const scrollHeight = this._getScrollHeight() const maxScroll = this._config.offset + scrollHeight - this._getOffsetHeight()
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
if (this._scrollHeight !== scrollHeight) { this.refresh() } if (scrollTop >= maxScroll) { const target = this._targets[this._targets.length - 1] if (this._activeTarget !== target) { this._activate(target) } return } if (this._activeTarget && scrollTop < this._offsets[0] && this._offsets[0] > 0) { this._activeTarget = null this._clear() return } for (let i = this._offsets.length; i--;) { const isActiveTarget = this._activeTarget !== this._targets[i] && scrollTop >= this._offsets[i] && (this._offsets[i + 1] === undefined || scrollTop < this._offsets[i + 1]) if (isActiveTarget) { this._activate(this._targets[i]) } } } _activate(target) { this._activeTarget = target this._clear() let queries = this._selector.split(',') queries = queries.map((selector) => { return `${selector}[data-target="${target}"],` + `${selector}[href="${target}"]` }) const $link = $(queries.join(',')) if ($link.hasClass(ClassName.DROPDOWN_ITEM)) { $link.closest(Selector.DROPDOWN).find(Selector.DROPDOWN_TOGGLE).addClass(ClassName.ACTIVE) $link.addClass(ClassName.ACTIVE) } else { // todo (fat) this is kinda sus... // recursively add actives to tested nav-links $link.parents(Selector.LI).find(`> ${Selector.NAV_LINKS}`).addClass(ClassName.ACTIVE) } $(this._scrollElement).trigger(Event.ACTIVATE, { relatedTarget: target }) } _clear() { $(this._selector).filter(Selector.ACTIVE).removeClass(ClassName.ACTIVE) } // static static _jQueryInterface(config) { return this.each(function () { let data = $(this).data(DATA_KEY) const _config = typeof config === 'object' && config
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
if (!data) { data = new ScrollSpy(this, _config) $(this).data(DATA_KEY, data) } if (typeof config === 'string') { if (data[config] === undefined) { throw new Error(`No method named "${config}"`) } data[config]() } }) } } /** * ------------------------------------------------------------------------ * Data Api implementation * ------------------------------------------------------------------------ */ $(window).on(Event.LOAD_DATA_API, () => { const scrollSpys = $.makeArray($(Selector.DATA_SPY)) for (let i = scrollSpys.length; i--;) { const $spy = $(scrollSpys[i]) ScrollSpy._jQueryInterface.call($spy, $spy.data()) } }) /** * ------------------------------------------------------------------------ * jQuery * ------------------------------------------------------------------------ */ $.fn[NAME] = ScrollSpy._jQueryInterface $.fn[NAME].Constructor = ScrollSpy $.fn[NAME].noConflict = function () { $.fn[NAME] = JQUERY_NO_CONFLICT return ScrollSpy._jQueryInterface } return ScrollSpy })(jQuery) export default ScrollSpy