vevet 3.19.2 → 4.0.0-beta.0

package/lib/cjs/components/ScrollView/index.js

@@ -33,7 +33,9 @@ var math_1 = require("../../utils/math");
 var common_1 = require("../../utils/common");
 var getApp_1 = require("../../utils/internal/getApp");
 /**
- * Detect when elements enter or leave the viewport
+ * `ScrollView` detects when elements enter or leave the viewport.
+ * It uses the `IntersectionObserver` API for efficient detection and triggers events when elements are visible or hidden.
+ * Supports adding custom delay and class toggling when elements are in view.
  */
 var ScrollView = /** @class */ (function (_super) {
     __extends(ScrollView, _super);
@@ -43,7 +45,7 @@ var ScrollView = /** @class */ (function (_super) {
         _this._isFirstStart = true;
         _this._elements = [];
         _this._isIntersectionObserverSupported = (0, listeners_1.isIntersectionObserverSupported)();
-        // initialize the class
+        // initialize the class if requested
         if (canInit) {
             _this.init();
         }
@@ -53,7 +55,9 @@ var ScrollView = /** @class */ (function (_super) {
         return __assign(__assign({}, _super.prototype._getDefaultProps.call(this)), { intersectionRoot: null, isEnabled: true, rootMargin: 0.05, states: 'in', classToToggle: 'viewed', hasDelay: true, maxDelay: 1000, direction: 'vertical', viewportTarget: 'any', resizeDebounce: 0 });
     };
     Object.defineProperty(ScrollView.prototype, "isFirstStart", {
-        /** If first start */
+        /**
+         * Returns whether this is the first start of observing elements.
+         */
         get: function () {
             return this._isFirstStart;
         },
@@ -61,7 +65,9 @@ var ScrollView = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(ScrollView.prototype, "elements", {
-        /** Elements */
+        /**
+         * Returns the elements being observed by the `ScrollView`.
+         */
         get: function () {
             return this._elements;
         },
@@ -76,16 +82,21 @@ var ScrollView = /** @class */ (function (_super) {
         _super.prototype._onPropsMutate.call(this);
         this.resize();
     };
-    /** Set class events */
+    /**
+     * Sets up the events needed for viewport resizing and element observation.
+     */
     ScrollView.prototype._setEvents = function () {
         var _this = this;
         var _a = this.props, viewportTarget = _a.viewportTarget, resizeDebounce = _a.resizeDebounce;
         this.resize();
+        // Set up a viewport callback to trigger the resize method
         this.addViewportCallback(viewportTarget, function () { return _this.resize(); }, {
             timeout: resizeDebounce,
         });
     };
-    /** Resize the scene */
+    /**
+     * Triggers a resize event to update the `ScrollView` tracking of elements.
+     */
     ScrollView.prototype.resize = function () {
         this._removeViewEvents();
         if (this.props.isEnabled) {
@@ -93,7 +104,9 @@ var ScrollView = /** @class */ (function (_super) {
         }
     };
     Object.defineProperty(ScrollView.prototype, "rootBounding", {
-        /** Root bounding rect */
+        /**
+         * Returns the bounding rectangle for the root element or the viewport.
+         */
         get: function () {
             var props = this.props;
             if (props.intersectionRoot) {
@@ -116,13 +129,16 @@ var ScrollView = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
-    /** Set view events */
+    /**
+     * Sets up the `IntersectionObserver` to detect when elements come into view.
+     */
     ScrollView.prototype._setViewEvents = function () {
         var _this = this;
         if (!this._isIntersectionObserverSupported) {
             return;
         }
         var _a = this, rootBounding = _a.rootBounding, isFirstStart = _a.isFirstStart, props = _a.props;
+        // Calculate margins for intersection detection
         var xMargin = isFirstStart
             ? 0
             : rootBounding.width * props.rootMargin * -1;
@@ -144,7 +160,9 @@ var ScrollView = /** @class */ (function (_super) {
             this.elements.forEach(function (element) { var _a; return (_a = _this._intersectionObserverOut) === null || _a === void 0 ? void 0 : _a.observe(element); });
         }
     };
-    /** Remove View events */
+    /**
+     * Removes the view observation events by disconnecting the `IntersectionObserver`.
+     */
     ScrollView.prototype._removeViewEvents = function () {
         var _a, _b;
         (_a = this._intersectionObserverIn) === null || _a === void 0 ? void 0 : _a.disconnect();
@@ -152,7 +170,11 @@ var ScrollView = /** @class */ (function (_super) {
         (_b = this._intersectionObserverOut) === null || _b === void 0 ? void 0 : _b.disconnect();
         this._intersectionObserverOut = undefined;
     };
-    /** Event on IntersectionObserver In */
+    /**
+     * Handles when elements come into the viewport.
+     *
+     * @param data - The intersection data for the observed elements.
+     */
     ScrollView.prototype._handleIntersectionIn = function (data) {
         var _this = this;
         data.forEach(function (entry) {
@@ -166,7 +188,7 @@ var ScrollView = /** @class */ (function (_super) {
                 _this.removeElement(element);
             }
         });
-        // change states
+        // Mark first start complete and trigger resize
         if (this.isFirstStart) {
             this._isFirstStart = false;
             this.resize();
@@ -185,7 +207,11 @@ var ScrollView = /** @class */ (function (_super) {
             : (bounding.top - rootBounding.top) / rootBounding.height, [0, 1]);
         return progress * props.maxDelay;
     };
-    /** Event on IntersectionObserver Out */
+    /**
+     * Handles when elements leave the viewport.
+     *
+     * @param data - The intersection data for the observed elements.
+     */
     ScrollView.prototype._handleIntersectionOut = function (data) {
         var _this = this;
         data.forEach(function (entry) {
@@ -197,7 +223,7 @@ var ScrollView = /** @class */ (function (_super) {
         });
     };
     /**
-     * Event that is triggered when an element appears or disappears
+     * Toggles classes and triggers callbacks when elements enter or leave the viewport.
      */
     ScrollView.prototype._handleInOut = function (elementProp, isInViewport, delay) {
         var _this = this;
@@ -208,15 +234,15 @@ var ScrollView = /** @class */ (function (_super) {
             (!element.isScrollViewIn && !isInViewport)) {
             return;
         }
-        // update props
+        // Update element's viewport state
         element.isScrollViewIn = isInViewport;
-        // toggle classes
+        // Toggle class for the element
         if (classToToggle) {
             (0, common_1.normalizedTimeoutCallback)(function () {
                 element.classList.toggle(classToToggle, isInViewport);
             }, delay);
         }
-        // process callbacks
+        // Trigger appropriate callback
         if (isInViewport) {
             (0, common_1.normalizedTimeoutCallback)(function () {
                 _this.callbacks.tbt('in', { element: element });
@@ -228,7 +254,9 @@ var ScrollView = /** @class */ (function (_super) {
             }, delay);
         }
     };
-    /** Add an element */
+    /**
+     * Adds an element to the observer list and starts tracking its visibility in the viewport.
+     */
     ScrollView.prototype.addElement = function (elementProp) {
         var _this = this;
         var _a, _b;
@@ -246,7 +274,11 @@ var ScrollView = /** @class */ (function (_super) {
             remove: function () { return _this.removeElement(element); },
         };
     };
-    /** Remove an element */
+    /**
+     * Stops observing an element and removes it from the observer list.
+     *
+     * @param {Element} elementProp - The element to stop observing.
+     */
     ScrollView.prototype.removeElement = function (elementProp) {
         var _a, _b;
         var element = elementProp;
@@ -255,13 +287,17 @@ var ScrollView = /** @class */ (function (_super) {
         element.isScrollViewIn = undefined;
         this._elements = this._elements.filter(function (el) { return el !== element; });
     };
-    /** Remove all elements */
+    /**
+     * Stops observing all elements and clears the observer list.
+     */
     ScrollView.prototype.removeElements = function () {
         var _this = this;
         this._elements.forEach(function (element) { return _this.removeElement(element); });
         this._elements = [];
     };
-    /** Destroy the module */
+    /**
+     * Destroys the `ScrollView` and disconnects all observers and listeners.
+     */
     ScrollView.prototype._destroy = function () {
         _super.prototype._destroy.call(this);
         this._removeViewEvents();

package/lib/cjs/components/ScrollView/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/ScrollView/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAA+D;AAE/D,+CAAoE;AACpE,qCAAqC;AACrC,yCAA2D;AAE3D,kDAAiD;AAIjD;;GAEG;AACH;IAMU,8BAA4D;IA0CpE,oBAAY,YAA4C,EAAE,OAAc;QAAd,wBAAA,EAAA,cAAc;QAAxE,YACE,kBAAM,YAAY,EAAE,KAAK,CAAC,SAU3B;QARC,KAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,KAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,KAAI,CAAC,gCAAgC,GAAG,IAAA,2CAA+B,GAAE,CAAC;QAE1E,uBAAuB;QACvB,IAAI,OAAO,EAAE;YACX,KAAI,CAAC,IAAI,EAAE,CAAC;SACb;;IACH,CAAC;IApDS,qCAAgB,GAA1B;QACE,6BACK,iBAAM,gBAAgB,WAAE,KAC3B,gBAAgB,EAAE,IAAI,EACtB,SAAS,EAAE,IAAI,EACf,UAAU,EAAE,IAAI,EAChB,MAAM,EAAE,IAAI,EACZ,aAAa,EAAE,QAAQ,EACvB,QAAQ,EAAE,IAAI,EACd,QAAQ,EAAE,IAAI,EACd,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,KAAK,EACrB,cAAc,EAAE,CAAC,IACjB;IACJ,CAAC;IAYD,sBAAI,oCAAY;QADhB,qBAAqB;aACrB;YACE,OAAO,IAAI,CAAC,aAAa,CAAC;QAC5B,CAAC;;;OAAA;IASD,sBAAI,gCAAQ;QADZ,eAAe;aACf;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IAeS,0BAAK,GAAf;QACE,iBAAM,KAAK,WAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAES,mCAAc,GAAxB;QACE,iBAAM,cAAc,WAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,uBAAuB;IACb,+BAAU,GAApB;QAAA,iBAQC;QAPO,IAAA,KAAqC,IAAI,CAAC,KAAK,EAA7C,cAAc,oBAAA,EAAE,cAAc,oBAAe,CAAC;QAEtD,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,cAAM,OAAA,KAAI,CAAC,MAAM,EAAE,EAAb,CAAa,EAAE;YAC5D,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IAChB,2BAAM,GAAb;QACE,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACxB,IAAI,CAAC,cAAc,EAAE,CAAC;SACvB;IACH,CAAC;IAGD,sBAAc,oCAAY;QAD1B,yBAAyB;aACzB;YACU,IAAA,KAAK,GAAK,IAAI,MAAT,CAAU;YAEvB,IAAI,KAAK,CAAC,gBAAgB,EAAE;gBAC1B,IAAM,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC;gBAEhE,OAAO;oBACL,GAAG,EAAE,QAAQ,CAAC,GAAG;oBACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;iBACxB,CAAC;aACH;YAEO,IAAA,QAAQ,GAAK,IAAA,eAAM,GAAE,SAAb,CAAc;YAE9B,OAAO;gBACL,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB,CAAC;QACJ,CAAC;;;OAAA;IAED,sBAAsB;IACZ,mCAAc,GAAxB;QAAA,iBA0CC;QAzCC,IAAI,CAAC,IAAI,CAAC,gCAAgC,EAAE;YAC1C,OAAO;SACR;QAEK,IAAA,KAAwC,IAAI,EAA1C,YAAY,kBAAA,EAAE,YAAY,kBAAA,EAAE,KAAK,WAAS,CAAC;QAEnD,IAAM,OAAO,GAAG,YAAY;YAC1B,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE/C,IAAM,OAAO,GAAG,YAAY;YAC1B,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAEhD,IAAI,CAAC,uBAAuB,GAAG,IAAI,oBAAoB,CACrD,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAhC,CAAgC,EAC1C;YACE,IAAI,EAAE,KAAK,CAAC,gBAAgB;YAC5B,SAAS,EAAE,CAAC;YACZ,UAAU,EAAE,cAAO,OAAO,gBAAM,OAAO,WAAQ;SAChD,CACF,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO,YAC5B,OAAA,MAAA,KAAI,CAAC,uBAAuB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAA,EAAA,CAC/C,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,EAAE;YAC5B,IAAI,CAAC,wBAAwB,GAAG,IAAI,oBAAoB,CACtD,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAjC,CAAiC,EAC3C;gBACE,IAAI,EAAE,KAAK,CAAC,gBAAgB;gBAC5B,SAAS,EAAE,CAAC;gBACZ,UAAU,EAAE,iBAAiB;aAC9B,CACF,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO,YAC5B,OAAA,MAAA,KAAI,CAAC,wBAAwB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAA,EAAA,CAChD,CAAC;SACH;IACH,CAAC;IAED,yBAAyB;IACf,sCAAiB,GAA3B;;QACE,MAAA,IAAI,CAAC,uBAAuB,0CAAE,UAAU,EAAE,CAAC;QAC3C,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QAEzC,MAAA,IAAI,CAAC,wBAAwB,0CAAE,UAAU,EAAE,CAAC;QAC5C,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAC5C,CAAC;IAED,uCAAuC;IAC7B,0CAAqB,GAA/B,UAAgC,IAAiC;QAAjE,iBAqBC;QApBC,IAAI,CAAC,OAAO,CAAC,UAAC,KAAK;YACjB,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;gBACzB,OAAO;aACR;YAED,IAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;YAC7B,IAAM,KAAK,GAAG,KAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAE7C,KAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAExC,IAAI,KAAI,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;gBAC9B,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,gBAAgB;QAChB,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;IACH,CAAC;IAED,wBAAwB;IACd,qCAAgB,GAA1B,UAA2B,OAA6B;QAChD,IAAA,KAA0B,IAAI,EAA5B,YAAY,kBAAA,EAAE,KAAK,WAAS,CAAC;QACrC,IAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;QAE9D,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACrD,OAAO,CAAC,CAAC;SACV;QAED,IAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAEjD,IAAM,QAAQ,GAAG,IAAA,YAAK,EACpB,KAAK,CAAC,SAAS,KAAK,YAAY;YAC9B,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK;YAC1D,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAC3D,CAAC,CAAC,EAAE,CAAC,CAAC,CACP,CAAC;QAEF,OAAO,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED,wCAAwC;IAC9B,2CAAsB,GAAhC,UAAiC,IAAiC;QAAlE,iBASC;QARC,IAAI,CAAC,OAAO,CAAC,UAAC,KAAK;YACjB,IAAI,KAAK,CAAC,cAAc,EAAE;gBACxB,OAAO;aACR;YAED,IAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;YAC7B,KAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,iCAAY,GAAtB,UACE,WAAiC,EACjC,YAAqB,EACrB,KAAS;QAHX,iBAmCC;QAhCC,sBAAA,EAAA,SAAS;QAED,IAAA,aAAa,GAAK,IAAI,CAAC,KAAK,cAAf,CAAgB;QACrC,IAAM,OAAO,GAAG,WAAW,CAAC;QAE5B,IACE,CAAC,OAAO,CAAC,cAAc,IAAI,YAAY,CAAC;YACxC,CAAC,CAAC,OAAO,CAAC,cAAc,IAAI,CAAC,YAAY,CAAC,EAC1C;YACA,OAAO;SACR;QAED,eAAe;QACf,OAAO,CAAC,cAAc,GAAG,YAAY,CAAC;QAEtC,iBAAiB;QACjB,IAAI,aAAa,EAAE;YACjB,IAAA,kCAAyB,EAAC;gBACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;YACxD,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;QAED,oBAAoB;QACpB,IAAI,YAAY,EAAE;YAChB,IAAA,kCAAyB,EAAC;gBACxB,KAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;YACxC,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;aAAM;YACL,IAAA,kCAAyB,EAAC;gBACxB,KAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;YACzC,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;IACH,CAAC;IAED,qBAAqB;IACd,+BAAU,GAAjB,UAAkB,WAAoB;QAAtC,iBAiBC;;QAhBC,IAAM,OAAO,GAAG,WAAmC,CAAC;QAEpD,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,gCAAgC,EAAE;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE7B,MAAA,IAAI,CAAC,uBAAuB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAA,IAAI,CAAC,wBAAwB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAC;SACjD;aAAM;YACL,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAClC;QAED,OAAO;YACL,MAAM,EAAE,cAAM,OAAA,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAA3B,CAA2B;SAC1C,CAAC;IACJ,CAAC;IAED,wBAAwB;IACjB,kCAAa,GAApB,UAAqB,WAAoB;;QACvC,IAAM,OAAO,GAAG,WAAmC,CAAC;QAEpD,MAAA,IAAI,CAAC,uBAAuB,0CAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACjD,MAAA,IAAI,CAAC,wBAAwB,0CAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;QAEnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAC,EAAE,IAAK,OAAA,EAAE,KAAK,OAAO,EAAd,CAAc,CAAC,CAAC;IACjE,CAAC;IAED,0BAA0B;IACnB,mCAAc,GAArB;QAAA,iBAGC;QAFC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAA3B,CAA2B,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAED,yBAAyB;IACf,6BAAQ,GAAlB;QACE,iBAAM,QAAQ,WAAE,CAAC;QAEjB,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IACH,iBAAC;AAAD,CAAC,AAxTD,CAMU,qBAAc,GAkTvB;AAxTY,gCAAU"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/ScrollView/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAA+D;AAE/D,+CAAoE;AACpE,qCAAqC;AACrC,yCAA2D;AAE3D,kDAAiD;AAIjD;;;;GAIG;AACH;IAMU,8BAA4D;IAwDpE,oBAAY,YAA4C,EAAE,OAAc;QAAd,wBAAA,EAAA,cAAc;QAAxE,YACE,kBAAM,YAAY,EAAE,KAAK,CAAC,SAU3B;QARC,KAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,KAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QACpB,KAAI,CAAC,gCAAgC,GAAG,IAAA,2CAA+B,GAAE,CAAC;QAE1E,oCAAoC;QACpC,IAAI,OAAO,EAAE;YACX,KAAI,CAAC,IAAI,EAAE,CAAC;SACb;;IACH,CAAC;IAlES,qCAAgB,GAA1B;QACE,6BACK,iBAAM,gBAAgB,WAAE,KAC3B,gBAAgB,EAAE,IAAI,EACtB,SAAS,EAAE,IAAI,EACf,UAAU,EAAE,IAAI,EAChB,MAAM,EAAE,IAAI,EACZ,aAAa,EAAE,QAAQ,EACvB,QAAQ,EAAE,IAAI,EACd,QAAQ,EAAE,IAAI,EACd,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,KAAK,EACrB,cAAc,EAAE,CAAC,IACjB;IACJ,CAAC;IAoBD,sBAAI,oCAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAC;QAC5B,CAAC;;;OAAA;IAUD,sBAAI,gCAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IAoBS,0BAAK,GAAf;QACE,iBAAM,KAAK,WAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAES,mCAAc,GAAxB;QACE,iBAAM,cAAc,WAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACO,+BAAU,GAApB;QAAA,iBASC;QARO,IAAA,KAAqC,IAAI,CAAC,KAAK,EAA7C,cAAc,oBAAA,EAAE,cAAc,oBAAe,CAAC;QAEtD,IAAI,CAAC,MAAM,EAAE,CAAC;QAEd,0DAA0D;QAC1D,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,cAAM,OAAA,KAAI,CAAC,MAAM,EAAE,EAAb,CAAa,EAAE;YAC5D,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,2BAAM,GAAb;QACE,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACxB,IAAI,CAAC,cAAc,EAAE,CAAC;SACvB;IACH,CAAC;IAKD,sBAAc,oCAAY;QAH1B;;WAEG;aACH;YACU,IAAA,KAAK,GAAK,IAAI,MAAT,CAAU;YAEvB,IAAI,KAAK,CAAC,gBAAgB,EAAE;gBAC1B,IAAM,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC;gBAEhE,OAAO;oBACL,GAAG,EAAE,QAAQ,CAAC,GAAG;oBACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;iBACxB,CAAC;aACH;YAEO,IAAA,QAAQ,GAAK,IAAA,eAAM,GAAE,SAAb,CAAc;YAE9B,OAAO;gBACL,GAAG,EAAE,CAAC;gBACN,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB,CAAC;QACJ,CAAC;;;OAAA;IAED;;OAEG;IACO,mCAAc,GAAxB;QAAA,iBA2CC;QA1CC,IAAI,CAAC,IAAI,CAAC,gCAAgC,EAAE;YAC1C,OAAO;SACR;QAEK,IAAA,KAAwC,IAAI,EAA1C,YAAY,kBAAA,EAAE,YAAY,kBAAA,EAAE,KAAK,WAAS,CAAC;QAEnD,+CAA+C;QAC/C,IAAM,OAAO,GAAG,YAAY;YAC1B,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE/C,IAAM,OAAO,GAAG,YAAY;YAC1B,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,YAAY,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAEhD,IAAI,CAAC,uBAAuB,GAAG,IAAI,oBAAoB,CACrD,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAhC,CAAgC,EAC1C;YACE,IAAI,EAAE,KAAK,CAAC,gBAAgB;YAC5B,SAAS,EAAE,CAAC;YACZ,UAAU,EAAE,cAAO,OAAO,gBAAM,OAAO,WAAQ;SAChD,CACF,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO,YAC5B,OAAA,MAAA,KAAI,CAAC,uBAAuB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAA,EAAA,CAC/C,CAAC;QAEF,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,EAAE;YAC5B,IAAI,CAAC,wBAAwB,GAAG,IAAI,oBAAoB,CACtD,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAjC,CAAiC,EAC3C;gBACE,IAAI,EAAE,KAAK,CAAC,gBAAgB;gBAC5B,SAAS,EAAE,CAAC;gBACZ,UAAU,EAAE,iBAAiB;aAC9B,CACF,CAAC;YAEF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAC,OAAO,YAC5B,OAAA,MAAA,KAAI,CAAC,wBAAwB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAA,EAAA,CAChD,CAAC;SACH;IACH,CAAC;IAED;;OAEG;IACO,sCAAiB,GAA3B;;QACE,MAAA,IAAI,CAAC,uBAAuB,0CAAE,UAAU,EAAE,CAAC;QAC3C,IAAI,CAAC,uBAAuB,GAAG,SAAS,CAAC;QAEzC,MAAA,IAAI,CAAC,wBAAwB,0CAAE,UAAU,EAAE,CAAC;QAC5C,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACO,0CAAqB,GAA/B,UAAgC,IAAiC;QAAjE,iBAqBC;QApBC,IAAI,CAAC,OAAO,CAAC,UAAC,KAAK;YACjB,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;gBACzB,OAAO;aACR;YAED,IAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;YAC7B,IAAM,KAAK,GAAG,KAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAE7C,KAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAExC,IAAI,KAAI,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,EAAE;gBAC9B,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;YAC3B,IAAI,CAAC,MAAM,EAAE,CAAC;SACf;IACH,CAAC;IAED,wBAAwB;IACd,qCAAgB,GAA1B,UAA2B,OAA6B;QAChD,IAAA,KAA0B,IAAI,EAA5B,YAAY,kBAAA,EAAE,KAAK,WAAS,CAAC;QACrC,IAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;QAE9D,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACrD,OAAO,CAAC,CAAC;SACV;QAED,IAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAEjD,IAAM,QAAQ,GAAG,IAAA,YAAK,EACpB,KAAK,CAAC,SAAS,KAAK,YAAY;YAC9B,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,KAAK;YAC1D,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,MAAM,EAC3D,CAAC,CAAC,EAAE,CAAC,CAAC,CACP,CAAC;QAEF,OAAO,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACO,2CAAsB,GAAhC,UAAiC,IAAiC;QAAlE,iBASC;QARC,IAAI,CAAC,OAAO,CAAC,UAAC,KAAK;YACjB,IAAI,KAAK,CAAC,cAAc,EAAE;gBACxB,OAAO;aACR;YAED,IAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;YAC7B,KAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACO,iCAAY,GAAtB,UACE,WAAiC,EACjC,YAAqB,EACrB,KAAS;QAHX,iBAmCC;QAhCC,sBAAA,EAAA,SAAS;QAED,IAAA,aAAa,GAAK,IAAI,CAAC,KAAK,cAAf,CAAgB;QACrC,IAAM,OAAO,GAAG,WAAW,CAAC;QAE5B,IACE,CAAC,OAAO,CAAC,cAAc,IAAI,YAAY,CAAC;YACxC,CAAC,CAAC,OAAO,CAAC,cAAc,IAAI,CAAC,YAAY,CAAC,EAC1C;YACA,OAAO;SACR;QAED,kCAAkC;QAClC,OAAO,CAAC,cAAc,GAAG,YAAY,CAAC;QAEtC,+BAA+B;QAC/B,IAAI,aAAa,EAAE;YACjB,IAAA,kCAAyB,EAAC;gBACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;YACxD,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;QAED,+BAA+B;QAC/B,IAAI,YAAY,EAAE;YAChB,IAAA,kCAAyB,EAAC;gBACxB,KAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;YACxC,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;aAAM;YACL,IAAA,kCAAyB,EAAC;gBACxB,KAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;YACzC,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;IACH,CAAC;IAED;;OAEG;IACI,+BAAU,GAAjB,UAAkB,WAAoB;QAAtC,iBAiBC;;QAhBC,IAAM,OAAO,GAAG,WAAmC,CAAC;QAEpD,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,gCAAgC,EAAE;YACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE7B,MAAA,IAAI,CAAC,uBAAuB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAA,IAAI,CAAC,wBAAwB,0CAAE,OAAO,CAAC,OAAO,CAAC,CAAC;SACjD;aAAM;YACL,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SAClC;QAED,OAAO;YACL,MAAM,EAAE,cAAM,OAAA,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAA3B,CAA2B;SAC1C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,kCAAa,GAApB,UAAqB,WAAoB;;QACvC,IAAM,OAAO,GAAG,WAAmC,CAAC;QAEpD,MAAA,IAAI,CAAC,uBAAuB,0CAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QACjD,MAAA,IAAI,CAAC,wBAAwB,0CAAE,SAAS,CAAC,OAAO,CAAC,CAAC;QAClD,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;QAEnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAC,EAAE,IAAK,OAAA,EAAE,KAAK,OAAO,EAAd,CAAc,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACI,mCAAc,GAArB;QAAA,iBAGC;QAFC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAC,OAAO,IAAK,OAAA,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAA3B,CAA2B,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACO,6BAAQ,GAAlB;QACE,iBAAM,QAAQ,WAAE,CAAC;QAEjB,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IACH,iBAAC;AAAD,CAAC,AApWD,CAMU,qBAAc,GA8VvB;AApWY,gCAAU"}

package/lib/cjs/components/SectionScrollProgress/index.js

@@ -34,24 +34,25 @@ var scroll_1 = require("../../utils/scroll");
 var onResize_1 = require("../../utils/listeners/onResize");
 var getApp_1 = require("../../utils/internal/getApp");
 /**
- * Trace scroll progress of a section
+ * `SectionScrollProgress` is a component that traces the scroll progress of a specified section.
+ * It provides the progress of entering the viewport, moving within it, and exiting it.
  */
 var SectionScrollProgress = /** @class */ (function (_super) {
     __extends(SectionScrollProgress, _super);
     function SectionScrollProgress(initialProps, canInit) {
         if (canInit === void 0) { canInit = true; }
         var _this = _super.call(this, initialProps, false) || this;
-        var _a = _this.props, container = _a.container, section = _a.section;
-        // get scroll container
-        if (typeof container === 'string') {
-            _this._scrollContainer = (0, vevet_dom_1.selectOne)(container);
+        var _a = _this.props, scrollContainer = _a.scrollContainer, section = _a.section;
+        // Get the scroll container
+        if (typeof scrollContainer === 'string') {
+            _this._scrollContainer = (0, vevet_dom_1.selectOne)(scrollContainer);
         }
         else {
-            _this._scrollContainer = container;
+            _this._scrollContainer = scrollContainer;
         }
-        // get section element
+        // Get the section element
         _this._section = (0, vevet_dom_1.selectOne)(section);
-        // set defaults
+        // Set default values
         _this._prevProgressGlobal = -0.001;
         _this._progressGlobal = -0.001;
         _this._scopeGlobal = [0, 0];
@@ -59,17 +60,21 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         _this._scopeMove = [0, 0];
         _this._scopeOut = [0, 0];
         _this._frameThrottleIndex = 0;
-        // initialize the class
+        // Initialize the component
         if (canInit) {
             _this.init();
         }
         return _this;
     }
     SectionScrollProgress.prototype._getDefaultProps = function () {
-        return __assign(__assign({}, _super.prototype._getDefaultProps.call(this)), { container: window, viewportTarget: 'any', resizeTimeout: 0 });
+        return __assign(__assign({}, _super.prototype._getDefaultProps.call(this)), { scrollContainer: window, viewportTarget: 'any', resizeTimeout: 0 });
     };
     Object.defineProperty(SectionScrollProgress.prototype, "scrollContainer", {
-        /** Scroll container */
+        /**
+         * Returns the scroll container.
+         *
+         * @returns {Element | CustomScroll | Window} The scroll container.
+         */
         get: function () {
             return this._scrollContainer;
         },
@@ -77,7 +82,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "section", {
-        /** Section element */
+        /**
+         * Returns the section element being tracked.
+         */
         get: function () {
             return this._section;
         },
@@ -85,7 +92,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "scopeGlobal", {
-        /** Scrolling scope */
+        /**
+         * Returns the global scope of the scrolling section.
+         */
         get: function () {
             return this._scopeGlobal;
         },
@@ -93,7 +102,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "scopeIn", {
-        /** Scope of element appearing from bottom to top */
+        /**
+         * Returns the scope of the section appearing in the viewport.
+         */
         get: function () {
             return this._scopeIn;
         },
@@ -101,7 +112,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "scopeMove", {
-        /** Scope of element moving */
+        /**
+         * Returns the scope of the section moving through the viewport.
+         */
         get: function () {
             return this._scopeMove;
         },
@@ -109,7 +122,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "scopeOut", {
-        /** Scope of element disappearing from bottom to top */
+        /**
+         * Returns the scope of the section disappearing from the viewport.
+         */
         get: function () {
             return this._scopeOut;
         },
@@ -117,7 +132,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "progressGlobal", {
-        /** Global progress */
+        /**
+         * Returns the current global progress of the scroll.
+         */
         get: function () {
             return this._progressGlobal;
         },
@@ -127,11 +144,16 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Initializes the `SectionScrollProgress` component and sets up scroll and resize events.
+     */
     SectionScrollProgress.prototype._init = function () {
         _super.prototype._init.call(this);
         this._setEvents();
     };
-    /** Set events */
+    /**
+     * Sets the resize and scroll events for monitoring the section's scroll progress.
+     */
     SectionScrollProgress.prototype._setEvents = function () {
         var _this = this;
         var _a = this.props, viewportTarget = _a.viewportTarget, resizeDebounce = _a.resizeDebounce;
@@ -144,12 +166,12 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         });
         var loadEvent = (0, getApp_1.getApp)().onPageLoad();
         loadEvent.then(function () { return resizeHandler.debounceResize(); }).catch(function () { });
-        // set scroll events
+        // Set up scroll event
         var scrollEvent = (0, scroll_1.onScroll)({
             container: this.scrollContainer,
             callback: function (data) { return _this._render(data); },
         });
-        // destroy events
+        // Clean up actions on destroy
         this.addDestroyableAction(function () {
             resizeHandler.remove();
             loadEvent.cancel();
@@ -161,7 +183,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         this.resize();
     };
     Object.defineProperty(SectionScrollProgress.prototype, "progressIn", {
-        /** 'in' progress */
+        /**
+         * Returns the progress of the section as it appears in the viewport.
+         */
         get: function () {
             return (0, math_1.clampScope)(this.progressGlobal, this.scopeIn) || 0;
         },
@@ -169,7 +193,9 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "progressOut", {
-        /** 'out' progress */
+        /**
+         * Returns the progress of the section as it exits the viewport.
+         */
         get: function () {
             return (0, math_1.clampScope)(this.progressGlobal, this.scopeOut) || 0;
         },
@@ -177,45 +203,55 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(SectionScrollProgress.prototype, "progressMove", {
-        /** 'move' progress */
+        /**
+         * Returns the progress of the section as it moves through the viewport.
+         */
         get: function () {
             return (0, math_1.clampScope)(this.progressGlobal, this.scopeMove) || 0;
         },
         enumerable: false,
         configurable: true
     });
-    /** Resize the scene */
+    /**
+     * Resizes the section and recalculates the scroll progress.
+     */
     SectionScrollProgress.prototype.resize = function () {
         var scrollValues = (0, scroll_1.getScrollValues)(this.scrollContainer);
         if (!scrollValues) {
             return;
         }
-        // launch callbacks
+        // Trigger resize callback
         this.callbacks.tbt('resize', undefined);
-        // render the scene
+        // Render the section
         this._render(scrollValues, true);
     };
-    /** Calculate scopes */
+    /**
+     * Calculates the scroll scopes for the section.
+     */
     SectionScrollProgress.prototype._calculateScopes = function (_a) {
         var scrollTop = _a.scrollTop;
         var vHeight = (0, getApp_1.getApp)().viewport.height;
         var sectionBounding = this.section.getBoundingClientRect();
-        // calculate scroll scope
+        // Calculate scroll scopes
         var inStart = scrollTop + sectionBounding.top - vHeight;
         var moveEnd = scrollTop + sectionBounding.top + sectionBounding.height;
         var scrollLine = moveEnd - inStart;
         this._scopeGlobal = [inStart, moveEnd];
-        // calculate other scopes
+        // Calculate individual scopes
         this._scopeIn = [0, vHeight / scrollLine];
         this._scopeOut = [1 - vHeight / scrollLine, 1];
         this._scopeMove = [this._scopeIn[1], this._scopeOut[0]];
     };
-    /** Check if the section can be rendered */
+    /**
+     * Determines whether the section can be rendered based on scroll progress changes.
+     */
     SectionScrollProgress.prototype._canRender = function (isForce) {
         if (isForce === void 0) { isForce = false; }
         return isForce || this.progressGlobal !== this._prevProgressGlobal;
     };
-    /** Render the scene */
+    /**
+     * Renders the section by updating its scroll progress and triggering callbacks.
+     */
     SectionScrollProgress.prototype._render = function (scrollValues, isForce) {
         if (isForce === void 0) { isForce = false; }
         this._frameThrottleIndex += 1;
@@ -227,6 +263,7 @@ var SectionScrollProgress = /** @class */ (function (_super) {
         if (!this._canRender(isForce)) {
             return;
         }
+        // Trigger render callback
         this.callbacks.tbt('render', undefined);
     };
     return SectionScrollProgress;

package/lib/cjs/components/SectionScrollProgress/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAsC;AAGtC,8CAA+D;AAC/D,qCAA0C;AAC1C,yCAA6E;AAC7E,uDAAsD;AACtD,kDAAiD;AAIjD;;GAEG;AACH;IAOU,yCAA4D;IA2EpE,+BAAY,YAA4C,EAAE,OAAc;QAAd,wBAAA,EAAA,cAAc;QAAxE,YACE,kBAAM,YAAY,EAAE,KAAK,CAAC,SA2B3B;QAzBO,IAAA,KAAyB,KAAI,CAAC,KAAK,EAAjC,SAAS,eAAA,EAAE,OAAO,aAAe,CAAC;QAE1C,uBAAuB;QACvB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,KAAI,CAAC,gBAAgB,GAAG,IAAA,qBAAS,EAAC,SAAS,CAAY,CAAC;SACzD;aAAM;YACL,KAAI,CAAC,gBAAgB,GAAG,SAAgB,CAAC;SAC1C;QAED,sBAAsB;QACtB,KAAI,CAAC,QAAQ,GAAG,IAAA,qBAAS,EAAC,OAAO,CAAY,CAAC;QAE9C,eAAe;QACf,KAAI,CAAC,mBAAmB,GAAG,CAAC,KAAK,CAAC;QAClC,KAAI,CAAC,eAAe,GAAG,CAAC,KAAK,CAAC;QAC9B,KAAI,CAAC,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,KAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,KAAI,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzB,KAAI,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,KAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;QAE7B,uBAAuB;QACvB,IAAI,OAAO,EAAE;YACX,KAAI,CAAC,IAAI,EAAE,CAAC;SACb;;IACH,CAAC;IAtGS,gDAAgB,GAA1B;QACE,6BACK,iBAAM,gBAAgB,WAAE,KAC3B,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,KAAK,EACrB,aAAa,EAAE,CAAC,IAChB;IACJ,CAAC;IAMD,sBAAI,kDAAe;QADnB,uBAAuB;aACvB;YACE,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;;;OAAA;IAMD,sBAAI,0CAAO;QADX,sBAAsB;aACtB;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAMD,sBAAI,8CAAW;QADf,sBAAsB;aACtB;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;;;OAAA;IAMD,sBAAI,0CAAO;QADX,oDAAoD;aACpD;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAMD,sBAAI,4CAAS;QADb,8BAA8B;aAC9B;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAMD,sBAAI,2CAAQ;QADZ,uDAAuD;aACvD;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IASD,sBAAI,iDAAc;QADlB,sBAAsB;aACtB;YACE,OAAO,IAAI,CAAC,eAAe,CAAC;QAC9B,CAAC;aAED,UAA6B,KAAK;YAChC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC/B,CAAC;;;OAJA;IAsCS,qCAAK,GAAf;QACE,iBAAM,KAAK,WAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,iBAAiB;IACP,0CAAU,GAApB;QAAA,iBA0BC;QAzBO,IAAA,KAAqC,IAAI,CAAC,KAAK,EAA7C,cAAc,oBAAA,EAAE,cAAc,oBAAe,CAAC;QAEtD,IAAM,aAAa,GAAG,IAAA,mBAAQ,EAAC;YAC7B,QAAQ,EAAE,cAAM,OAAA,KAAI,CAAC,MAAM,EAAE,EAAb,CAAa;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,cAAc,gBAAA;YACd,aAAa,EAAE,IAAI;YACnB,cAAc,gBAAA;SACf,CAAC,CAAC;QAEH,IAAM,SAAS,GAAG,IAAA,eAAM,GAAE,CAAC,UAAU,EAAE,CAAC;QACxC,SAAS,CAAC,IAAI,CAAC,cAAM,OAAA,aAAa,CAAC,cAAc,EAAE,EAA9B,CAA8B,CAAC,CAAC,KAAK,CAAC,cAAO,CAAC,CAAC,CAAC;QAErE,oBAAoB;QACpB,IAAM,WAAW,GAAG,IAAA,iBAAQ,EAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,eAAe;YAC/B,QAAQ,EAAE,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAlB,CAAkB;SACvC,CAAC,CAAC;QAEH,iBAAiB;QACjB,IAAI,CAAC,oBAAoB,CAAC;YACxB,aAAa,CAAC,MAAM,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,EAAE,CAAC;YACnB,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAES,8CAAc,GAAxB;QACE,iBAAM,cAAc,WAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAGD,sBAAI,6CAAU;QADd,oBAAoB;aACpB;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;;;OAAA;IAGD,sBAAI,8CAAW;QADf,qBAAqB;aACrB;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,CAAC;;;OAAA;IAGD,sBAAI,+CAAY;QADhB,sBAAsB;aACtB;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9D,CAAC;;;OAAA;IAED,uBAAuB;IAChB,sCAAM,GAAb;QACE,IAAM,YAAY,GAAG,IAAA,wBAAe,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,mBAAmB;QACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAExC,mBAAmB;QACnB,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,uBAAuB;IACb,gDAAgB,GAA1B,UAA2B,EAA+B;YAA7B,SAAS,eAAA;QAC5B,IAAQ,OAAO,GAAK,IAAA,eAAM,GAAE,CAAC,QAAQ,OAAtB,CAAuB;QAC9C,IAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAE7D,yBAAyB;QACzB,IAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC,GAAG,GAAG,OAAO,CAAC;QAC1D,IAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC;QACzE,IAAM,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAEvC,yBAAyB;QACzB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,OAAO,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,2CAA2C;IACjC,0CAAU,GAApB,UAAqB,OAAe;QAAf,wBAAA,EAAA,eAAe;QAClC,OAAO,OAAO,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,mBAAmB,CAAC;IACrE,CAAC;IAED,uBAAuB;IACb,uCAAO,GAAjB,UAAkB,YAA8B,EAAE,OAAe;QAAf,wBAAA,EAAA,eAAe;QAC/D,IAAI,CAAC,mBAAmB,IAAI,CAAC,CAAC;QAE9B,IAAI,IAAI,CAAC,mBAAmB,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE;YAClD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAAC;QAC/C,IAAI,CAAC,cAAc,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5E,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO;SACR;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IACH,4BAAC;AAAD,CAAC,AA7ND,CAOU,qBAAc,GAsNvB;AA7NY,sDAAqB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAsC;AAGtC,8CAA+D;AAC/D,qCAA0C;AAC1C,yCAA6E;AAC7E,uDAAsD;AACtD,kDAAiD;AAIjD;;;GAGG;AACH;IAOU,yCAA4D;IA8GpE,+BAAY,YAA4C,EAAE,OAAc;QAAd,wBAAA,EAAA,cAAc;QAAxE,YACE,kBAAM,YAAY,EAAE,KAAK,CAAC,SA2B3B;QAzBO,IAAA,KAA+B,KAAI,CAAC,KAAK,EAAvC,eAAe,qBAAA,EAAE,OAAO,aAAe,CAAC;QAEhD,2BAA2B;QAC3B,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YACvC,KAAI,CAAC,gBAAgB,GAAG,IAAA,qBAAS,EAAC,eAAe,CAAY,CAAC;SAC/D;aAAM;YACL,KAAI,CAAC,gBAAgB,GAAG,eAAsB,CAAC;SAChD;QAED,0BAA0B;QAC1B,KAAI,CAAC,QAAQ,GAAG,IAAA,qBAAS,EAAC,OAAO,CAAY,CAAC;QAE9C,qBAAqB;QACrB,KAAI,CAAC,mBAAmB,GAAG,CAAC,KAAK,CAAC;QAClC,KAAI,CAAC,eAAe,GAAG,CAAC,KAAK,CAAC;QAC9B,KAAI,CAAC,YAAY,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,KAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACvB,KAAI,CAAC,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACzB,KAAI,CAAC,SAAS,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,KAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;QAE7B,2BAA2B;QAC3B,IAAI,OAAO,EAAE;YACX,KAAI,CAAC,IAAI,EAAE,CAAC;SACb;;IACH,CAAC;IAzIS,gDAAgB,GAA1B;QACE,6BACK,iBAAM,gBAAgB,WAAE,KAC3B,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,KAAK,EACrB,aAAa,EAAE,CAAC,IAChB;IACJ,CAAC;IAYD,sBAAI,kDAAe;QALnB;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;;;OAAA;IAUD,sBAAI,0CAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAUD,sBAAI,8CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;;;OAAA;IAUD,sBAAI,0CAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC;QACvB,CAAC;;;OAAA;IAUD,sBAAI,4CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAUD,sBAAI,2CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IAeD,sBAAI,iDAAc;QAHlB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,eAAe,CAAC;QAC9B,CAAC;aAED,UAA6B,KAAK;YAChC,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC/B,CAAC;;;OAJA;IAyCD;;OAEG;IACO,qCAAK,GAAf;QACE,iBAAM,KAAK,WAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACO,0CAAU,GAApB;QAAA,iBA0BC;QAzBO,IAAA,KAAqC,IAAI,CAAC,KAAK,EAA7C,cAAc,oBAAA,EAAE,cAAc,oBAAe,CAAC;QAEtD,IAAM,aAAa,GAAG,IAAA,mBAAQ,EAAC;YAC7B,QAAQ,EAAE,cAAM,OAAA,KAAI,CAAC,MAAM,EAAE,EAAb,CAAa;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,cAAc,gBAAA;YACd,aAAa,EAAE,IAAI;YACnB,cAAc,gBAAA;SACf,CAAC,CAAC;QAEH,IAAM,SAAS,GAAG,IAAA,eAAM,GAAE,CAAC,UAAU,EAAE,CAAC;QACxC,SAAS,CAAC,IAAI,CAAC,cAAM,OAAA,aAAa,CAAC,cAAc,EAAE,EAA9B,CAA8B,CAAC,CAAC,KAAK,CAAC,cAAO,CAAC,CAAC,CAAC;QAErE,sBAAsB;QACtB,IAAM,WAAW,GAAG,IAAA,iBAAQ,EAAC;YAC3B,SAAS,EAAE,IAAI,CAAC,eAAe;YAC/B,QAAQ,EAAE,UAAC,IAAI,IAAK,OAAA,KAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAlB,CAAkB;SACvC,CAAC,CAAC;QAEH,8BAA8B;QAC9B,IAAI,CAAC,oBAAoB,CAAC;YACxB,aAAa,CAAC,MAAM,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,EAAE,CAAC;YACnB,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;IAES,8CAAc,GAAxB;QACE,iBAAM,cAAc,WAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAKD,sBAAI,6CAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;;;OAAA;IAKD,sBAAI,8CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7D,CAAC;;;OAAA;IAKD,sBAAI,+CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9D,CAAC;;;OAAA;IAED;;OAEG;IACI,sCAAM,GAAb;QACE,IAAM,YAAY,GAAG,IAAA,wBAAe,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO;SACR;QAED,0BAA0B;QAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAExC,qBAAqB;QACrB,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACO,gDAAgB,GAA1B,UAA2B,EAA+B;YAA7B,SAAS,eAAA;QAC5B,IAAQ,OAAO,GAAK,IAAA,eAAM,GAAE,CAAC,QAAQ,OAAtB,CAAuB;QAC9C,IAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;QAE7D,0BAA0B;QAC1B,IAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC,GAAG,GAAG,OAAO,CAAC;QAC1D,IAAM,OAAO,GAAG,SAAS,GAAG,eAAe,CAAC,GAAG,GAAG,eAAe,CAAC,MAAM,CAAC;QACzE,IAAM,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAEvC,8BAA8B;QAC9B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,OAAO,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACO,0CAAU,GAApB,UAAqB,OAAe;QAAf,wBAAA,EAAA,eAAe;QAClC,OAAO,OAAO,IAAI,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,mBAAmB,CAAC;IACrE,CAAC;IAED;;OAEG;IACO,uCAAO,GAAjB,UAAkB,YAA8B,EAAE,OAAe;QAAf,wBAAA,EAAA,eAAe;QAC/D,IAAI,CAAC,mBAAmB,IAAI,CAAC,CAAC;QAE9B,IAAI,IAAI,CAAC,mBAAmB,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE;YAClD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,cAAc,CAAC;QAC/C,IAAI,CAAC,cAAc,GAAG,IAAA,iBAAU,EAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAE5E,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YAC7B,OAAO;SACR;QAED,0BAA0B;QAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IACH,4BAAC;AAAD,CAAC,AApRD,CAOU,qBAAc,GA6QvB;AApRY,sDAAqB"}