scrollspy.js 10.4 KB
Newer Older
fat's avatar
fat committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
(function (global, factory) {
  if (typeof define === 'function' && define.amd) {
    define(['exports', 'module', './util'], factory);
  } else if (typeof exports !== 'undefined' && typeof module !== 'undefined') {
    factory(exports, module, require('./util'));
  } else {
    var mod = {
      exports: {}
    };
    factory(mod.exports, mod, global.Util);
    global.scrollspy = mod.exports;
  }
})(this, function (exports, module, _util) {
  'use strict';

  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; }; })();

18
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
fat's avatar
fat committed
19
20
21

  function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError('Cannot call a class as a function'); } }

22
  var _Util = _interopRequireDefault(_util);
fat's avatar
fat committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

  /**
   * --------------------------------------------------------------------------
   * Bootstrap (v4.0.0): scrollspy.js
   * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
   * --------------------------------------------------------------------------
   */

  var ScrollSpy = (function ($) {

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

    var NAME = 'scrollspy';
    var VERSION = '4.0.0';
    var DATA_KEY = 'bs.scrollspy';
fat's avatar
fat committed
42
43
    var EVENT_KEY = '.' + DATA_KEY;
    var DATA_API_KEY = '.data-api';
fat's avatar
fat committed
44
45
46
    var JQUERY_NO_CONFLICT = $.fn[NAME];

    var Default = {
47
48
49
50
51
52
53
54
55
      offset: 10,
      method: 'auto',
      target: ''
    };

    var DefaultType = {
      offset: 'number',
      method: 'string',
      target: '(string|element)'
fat's avatar
fat committed
56
57
58
    };

    var Event = {
fat's avatar
fat committed
59
60
      ACTIVATE: 'activate' + EVENT_KEY,
      SCROLL: 'scroll' + EVENT_KEY,
Jacob Thornton's avatar
Jacob Thornton committed
61
      LOAD_DATA_API: 'load' + EVENT_KEY + DATA_API_KEY
fat's avatar
fat committed
62
63
64
65
66
67
68
69
70
71
    };

    var ClassName = {
      DROPDOWN_MENU: 'dropdown-menu',
      ACTIVE: 'active'
    };

    var Selector = {
      DATA_SPY: '[data-spy="scroll"]',
      ACTIVE: '.active',
72
      LI: 'li',
fat's avatar
fat committed
73
      LI_DROPDOWN: 'li.dropdown',
74
75
76
77
78
79
      NAV_ANCHORS: '.nav li > a'
    };

    var OffsetMethod = {
      OFFSET: 'offset',
      POSITION: 'position'
fat's avatar
fat committed
80
81
82
83
84
85
86
87
88
89
90
91
    };

    /**
     * ------------------------------------------------------------------------
     * Class Definition
     * ------------------------------------------------------------------------
     */

    var ScrollSpy = (function () {
      function ScrollSpy(element, config) {
        _classCallCheck(this, ScrollSpy);

fat's avatar
fat committed
92
        this._element = element;
fat's avatar
fat committed
93
        this._scrollElement = element.tagName === 'BODY' ? window : element;
94
        this._config = this._getConfig(config);
Jacob Thornton's avatar
Jacob Thornton committed
95
        this._selector = this._config.target + ' ' + Selector.NAV_ANCHORS;
fat's avatar
fat committed
96
97
98
99
100
101
102
103
104
105
106
        this._offsets = [];
        this._targets = [];
        this._activeTarget = null;
        this._scrollHeight = 0;

        $(this._scrollElement).on(Event.SCROLL, $.proxy(this._process, this));

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

Jacob Thornton's avatar
Jacob Thornton committed
107
108
109
110
111
112
113
114
      /**
       * ------------------------------------------------------------------------
       * Data Api implementation
       * ------------------------------------------------------------------------
       */

      // getters

fat's avatar
fat committed
115
116
117
118
119
120
121
122
      _createClass(ScrollSpy, [{
        key: 'refresh',

        // public

        value: function refresh() {
          var _this = this;

123
          var autoMethod = this._scrollElement !== this._scrollElement.window ? OffsetMethod.POSITION : OffsetMethod.OFFSET;
fat's avatar
fat committed
124

125
126
127
          var offsetMethod = this._config.method === 'auto' ? autoMethod : this._config.method;

          var offsetBase = offsetMethod === OffsetMethod.POSITION ? this._getScrollTop() : 0;
fat's avatar
fat committed
128
129
130
131
132
133
134
135
136
137

          this._offsets = [];
          this._targets = [];

          this._scrollHeight = this._getScrollHeight();

          var targets = $.makeArray($(this._selector));

          targets.map(function (element) {
            var target = undefined;
138
            var targetSelector = _Util['default'].getSelectorFromElement(element);
fat's avatar
fat committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

            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];
            }
          }).filter(function (item) {
            return item;
          }).sort(function (a, b) {
            return a[0] - b[0];
          }).forEach(function (item) {
            _this._offsets.push(item[0]);
            _this._targets.push(item[1]);
          });
        }
fat's avatar
fat committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
      }, {
        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;
        }
fat's avatar
fat committed
172
173
174

        // private

Jacob Thornton's avatar
Jacob Thornton committed
175
176
      }, {
        key: '_getConfig',
177
178
179
180
181
182
        value: function _getConfig(config) {
          config = $.extend({}, Default, config);

          if (typeof config.target !== 'string') {
            var id = $(config.target).attr('id');
            if (!id) {
183
              id = _Util['default'].getUID(NAME);
184
185
186
187
188
              $(config.target).attr('id', id);
            }
            config.target = '#' + id;
          }

189
          _Util['default'].typeCheckConfig(NAME, config, DefaultType);
190
191
192
193
194

          return config;
        }
      }, {
        key: '_getScrollTop',
fat's avatar
fat committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
        value: function _getScrollTop() {
          return this._scrollElement === window ? this._scrollElement.scrollY : this._scrollElement.scrollTop;
        }
      }, {
        key: '_getScrollHeight',
        value: function _getScrollHeight() {
          return this._scrollElement.scrollHeight || Math.max(document.body.scrollHeight, document.documentElement.scrollHeight);
        }
      }, {
        key: '_process',
        value: function _process() {
          var scrollTop = this._getScrollTop() + this._config.offset;
          var scrollHeight = this._getScrollHeight();
          var maxScroll = this._config.offset + scrollHeight - this._scrollElement.offsetHeight;

          if (this._scrollHeight !== scrollHeight) {
            this.refresh();
          }

          if (scrollTop >= maxScroll) {
            var target = this._targets[this._targets.length - 1];

            if (this._activeTarget !== target) {
              this._activate(target);
            }
          }

          if (this._activeTarget && scrollTop < this._offsets[0]) {
            this._activeTarget = null;
            this._clear();
            return;
          }

          for (var i = this._offsets.length; i--;) {
            var 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]);
            }
          }
        }
      }, {
        key: '_activate',
        value: function _activate(target) {
          this._activeTarget = target;

          this._clear();

Jacob Thornton's avatar
Jacob Thornton committed
243
          var selector = this._selector + '[data-target="' + target + '"],' + (this._selector + '[href="' + target + '"]');
fat's avatar
fat committed
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

          // todo (fat): getting all the raw li's up the tree is not great.
          var parentListItems = $(selector).parents(Selector.LI);

          for (var i = parentListItems.length; i--;) {
            $(parentListItems[i]).addClass(ClassName.ACTIVE);

            var itemParent = parentListItems[i].parentNode;

            if (itemParent && $(itemParent).hasClass(ClassName.DROPDOWN_MENU)) {
              var closestDropdown = $(itemParent).closest(Selector.LI_DROPDOWN)[0];
              $(closestDropdown).addClass(ClassName.ACTIVE);
            }
          }

          $(this._scrollElement).trigger(Event.ACTIVATE, {
            relatedTarget: target
          });
        }
      }, {
        key: '_clear',
        value: function _clear() {
          var activeParents = $(this._selector).parentsUntil(this._config.target, Selector.ACTIVE);

          for (var i = activeParents.length; i--;) {
            $(activeParents[i]).removeClass(ClassName.ACTIVE);
          }
        }

        // static

Jacob Thornton's avatar
Jacob Thornton committed
275
276
      }], [{
        key: '_jQueryInterface',
fat's avatar
fat committed
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
        value: function _jQueryInterface(config) {
          return this.each(function () {
            var data = $(this).data(DATA_KEY);
            var _config = typeof config === 'object' && config || null;

            if (!data) {
              data = new ScrollSpy(this, _config);
              $(this).data(DATA_KEY, data);
            }

            if (typeof config === 'string') {
              data[config]();
            }
          });
        }
Mark Otto's avatar
grunt    
Mark Otto committed
292
293
      }, {
        key: 'VERSION',
Jacob Thornton's avatar
Jacob Thornton committed
294
        get: function get() {
Mark Otto's avatar
grunt    
Mark Otto committed
295
296
297
298
          return VERSION;
        }
      }, {
        key: 'Default',
Jacob Thornton's avatar
Jacob Thornton committed
299
        get: function get() {
Mark Otto's avatar
grunt    
Mark Otto committed
300
301
          return Default;
        }
fat's avatar
fat committed
302
303
304
305
306
      }]);

      return ScrollSpy;
    })();

fat's avatar
fat committed
307
    $(window).on(Event.LOAD_DATA_API, function () {
fat's avatar
fat committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
      var scrollSpys = $.makeArray($(Selector.DATA_SPY));

      for (var i = scrollSpys.length; i--;) {
        var $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);

  module.exports = ScrollSpy;
Mark Otto's avatar
grunt    
Mark Otto committed
333
});