tiny-essentials 1.16.1 → 1.16.2

package/dist/v1/TinyAfterScrollWatcher.js

@@ -49,8 +49,8 @@ class TinyAfterScrollWatcher {
   /** @type {Element|Window} */
   #scrollTarget;
 
-  /** @type {number} */
-  lastScrollTime = 0;
+  /** @type {null|NodeJS.Timeout} */
+  #lastScrollTime = null;
 
   /** @type {FnData[]} */
   #afterScrollQueue = [];
@@ -61,6 +61,9 @@ class TinyAfterScrollWatcher {
   /** @type {Set<OnScrollFunc>} */
   #externalScrollListeners = new Set();
 
+  /** @type {Set<FnData>} */
+  #onStopListeners = new Set();
+
   /** @type {boolean} */
   #destroyed = false;
 
@@ -74,16 +77,20 @@ class TinyAfterScrollWatcher {
     if (!(scrollTarget instanceof Element) && !(scrollTarget instanceof Window))
       throw new TypeError('scrollTarget must be an Element or the Window object.');
     this.#scrollTarget = scrollTarget;
+    this._checkTimer = this._checkTimer.bind(this);
 
-    this._onScroll = this._onScroll.bind(this);
-    this._checkQueue = this._checkQueue.bind(this);
-
-    this.#scrollTarget.addEventListener('scroll', this._onScroll);
+    this.#scrollTarget.addEventListener('scroll', this._checkTimer);
     this.#inactivityTime = inactivityTime;
-
-    requestAnimationFrame(this._checkQueue);
   }
 
+  _checkTimer = () => {
+    if (this.#lastScrollTime) clearTimeout(this.#lastScrollTime);
+    this.#lastScrollTime = setTimeout(() => {
+      this.#lastScrollTime = null;
+      this.#checkQueue();
+    }, this.#inactivityTime);
+  };
+
   /**
    * Gets the current inactivity time in milliseconds.
    * @returns {number}
@@ -104,29 +111,21 @@ class TinyAfterScrollWatcher {
     this.#inactivityTime = value;
   }
 
-  /**
-   * Internal handler for scroll events.
-   * Updates the last scroll timestamp.
-   * @private
-   */
-  _onScroll() {
-    this.lastScrollTime = Date.now();
-  }
-
   /**
    * Continuously checks whether the user has stopped scrolling,
    * and if so, runs all queued functions.
-   * @private
    */
-  _checkQueue() {
+  #checkQueue() {
     if (this.#destroyed) return;
-    requestAnimationFrame(this._checkQueue);
+    // Runs all onStop first listeners
+    for (const fn of this.#onStopListeners) {
+      if (typeof fn === 'function') fn();
+    }
 
-    if (Date.now() - this.lastScrollTime > this.#inactivityTime) {
-      while (this.#afterScrollQueue.length) {
-        const fn = this.#afterScrollQueue.pop();
-        if (typeof fn === 'function') fn();
-      }
+    // Then execute the queue afterScrollQueue
+    while (this.#afterScrollQueue.length) {
+      const fn = this.#afterScrollQueue.pop();
+      if (typeof fn === 'function') fn();
     }
   }
 
@@ -143,6 +142,29 @@ class TinyAfterScrollWatcher {
     this.#afterScrollQueue.push(fn);
   }
 
+  /**
+   * Registers a function to run once after scrolling has stopped,
+   * before any afterScrollQueue functions.
+   *
+   * @param {FnData} fn - A function to execute after scroll stop.
+   * @throws {TypeError} If the argument is not a function.
+   */
+  onStop(fn) {
+    if (typeof fn !== 'function') throw new TypeError('Argument must be a function.');
+    this.#onStopListeners.add(fn);
+  }
+
+  /**
+   * Removes a previously registered onStop function.
+   *
+   * @param {FnData} fn - The function to remove.
+   * @throws {TypeError} If the argument is not a function.
+   */
+  offStop(fn) {
+    if (typeof fn !== 'function') throw new TypeError('Argument must be a function.');
+    this.#onStopListeners.delete(fn);
+  }
+
   /**
    * Registers an external scroll listener on the tracked element.
    *
@@ -176,11 +198,12 @@ class TinyAfterScrollWatcher {
     if (this.#destroyed) return;
     this.#destroyed = true;
 
-    this.#scrollTarget.removeEventListener('scroll', this._onScroll);
+    this.#scrollTarget.removeEventListener('scroll', this._checkTimer);
     for (const fn of this.#externalScrollListeners)
       this.#scrollTarget.removeEventListener('scroll', fn);
 
     this.#externalScrollListeners.clear();
+    this.#onStopListeners.clear();
   }
 }
 

package/dist/v1/TinyAfterScrollWatcher.min.js

@@ -1 +1 @@
-(()=>{"use strict";var e={d:(t,r)=>{for(var i in r)e.o(r,i)&&!e.o(t,i)&&Object.defineProperty(t,i,{enumerable:!0,get:r[i]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t)},t={};e.d(t,{TinyAfterScrollWatcher:()=>r});const r=class{#e;lastScrollTime=0;#t=[];#r=100;#i=new Set;#o=!1;constructor(e=window,t=100){if(!(e instanceof Element||e instanceof Window))throw new TypeError("scrollTarget must be an Element or the Window object.");this.#e=e,this._onScroll=this._onScroll.bind(this),this._checkQueue=this._checkQueue.bind(this),this.#e.addEventListener("scroll",this._onScroll),this.#r=t,requestAnimationFrame(this._checkQueue)}get inactivityTime(){return this.#r}set inactivityTime(e){if("number"!=typeof e||e<=0||!Number.isFinite(e))throw new Error("inactivityTime must be a positive number in milliseconds.");this.#r=e}_onScroll(){this.lastScrollTime=Date.now()}_checkQueue(){if(!this.#o&&(requestAnimationFrame(this._checkQueue),Date.now()-this.lastScrollTime>this.#r))for(;this.#t.length;){const e=this.#t.pop();"function"==typeof e&&e()}}doAfterScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.lastScrollTime=Date.now(),this.#t.push(e)}onScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#e.addEventListener("scroll",e),this.#i.add(e)}offScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#i.has(e)&&(this.#e.removeEventListener("scroll",e),this.#i.delete(e))}destroy(){if(!this.#o){this.#o=!0,this.#e.removeEventListener("scroll",this._onScroll);for(const e of this.#i)this.#e.removeEventListener("scroll",e);this.#i.clear()}}};window.TinyAfterScrollWatcher=t.TinyAfterScrollWatcher})();
+(()=>{"use strict";var e={d:(t,r)=>{for(var i in r)e.o(r,i)&&!e.o(t,i)&&Object.defineProperty(t,i,{enumerable:!0,get:r[i]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t)},t={};e.d(t,{TinyAfterScrollWatcher:()=>r});const r=class{#e;#t=null;#r=[];#i=100;#o=new Set;#n=new Set;#s=!1;constructor(e=window,t=100){if(!(e instanceof Element||e instanceof Window))throw new TypeError("scrollTarget must be an Element or the Window object.");this.#e=e,this._checkTimer=this._checkTimer.bind(this),this.#e.addEventListener("scroll",this._checkTimer),this.#i=t}_checkTimer=()=>{this.#t&&clearTimeout(this.#t),this.#t=setTimeout((()=>{this.#t=null,this.#l()}),this.#i)};get inactivityTime(){return this.#i}set inactivityTime(e){if("number"!=typeof e||e<=0||!Number.isFinite(e))throw new Error("inactivityTime must be a positive number in milliseconds.");this.#i=e}#l(){if(!this.#s){for(const e of this.#n)"function"==typeof e&&e();for(;this.#r.length;){const e=this.#r.pop();"function"==typeof e&&e()}}}doAfterScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.lastScrollTime=Date.now(),this.#r.push(e)}onStop(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#n.add(e)}offStop(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#n.delete(e)}onScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#e.addEventListener("scroll",e),this.#o.add(e)}offScroll(e){if("function"!=typeof e)throw new TypeError("Argument must be a function.");this.#o.has(e)&&(this.#e.removeEventListener("scroll",e),this.#o.delete(e))}destroy(){if(!this.#s){this.#s=!0,this.#e.removeEventListener("scroll",this._checkTimer);for(const e of this.#o)this.#e.removeEventListener("scroll",e);this.#o.clear(),this.#n.clear()}}};window.TinyAfterScrollWatcher=t.TinyAfterScrollWatcher})();

package/dist/v1/TinyEssentials.js

@@ -13791,8 +13791,8 @@ class TinyAfterScrollWatcher {
   /** @type {Element|Window} */
   #scrollTarget;
 
-  /** @type {number} */
-  lastScrollTime = 0;
+  /** @type {null|NodeJS.Timeout} */
+  #lastScrollTime = null;
 
   /** @type {FnData[]} */
   #afterScrollQueue = [];
@@ -13803,6 +13803,9 @@ class TinyAfterScrollWatcher {
   /** @type {Set<OnScrollFunc>} */
   #externalScrollListeners = new Set();
 
+  /** @type {Set<FnData>} */
+  #onStopListeners = new Set();
+
   /** @type {boolean} */
   #destroyed = false;
 
@@ -13816,16 +13819,20 @@ class TinyAfterScrollWatcher {
     if (!(scrollTarget instanceof Element) && !(scrollTarget instanceof Window))
       throw new TypeError('scrollTarget must be an Element or the Window object.');
     this.#scrollTarget = scrollTarget;
+    this._checkTimer = this._checkTimer.bind(this);
 
-    this._onScroll = this._onScroll.bind(this);
-    this._checkQueue = this._checkQueue.bind(this);
-
-    this.#scrollTarget.addEventListener('scroll', this._onScroll);
+    this.#scrollTarget.addEventListener('scroll', this._checkTimer);
     this.#inactivityTime = inactivityTime;
-
-    requestAnimationFrame(this._checkQueue);
   }
 
+  _checkTimer = () => {
+    if (this.#lastScrollTime) clearTimeout(this.#lastScrollTime);
+    this.#lastScrollTime = setTimeout(() => {
+      this.#lastScrollTime = null;
+      this.#checkQueue();
+    }, this.#inactivityTime);
+  };
+
   /**
    * Gets the current inactivity time in milliseconds.
    * @returns {number}
@@ -13846,29 +13853,21 @@ class TinyAfterScrollWatcher {
     this.#inactivityTime = value;
   }
 
-  /**
-   * Internal handler for scroll events.
-   * Updates the last scroll timestamp.
-   * @private
-   */
-  _onScroll() {
-    this.lastScrollTime = Date.now();
-  }
-
   /**
    * Continuously checks whether the user has stopped scrolling,
    * and if so, runs all queued functions.
-   * @private
    */
-  _checkQueue() {
+  #checkQueue() {
     if (this.#destroyed) return;
-    requestAnimationFrame(this._checkQueue);
+    // Runs all onStop first listeners
+    for (const fn of this.#onStopListeners) {
+      if (typeof fn === 'function') fn();
+    }
 
-    if (Date.now() - this.lastScrollTime > this.#inactivityTime) {
-      while (this.#afterScrollQueue.length) {
-        const fn = this.#afterScrollQueue.pop();
-        if (typeof fn === 'function') fn();
-      }
+    // Then execute the queue afterScrollQueue
+    while (this.#afterScrollQueue.length) {
+      const fn = this.#afterScrollQueue.pop();
+      if (typeof fn === 'function') fn();
     }
   }
 
@@ -13885,6 +13884,29 @@ class TinyAfterScrollWatcher {
     this.#afterScrollQueue.push(fn);
   }
 
+  /**
+   * Registers a function to run once after scrolling has stopped,
+   * before any afterScrollQueue functions.
+   *
+   * @param {FnData} fn - A function to execute after scroll stop.
+   * @throws {TypeError} If the argument is not a function.
+   */
+  onStop(fn) {
+    if (typeof fn !== 'function') throw new TypeError('Argument must be a function.');
+    this.#onStopListeners.add(fn);
+  }
+
+  /**
+   * Removes a previously registered onStop function.
+   *
+   * @param {FnData} fn - The function to remove.
+   * @throws {TypeError} If the argument is not a function.
+   */
+  offStop(fn) {
+    if (typeof fn !== 'function') throw new TypeError('Argument must be a function.');
+    this.#onStopListeners.delete(fn);
+  }
+
   /**
    * Registers an external scroll listener on the tracked element.
    *
@@ -13918,11 +13940,12 @@ class TinyAfterScrollWatcher {
     if (this.#destroyed) return;
     this.#destroyed = true;
 
-    this.#scrollTarget.removeEventListener('scroll', this._onScroll);
+    this.#scrollTarget.removeEventListener('scroll', this._checkTimer);
     for (const fn of this.#externalScrollListeners)
       this.#scrollTarget.removeEventListener('scroll', fn);
 
     this.#externalScrollListeners.clear();
+    this.#onStopListeners.clear();
   }
 }