handy-scroll 2.0.1 → 2.0.3

package/README.md

@@ -29,6 +29,12 @@ If you don’t use bundlers, just import the component as a module in your HTML
 <script type="module" src="https://esm.run/handy-scroll"></script>
 ```
 
+or in your ES modules:
+
+```javascript
+import "https://esm.run/handy-scroll";
+```
+
 ## Standard usage
 
 Drop the custom element `<handy-scroll>` where you need in your markup and link the component to the horizontally-scrollable target using the `owner` attribute:

package/dist/handy-scroll.mjs

@@ -1,19 +1,19 @@
 /*!
-handy-scroll v2.0.0
+handy-scroll v2.0.3
 https://amphiluke.github.io/handy-scroll/
 (c) 2024 Amphiluke
 */
-const o = ':host{bottom:0;min-height:17px;overflow:auto;position:fixed}.strut{height:1px;overflow:hidden;pointer-events:none;&:before{content:" "}}:host,.strut{font-size:1px;line-height:0;margin:0;padding:0}:host(:state(latent)){bottom:110vh;.strut:before{content:"  "}}:host([viewport]){display:block;position:sticky}:host([viewport]:state(latent)){position:fixed}';
-let h = (n) => `Attribute ‘${n}’ must reference a valid container ‘id’`;
-class r extends HTMLElement {
+const h = ':host{bottom:0;min-height:17px;overflow:auto;position:fixed}.strut{height:1px;overflow:hidden;pointer-events:none;&:before{content:" "}}:host,.strut{font-size:1px;line-height:0;margin:0;padding:0}:host(:state(latent)){bottom:110vh;.strut:before{content:"  "}}:host([viewport]:not([hidden])){display:block}:host([viewport]){position:sticky}:host([viewport]:state(latent)){position:fixed}';
+let n = (s) => `Attribute ‘${s}’ must reference a valid container ‘id’`;
+class o extends HTMLElement {
   static get observedAttributes() {
-    return ["owner", "viewport"];
+    return ["owner", "viewport", "hidden"];
   }
   #o = null;
   #t = null;
   #e = null;
   #s = null;
-  #i = /* @__PURE__ */ new Map();
+  #i = null;
   #n = null;
   #r = !0;
   #l = !0;
@@ -38,21 +38,27 @@ class r extends HTMLElement {
   constructor() {
     super();
     let t = this.attachShadow({ mode: "open" }), e = document.createElement("style");
-    e.textContent = o, t.appendChild(e), this.#s = document.createElement("div"), this.#s.classList.add("strut"), t.appendChild(this.#s), this.#o = this.attachInternals();
+    e.textContent = h, t.appendChild(e), this.#s = document.createElement("div"), this.#s.classList.add("strut"), t.appendChild(this.#s), this.#o = this.attachInternals();
   }
   connectedCallback() {
-    this.#a(), this.#c(), this.#u(), this.#f(), this.update();
+    this.#a(), this.#c(), this.#u(), this.#p(), this.update();
   }
   disconnectedCallback() {
-    this.#w(), this.#p(), this.#e = this.#t = null;
+    this.#w(), this.#f(), this.#e = this.#t = null;
   }
   attributeChangedCallback(t) {
-    this.#i.size && (t === "owner" ? this.#a() : t === "viewport" && this.#c(), this.#w(), this.#p(), this.#u(), this.#f(), this.update());
+    if (this.#i) {
+      if (t === "hidden") {
+        this.hasAttribute("hidden") || this.update();
+        return;
+      }
+      t === "owner" ? this.#a() : t === "viewport" && this.#c(), this.#w(), this.#f(), this.#u(), this.#p(), this.update();
+    }
   }
   #a() {
     let t = this.getAttribute("owner");
     if (this.#e = document.getElementById(t), !this.#e)
-      throw new DOMException(h("owner"));
+      throw new DOMException(n("owner"));
   }
   #c() {
     if (!this.hasAttribute("viewport")) {
@@ -61,40 +67,30 @@ class r extends HTMLElement {
     }
     let t = this.getAttribute("viewport");
     if (this.#t = document.getElementById(t), !this.#t)
-      throw new DOMException(h("viewport"));
+      throw new DOMException(n("viewport"));
   }
   #u() {
-    this.#i.set(this.#t, {
-      scroll: () => this.#v(),
-      ...this.#t === window ? { resize: () => this.update() } : {}
-    }), this.#i.set(this, {
-      scroll: () => {
-        this.#r && !this.#h && this.#b(), this.#r = !0;
-      }
-    }), this.#i.set(this.#e, {
-      scroll: () => {
-        this.#l && this.#d(), this.#l = !0;
-      },
-      focusin: () => {
-        setTimeout(() => {
-          this.isConnected && this.#d();
-        }, 0);
-      }
-    }), this.#i.forEach((t, e) => {
-      Object.entries(t).forEach(([i, s]) => e.addEventListener(i, s, !1));
-    });
+    this.#i = new AbortController();
+    let t = { signal: this.#i.signal };
+    this.#t.addEventListener("scroll", () => this.#v(), t), this.#t === window && this.#t.addEventListener("resize", () => this.update(), t), this.addEventListener("scroll", () => {
+      this.#r && !this.#h && this.#b(), this.#r = !0;
+    }, t), this.#e.addEventListener("scroll", () => {
+      this.#l && this.#d(), this.#l = !0;
+    }, t), this.#e.addEventListener("focusin", () => {
+      setTimeout(() => {
+        this.isConnected && this.#d();
+      }, 0);
+    }, t);
   }
   #w() {
-    this.#i.forEach((t, e) => {
-      Object.entries(t).forEach(([i, s]) => e.removeEventListener(i, s, !1));
-    }), this.#i.clear();
+    this.#i?.abort(), this.#i = null;
   }
-  #f() {
+  #p() {
     this.#t !== window && (this.#n = new ResizeObserver(([t]) => {
       t.contentBoxSize?.[0]?.inlineSize && this.update();
     }), this.#n.observe(this.#t));
   }
-  #p() {
+  #f() {
     this.#n?.disconnect(), this.#n = null;
   }
   #b() {
@@ -118,7 +114,7 @@ class r extends HTMLElement {
     i.width = `${t}px`, this.#t === window && (i.left = `${this.#e.getBoundingClientRect().left}px`), this.#s.style.width = `${e}px`, e > t && (i.height = `${this.offsetHeight - this.clientHeight + 1}px`), this.#d(), this.#v();
   }
 }
