@coreui/coreui 4.0.2

package/js/src/scrollspy.js

@@ -0,0 +1,298 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (v4.0.2): scrollspy.js
+ * Licensed under MIT (https://coreui.io/license)
+ *
+ * This component is a modified version of the Bootstrap's scrollspy.js
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
+import {
+  defineJQueryPlugin,
+  getElement,
+  getSelectorFromElement,
+  typeCheckConfig
+} from './util/index'
+import EventHandler from './dom/event-handler'
+import Manipulator from './dom/manipulator'
+import SelectorEngine from './dom/selector-engine'
+import BaseComponent from './base-component'
+
+/**
+ * ------------------------------------------------------------------------
+ * Constants
+ * ------------------------------------------------------------------------
+ */
+
+const NAME = 'scrollspy'
+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-coreui-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_LINK_ITEMS = `${SELECTOR_NAV_LINKS}, ${SELECTOR_LIST_ITEMS}, .${CLASS_NAME_DROPDOWN_ITEM}`
+const SELECTOR_DROPDOWN = '.dropdown'
+const SELECTOR_DROPDOWN_TOGGLE = '.dropdown-toggle'
+
+const METHOD_OFFSET = 'offset'
+const METHOD_POSITION = 'position'
+
+/**
+ * ------------------------------------------------------------------------
+ * Class Definition
+ * ------------------------------------------------------------------------
+ */
+
+class ScrollSpy extends BaseComponent {
+  constructor(element, config) {
+    super(element)
+    this._scrollElement = this._element.tagName === 'BODY' ? window : this._element
+    this._config = this._getConfig(config)
+    this._offsets = []
+    this._targets = []
+    this._activeTarget = null
+    this._scrollHeight = 0
+
+    EventHandler.on(this._scrollElement, EVENT_SCROLL, () => this._process())
+
+    this.refresh()
+    this._process()
+  }
+
+  // Getters
+
+  static get Default() {
+    return Default
+  }
+
+  static get NAME() {
+    return NAME
+  }
+
+  // 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(SELECTOR_LINK_ITEMS, this._config.target)
+
+    targets.map(element => {
+      const targetSelector = getSelectorFromElement(element)
+      const target = targetSelector ? SelectorEngine.findOne(targetSelector) : null
+
+      if (target) {
+        const targetBCR = target.getBoundingClientRect()
+        if (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() {
+    EventHandler.off(this._scrollElement, EVENT_KEY)
+    super.dispose()
+  }
+
+  // Private
+
+  _getConfig(config) {
+    config = {
+      ...Default,
+      ...Manipulator.getDataAttributes(this._element),
+      ...(typeof config === 'object' && config ? config : {})
+    }
+
+    config.target = getElement(config.target) || document.documentElement
+
+    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()
+
+    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] &&
+          (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 = SELECTOR_LINK_ITEMS.split(',')
+      .map(selector => `${selector}[data-coreui-target="${target}"],${selector}[href="${target}"]`)
+
+    const link = SelectorEngine.findOne(queries.join(','), this._config.target)
+
+    link.classList.add(CLASS_NAME_ACTIVE)
+    if (link.classList.contains(CLASS_NAME_DROPDOWN_ITEM)) {
+      SelectorEngine.findOne(SELECTOR_DROPDOWN_TOGGLE, link.closest(SELECTOR_DROPDOWN))
+        .classList.add(CLASS_NAME_ACTIVE)
+    } else {
+      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(SELECTOR_LINK_ITEMS, this._config.target)
+      .filter(node => node.classList.contains(CLASS_NAME_ACTIVE))
+      .forEach(node => node.classList.remove(CLASS_NAME_ACTIVE))
+  }
+
+  // Static
+
+  static jQueryInterface(config) {
+    return this.each(function () {
+      const data = ScrollSpy.getOrCreateInstance(this, config)
+
+      if (typeof config !== 'string') {
+        return
+      }
+
+      if (typeof data[config] === 'undefined') {
+        throw new TypeError(`No method named "${config}"`)
+      }
+
+      data[config]()
+    })
+  }
+}
+
+/**
+ * ------------------------------------------------------------------------
+ * Data Api implementation
+ * ------------------------------------------------------------------------
+ */
+
+EventHandler.on(window, EVENT_LOAD_DATA_API, () => {
+  SelectorEngine.find(SELECTOR_DATA_SPY)
+    .forEach(spy => new ScrollSpy(spy))
+})
+
+/**
+ * ------------------------------------------------------------------------
+ * jQuery
+ * ------------------------------------------------------------------------
+ * add .ScrollSpy to jQuery only if jQuery is present
+ */
+
+defineJQueryPlugin(ScrollSpy)
+
+export default ScrollSpy

package/js/src/sidebar.js

@@ -0,0 +1,347 @@
+/**
+ * --------------------------------------------------------------------------
+ * CoreUI (v4.0.2): sidebar.js
+ * Licensed under MIT (https://coreui.io/license)
+ * --------------------------------------------------------------------------
+ */
+
+import {
+  defineJQueryPlugin,
+  reflow,
+  typeCheckConfig
+} from './util/index'
+import EventHandler from './dom/event-handler'
+import Manipulator from './dom/manipulator'
+import BaseComponent from './base-component'
+
+/**
+ * ------------------------------------------------------------------------
+ * Constants
+ * ------------------------------------------------------------------------
+ */
+
+const NAME = 'sidebar'
+const DATA_KEY = 'coreui.sidebar'
+const EVENT_KEY = `.${DATA_KEY}`
+const DATA_API_KEY = '.data-api'
+
+const Default = {}
+
+const DefaultType = {}
+
+const CLASS_NAME_BACKDROP = 'sidebar-backdrop'
+const CLASS_NAME_FADE = 'fade'
+const CLASS_NAME_HIDE = 'hide'
+const CLASS_NAME_SHOW = 'show'
+const CLASS_NAME_SIDEBAR_NARROW = 'sidebar-narrow'
+const CLASS_NAME_SIDEBAR_OVERLAID = 'sidebar-overlaid'
+const CLASS_NAME_SIDEBAR_NARROW_UNFOLDABLE = 'sidebar-narrow-unfoldable'
+
+const EVENT_HIDE = `hide${EVENT_KEY}`
+const EVENT_HIDDEN = `hidden${EVENT_KEY}`
+const EVENT_RESIZE = 'resize'
+const EVENT_SHOW = `show${EVENT_KEY}`
+const EVENT_SHOWN = `shown${EVENT_KEY}`
+const EVENT_CLICK_DATA_API = `click${EVENT_KEY}${DATA_API_KEY}`
+const EVENT_LOAD_DATA_API = `load${EVENT_KEY}${DATA_API_KEY}`
+
+const SELECTOR_DATA_CLOSE = '[data-coreui-close="sidebar"]'
+const SELECTOR_DATA_TOGGLE = '[data-coreui-toggle]'
+
+const SELECTOR_SIDEBAR = '.sidebar'
+
+/**
+ * ------------------------------------------------------------------------
+ * Class Definition
+ * ------------------------------------------------------------------------
+ */
+
+class Sidebar extends BaseComponent {
+  constructor(element, config) {
+    super(element)
+    this._config = this._getConfig(config)
+    this._show = this._isVisible()
+    this._mobile = this._isMobile()
+    this._overlaid = this._isOverlaid()
+    this._narrow = this._isNarrow()
+    this._unfoldable = this._isUnfoldable()
+    this._backdrop = null
+    this._addEventListeners()
+  }
+
+  // Getters
+
+  static get Default() {
+    return Default
+  }
+
+  static get DefaultType() {
+    return DefaultType
+  }
+
+  static get NAME() {
+    return NAME
+  }
+
+  // Public
+
+  show() {
+    EventHandler.trigger(this._element, EVENT_SHOW)
+
+    if (this._element.classList.contains(CLASS_NAME_HIDE)) {
+      this._element.classList.remove(CLASS_NAME_HIDE)
+    }
+
+    if (this._isMobile()) {
+      this._element.classList.add(CLASS_NAME_SHOW)
+      this._showBackdrop()
+    }
+
+    const complete = () => {
+      if (this._isVisible() === true) {
+        this._show = true
+        if (this._isMobile() || this._isOverlaid()) {
+          this._addClickOutListener()
+        }
+
+        EventHandler.trigger(this._element, EVENT_SHOWN)
+      }
+    }
+
+    this._queueCallback(complete, this._element, true)
+  }
+
+  hide() {
+    EventHandler.trigger(this._element, EVENT_HIDE)
+
+    if (this._element.classList.contains(CLASS_NAME_SHOW)) {
+      this._element.classList.remove(CLASS_NAME_SHOW)
+    }
+
+    if (this._isMobile()) {
+      this._removeBackdrop()
+    } else {
+      this._element.classList.add(CLASS_NAME_HIDE)
+    }
+
+    const complete = () => {
+      if (this._isVisible() === false) {
+        this._show = false
+        if (this._isMobile() || this._isOverlaid()) {
+          this._removeClickOutListener()
+        }
+
+        EventHandler.trigger(this._element, EVENT_HIDDEN)
+      }
+    }
+
+    this._queueCallback(complete, this._element, true)
+  }
+
+  toggle() {
+    if (this._isVisible()) {
+      this.hide()
+      return
+    }
+
+    this.show()
+  }
+
+  narrow() {
+    if (!this._isMobile()) {
+      this._addClassName(CLASS_NAME_SIDEBAR_NARROW)
+      this._narrow = true
+    }
+  }
+
+  unfoldable() {
+    if (!this._isMobile()) {
+      this._addClassName(CLASS_NAME_SIDEBAR_NARROW_UNFOLDABLE)
+      this._unfoldable = true
+    }
+  }
+
+  reset() {
+    if (!this._isMobile()) {
+      if (this._narrow) {
+        this._element.classList.remove(CLASS_NAME_SIDEBAR_NARROW)
+        this._narrow = false
+      }
+
+      if (this._unfoldable) {
+        this._element.classList.remove(CLASS_NAME_SIDEBAR_NARROW_UNFOLDABLE)
+        this._unfoldable = false
+      }
+    }
+  }
+
+  toggleNarrow() {
+    if (this._narrow) {
+      this.reset()
+      return
+    }
+
+    this.narrow()
+  }
+
+  toggleUnfoldable() {
+    if (this._unfoldable) {
+      this.reset()
+      return
+    }
+
+    this.unfoldable()
+  }
+
+  // Private
+
+  _getConfig(config) {
+    config = {
+      ...Default,
+      ...Manipulator.getDataAttributes(this._element),
+      ...(typeof config === 'object' ? config : {})
+    }
+    typeCheckConfig(NAME, config, DefaultType)
+    return config
+  }
+
+  _isMobile() {
+    return Boolean(window.getComputedStyle(this._element, null).getPropertyValue('--cui-is-mobile'))
+  }
+
+  _isNarrow() {
+    return this._element.classList.contains(CLASS_NAME_SIDEBAR_NARROW)
+  }
+
+  _isOverlaid() {
+    return this._element.classList.contains(CLASS_NAME_SIDEBAR_OVERLAID)
+  }
+
+  _isUnfoldable() {
+    return this._element.classList.contains(CLASS_NAME_SIDEBAR_NARROW_UNFOLDABLE)
+  }
+
+  _isVisible() {
+    const rect = this._element.getBoundingClientRect()
+    return (
+      rect.top >= 0 && rect.left >= 0 && rect.bottom <= (window.innerHeight || document.documentElement.clientHeight) && rect.right <= (window.innerWidth || document.documentElement.clientWidth)
+    )
+  }
+
+  _addClassName(className) {
+    this._element.classList.add(className)
+  }
+
+  _removeBackdrop() {
+    if (this._backdrop) {
+      this._backdrop.parentNode.removeChild(this._backdrop)
+      this._backdrop = null
+    }
+  }
+
+  _showBackdrop() {
+    if (!this._backdrop) {
+      this._backdrop = document.createElement('div')
+      this._backdrop.className = CLASS_NAME_BACKDROP
+      this._backdrop.classList.add(CLASS_NAME_FADE)
+      document.body.appendChild(this._backdrop)
+      reflow(this._backdrop)
+      this._backdrop.classList.add(CLASS_NAME_SHOW)
+    }
+  }
+
+  _clickOutListener(event, sidebar) {
+    if (event.target.closest(SELECTOR_SIDEBAR) === null) {
+      event.preventDefault()
+      event.stopPropagation()
+      sidebar.hide()
+    }
+  }
+
+  _addClickOutListener() {
+    EventHandler.on(document, EVENT_CLICK_DATA_API, event => {
+      this._clickOutListener(event, this)
+    })
+  }
+
+  _removeClickOutListener() {
+    EventHandler.off(document, EVENT_CLICK_DATA_API)
+  }
+
+  // Sidebar navigation
+  _addEventListeners() {
+    if (this._mobile && this._show) {
+      this._addClickOutListener()
+    }
+
+    if (this._overlaid && this._show) {
+      this._addClickOutListener()
+    }
+
+    EventHandler.on(this._element, EVENT_CLICK_DATA_API, SELECTOR_DATA_TOGGLE, event => {
+      event.preventDefault()
+      const toggle = Manipulator.getDataAttribute(event.target, 'toggle')
+
+      if (toggle === 'narrow') {
+        this.toggleNarrow()
+      }
+
+      if (toggle === 'unfoldable') {
+        this.toggleUnfoldable()
+      }
+    })
+
+    EventHandler.on(this._element, EVENT_CLICK_DATA_API, SELECTOR_DATA_CLOSE, event => {
+      event.preventDefault()
+      this.hide()
+    })
+
+    EventHandler.on(window, EVENT_RESIZE, () => {
+      if (this._isMobile() && this._isVisible()) {
+        this.hide()
+      }
+    })
+  }
+
+  // Static
+
+  static sidebarInterface(element, config) {
+    const data = Sidebar.getOrCreateInstance(element, config)
+
+    if (typeof config === 'string') {
+      if (typeof data[config] === 'undefined') {
+        throw new TypeError(`No method named "${config}"`)
+      }
+
+      data[config]()
+    }
+  }
+
+  static jQueryInterface(config) {
+    return this.each(function () {
+      Sidebar.sidebarInterface(this, config)
+    })
+  }
+}
+
+/**
+ * ------------------------------------------------------------------------
+ * Data Api implementation
+ * ------------------------------------------------------------------------
+ */
+
+EventHandler.on(window, EVENT_LOAD_DATA_API, () => {
+  Array.from(document.querySelectorAll(SELECTOR_SIDEBAR)).forEach(element => {
+    Sidebar.sidebarInterface(element)
+  })
+})
+
+/**
+ * ------------------------------------------------------------------------
+ * jQuery
+ * ------------------------------------------------------------------------
+ */
+
+defineJQueryPlugin(NAME, Sidebar)
+
+export default Sidebar