Toggler compontent from upstrea PR

js/index.esm.js

@@ -16,4 +16,5 @@ export { default as Popover } from './src/popover.js'
 export { default as ScrollSpy } from './src/scrollspy.js'
 export { default as Tab } from './src/tab.js'
 export { default as Toast } from './src/toast.js'
+export { default as Toggler } from './src/toggler.js'
 export { default as Tooltip } from './src/tooltip.js'

js/index.umd.js

@@ -16,6 +16,7 @@ import Popover from './src/popover.js'
 import ScrollSpy from './src/scrollspy.js'
 import Tab from './src/tab.js'
 import Toast from './src/toast.js'
+import Toggler from './src/toggler.js'
 import Tooltip from './src/tooltip.js'
 
 export default {
@@ -30,5 +31,6 @@ export default {
   ScrollSpy,
   Tab,
   Toast,
+  Toggler,
   Tooltip
 }

js/src/toggler.js

@@ -0,0 +1,98 @@
+/**
+ * --------------------------------------------------------------------------
+ * Bootstrap (v5.1.3): toggler.js
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
+import BaseComponent from './base-component.js'
+import EventHandler from './dom/event-handler.js'
+import { eventActionOnPlugin } from './util/component-functions.js'
+
+/**
+ * Constants
+ */
+
+const NAME = 'toggler'
+const DATA_KEY = 'bs.toggle'
+const EVENT_KEY = `.${DATA_KEY}`
+
+const EVENT_TOGGLE = `toggle${EVENT_KEY}`
+const EVENT_TOGGLED = `toggled${EVENT_KEY}`
+const EVENT_CLICK = 'click'
+
+const SELECTOR_DATA_TOGGLE = '[data-bs-toggle="toggler"]'
+
+const DefaultType = {
+  attribute: 'string',
+  value: '(string|number|boolean)'
+}
+
+const Default = {
+  attribute: 'class',
+  value: null
+}
+
+/**
+ * Class definition
+ */
+
+class Toggler extends BaseComponent {
+  // Getters
+  static get Default() {
+    return Default
+  }
+
+  static get DefaultType() {
+    return DefaultType
+  }
+
+  static get NAME() {
+    return NAME
+  }
+
+  _configAfterMerge(config) {
+    return config
+  }
+
+  // Private
+  toggle() {
+    const toggleEvent = EventHandler.trigger(this._element, EVENT_TOGGLE)
+
+    if (toggleEvent.defaultPrevented) {
+      return
+    }
+
+    this._execute()
+
+    EventHandler.trigger(this._element, EVENT_TOGGLED)
+  }
+
+  _execute() {
+    const { attribute, value } = this._config
+
+    if (attribute === 'id') {
+      return // You have to be kidding
+    }
+
+    if (attribute === 'class') {
+      this._element.classList.toggle(value)
+      return
+    }
+
+    if (this._element.getAttribute(attribute) === value) {
+      this._element.removeAttribute(attribute)
+      return
+    }
+
+    this._element.setAttribute(attribute, value)
+  }
+}
+
+/**
+ * Data API implementation
+ */
+
+eventActionOnPlugin(Toggler, EVENT_CLICK, SELECTOR_DATA_TOGGLE, 'toggle')
+
+export default Toggler

js/src/util/component-functions.js

@@ -30,6 +30,34 @@ const enableDismissTrigger = (component, method = 'hide') => {
   })
 }
 
