vevet 3.20.0 → 4.0.0-beta.0

package/lib/esm/components/ScrollBar/Bar/index.js

@@ -3,53 +3,87 @@ import { DraggerMove } from '../../DraggerMove';
 import { onScroll } from '../../../utils/scroll/onScroll';
 import { clamp } from '../../../utils/math';
 import { getScrollValues } from '../../../utils/scroll';
-export default class Bar {
+/**
+ * Represents a custom scroll bar with a draggable thumb.
+ */
+export class Bar {
+    /**
+     * Gets the outer container of the scroll bar.
+     */
     get outer() {
         return this._outer;
     }
+    /**
+     * Gets the thumb element of the scroll bar.
+     */
     get thumb() {
         return this._thumb;
     }
-    get prefix() {
-        return this.props.prefix;
-    }
+    /**
+     * Determines if the scroll bar is horizontal.
+     */
     get isHorizontal() {
         return this.props.direction === 'x';
     }
+    /**
+     * Determines if the scroll bar is vertical.
+     */
     get isVertical() {
         return !this.isHorizontal;
     }
+    /**
+     * Gets the scrollable element.
+     */
     get scrollElement() {
         return this.props.container instanceof Window
             ? document.documentElement
             : this.props.container;
     }
+    /**
+     * Gets the total scrollable distance (scroll line) for the scroll bar.
+     */
     get scrollLine() {
         const { scrollElement } = this;
         return this.isHorizontal
             ? scrollElement.scrollWidth - scrollElement.clientWidth
             : scrollElement.scrollHeight - scrollElement.clientHeight;
     }
+    /**
+     * Gets the total width of the scrollable element.
+     */
     get scrollWidth() {
         return this.scrollElement.scrollWidth;
     }
+    /**
+     * Gets the total height of the scrollable element.
+     */
     get scrollHeight() {
         return this.scrollElement.scrollHeight;
     }
+    /**
+     * Gets the scroll bar properties.
+     */
     get props() {
         return this._props;
     }
     constructor(_props) {
         this._props = _props;
-        const { direction, domParent, container, canAutoHide } = _props;
-        // set default vars
+        /** The outer height of the scroll bar container */
         this._outerHeight = 0;
+        /** The outer width of the scroll bar container */
         this._outerWidth = 0;
+        /** The thumb's height */
         this._thumbHeight = 0;
+        /** The thumb's width */
         this._thumbWidth = 0;
+        /** Stores the previous scroll value for comparison */
         this._prevScrollValue = 0;
+        /** Stores the coordinates of the scroll element at the start of dragging */
         this._coordsAtDragStart = { scrollLeft: 0, scrollTop: 0 };
-        // create container
+        /** Stores the list of event listeners */
+        this._listeners = [];
+        const { direction, domParent, container, canAutoHide } = _props;
+        // Create the outer scroll bar container
         const outer = document.createElement('div');
         this._outer = outer;
         outer.classList.add(this.className(''));
@@ -59,30 +93,36 @@ export default class Bar {
         }
         outer.classList.toggle(this.className('_auto-hide'), canAutoHide);
         domParent.append(outer);
-        // create a thumb
+        // Create the thumb for the scroll bar
         const thumb = document.createElement('div');
         this._thumb = thumb;
         thumb.classList.add(this.className('__thumb'));
         thumb.classList.add(this.className(`__thumb_${direction}`));
         outer.append(thumb);
-        // set events
+        // Set events for the scroll bar
         this._setEvents();
     }
+    /**
+     * Generates the scroll bar's class name based on the prefix and value.
+     * @param value - The suffix to add to the prefix for the class name.
+     */
     className(value) {
         return `${this.props.prefix}${value}`;
     }
-    /** Set scrolblar events */
+    /**
+     * Sets the necessary events for the scroll bar, such as hover and scroll events.
+     */
     _setEvents() {
-        if (!this._listeners) {
-            this._listeners = [];
-        }
         const { outer, thumb, props } = this;
+        // Add hover events for the outer container
         this._listeners.push(addEventListener(outer, 'mouseenter', () => this._handleHover(true)));
         this._listeners.push(addEventListener(outer, 'mouseleave', () => this._handleHover(false)));
+        // Add scroll event for the container
         this._scrollEvent = onScroll({
             container: props.container,
             callback: (data) => this._handleScroll(data),
         });
+        // Set drag events if the scroll bar is draggable
         if (this.props.isDraggable) {
             this._dragger = new DraggerMove({ container: thumb });
             this._dragger.addCallback('start', () => {
@@ -91,22 +131,30 @@ export default class Bar {
             this._dragger.addCallback('move', (data) => this._handleThumbDrag(data));
         }
     }
-    /** Remove events */
+    /**
+     * Removes all the event listeners for the scroll bar.
+     */
     _removeEvents() {
         var _a, _b, _c;
         (_a = this._listeners) === null || _a === void 0 ? void 0 : _a.forEach((listener) => listener.remove());
         (_b = this._scrollEvent) === null || _b === void 0 ? void 0 : _b.remove();
         (_c = this._dragger) === null || _c === void 0 ? void 0 : _c.destroy();
     }
-    /** Handle hover state */
+    /**
+     * Handles the hover state of the scroll bar.
+     * @param isHovered - Whether the scroll bar is hovered or not.
+     */
     _handleHover(isHovered) {
         const className = this.className('_is-hovered');
         this.outer.classList.toggle(className, isHovered);
     }
-    /** Handle Scroll Event */
+    /**
+     * Handles the scroll event by updating the thumb position and auto-hide behavior.
+     * @param param - The scroll position of the container.
+     */
     _handleScroll({ scrollLeft, scrollTop }) {
         let hasChanged = false;
-        // check if changes happened
+        // Check if changes happened
         if (this.isHorizontal) {
             hasChanged = scrollLeft !== this._prevScrollValue;
             this._prevScrollValue = scrollLeft;
@@ -115,11 +163,11 @@ export default class Bar {
             hasChanged = scrollTop !== this._prevScrollValue;
             this._prevScrollValue = scrollTop;
         }
-        // continue if there are changes
+        // If no changes, return early
         if (!hasChanged) {
             return;
         }
-        // set auto hide
+        // Handle auto-hide behavior
         if (this.props.canAutoHide && hasChanged) {
             const actionClassName = this.className('_in-action');
             this.outer.classList.add(actionClassName);
@@ -128,20 +176,22 @@ export default class Bar {
             }
             this._actionTimeout = setTimeout(() => this.outer.classList.remove(actionClassName), 500);
         }
-        // render elements
+        // Render the thumb
         this._renderThumb();
     }
-    /** Event on dragger move */
+    /**
+     * Handles the thumb dragging event by calculating new scroll values based on the drag movement.
+     * @param param - The drag event data.
+     */
     _handleThumbDrag({ event, coords, start, }) {
         event.preventDefault();
         const { scrollLine } = this;
         const { container } = this.props;
-        // calculate scroll iterators
+        // Calculate new scroll values based on the drag movement
         const leftIterator = ((coords.x - start.x) / (this._outerWidth - this._thumbWidth)) *
             scrollLine;
         const topIterator = ((coords.y - start.y) / (this._outerHeight - this._thumbHeight)) *
             scrollLine;
-        // calculate new scroll values
         let { scrollLeft, scrollTop } = this._coordsAtDragStart;
         if (this.isHorizontal) {
             scrollLeft += leftIterator;
@@ -149,16 +199,18 @@ export default class Bar {
         else {
             scrollTop += topIterator;
         }
-        // apply the values
+        // Apply new scroll values
         container.scrollTo({
             top: scrollTop,
             left: scrollLeft,
-            behavior: 'isSmoothScroll' in this.props.container
+            behavior: 'isCustomScroll' in this.props.container
                 ? this.props.scrollBehavior
                 : 'auto',
         });
     }
-    /** Render thumb */
+    /**
+     * Renders the thumb position based on the current scroll position.
+     */
     _renderThumb() {
         const progress = clamp(this._prevScrollValue / this.scrollLine, [0, 1]);
         const x = this.isHorizontal
@@ -169,16 +221,18 @@ export default class Bar {
             : 0;
         this._thumb.style.transform = `translate(${x}px, ${y}px)`;
     }
-    /** Resize the scene */
+    /**
+     * Resizes the scroll bar by recalculating the thumb and outer container sizes.
+     */
     resize() {
         const { outer, thumb, scrollLine, scrollWidth, scrollHeight, isHorizontal, } = this;
         const { minSize, shouldAutoSize } = this.props;
-        // define if empty before other calculations
+        // Define if the scrollbar is empty
         outer.classList.toggle(this.className('_is-empty'), scrollLine === 0);
-        // get outer sizes
+        // Get outer sizes
         this._outerHeight = outer.clientHeight;
         this._outerWidth = outer.clientWidth;
-        // calculate thumb sizes
+        // Calculate thumb sizes if auto-size is enabled
         if (shouldAutoSize) {
             if (isHorizontal) {
                 const barSize = clamp(this._outerWidth / (scrollWidth / (scrollWidth - scrollLine)), [minSize, Infinity]);
@@ -189,12 +243,15 @@ export default class Bar {
                 thumb.style.height = `${barSize}px`;
             }
         }
-        // get thumb sizes
+        // Get thumb sizes
         this._thumbHeight = thumb.clientHeight;
         this._thumbWidth = thumb.clientWidth;
-        // render elements
+        // Render the thumb position
         this._renderThumb();
     }
+    /**
+     * Destroys the scroll bar by removing events and clearing timeouts.
+     */
     destroy() {
         this._removeEvents();
         if (this._actionTimeout) {

package/lib/esm/components/ScrollBar/Bar/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAgB,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAA8B,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,MAAM,CAAC,OAAO,OAAO,GAAG;IAGtB,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAID,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,GAAG,CAAC;IACtC,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5B,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,YAAY,MAAM;YAC3C,CAAC,CAAC,QAAQ,CAAC,eAAe;YAC1B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC3B,CAAC;IAED,IAAI,UAAU;QACZ,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;QAE/B,OAAO,IAAI,CAAC,YAAY;YACtB,CAAC,CAAC,aAAa,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW;YACvD,CAAC,CAAC,aAAa,CAAC,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;IACxC,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;IACzC,CAAC;IAsBD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,YAAoB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;QACnC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAEhE,mBAAmB;QACnB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;QAE1D,mBAAmB;QACnB,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;QACrD,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;SACnD;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,CAAC;QAClE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAExB,iBAAiB;QACjB,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpB,aAAa;QACb,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAEO,SAAS,CAAC,KAAa;QAC7B,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;IACxC,CAAC;IAED,2BAA2B;IACnB,UAAU;QAChB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;SACtB;QAED,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAErC,IAAI,CAAC,UAAU,CAAC,IAAI,CAClB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CACrE,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAClB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CACtE,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;YAC3B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;SAC7C,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAEtD,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtC,IAAI,CAAC,kBAAkB,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;YACnE,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED,oBAAoB;IACZ,aAAa;;QACnB,MAAA,IAAI,CAAC,UAAU,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,MAAA,IAAI,CAAC,YAAY,0CAAE,MAAM,EAAE,CAAC;QAC5B,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,yBAAyB;IACjB,YAAY,CAAC,SAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAEhD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED,0BAA0B;IAClB,aAAa,CAAC,EAAE,UAAU,EAAE,SAAS,EAA8B;QACzE,IAAI,UAAU,GAAG,KAAK,CAAC;QAEvB,4BAA4B;QAC5B,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,UAAU,GAAG,UAAU,KAAK,IAAI,CAAC,gBAAgB,CAAC;YAClD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;SACpC;aAAM;YACL,UAAU,GAAG,SAAS,KAAK,IAAI,CAAC,gBAAgB,CAAC;YACjD,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;QAED,gCAAgC;QAChC,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;QAED,gBAAgB;QAChB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,UAAU,EAAE;YACxC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAErD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAE1C,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACnC;YAED,IAAI,CAAC,cAAc,GAAG,UAAU,CAC9B,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,EAClD,GAAG,CACJ,CAAC;SACH;QAED,kBAAkB;QAClB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,4BAA4B;IACpB,gBAAgB,CAAC,EACvB,KAAK,EACL,MAAM,EACN,KAAK,GACgC;QACrC,KAAK,CAAC,cAAc,EAAE,CAAC;QAEvB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC5B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,6BAA6B;QAC7B,MAAM,YAAY,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YAC9D,UAAU,CAAC;QACb,MAAM,WAAW,GACf,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAChE,UAAU,CAAC;QAEb,8BAA8B;QAC9B,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,UAAU,IAAI,YAAY,CAAC;SAC5B;aAAM;YACL,SAAS,IAAI,WAAW,CAAC;SAC1B;QAED,mBAAmB;QACnB,SAAS,CAAC,QAAQ,CAAC;YACjB,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,UAAU;YAChB,QAAQ,EACN,gBAAgB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS;gBACtC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;gBAC3B,CAAC,CAAC,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACX,YAAY;QAClB,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY;YACzB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,QAAQ;YAClD,CAAC,CAAC,CAAC,CAAC;QACN,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU;YACvB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,QAAQ;YACpD,CAAC,CAAC,CAAC,CAAC;QAEN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5D,CAAC;IAED,uBAAuB;IAChB,MAAM;QACX,MAAM,EACJ,KAAK,EACL,KAAK,EACL,UAAU,EACV,WAAW,EACX,YAAY,EACZ,YAAY,GACb,GAAG,IAAI,CAAC;QAET,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE/C,4CAA4C;QAC5C,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC;QAEtE,kBAAkB;QAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAErC,wBAAwB;QACxB,IAAI,cAAc,EAAE;YAClB,IAAI,YAAY,EAAE;gBAChB,MAAM,OAAO,GAAG,KAAK,CACnB,IAAI,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,EAC7D,CAAC,OAAO,EAAE,QAAQ,CAAC,CACpB,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,OAAO,IAAI,CAAC;aACpC;iBAAM;gBACL,MAAM,OAAO,GAAG,KAAK,CACnB,IAAI,CAAC,YAAY,GAAG,CAAC,YAAY,GAAG,CAAC,YAAY,GAAG,UAAU,CAAC,CAAC,EAChE,CAAC,OAAO,EAAE,QAAQ,CAAC,CACpB,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC;aACrC;SACF;QAED,kBAAkB;QAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAErC,kBAAkB;QAClB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACnC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAGhE,OAAO,EAAE,WAAW,EAAgB,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAA8B,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC/E,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;GAEG;AACH,MAAM,OAAO,GAAG;IAId;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAKD;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAgCD;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,GAAG,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,YAAY,MAAM;YAC3C,CAAC,CAAC,QAAQ,CAAC,eAAe;YAC1B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;QAE/B,OAAO,IAAI,CAAC,YAAY;YACtB,CAAC,CAAC,aAAa,CAAC,WAAW,GAAG,aAAa,CAAC,WAAW;YACvD,CAAC,CAAC,aAAa,CAAC,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,YAAoB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;QArFrC,mDAAmD;QAC3C,iBAAY,GAAG,CAAC,CAAC;QAEzB,kDAAkD;QAC1C,gBAAW,GAAG,CAAC,CAAC;QAExB,yBAAyB;QACjB,iBAAY,GAAG,CAAC,CAAC;QAEzB,wBAAwB;QAChB,gBAAW,GAAG,CAAC,CAAC;QAExB,sDAAsD;QAC9C,qBAAgB,GAAG,CAAC,CAAC;QAE7B,4EAA4E;QACpE,uBAAkB,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;QAE7D,yCAAyC;QACjC,eAAU,GAAwB,EAAE,CAAC;QAmE3C,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAEhE,wCAAwC;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;QACrD,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;SACnD;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,CAAC;QAClE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAExB,sCAAsC;QACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5D,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEpB,gCAAgC;QAChC,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,KAAa;QAC7B,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;IACxC,CAAC;IAED;;OAEG;IACK,UAAU;QAChB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAErC,2CAA2C;QAC3C,IAAI,CAAC,UAAU,CAAC,IAAI,CAClB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CACrE,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAClB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CACtE,CAAC;QAEF,qCAAqC;QACrC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;YAC3B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;SAC7C,CAAC,CAAC;QAEH,iDAAiD;QACjD,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAEtD,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE;gBACtC,IAAI,CAAC,kBAAkB,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAE,CAAC;YACnE,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;OAEG;IACK,aAAa;;QACnB,MAAA,IAAI,CAAC,UAAU,0CAAE,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,MAAA,IAAI,CAAC,YAAY,0CAAE,MAAM,EAAE,CAAC;QAC5B,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,SAAkB;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAChD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACK,aAAa,CAAC,EAAE,UAAU,EAAE,SAAS,EAA8B;QACzE,IAAI,UAAU,GAAG,KAAK,CAAC;QAEvB,4BAA4B;QAC5B,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,UAAU,GAAG,UAAU,KAAK,IAAI,CAAC,gBAAgB,CAAC;YAClD,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;SACpC;aAAM;YACL,UAAU,GAAG,SAAS,KAAK,IAAI,CAAC,gBAAgB,CAAC;YACjD,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;QAED,8BAA8B;QAC9B,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;QAED,4BAA4B;QAC5B,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,UAAU,EAAE;YACxC,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACrD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;YAE1C,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACnC;YAED,IAAI,CAAC,cAAc,GAAG,UAAU,CAC9B,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,EAClD,GAAG,CACJ,CAAC;SACH;QAED,mBAAmB;QACnB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;;OAGG;IACK,gBAAgB,CAAC,EACvB,KAAK,EACL,MAAM,EACN,KAAK,GACgC;QACrC,KAAK,CAAC,cAAc,EAAE,CAAC;QAEvB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAC5B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,yDAAyD;QACzD,MAAM,YAAY,GAChB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YAC9D,UAAU,CAAC;QACb,MAAM,WAAW,GACf,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAChE,UAAU,CAAC;QAEb,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACxD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,UAAU,IAAI,YAAY,CAAC;SAC5B;aAAM;YACL,SAAS,IAAI,WAAW,CAAC;SAC1B;QAED,0BAA0B;QAC1B,SAAS,CAAC,QAAQ,CAAC;YACjB,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,UAAU;YAChB,QAAQ,EACN,gBAAgB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS;gBACtC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;gBAC3B,CAAC,CAAC,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACK,YAAY;QAClB,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY;YACzB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,QAAQ;YAClD,CAAC,CAAC,CAAC,CAAC;QACN,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU;YACvB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,QAAQ;YACpD,CAAC,CAAC,CAAC,CAAC;QAEN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,EACJ,KAAK,EACL,KAAK,EACL,UAAU,EACV,WAAW,EACX,YAAY,EACZ,YAAY,GACb,GAAG,IAAI,CAAC;QAET,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAE/C,mCAAmC;QACnC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,UAAU,KAAK,CAAC,CAAC,CAAC;QAEtE,kBAAkB;QAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAErC,gDAAgD;QAChD,IAAI,cAAc,EAAE;YAClB,IAAI,YAAY,EAAE;gBAChB,MAAM,OAAO,GAAG,KAAK,CACnB,IAAI,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,EAC7D,CAAC,OAAO,EAAE,QAAQ,CAAC,CACpB,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,OAAO,IAAI,CAAC;aACpC;iBAAM;gBACL,MAAM,OAAO,GAAG,KAAK,CACnB,IAAI,CAAC,YAAY,GAAG,CAAC,YAAY,GAAG,CAAC,YAAY,GAAG,UAAU,CAAC,CAAC,EAChE,CAAC,OAAO,EAAE,QAAQ,CAAC,CACpB,CAAC;gBACF,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC;aACrC;SACF;QAED,kBAAkB;QAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAErC,4BAA4B;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACnC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF"}

package/lib/esm/components/ScrollBar/index.js

@@ -1,10 +1,14 @@
 import { selectOne } from 'vevet-dom';
-import Bar from './Bar';
+import { Bar } from './Bar';
 import { Component as ComponentClass } from '../../base/Component';
 import { onResize } from '../../utils/listeners/onResize';
 import { getApp } from '../../utils/internal/getApp';
 /**
- * Create custom scroll bar
+ * A custom scroll bar component that can be added to custom or native scroll containers.
+ * It supports both horizontal and vertical scroll bars, auto-hide functionality,
+ * and drag-to-scroll.
+ *
+ * @requires Requires styles: `@import '~vevet/lib/styles/components/ScrollBar';`
  */
 export class ScrollBar extends ComponentClass {
     _getDefaultProps() {
@@ -13,11 +17,15 @@ export class ScrollBar extends ComponentClass {
     get prefix() {
         return `${getApp().prefix}scrollbar`;
     }
-    /** Scroll container */
+    /**
+     * The container element or window where the scroll is applied.
+     */
     get container() {
         return this._container;
     }
-    /** Scrollable element */
+    /**
+     * Returns the scrollable element within the container.
+     */
     get scrollableElement() {
         const { container } = this;
         if (container instanceof Window) {
@@ -29,7 +37,7 @@ export class ScrollBar extends ComponentClass {
         return container.container;
     }
     /**
-     * The element where scrollbars will be appended
+     * Returns the DOM element where the scroll bars will be appended.
      */
     get domParent() {
         const { domParent } = this.props;
@@ -45,6 +53,20 @@ export class ScrollBar extends ComponentClass {
         }
         return container.container;
     }
+    /**
+     * Returns the horizontal scroll bar instance.
+     * @ignore
+     */
+    get xBar() {
+        return this._xBar;
+    }
+    /**
+     * Returns the vertical scroll bar instance.
+     * @ignore
+     */
+    get yBar() {
+        return this._yBar;
+    }
     constructor(initialProps, canInit = true) {
         super(initialProps, false);
         const { container } = this.props;
@@ -55,7 +77,7 @@ export class ScrollBar extends ComponentClass {
                 this._container = element;
             }
             else {
-                throw new Error('No scroll container');
+                throw new Error('No scroll container found');
             }
         }
         else {
@@ -72,42 +94,54 @@ export class ScrollBar extends ComponentClass {
             this.init();
         }
     }
+    /**
+     * Initializes the ScrollBar component.
+     */
     _init() {
         super._init();
         this._setEvents();
     }
-    // Set Module Events
+    /**
+     * Sets event listeners for the component.
+     */
     _setEvents() {
         const { container, props } = this;
         // default resize handler
         const resizeHandler = onResize({
             onResize: () => this.resize(),
-            element: [this._xBar.outer, this._yBar.outer],
+            element: [this.xBar.outer, this.yBar.outer],
             viewportTarget: 'any',
             hasBothEvents: true,
             resizeDebounce: props.resizeDebounce,
         });
-        // resize for smoothscroll
-        const smoothScrollResize = 'isSmoothScroll' in container
+        // resize for custom scroll
+        const scrollResize = 'isCustomScroll' in container
             ? container.addCallback('resize', () => resizeHandler.debounceResize(), { name: this.name })
             : undefined;
         this.addDestroyableAction(() => {
             resizeHandler.remove();
-            smoothScrollResize === null || smoothScrollResize === void 0 ? void 0 : smoothScrollResize.remove();
+            scrollResize === null || scrollResize === void 0 ? void 0 : scrollResize.remove();
         });
         // initial resize
         resizeHandler.resize();
     }
+    /**
+     * Handles the mutation of the properties and updates the component accordingly.
+     */
     _onPropsMutate() {
         super._onPropsMutate();
         this.resize();
     }
-    /** Resize the scene */
+    /**
+     * Resizes the scene and updates the scroll bars.
+     */
     resize() {
-        this._xBar.resize();
-        this._yBar.resize();
+        this.xBar.resize();
+        this.yBar.resize();
     }
-    /** Destroy the module */
+    /**
+     * Destroys the scroll bar component and cleans up.
+     */
     _destroy() {
         super._destroy();
         // destroy bars

package/lib/esm/components/ScrollBar/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/ScrollBar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,GAAG,MAAM,OAAO,CAAC;AAExB,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAIjD;;GAEG;AACH,MAAM,OAAO,SAMX,SAAQ,cAA4D;IAC1D,gBAAgB;QACxB,uCACK,KAAK,CAAC,gBAAgB,EAAE,KAC3B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,KAAK,EAChB,cAAc,EAAE,EAAE,EAClB,WAAW,EAAE,IAAI,EACjB,cAAc,EAAE,IAAI,EACpB,WAAW,EAAE,IAAI,EACjB,OAAO,EAAE,EAAE,EACX,cAAc,EAAE,QAAQ,IACxB;IACJ,CAAC;IAED,IAAI,MAAM;QACR,OAAO,GAAG,MAAM,EAAE,CAAC,MAAM,WAAW,CAAC;IACvC,CAAC;IAKD,uBAAuB;IACvB,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yBAAyB;IACzB,IAAI,iBAAiB;QACnB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAE3B,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC;SACtB;QAED,IAAI,SAAS,YAAY,OAAO,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,IAAI,SAAS,EAAE;YACb,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAE3B,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC;SACtB;QAED,IAAI,SAAS,YAAY,OAAO,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAQD,YAAY,YAA4C,EAAE,OAAO,GAAG,IAAI;QACtE,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAE3B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,gBAAgB;QAChB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;YACrC,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;aAC3B;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;aACxC;SACF;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAgB,CAAC;SACpC;QAED,cAAc;QACd,MAAM,QAAQ,mCACT,IAAI,CAAC,KAAK,KACb,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,MAAM,EAAE,IAAI,CAAC,MAAM,GACpB,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,iCACf,QAAQ,KACX,SAAS,EAAE,GAAG,IACd,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,iCACf,QAAQ,KACX,SAAS,EAAE,GAAG,IACd,CAAC;QAEH,iBAAiB;QACjB,IAAI,CAAC,eAAe,CAClB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EACzB,IAAI,CACL,CAAC;QAEF,uBAAuB;QACvB,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,IAAI,EAAE,CAAC;SACb;IACH,CAAC;IAES,KAAK;QACb,KAAK,CAAC,KAAK,EAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,oBAAoB;IACV,UAAU;QAClB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAElC,yBAAyB;QACzB,MAAM,aAAa,GAAG,QAAQ,CAAC;YAC7B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;YAC7B,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YAC7C,cAAc,EAAE,KAAK;YACrB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK,CAAC,cAAc;SACrC,CAAC,CAAC;QAEH,0BAA0B;QAC1B,MAAM,kBAAkB,GACtB,gBAAgB,IAAI,SAAS;YAC3B,CAAC,CAAC,SAAS,CAAC,WAAW,CACnB,QAAQ,EACR,GAAG,EAAE,CAAC,aAAa,CAAC,cAAc,EAAE,EACpC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CACpB;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE;YAC7B,aAAa,CAAC,MAAM,EAAE,CAAC;YACvB,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,MAAM,EAAE,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,iBAAiB;QACjB,aAAa,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAES,cAAc;QACtB,KAAK,CAAC,cAAc,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED,uBAAuB;IAChB,MAAM;QACX,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;IAED,yBAAyB;IACf,QAAQ;QAChB,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEjB,eAAe;QACf,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/ScrollBar/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAIjD;;;;;;GAMG;AACH,MAAM,OAAO,SAMX,SAAQ,cAA4D;IAC1D,gBAAgB;QACxB,uCACK,KAAK,CAAC,gBAAgB,EAAE,KAC3B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,KAAK,EAChB,cAAc,EAAE,EAAE,EAClB,WAAW,EAAE,IAAI,EACjB,cAAc,EAAE,IAAI,EACpB,WAAW,EAAE,IAAI,EACjB,OAAO,EAAE,EAAE,EACX,cAAc,EAAE,QAAQ,IACxB;IACJ,CAAC;IAED,IAAI,MAAM;QACR,OAAO,GAAG,MAAM,EAAE,CAAC,MAAM,WAAW,CAAC;IACvC,CAAC;IAKD;;OAEG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,iBAAiB;QACnB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAE3B,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC;SACtB;QAED,IAAI,SAAS,YAAY,OAAO,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,IAAI,SAAS,EAAE;YACb,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAE3B,IAAI,SAAS,YAAY,MAAM,EAAE;YAC/B,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC;SACtB;QAED,IAAI,SAAS,YAAY,OAAO,EAAE;YAChC,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IAQD;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAQD;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,YAAY,YAA4C,EAAE,OAAO,GAAG,IAAI;QACtE,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAE3B,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAEjC,gBAAgB;QAChB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;YACrC,IAAI,OAAO,EAAE;gBACX,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;aAC3B;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;aAC9C;SACF;aAAM;YACL,IAAI,CAAC,UAAU,GAAG,SAAgB,CAAC;SACpC;QAED,cAAc;QACd,MAAM,QAAQ,mCACT,IAAI,CAAC,KAAK,KACb,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,SAAS,EAAE,IAAI,CAAC,SAAS,EACzB,MAAM,EAAE,IAAI,CAAC,MAAM,GACpB,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,iCACf,QAAQ,KACX,SAAS,EAAE,GAAG,IACd,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,iCACf,QAAQ,KACX,SAAS,EAAE,GAAG,IACd,CAAC;QAEH,iBAAiB;QACjB,IAAI,CAAC,eAAe,CAClB,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EACzB,IAAI,CACL,CAAC;QAEF,uBAAuB;QACvB,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,IAAI,EAAE,CAAC;SACb;IACH,CAAC;IAED;;OAEG;IACO,KAAK;QACb,KAAK,CAAC,KAAK,EAAE,CAAC;QAEd,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACO,UAAU;QAClB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAElC,yBAAyB;QACzB,MAAM,aAAa,GAAG,QAAQ,CAAC;YAC7B,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;YAC7B,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;YAC3C,cAAc,EAAE,KAAK;YACrB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,KAAK,CAAC,cAAc;SACrC,CAAC,CAAC;QAEH,2BAA2B;QAC3B,MAAM,YAAY,GAChB,gBAAgB,IAAI,SAAS;YAC3B,CAAC,CAAC,SAAS,CAAC,WAAW,CACnB,QAAQ,EACR,GAAG,EAAE,CAAC,aAAa,CAAC,cAAc,EAAE,EACpC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CACpB;YACH,CAAC,CAAC,SAAS,CAAC;QAEhB,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE;YAC7B,aAAa,CAAC,MAAM,EAAE,CAAC;YACvB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,iBAAiB;QACjB,aAAa,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACO,cAAc;QACtB,KAAK,CAAC,cAAc,EAAE,CAAC;QAEvB,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,MAAM;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IAED;;OAEG;IACO,QAAQ;QAChB,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEjB,eAAe;QACf,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;CACF"}

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

@@ -4,17 +4,23 @@ import { clamp } from '../../utils/math';
 import { normalizedTimeoutCallback } from '../../utils/common';
 import { getApp } from '../../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.
  */
 export class ScrollView extends ComponentClass {
     _getDefaultProps() {
         return Object.assign(Object.assign({}, super._getDefaultProps()), { intersectionRoot: null, isEnabled: true, rootMargin: 0.05, states: 'in', classToToggle: 'viewed', hasDelay: true, maxDelay: 1000, direction: 'vertical', viewportTarget: 'any', resizeDebounce: 0 });
     }
-    /** If first start */
+    /**
+     * Returns whether this is the first start of observing elements.
+     */
     get isFirstStart() {
         return this._isFirstStart;
     }
-    /** Elements */
+    /**
+     * Returns the elements being observed by the `ScrollView`.
+     */
     get elements() {
         return this._elements;
     }
@@ -23,7 +29,7 @@ export class ScrollView extends ComponentClass {
         this._isFirstStart = true;
         this._elements = [];
         this._isIntersectionObserverSupported = isIntersectionObserverSupported();
-        // initialize the class
+        // initialize the class if requested
         if (canInit) {
             this.init();
         }
@@ -36,22 +42,29 @@ export class ScrollView extends ComponentClass {
         super._onPropsMutate();
         this.resize();
     }
-    /** Set class events */
+    /**
+     * Sets up the events needed for viewport resizing and element observation.
+     */
     _setEvents() {
         const { viewportTarget, resizeDebounce } = this.props;
         this.resize();
+        // Set up a viewport callback to trigger the resize method
         this.addViewportCallback(viewportTarget, () => this.resize(), {
             timeout: resizeDebounce,
         });
     }
-    /** Resize the scene */
+    /**
+     * Triggers a resize event to update the `ScrollView` tracking of elements.
+     */
     resize() {
         this._removeViewEvents();
         if (this.props.isEnabled) {
             this._setViewEvents();
         }
     }
-    /** Root bounding rect */
+    /**
+     * Returns the bounding rectangle for the root element or the viewport.
+     */
     get rootBounding() {
         const { props } = this;
         if (props.intersectionRoot) {
@@ -71,12 +84,15 @@ export class ScrollView extends ComponentClass {
             height: viewport.height,
         };
     }
-    /** Set view events */
+    /**
+     * Sets up the `IntersectionObserver` to detect when elements come into view.
+     */
     _setViewEvents() {
         if (!this._isIntersectionObserverSupported) {
             return;
         }
         const { rootBounding, isFirstStart, props } = this;
+        // Calculate margins for intersection detection
         const xMargin = isFirstStart
             ? 0
             : rootBounding.width * props.rootMargin * -1;
@@ -98,7 +114,9 @@ export class ScrollView extends ComponentClass {
             this.elements.forEach((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`.
+     */
     _removeViewEvents() {
         var _a, _b;
         (_a = this._intersectionObserverIn) === null || _a === void 0 ? void 0 : _a.disconnect();
@@ -106,7 +124,11 @@ export class ScrollView extends ComponentClass {
         (_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.
+     */
     _handleIntersectionIn(data) {
         data.forEach((entry) => {
             if (!entry.isIntersecting) {
@@ -119,7 +141,7 @@ export class ScrollView extends ComponentClass {
                 this.removeElement(element);
             }
         });
-        // change states
+        // Mark first start complete and trigger resize
         if (this.isFirstStart) {
             this._isFirstStart = false;
             this.resize();
@@ -138,7 +160,11 @@ export class ScrollView extends ComponentClass {
             : (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.
+     */
     _handleIntersectionOut(data) {
         data.forEach((entry) => {
             if (entry.isIntersecting) {
@@ -149,7 +175,7 @@ export class ScrollView extends ComponentClass {
         });
     }
     /**
-     * Event that is triggered when an element appears or disappears
+     * Toggles classes and triggers callbacks when elements enter or leave the viewport.
      */
     _handleInOut(elementProp, isInViewport, delay = 0) {
         const { classToToggle } = this.props;
@@ -158,15 +184,15 @@ export class ScrollView extends ComponentClass {
             (!element.isScrollViewIn && !isInViewport)) {
             return;
         }
-        // update props
+        // Update element's viewport state
         element.isScrollViewIn = isInViewport;
-        // toggle classes
+        // Toggle class for the element
         if (classToToggle) {
             normalizedTimeoutCallback(() => {
                 element.classList.toggle(classToToggle, isInViewport);
             }, delay);
         }
-        // process callbacks
+        // Trigger appropriate callback
         if (isInViewport) {
             normalizedTimeoutCallback(() => {
                 this.callbacks.tbt('in', { element });
@@ -178,7 +204,9 @@ export class ScrollView extends ComponentClass {
             }, delay);
         }
     }
-    /** Add an element */
+    /**
+     * Adds an element to the observer list and starts tracking its visibility in the viewport.
+     */
     addElement(elementProp) {
         var _a, _b;
         const element = elementProp;
@@ -195,7 +223,11 @@ export class ScrollView extends ComponentClass {
             remove: () => 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.
+     */
     removeElement(elementProp) {
         var _a, _b;
         const element = elementProp;
@@ -204,12 +236,16 @@ export class ScrollView extends ComponentClass {
         element.isScrollViewIn = undefined;
         this._elements = this._elements.filter((el) => el !== element);
     }
-    /** Remove all elements */
+    /**
+     * Stops observing all elements and clears the observer list.
+     */
     removeElements() {
         this._elements.forEach((element) => this.removeElement(element));
         this._elements = [];
     }
-    /** Destroy the module */
+    /**
+     * Destroys the `ScrollView` and disconnects all observers and listeners.
+     */
     _destroy() {
         super._destroy();
         this._removeViewEvents();