scrollspy.js 10.5 KB
Newer Older
Mark Otto's avatar
dist    
Mark Otto committed
1
2
'use strict';

Mark Otto's avatar
grunt    
Mark Otto committed
3
var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
fat's avatar
fat committed
4

Mark Otto's avatar
grunt    
Mark Otto committed
5
var _createClass = function () { 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); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
fat's avatar
fat committed
6

Mark Otto's avatar
grunt    
Mark Otto committed
7
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
fat's avatar
fat committed
8
9
10

/**
 * --------------------------------------------------------------------------
Mark Otto's avatar
Mark Otto committed
11
 * Bootstrap (v4.0.0-beta): scrollspy.js
fat's avatar
fat committed
12
13
14
15
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */

Mark Otto's avatar
dist    
Mark Otto committed
16
var ScrollSpy = function () {
fat's avatar
fat committed
17
18
19
20
21
22
23
24

  /**
   * ------------------------------------------------------------------------
   * Constants
   * ------------------------------------------------------------------------
   */

  var NAME = 'scrollspy';
Mark Otto's avatar
Mark Otto committed
25
  var VERSION = '4.0.0-beta';
fat's avatar
fat committed
26
  var DATA_KEY = 'bs.scrollspy';
fat's avatar
fat committed
27
28
  var EVENT_KEY = '.' + DATA_KEY;
  var DATA_API_KEY = '.data-api';
fat's avatar
fat committed
29
30
  var JQUERY_NO_CONFLICT = $.fn[NAME];

31
  var Default = {
32
    offset: 10,
fat's avatar
fat committed
33
34
    method: 'auto',
    target: ''
fat's avatar
fat committed
35
36
  };

fat's avatar
fat committed
37
38
39
40
41
42
  var DefaultType = {
    offset: 'number',
    method: 'string',
    target: '(string|element)'
  };

fat's avatar
fat committed
43
  var Event = {
fat's avatar
fat committed
44
45
    ACTIVATE: 'activate' + EVENT_KEY,
    SCROLL: 'scroll' + EVENT_KEY,
Jacob Thornton's avatar
Jacob Thornton committed
46
    LOAD_DATA_API: 'load' + EVENT_KEY + DATA_API_KEY
fat's avatar
fat committed
47
48
49
  };

  var ClassName = {
Jacob Thornton's avatar
Jacob Thornton committed
50
    DROPDOWN_ITEM: 'dropdown-item',
fat's avatar
fat committed
51
52
53
54
55
56
57
    DROPDOWN_MENU: 'dropdown-menu',
    ACTIVE: 'active'
  };

  var Selector = {
    DATA_SPY: '[data-spy="scroll"]',
    ACTIVE: '.active',
Mark Otto's avatar
grunt    
Mark Otto committed
58
    NAV_LIST_GROUP: '.nav, .list-group',
Jacob Thornton's avatar
Jacob Thornton committed
59
    NAV_LINKS: '.nav-link',
Mark Otto's avatar
grunt    
Mark Otto committed
60
    LIST_ITEMS: '.list-group-item',
61
62
63
    DROPDOWN: '.dropdown',
    DROPDOWN_ITEMS: '.dropdown-item',
    DROPDOWN_TOGGLE: '.dropdown-toggle'
fat's avatar
fat committed
64
65
  };

66
67
68
69
  var OffsetMethod = {
    OFFSET: 'offset',
    POSITION: 'position'

Mark Otto's avatar
dist    
Mark Otto committed
70
71
72
73
74
    /**
     * ------------------------------------------------------------------------
     * Class Definition
     * ------------------------------------------------------------------------
     */
fat's avatar
fat committed
75

Mark Otto's avatar
dist    
Mark Otto committed
76
  };
Mark Otto's avatar
grunt    
Mark Otto committed
77
  var ScrollSpy = function () {
fat's avatar
fat committed
78
    function ScrollSpy(element, config) {
Mark Otto's avatar
grunt    
Mark Otto committed
79
80
      var _this = this;

fat's avatar
fat committed
81
82
      _classCallCheck(this, ScrollSpy);

fat's avatar
fat committed
83
      this._element = element;
fat's avatar
fat committed
84
      this._scrollElement = element.tagName === 'BODY' ? window : element;
fat's avatar
fat committed
85
      this._config = this._getConfig(config);
Mark Otto's avatar
grunt    
Mark Otto committed
86
      this._selector = this._config.target + ' ' + Selector.NAV_LINKS + ',' + (this._config.target + ' ' + Selector.LIST_ITEMS + ',') + (this._config.target + ' ' + Selector.DROPDOWN_ITEMS);
fat's avatar
fat committed
87
88
89
90
91
      this._offsets = [];
      this._targets = [];
      this._activeTarget = null;
      this._scrollHeight = 0;

Mark Otto's avatar
grunt    
Mark Otto committed
92
93
94
      $(this._scrollElement).on(Event.SCROLL, function (event) {
        return _this._process(event);
      });
fat's avatar
fat committed
95
96
97
98
99

      this.refresh();
      this._process();
    }

Jacob Thornton's avatar
Jacob Thornton committed
100
101
    // getters

Mark Otto's avatar
dist    
Mark Otto committed
102
103
    _createClass(ScrollSpy, [{
      key: 'refresh',
fat's avatar
fat committed
104
105


Mark Otto's avatar
dist    
Mark Otto committed
106
      // public
fat's avatar
fat committed
107

Mark Otto's avatar
dist    
Mark Otto committed
108
109
      value: function refresh() {
        var _this2 = this;
110

Mark Otto's avatar
dist    
Mark Otto committed
111
        var autoMethod = this._scrollElement !== this._scrollElement.window ? OffsetMethod.POSITION : OffsetMethod.OFFSET;
fat's avatar
fat committed
112

Mark Otto's avatar
dist    
Mark Otto committed
113
        var offsetMethod = this._config.method === 'auto' ? autoMethod : this._config.method;
fat's avatar
fat committed
114

Mark Otto's avatar
dist    
Mark Otto committed
115
        var offsetBase = offsetMethod === OffsetMethod.POSITION ? this._getScrollTop() : 0;
fat's avatar
fat committed
116

Mark Otto's avatar
dist    
Mark Otto committed
117
118
        this._offsets = [];
        this._targets = [];
fat's avatar
fat committed
119

Mark Otto's avatar
dist    
Mark Otto committed
120
        this._scrollHeight = this._getScrollHeight();
fat's avatar
fat committed
121

Mark Otto's avatar
dist    
Mark Otto committed
122
        var targets = $.makeArray($(this._selector));
fat's avatar
fat committed
123

Mark Otto's avatar
dist    
Mark Otto committed
124
125
126
        targets.map(function (element) {
          var target = void 0;
          var targetSelector = Util.getSelectorFromElement(element);
fat's avatar
fat committed
127

Mark Otto's avatar
dist    
Mark Otto committed
128
129
130
          if (targetSelector) {
            target = $(targetSelector)[0];
          }
fat's avatar
fat committed
131

Mark Otto's avatar
dist    
Mark Otto committed
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
          if (target) {
            var targetBCR = target.getBoundingClientRect();
            if (targetBCR.width || targetBCR.height) {
              // todo (fat): remove sketch reliance on jQuery position/offset
              return [$(target)[offsetMethod]().top + offsetBase, targetSelector];
            }
          }
          return null;
        }).filter(function (item) {
          return item;
        }).sort(function (a, b) {
          return a[0] - b[0];
        }).forEach(function (item) {
          _this2._offsets.push(item[0]);
          _this2._targets.push(item[1]);
        });
      }
    }, {
      key: 'dispose',
      value: 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;
Mark Otto's avatar
grunt    
Mark Otto committed
163
      }
fat's avatar
fat committed
164

Mark Otto's avatar
dist    
Mark Otto committed
165
      // private
Mark Otto's avatar
grunt    
Mark Otto committed
166

Mark Otto's avatar
dist    
Mark Otto committed
167
168
169
170
171
172
173
174
175
176
177
178
179
    }, {
      key: '_getConfig',
      value: function _getConfig(config) {
        config = $.extend({}, Default, config);

        if (typeof config.target !== 'string') {
          var id = $(config.target).attr('id');
          if (!id) {
            id = Util.getUID(NAME);
            $(config.target).attr('id', id);
          }
          config.target = '#' + id;
        }
matus's avatar
matus committed
180

Mark Otto's avatar
dist    
Mark Otto committed
181
        Util.typeCheckConfig(NAME, config, DefaultType);
Mark Otto's avatar
grunt    
Mark Otto committed
182

Mark Otto's avatar
dist    
Mark Otto committed
183
        return config;
fat's avatar
fat committed
184
      }
Mark Otto's avatar
dist    
Mark Otto committed
185
186
187
188
    }, {
      key: '_getScrollTop',
      value: function _getScrollTop() {
        return this._scrollElement === window ? this._scrollElement.pageYOffset : this._scrollElement.scrollTop;
Mark Otto's avatar
grunt    
Mark Otto committed
189
      }
Mark Otto's avatar
dist    
Mark Otto committed
190
191
192
193
194
195
196
197
198
    }, {
      key: '_getScrollHeight',
      value: function _getScrollHeight() {
        return this._scrollElement.scrollHeight || Math.max(document.body.scrollHeight, document.documentElement.scrollHeight);
      }
    }, {
      key: '_getOffsetHeight',
      value: function _getOffsetHeight() {
        return this._scrollElement === window ? window.innerHeight : this._scrollElement.getBoundingClientRect().height;
Mark Otto's avatar
grunt    
Mark Otto committed
199
      }
Mark Otto's avatar
dist    
Mark Otto committed
200
201
202
203
204
205
206
207
208
209
    }, {
      key: '_process',
      value: function _process() {
        var scrollTop = this._getScrollTop() + this._config.offset;
        var scrollHeight = this._getScrollHeight();
        var maxScroll = this._config.offset + scrollHeight - this._getOffsetHeight();

        if (this._scrollHeight !== scrollHeight) {
          this.refresh();
        }
fat's avatar
fat committed
210

Mark Otto's avatar
dist    
Mark Otto committed
211
212
        if (scrollTop >= maxScroll) {
          var target = this._targets[this._targets.length - 1];
fat's avatar
fat committed
213

Mark Otto's avatar
dist    
Mark Otto committed
214
215
216
217
          if (this._activeTarget !== target) {
            this._activate(target);
          }
          return;
fat's avatar
fat committed
218
219
        }

Mark Otto's avatar
dist    
Mark Otto committed
220
221
222
223
224
        if (this._activeTarget && scrollTop < this._offsets[0] && this._offsets[0] > 0) {
          this._activeTarget = null;
          this._clear();
          return;
        }
fat's avatar
fat committed
225

Mark Otto's avatar
dist    
Mark Otto committed
226
227
        for (var i = this._offsets.length; i--;) {
          var isActiveTarget = this._activeTarget !== this._targets[i] && scrollTop >= this._offsets[i] && (typeof this._offsets[i + 1] === 'undefined' || scrollTop < this._offsets[i + 1]);
fat's avatar
fat committed
228

Mark Otto's avatar
dist    
Mark Otto committed
229
230
231
232
          if (isActiveTarget) {
            this._activate(this._targets[i]);
          }
        }
fat's avatar
fat committed
233
      }
Mark Otto's avatar
dist    
Mark Otto committed
234
235
236
237
    }, {
      key: '_activate',
      value: function _activate(target) {
        this._activeTarget = target;
fat's avatar
fat committed
238

Mark Otto's avatar
dist    
Mark Otto committed
239
        this._clear();
fat's avatar
fat committed
240

Mark Otto's avatar
dist    
Mark Otto committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
        var queries = this._selector.split(',');
        // eslint-disable-next-line arrow-body-style
        queries = queries.map(function (selector) {
          return selector + '[data-target="' + target + '"],' + (selector + '[href="' + target + '"]');
        });

        var $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 {
          // Set triggered link as active
          $link.addClass(ClassName.ACTIVE);
          // Set triggered links parents as active
          // With both <ul> and <nav> markup a parent is the previous sibling of any nav ancestor
          $link.parents(Selector.NAV_LIST_GROUP).prev(Selector.NAV_LINKS + ', ' + Selector.LIST_ITEMS).addClass(ClassName.ACTIVE);
        }
fat's avatar
fat committed
259

Mark Otto's avatar
dist    
Mark Otto committed
260
261
262
263
264
265
266
267
268
        $(this._scrollElement).trigger(Event.ACTIVATE, {
          relatedTarget: target
        });
      }
    }, {
      key: '_clear',
      value: function _clear() {
        $(this._selector).filter(Selector.ACTIVE).removeClass(ClassName.ACTIVE);
      }
fat's avatar
fat committed
269

Mark Otto's avatar
dist    
Mark Otto committed
270
      // static
Mark Otto's avatar
grunt    
Mark Otto committed
271

Mark Otto's avatar
dist    
Mark Otto committed
272
273
274
275
276
277
    }], [{
      key: '_jQueryInterface',
      value: function _jQueryInterface(config) {
        return this.each(function () {
          var data = $(this).data(DATA_KEY);
          var _config = (typeof config === 'undefined' ? 'undefined' : _typeof(config)) === 'object' && config;
Mark Otto's avatar
grunt    
Mark Otto committed
278

Mark Otto's avatar
dist    
Mark Otto committed
279
280
281
          if (!data) {
            data = new ScrollSpy(this, _config);
            $(this).data(DATA_KEY, data);
fat's avatar
fat committed
282
          }
Mark Otto's avatar
grunt    
Mark Otto committed
283

Mark Otto's avatar
dist    
Mark Otto committed
284
285
286
287
288
289
290
291
292
          if (typeof config === 'string') {
            if (typeof data[config] === 'undefined') {
              throw new Error('No method named "' + config + '"');
            }
            data[config]();
          }
        });
      }
    }, {
Jacob Thornton's avatar
Jacob Thornton committed
293
294
295
296
297
298
299
300
301
      key: 'VERSION',
      get: function get() {
        return VERSION;
      }
    }, {
      key: 'Default',
      get: function get() {
        return Default;
      }
fat's avatar
fat committed
302
303
304
    }]);

    return ScrollSpy;
Mark Otto's avatar
grunt    
Mark Otto committed
305
306
307
308
309
310
311
  }();

  /**
   * ------------------------------------------------------------------------
   * Data Api implementation
   * ------------------------------------------------------------------------
   */