-export {
-  enableDismissTrigger
+const eventActionOnPlugin = (Plugin, onEvent, stringSelector, method, callback = null) => {
+  eventAction(`${onEvent}.${Plugin.NAME}`, stringSelector, data => {
+    const instances = data.targets.filter(Boolean).map(element => Plugin.getOrCreateInstance(element))
+    if (typeof callback === 'function') {
+      callback({ ...data, instances })
+    }
+
+    for (const instance of instances) {
+      instance[method]()
+    }
+  })
+}
+
+const eventAction = (onEvent, stringSelector, callback) => {
+  const selector = `${stringSelector}:not(.disabled):not(:disabled)`
+  EventHandler.on(document, onEvent, selector, function (event) {
+    if (['A', 'AREA'].includes(this.tagName)) {
+      event.preventDefault()
+    }
+
+    const selector = SelectorEngine.getSelectorFromElement(this)
+    const targets = selector ? SelectorEngine.find(selector) : [this]
+
+    callback({ targets, event })
+  })
+}
+
+export {
+  enableDismissTrigger,
+  eventActionOnPlugin
 }

js/tests/unit/toggler.spec.js

@@ -0,0 +1,195 @@
+import Toggler from '../../src/toggler.js'
+import { clearFixture, getFixture } from '../helpers/fixture.js'
+
+describe('Toggler', () => {
+  let fixtureEl
+
+  beforeAll(() => {
+    fixtureEl = getFixture()
+  })
+
+  afterEach(() => {
+    clearFixture()
+  })
+
+  describe('VERSION', () => {
+    it('should return plugin version', () => {
+      expect(Toggler.VERSION).toEqual(jasmine.any(String))
+    })
+  })
+
+  describe('constructor', () => {
+    it('should take care of element either passed as a CSS selector or DOM element', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const togglerBySelector = new Toggler('[data-bs-toggle="toggler"]')
+      const togglerByElement = new Toggler(togglerEl)
+
+      expect(togglerBySelector._element).toEqual(togglerEl)
+      expect(togglerByElement._element).toEqual(togglerEl)
+    })
+  })
+
+  describe('toggle', () => {
+    it('should toggle class on the element', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      toggler.toggle()
+      expect(togglerEl.classList.contains('bg-warning')).toBeTrue()
+
+      toggler.toggle()
+      expect(togglerEl.classList.contains('bg-warning')).toBeFalse()
+    })
+
+    it('should toggle attribute on the element', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="true" data-bs-attribute="hidden"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      toggler.toggle()
+      expect(togglerEl.getAttribute('hidden')).toEqual('true')
+
+      toggler.toggle()
+      expect(togglerEl.hasAttribute('hidden')).toBeFalse()
+    })
+
+    it('should not toggle id attribute', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="new-id" data-bs-attribute="id"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      toggler.toggle()
+      expect(togglerEl.getAttribute('id')).toBeNull()
+    })
+
+    it('should trigger events', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      const toggleSpy = jasmine.createSpy()
+      const toggledSpy = jasmine.createSpy()
+
+      togglerEl.addEventListener('toggle.bs.toggler', toggleSpy)
+      togglerEl.addEventListener('toggled.bs.toggler', toggledSpy)
+
+      toggler.toggle()
+
+      expect(toggleSpy).toHaveBeenCalled()
+      expect(toggledSpy).toHaveBeenCalled()
+    })
+
+    it('should not trigger toggled event if toggle is prevented', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      const toggledSpy = jasmine.createSpy()
+
+      togglerEl.addEventListener('toggle.bs.toggler', event => {
+        event.preventDefault()
+      })
+      togglerEl.addEventListener('toggled.bs.toggler', toggledSpy)
+
+      toggler.toggle()
+
+      expect(toggledSpy).not.toHaveBeenCalled()
+    })
+  })
+
+  describe('dispose', () => {
+    it('should dispose a toggler', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      expect(Toggler.getInstance(togglerEl)).not.toBeNull()
+
+      toggler.dispose()
+
+      expect(Toggler.getInstance(togglerEl)).toBeNull()
+    })
+  })
+
+  describe('getInstance', () => {
+    it('should return null if there is no instance', () => {
+      expect(Toggler.getInstance(fixtureEl)).toBeNull()
+    })
+
+    it('should return this instance', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      expect(Toggler.getInstance(togglerEl)).toEqual(toggler)
+      expect(Toggler.getInstance(togglerEl)).toBeInstanceOf(Toggler)
+    })
+  })
+
+  describe('getOrCreateInstance', () => {
+    it('should return toggler instance', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+      const toggler = new Toggler(togglerEl)
+
+      expect(Toggler.getOrCreateInstance(togglerEl)).toEqual(toggler)
+      expect(Toggler.getInstance(togglerEl)).toEqual(Toggler.getOrCreateInstance(togglerEl, {}))
+      expect(Toggler.getOrCreateInstance(togglerEl)).toBeInstanceOf(Toggler)
+    })
+
+    it('should return new instance when there is no toggler instance', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+
+      expect(Toggler.getInstance(togglerEl)).toBeNull()
+      expect(Toggler.getOrCreateInstance(togglerEl)).toBeInstanceOf(Toggler)
+    })
+  })
+
+  describe('data-api', () => {
+    it('should toggle class on click', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="bg-warning" data-bs-attribute="class"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+
+      togglerEl.click()
+      expect(togglerEl.classList.contains('bg-warning')).toBeTrue()
+
+      togglerEl.click()
+      expect(togglerEl.classList.contains('bg-warning')).toBeFalse()
+    })
+
+    it('should toggle attribute on click', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="true" data-bs-attribute="hidden"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+
+      togglerEl.click()
+      expect(togglerEl.getAttribute('hidden')).toEqual('true')
+
+      togglerEl.click()
+      expect(togglerEl.hasAttribute('hidden')).toBeFalse()
+    })
+
+    it('should not toggle id attribute on click', () => {
+      fixtureEl.innerHTML = '<div data-bs-toggle="toggler" data-bs-value="new-id" data-bs-attribute="id"></div>'
+
+      const togglerEl = fixtureEl.querySelector('[data-bs-toggle="toggler"]')
+
+      togglerEl.click()
+      expect(togglerEl.getAttribute('id')).toBeNull()
+    })
+  })
+})