# All files / src scrollspy.js

95.35% Statements 123/129
83.33% Branches 50/60
89.66% Functions 26/29
95.31% Lines 122/128

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    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
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    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
    243
    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
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    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
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343

    1x
    1x
    1x
    1x
    1x

    1x

    1x

    1x
    1x
    1x

    1x
    1x

    1x
    1x
    1x
    1x
    1x
    1x
    1x

    1x
    1x

    19x
    19x
    19x
    19x
    19x
    19x
    19x
    19x

    19x

    19x
    19x

    19x

    1x

    1x

    19x

    19x

    19x

    19x
    19x
    19x

    19x

    19x
    29x
    29x

    29x
    28x
    28x
    28x

    1x

    29x
    18x

    28x
    28x

    1x
    1x

    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x

    19x

    19x
    2x
    2x
    1x
    1x

    2x

    19x

    19x

    55x

    56x

    37x

    37x
    37x
    37x

    37x

    37x
    1x

    1x
    1x

    1x

    36x
    1x
    1x
    1x

    35x
    72x

    72x
    19x

    20x

    20x

    20x
    60x

    20x

    20x

    20x

    20x

    14x

    14x

    20x

    21x
    69x
    14x

    4x
    4x
    4x

    4x
    2x

    4x
    2x
    1x

    1x

    5x

    1x
    3x
    1x

    1x

    1x

     /**
     * --------------------------------------------------------------------------
     * CoreUI (v3.3.0): scrollspy.js
     * Licensed under MIT (https://coreui.io/license)
     *
     * This component is a modified version of the Bootstrap's scrollspy.js
     * Bootstrap (v5.0.0): scrollspy.js
     * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
     * --------------------------------------------------------------------------
     */

    import {
      getjQuery,
      getSelectorFromElement,
      getUID,
      isElement,
      typeCheckConfig
    } from './util/index'
    import Data from './dom/data'
    import EventHandler from './dom/event-handler'
    import Manipulator from './dom/manipulator'
    import SelectorEngine from './dom/selector-engine'

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

    const NAME = 'scrollspy'
    const VERSION = '3.2.2'
    const DATA_KEY = 'coreui.scrollspy'
    const EVENT_KEY = `.${DATA_KEY}`
    const DATA_API_KEY = '.data-api'

    const Default = {
      offset: 10,
      method: 'auto',
      target: ''
    }

    const DefaultType = {
      offset: 'number',
      method: 'string',
      target: '(string|element)'
    }

    const EVENT_ACTIVATE = `activate${EVENT_KEY}`
    const EVENT_SCROLL = `scroll${EVENT_KEY}`
    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-spy="scroll"]'
    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'
    const SELECTOR_DROPDOWN = '.dropdown'
    const SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle'

    const METHOD_OFFSET = 'offset'
    const METHOD_POSITION = 'position'

    /**
     * ------------------------------------------------------------------------
     * 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_LIST_ITEMS}, ${this._config.target} .${CLASS_NAME_DROPDOWN_ITEM}`
        this._offsets = []
        this._targets = []
        this._activeTarget = null
        this._scrollHeight = 0

        EventHandler.on(this._scrollElement, EVENT_SCROLL, event => this._process(event))

        this.refresh()
        this._process()

        Data.setData(element, DATA_KEY, this)
      }

      // Getters

      static get VERSION() {
        return VERSION
      }

      static get Default() {
        return Default
      }

      // Public

      refresh() {
        const autoMethod = this._scrollElement === this._scrollElement.window ?
          METHOD_OFFSET :
          METHOD_POSITION

        const offsetMethod = this._config.method === 'auto' ?
          autoMethod :
          this._config.method

        const offsetBase = offsetMethod === METHOD_POSITION ?
          this._getScrollTop() :
          0

        this._offsets = []
        this._targets = []
        this._scrollHeight = this._getScrollHeight()

        const targets = SelectorEngine.find(this._selector)

        targets.map(element => {
          const targetSelector = getSelectorFromElement(element)
          const target = targetSelector ? SelectorEngine.findOne(targetSelector) : null

          if (target) {
            const targetBCR = target.getBoundingClientRect()
            Eif (targetBCR.width || targetBCR.height) {
              return [
                Manipulator[offsetMethod](target).top + offsetBase,
                targetSelector
              ]
            }
          }

          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() {
        Data.removeData(this._element, DATA_KEY)
        EventHandler.off(this._scrollElement, 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 = {
          ...Default,
          ...(typeof config === 'object' && config ? config : {})
        }

        if (typeof config.target !== 'string' && isElement(config.target)) {
          let { id } = config.target
          if (!id) {
            id = getUID(NAME)
            config.target.id = id
          }

          config.target = `#${id}`
        }

        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.getBoundingClientRect().height
      }

      _process() {
        const scrollTop = this._getScrollTop() + this._config.offset
        const scrollHeight = this._getScrollHeight()
        const maxScroll = this._config.offset +
          scrollHeight -
          this._getOffsetHeight()

        Iif (this._scrollHeight !== scrollHeight) {
          this.refresh()
        }

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

          Eif (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] &&
              (typeof this._offsets[i + 1] === 'undefined' ||
                  scrollTop < this._offsets[i + 1])

          if (isActiveTarget) {
            this._activate(this._targets[i])
          }
        }
      }

      _activate(target) {
        this._activeTarget = target

        this._clear()

        const queries = this._selector.split(',')
          .map(selector => `${selector}[data-target="${target}"],${selector}[href="${target}"]`)

        const link = SelectorEngine.findOne(queries.join(','))

        Iif (link.classList.contains(CLASS_NAME_DROPDOWN_ITEM)) {
          SelectorEngine.findOne(SELECTOR_DROPDOWN_TOGGLE, link.closest(SELECTOR_DROPDOWN))
            .classList.add(CLASS_NAME_ACTIVE)

          link.classList.add(CLASS_NAME_ACTIVE)
        } else {
          // Set triggered link as active
          link.classList.add(CLASS_NAME_ACTIVE)

          SelectorEngine.parents(link, SELECTOR_NAV_LIST_GROUP)
            .forEach(listGroup => {
              // Set triggered links parents as active
              // With both <ul> and <nav> markup a parent is the previous sibling of any nav ancestor
              SelectorEngine.prev(listGroup, `${SELECTOR_NAV_LINKS}, ${SELECTOR_LIST_ITEMS}`)
                .forEach(item => item.classList.add(CLASS_NAME_ACTIVE))

              // Handle special case when .nav-link is inside .nav-item
              SelectorEngine.prev(listGroup, SELECTOR_NAV_ITEMS)
                .forEach(navItem => {
                  SelectorEngine.children(navItem, SELECTOR_NAV_LINKS)
                    .forEach(item => item.classList.add(CLASS_NAME_ACTIVE))
                })
            })
        }

        EventHandler.trigger(this._scrollElement, EVENT_ACTIVATE, {
          relatedTarget: target
        })
      }

      _clear() {
        SelectorEngine.find(this._selector)
          .filter(node => node.classList.contains(CLASS_NAME_ACTIVE))
          .forEach(node => node.classList.remove(CLASS_NAME_ACTIVE))
      }

      // Static

      static jQueryInterface(config) {
        return this.each(function () {
          let data = Data.getData(this, DATA_KEY)
          const _config = typeof config === 'object' && config

          if (!data) {
            data = new ScrollSpy(this, _config)
          }

          if (typeof config === 'string') {
            if (typeof data[config] === 'undefined') {
              throw new TypeError(`No method named "${config}"`)
            }

            data[config]()
          }
        })
      }

      static getInstance(element) {
        return Data.getData(element, DATA_KEY)
      }
    }

    /**
     * ------------------------------------------------------------------------
     * Data Api implementation
     * ------------------------------------------------------------------------
     */

    EventHandler.on(window, EVENT_LOAD_DATA_API, () => {
      SelectorEngine.find(SELECTOR_DATA_SPY)
        .forEach(spy => new ScrollSpy(spy, Manipulator.getDataAttributes(spy)))
    })

    const $ = getjQuery()

    /**
     * ------------------------------------------------------------------------
     * jQuery
     * ------------------------------------------------------------------------
     */
    /* istanbul ignore if */
    if ($) {
      const JQUERY_NO_CONFLICT = $.fn[NAME]
      $.fn[NAME] = ScrollSpy.jQueryInterface
      $.fn[NAME].Constructor = ScrollSpy
      $.fn[NAME].noConflict = () => {
        $.fn[NAME] = JQUERY_NO_CONFLICT
        return ScrollSpy.jQueryInterface
      }
    }

    export default ScrollSpy