fat's avatar
fat committed
312

fat's avatar
fat committed
313
  $(window).on(Event.LOAD_DATA_API, function () {
fat's avatar
fat committed
314
315
316
317
318
319
    var scrollSpys = $.makeArray($(Selector.DATA_SPY));

    for (var i = scrollSpys.length; i--;) {
      var $spy = $(scrollSpys[i]);
      ScrollSpy._jQueryInterface.call($spy, $spy.data());
    }
Mark Otto's avatar
Mark Otto committed
320
  });
fat's avatar
fat committed
321
322
323
324
325
326
327

  /**
   * ------------------------------------------------------------------------
   * jQuery
   * ------------------------------------------------------------------------
   */

Mark Otto's avatar
Mark Otto committed
328
  $.fn[NAME] = ScrollSpy._jQueryInterface;
fat's avatar
fat committed
329
330
331
332
333
334
335
  $.fn[NAME].Constructor = ScrollSpy;
  $.fn[NAME].noConflict = function () {
    $.fn[NAME] = JQUERY_NO_CONFLICT;
    return ScrollSpy._jQueryInterface;
  };

  return ScrollSpy;
Mark Otto's avatar
grunt    
Mark Otto committed
336
}(jQuery);
Mark Otto's avatar
build    
Mark Otto committed
337
//# sourceMappingURL=scrollspy.js.map