-customElements.define("handy-scroll", r);
+customElements.define("handy-scroll", o);
 export {
-  r as default
+  o as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "handy-scroll",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "Handy dependency-free floating scrollbar web component",
   "exports": {
     ".": {
@@ -36,10 +36,10 @@
   },
   "homepage": "https://amphiluke.github.io/handy-scroll/",
   "devDependencies": {
-    "@eslint/js": "^9.9.1",
-    "@stylistic/eslint-plugin-js": "^2.7.2",
-    "eslint": "^9.9.1",
-    "globals": "^15.9.0",
-    "vite": "^5.4.2"
+    "@eslint/js": "^9.12.0",
+    "@stylistic/eslint-plugin-js": "^2.9.0",
+    "eslint": "^9.12.0",
+    "globals": "^15.10.0",
+    "vite": "^5.4.8"
   }
 }

package/src/handy-scroll.css

@@ -31,8 +31,11 @@
   }
 }
 
-:host([viewport]) {
+:host([viewport]:not([hidden])) {
   display: block;
+}
+
+:host([viewport]) {
   position: sticky;
 }
 

package/src/handy-scroll.mjs

@@ -4,7 +4,7 @@ let getAttributeErrorMessage = (attribute) => `Attribute ‘${attribute}’ must
 
 class HandyScroll extends HTMLElement {
   static get observedAttributes() {
-    return ["owner", "viewport"];
+    return ["owner", "viewport", "hidden"];
   }
 
   #internals = null;
@@ -13,7 +13,7 @@ class HandyScroll extends HTMLElement {
   #owner = null;
   #strut = null;
 
-  #eventHandlers = new Map();
+  #eventController = null;
   #resizeObserver = null;
 
   #syncingOwner = true;
@@ -70,7 +70,13 @@ class HandyScroll extends HTMLElement {
   }
 
   attributeChangedCallback(name) {
-    if (!this.#eventHandlers.size) { // handle only dynamic changes when the element is completely connected
+    if (!this.#eventController) { // handle only dynamic changes when the element is completely connected
+      return;
+    }
+    if (name === "hidden") {
+      if (!this.hasAttribute("hidden")) {
+        this.update();
+      }
       return;
     }
     if (name === "owner") {
@@ -106,48 +112,44 @@ class HandyScroll extends HTMLElement {
   }
 
   #addEventHandlers() {
-    this.#eventHandlers.set(this.#viewport, {
-      scroll: () => this.#recheckLatency(),
-      ...(this.#viewport === window ? {resize: () => this.update()} : {}),
-    });
-    this.#eventHandlers.set(this, {
-      scroll: () => {
-        if (this.#syncingOwner && !this.#isLatent) {
-          this.#syncOwner();
-        }
-        // Resume component->owner syncing after the component scrolling has finished
-        // (it might be temporally disabled by the owner while syncing the component)
-        this.#syncingOwner = true;
-      },
-    });
-    this.#eventHandlers.set(this.#owner, {
-      scroll: () => {
-        if (this.#syncingComponent) {
+    this.#eventController = new AbortController();
+    let options = {signal: this.#eventController.signal};
+
+    this.#viewport.addEventListener("scroll", () => this.#recheckLatency(), options);
+    if (this.#viewport === window) {
+      this.#viewport.addEventListener("resize", () => this.update(), options);
+    }
+
+    this.addEventListener("scroll", () => {
+      if (this.#syncingOwner && !this.#isLatent) {
+        this.#syncOwner();
+      }
+      // Resume component->owner syncing after the component scrolling has finished
+      // (it might be temporally disabled by the owner while syncing the component)
+      this.#syncingOwner = true;
+    }, options);
+
+    this.#owner.addEventListener("scroll", () => {
+      if (this.#syncingComponent) {
+        this.#syncComponent();
+      }
+      // Resume owner->component syncing after the owner scrolling has finished
+      // (it might be temporally disabled by the component while syncing the owner)
+      this.#syncingComponent = true;
+    }, options);
+    this.#owner.addEventListener("focusin", () => {
+      setTimeout(() => {
+        // The widget might be destroyed before the timer is triggered (issue #14)
+        if (this.isConnected) {
           this.#syncComponent();
         }
-        // Resume owner->component syncing after the owner scrolling has finished
-        // (it might be temporally disabled by the component while syncing the owner)
-        this.#syncingComponent = true;
-      },
-      focusin: () => {
-        setTimeout(() => {
-          // The widget might be destroyed before the timer is triggered (issue #14)
-          if (this.isConnected) {
-            this.#syncComponent();
-          }
-        }, 0);
-      },
-    });
-    this.#eventHandlers.forEach((handlers, el) => {
-      Object.entries(handlers).forEach(([event, handler]) => el.addEventListener(event, handler, false));
-    });
+      }, 0);
+    }, options);
   }
 
   #removeEventHandlers() {
-    this.#eventHandlers.forEach((handlers, el) => {
-      Object.entries(handlers).forEach(([event, handler]) => el.removeEventListener(event, handler, false));
-    });
-    this.#eventHandlers.clear();
+    this.#eventController?.abort();
+    this.#eventController = null;
   }
 
   #addResizeObserver() {