vevet 3.20.0 → 4.0.0-beta.0

package/lib/types/components/ScrollBar/Bar/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,SAAS,EAAE,MAAM,SAAS,CAAC;AAO7C,MAAM,CAAC,OAAO,OAAO,GAAG;IAuEV,OAAO,CAAC,MAAM;IAtE1B,OAAO,CAAC,MAAM,CAAc;IAE5B,IAAI,KAAK,gBAER;IAED,OAAO,CAAC,MAAM,CAAc;IAE5B,IAAI,KAAK,gBAER;IAED,IAAI,MAAM,WAET;IAED,IAAI,YAAY,YAEf;IAED,IAAI,UAAU,YAEb;IAED,IAAI,aAAa,sLAIhB;IAED,IAAI,UAAU,WAMb;IAED,IAAI,WAAW,WAEd;IAED,IAAI,YAAY,WAEf;IAED,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,WAAW,CAAS;IAE5B,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO,CAAC,kBAAkB,CAAU;IAEpC,OAAO,CAAC,UAAU,CAAC,CAAsB;IAEzC,OAAO,CAAC,YAAY,CAAC,CAAa;IAElC,OAAO,CAAC,cAAc,CAAC,CAAiB;IAExC,OAAO,CAAC,QAAQ,CAAC,CAAc;IAE/B,IAAI,KAAK,cAER;gBAEmB,MAAM,EAAE,SAAS;IAiCrC,OAAO,CAAC,SAAS;IAIjB,2BAA2B;IAC3B,OAAO,CAAC,UAAU;IA8BlB,oBAAoB;IACpB,OAAO,CAAC,aAAa;IAMrB,yBAAyB;IACzB,OAAO,CAAC,YAAY;IAMpB,0BAA0B;IAC1B,OAAO,CAAC,aAAa;IAqCrB,4BAA4B;IAC5B,OAAO,CAAC,gBAAgB;IAqCxB,mBAAmB;IACnB,OAAO,CAAC,YAAY;IAapB,uBAAuB;IAChB,MAAM;IA4CN,OAAO;CASf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAOpC;;GAEG;AACH,qBAAa,GAAG;IA0GF,OAAO,CAAC,MAAM;IAzG1B,oDAAoD;IACpD,OAAO,CAAC,MAAM,CAAc;IAE5B;;OAEG;IACH,IAAI,KAAK,gBAER;IAED,mCAAmC;IACnC,OAAO,CAAC,MAAM,CAAc;IAE5B;;OAEG;IACH,IAAI,KAAK,gBAER;IAED,mDAAmD;IACnD,OAAO,CAAC,YAAY,CAAK;IAEzB,kDAAkD;IAClD,OAAO,CAAC,WAAW,CAAK;IAExB,yBAAyB;IACzB,OAAO,CAAC,YAAY,CAAK;IAEzB,wBAAwB;IACxB,OAAO,CAAC,WAAW,CAAK;IAExB,sDAAsD;IACtD,OAAO,CAAC,gBAAgB,CAAK;IAE7B,4EAA4E;IAC5E,OAAO,CAAC,kBAAkB,CAAmC;IAE7D,yCAAyC;IACzC,OAAO,CAAC,UAAU,CAA2B;IAE7C,+BAA+B;IAC/B,OAAO,CAAC,YAAY,CAAC,CAAa;IAElC,8CAA8C;IAC9C,OAAO,CAAC,cAAc,CAAC,CAAiB;IAExC,mDAAmD;IACnD,OAAO,CAAC,QAAQ,CAAC,CAAc;IAE/B;;OAEG;IACH,IAAI,YAAY,YAEf;IAED;;OAEG;IACH,IAAI,UAAU,YAEb;IAED;;OAEG;IACH,IAAI,aAAa,sLAIhB;IAED;;OAEG;IACH,IAAI,UAAU,WAMb;IAED;;OAEG;IACH,IAAI,WAAW,WAEd;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAI,KAAK,cAER;gBAEmB,MAAM,EAAE,SAAS;IAyBrC;;;OAGG;IACH,OAAO,CAAC,SAAS;IAIjB;;OAEG;IACH,OAAO,CAAC,UAAU;IA6BlB;;OAEG;IACH,OAAO,CAAC,aAAa;IAMrB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAKpB;;;OAGG;IACH,OAAO,CAAC,aAAa;IAoCrB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAoCxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAapB;;OAEG;IACI,MAAM;IA4Cb;;OAEG;IACI,OAAO;CASf"}

package/lib/types/components/ScrollBar/Bar/types.d.ts

@@ -1,29 +1,51 @@
-import type { SmoothScroll } from '../../SmoothScroll';
+import type { CustomScroll } from '../../CustomScroll';
+/**
+ * Properties for configuring the behavior and appearance of a custom scroll bar.
+ */
 export interface IBarProps {
-    /** Scrollable container */
-    container: Window | SmoothScroll | Element;
-    /** DOM parent, where the scrollbar will be appended */
+    /**
+     * The scrollable container element.
+     * It can be the browser `window`, a custom scroll instance, or an HTML element.
+     */
+    container: Window | CustomScroll | Element;
+    /**
+     * The parent element where the scroll bar will be appended.
+     * This is the DOM element that will contain the scroll bar.
+     */
     domParent: Element;
-    /** Scrollbar type: horizontal or vertical */
+    /**
+     * The scroll bar's orientation or direction.
+     * Can be either horizontal ('x') or vertical ('y').
+     */
     direction: 'x' | 'y';
-    /** Hide scrollbars when not active */
+    /**
+     * If `true`, the scroll bars will be hidden when inactive.
+     * The scroll bar will only become visible during scrolling or interactions.
+     */
     canAutoHide: boolean;
-    /** Use auto-size */
+    /**
+     * If `true`, the size of the scroll bar's thumb will adjust automatically
+     * based on the content length and the viewport size.
+     */
     shouldAutoSize: boolean;
     /**
-     * Minimum size of the scrollbar thumb.
-     * Works when `hasAutoSize` is `true`
+     * The minimum size of the scroll bar's thumb.
+     * This property is only applied when `shouldAutoSize` is `true`.
      */
     minSize: number;
-    /** Prefix */
+    /**
+     * A prefix used for generating class names or other identifiers for the scroll bar elements.
+     */
     prefix: string;
-    /** Scrollbars are draggable */
+    /**
+     * If `true`, the scroll bars will be draggable, allowing users to drag the thumb to scroll.
+     */
     isDraggable: boolean;
-    /** ScrollBehavior when dragging (works only for `SmoothScroll`) */
+    /**
+     * Defines the scroll behavior during dragging for custom scroll instances.
+     * This property determines whether the scroll will be smooth or immediate ('auto').
+     * This option is only applicable for `CustomScroll` instances.
+     */
     scrollBehavior: 'smooth' | 'auto';
 }
-export interface ICoords {
-    scrollLeft: number;
-    scrollTop: number;
-}
 //# sourceMappingURL=types.d.ts.map

package/lib/types/components/ScrollBar/Bar/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,MAAM,WAAW,SAAS;IACxB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;IAC3C,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,SAAS,EAAE,GAAG,GAAG,GAAG,CAAC;IACrB,sCAAsC;IACtC,WAAW,EAAE,OAAO,CAAC;IACrB,oBAAoB;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,WAAW,EAAE,OAAO,CAAC;IACrB,mEAAmE;IACnE,cAAc,EAAE,QAAQ,GAAG,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/components/ScrollBar/Bar/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,CAAC;IAE3C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,GAAG,GAAG,GAAG,CAAC;IAErB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,cAAc,EAAE,QAAQ,GAAG,MAAM,CAAC;CACnC"}

package/lib/types/components/ScrollBar/index.d.ts

@@ -1,10 +1,14 @@
-import type { SmoothScroll } from '../SmoothScroll';
-import Bar from './Bar';
+import type { CustomScroll } from '../CustomScroll';
+import { Bar } from './Bar';
 import { NScrollBar } from './types';
 import { Component as ComponentClass } from '../../base/Component';
 export type { NScrollBar };
 /**
- * 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 declare class ScrollBar<StaticProps extends NScrollBar.IStaticProps = NScrollBar.IStaticProps, ChangeableProps extends NScrollBar.IChangeableProps = NScrollBar.IChangeableProps, CallbacksTypes extends NScrollBar.ICallbacksTypes = NScrollBar.ICallbacksTypes> extends ComponentClass<StaticProps, ChangeableProps, CallbacksTypes> {
     protected _getDefaultProps(): {
@@ -19,26 +23,59 @@ export declare class ScrollBar<StaticProps extends NScrollBar.IStaticProps = NSc
     };
     get prefix(): string;
     /** Scroll container */
-    protected _container: Element | Window | SmoothScroll;
-    /** Scroll container */
-    get container(): Window | Element | SmoothScroll<import("../SmoothScroll").NSmoothScroll.IStaticProps, import("../SmoothScroll").NSmoothScroll.IChangeableProps, import("../SmoothScroll").NSmoothScroll.ICallbacksTypes>;
-    /** Scrollable element */
+    protected _container: Element | Window | CustomScroll;
+    /**
+     * The container element or window where the scroll is applied.
+     */
+    get container(): Window | Element | CustomScroll<import("../CustomScroll").NCustomScroll.IStaticProps, import("../CustomScroll").NCustomScroll.IChangeableProps, import("../CustomScroll").NCustomScroll.ICallbacksTypes>;
+    /**
+     * Returns the scrollable element within the container.
+     */
     get scrollableElement(): Element;
     /**
-     * The element where scrollbars will be appended
+     * Returns the DOM element where the scroll bars will be appended.
      */
     get domParent(): Element;
-    /** Horizontal scrollbar */
+    /**
+     * Horizontal scrollbar instance
+     * @ignore
+     */
     protected _xBar: Bar;
-    /** Vertical scrollbar */
+    /**
+     * Returns the horizontal scroll bar instance.
+     * @ignore
+     */
+    get xBar(): Bar;
+    /**
+     * Vertical scrollbar instance
+     * @ignore
+     */
     protected _yBar: Bar;
+    /**
+     * Returns the vertical scroll bar instance.
+     * @ignore
+     */
+    get yBar(): Bar;
     constructor(initialProps?: StaticProps & ChangeableProps, canInit?: boolean);
+    /**
+     * Initializes the ScrollBar component.
+     */
     protected _init(): void;
+    /**
+     * Sets event listeners for the component.
+     */
     protected _setEvents(): void;
+    /**
+     * Handles the mutation of the properties and updates the component accordingly.
+     */
     protected _onPropsMutate(): void;
-    /** Resize the scene */
+    /**
+     * Resizes the scene and updates the scroll bars.
+     */
     resize(): void;
-    /** Destroy the module */
+    /**
+     * Destroys the scroll bar component and cleans up.
+     */
     protected _destroy(): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/components/ScrollBar/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollBar/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAK/D,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;GAEG;AACH,qBAAa,SAAS,CACpB,WAAW,SAAS,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,EACrE,eAAe,SACb,UAAU,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,EAC3D,cAAc,SACZ,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CACzD,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;;;;;;IAc1B,IAAI,MAAM,WAET;IAED,uBAAuB;IACvB,SAAS,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC;IAEtD,uBAAuB;IACvB,IAAI,SAAS,6MAEZ;IAED,yBAAyB;IACzB,IAAI,iBAAiB,YAYpB;IAED;;OAEG;IACH,IAAI,SAAS,YAkBZ;IAED,2BAA2B;IAC3B,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;IAErB,yBAAyB;IACzB,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;gBAET,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IA8CxE,SAAS,CAAC,KAAK;IAOf,SAAS,CAAC,UAAU;IA+BpB,SAAS,CAAC,cAAc;IAKxB,uBAAuB;IAChB,MAAM;IAKb,yBAAyB;IACzB,SAAS,CAAC,QAAQ;CAOnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollBar/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAK/D,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;;;;;GAMG;AACH,qBAAa,SAAS,CACpB,WAAW,SAAS,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,EACrE,eAAe,SACb,UAAU,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,EAC3D,cAAc,SACZ,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CACzD,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;;;;;;IAc1B,IAAI,MAAM,WAET;IAED,uBAAuB;IACvB,SAAS,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,YAAY,CAAC;IAEtD;;OAEG;IACH,IAAI,SAAS,6MAEZ;IAED;;OAEG;IACH,IAAI,iBAAiB,YAYpB;IAED;;OAEG;IACH,IAAI,SAAS,YAkBZ;IAED;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;IAErB;;;OAGG;IACH,IAAI,IAAI,QAEP;IAED;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC;IAErB;;;OAGG;IACH,IAAI,IAAI,QAEP;gBAEW,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IAgDxE;;OAEG;IACH,SAAS,CAAC,KAAK;IAMf;;OAEG;IACH,SAAS,CAAC,UAAU;IA+BpB;;OAEG;IACH,SAAS,CAAC,cAAc;IAMxB;;OAEG;IACI,MAAM;IAKb;;OAEG;IACH,SAAS,CAAC,QAAQ;CAOnB"}

package/lib/types/components/ScrollBar/types.d.ts

@@ -1,22 +1,24 @@
 import { NComponent } from '../../base/Component/types';
-import type { SmoothScroll } from '../SmoothScroll';
+import type { CustomScroll } from '../CustomScroll';
 import { IBarProps } from './Bar/types';
 type TPickedProps = 'isDraggable' | 'shouldAutoSize' | 'canAutoHide' | 'minSize' | 'scrollBehavior';
 export declare namespace NScrollBar {
     interface IStaticProps extends NComponent.IStaticProps, Partial<Pick<IBarProps, TPickedProps>> {
         /**
-         * The scrollable element
+         * The scrollable element to which the scroll bar will be applied.
+         * Can be the window, a custom scroll instance, or an HTML element.
          * @default window
          */
-        container?: Window | SmoothScroll | Element | string;
+        container?: Window | CustomScroll | Element | string;
         /**
-         * The element that will contain the scrollbar.
-         * If false, the property 'container' will be taken.
+         * The element where the scroll bars will be rendered.
+         * If `false`, the scroll bar will be appended to the `container`.
          * @default false
          */
         domParent?: false | Element;
         /**
-         * Timeout of resize event
+         * Timeout value (in milliseconds) to debounce the resize event.
+         * This helps avoid multiple rapid invocations of resize handling.
          * @default 16
          */
         resizeDebounce?: number;

package/lib/types/components/ScrollBar/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollBar/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,KAAK,YAAY,GACb,aAAa,GACb,gBAAgB,GAChB,aAAa,GACb,SAAS,GACT,gBAAgB,CAAC;AAErB,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,YACf,SAAQ,UAAU,CAAC,YAAY,EAC7B,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACxC;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;QACrD;;;;WAIG;QACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC;QAC5B;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,gBAAiB,SAAQ,UAAU,CAAC,gBAAgB;KAAG;IAExE,UAAiB,eAAgB,SAAQ,UAAU,CAAC,eAAe;KAAG;CACvE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollBar/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,KAAK,YAAY,GACb,aAAa,GACb,gBAAgB,GAChB,aAAa,GACb,SAAS,GACT,gBAAgB,CAAC;AAErB,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,YACf,SAAQ,UAAU,CAAC,YAAY,EAC7B,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACxC;;;;WAIG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,MAAM,CAAC;QAErD;;;;WAIG;QACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC;QAE5B;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,gBAAiB,SAAQ,UAAU,CAAC,gBAAgB;KAAG;IAExE,UAAiB,eAAgB,SAAQ,UAAU,CAAC,eAAe;KAAG;CACvE"}

package/lib/types/components/ScrollView/index.d.ts

@@ -3,7 +3,9 @@ import { NScrollView } from './types';
 import { IRemovable } from '../../types/general';
 export type { NScrollView };
 /**
- * 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 declare class ScrollView<StaticProps extends NScrollView.IStaticProps = NScrollView.IStaticProps, ChangeableProps extends NScrollView.IChangeableProps = NScrollView.IChangeableProps, CallbacksTypes extends NScrollView.ICallbacksTypes = NScrollView.ICallbacksTypes> extends ComponentClass<StaticProps, ChangeableProps, CallbacksTypes> {
     protected _getDefaultProps(): {
@@ -18,55 +20,97 @@ export declare class ScrollView<StaticProps extends NScrollView.IStaticProps = N
         viewportTarget: string;
         resizeDebounce: number;
     };
-    /** Intersection observer - type IN */
+    /**
+     * Intersection observer for detecting when elements come into view.
+     */
     protected _intersectionObserverIn?: IntersectionObserver;
-    /** Intersection observer - type OUT */
+    /**
+     * Intersection observer for detecting when elements leave the view.
+     */
     protected _intersectionObserverOut?: IntersectionObserver;
-    /** If first start */
+    /**
+     * Tracks if this is the first time the elements are being observed.
+     */
     protected _isFirstStart: boolean;
-    /** If first start */
+    /**
+     * Returns whether this is the first start of observing elements.
+     */
     get isFirstStart(): boolean;
-    /** Elements */
+    /**
+     * Stores the elements being observed for entering and leaving the viewport.
+     */
     protected _elements: NScrollView.IElement[];
-    /** If intersection observer is supported */
-    protected _isIntersectionObserverSupported: boolean;
-    /** Elements */
+    /**
+     * Returns the elements being observed by the `ScrollView`.
+     */
     get elements(): NScrollView.IElement[];
+    /**
+     * Indicates whether the `IntersectionObserver` API is supported in the current environment.
+     */
+    protected _isIntersectionObserverSupported: boolean;
     constructor(initialProps?: StaticProps & ChangeableProps, canInit?: boolean);
     protected _init(): void;
     protected _onPropsMutate(): void;
-    /** Set class events */
+    /**
+     * Sets up the events needed for viewport resizing and element observation.
+     */
     protected _setEvents(): void;
-    /** Resize the scene */
+    /**
+     * Triggers a resize event to update the `ScrollView` tracking of elements.
+     */
     resize(): void;
-    /** Root bounding rect */
+    /**
+     * Returns the bounding rectangle for the root element or the viewport.
+     */
     protected get rootBounding(): {
         top: number;
         left: number;
         width: number;
         height: number;
     };
-    /** Set view events */
+    /**
+     * Sets up the `IntersectionObserver` to detect when elements come into view.
+     */
     protected _setViewEvents(): void;
-    /** Remove View events */
+    /**
+     * Removes the view observation events by disconnecting the `IntersectionObserver`.
+     */
     protected _removeViewEvents(): void;
-    /** Event on IntersectionObserver In */
+    /**
+     * Handles when elements come into the viewport.
+     *
+     * @param data - The intersection data for the observed elements.
+     */
     protected _handleIntersectionIn(data: IntersectionObserverEntry[]): void;
     /** Get element delay */
     protected _getElementDelay(element: NScrollView.IElement): number;
-    /** Event on IntersectionObserver Out */
+    /**
+     * Handles when elements leave the viewport.
+     *
+     * @param data - The intersection data for the observed elements.
+     */
     protected _handleIntersectionOut(data: IntersectionObserverEntry[]): void;
     /**
-     * Event that is triggered when an element appears or disappears
+     * Toggles classes and triggers callbacks when elements enter or leave the viewport.
      */
     protected _handleInOut(elementProp: NScrollView.IElement, isInViewport: boolean, delay?: number): void;
-    /** Add an element */
+    /**
+     * Adds an element to the observer list and starts tracking its visibility in the viewport.
+     */
     addElement(elementProp: Element): IRemovable;
-    /** Remove an element */
+    /**
+     * Stops observing an element and removes it from the observer list.
+     *
+     * @param {Element} elementProp - The element to stop observing.
+     */
     removeElement(elementProp: Element): void;
-    /** Remove all elements */
+    /**
+     * Stops observing all elements and clears the observer list.
+     */
     removeElements(): void;
-    /** Destroy the module */
+    /**
+     * Destroys the `ScrollView` and disconnects all observers and listeners.
+     */
     protected _destroy(): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/components/ScrollView/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollView/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;GAEG;AACH,qBAAa,UAAU,CACrB,WAAW,SAAS,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EACvE,eAAe,SACb,WAAW,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,EAC7D,cAAc,SACZ,WAAW,CAAC,eAAe,GAAG,WAAW,CAAC,eAAe,CAC3D,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;;;;;;;;IAgB1B,sCAAsC;IACtC,SAAS,CAAC,uBAAuB,CAAC,EAAE,oBAAoB,CAAC;IAEzD,uCAAuC;IACvC,SAAS,CAAC,wBAAwB,CAAC,EAAE,oBAAoB,CAAC;IAE1D,qBAAqB;IACrB,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IAEjC,qBAAqB;IACrB,IAAI,YAAY,YAEf;IAED,eAAe;IACf,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE5C,4CAA4C;IAC5C,SAAS,CAAC,gCAAgC,EAAE,OAAO,CAAC;IAEpD,eAAe;IACf,IAAI,QAAQ,2BAEX;gBAEW,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IAaxE,SAAS,CAAC,KAAK;IAMf,SAAS,CAAC,cAAc;IAMxB,uBAAuB;IACvB,SAAS,CAAC,UAAU;IAUpB,uBAAuB;IAChB,MAAM;IAQb,yBAAyB;IACzB,SAAS,KAAK,YAAY;;;;;MAsBzB;IAED,sBAAsB;IACtB,SAAS,CAAC,cAAc;IA4CxB,yBAAyB;IACzB,SAAS,CAAC,iBAAiB;IAQ3B,uCAAuC;IACvC,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,EAAE;IAuBjE,wBAAwB;IACxB,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,QAAQ;IAoBxD,wCAAwC;IACxC,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,yBAAyB,EAAE;IAWlE;;OAEG;IACH,SAAS,CAAC,YAAY,CACpB,WAAW,EAAE,WAAW,CAAC,QAAQ,EACjC,YAAY,EAAE,OAAO,EACrB,KAAK,SAAI;IAkCX,qBAAqB;IACd,UAAU,CAAC,WAAW,EAAE,OAAO,GAAG,UAAU;IAmBnD,wBAAwB;IACjB,aAAa,CAAC,WAAW,EAAE,OAAO;IAUzC,0BAA0B;IACnB,cAAc;IAKrB,yBAAyB;IACzB,SAAS,CAAC,QAAQ;CAKnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/ScrollView/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;;;GAIG;AACH,qBAAa,UAAU,CACrB,WAAW,SAAS,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,EACvE,eAAe,SACb,WAAW,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,EAC7D,cAAc,SACZ,WAAW,CAAC,eAAe,GAAG,WAAW,CAAC,eAAe,CAC3D,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;;;;;;;;IAgB1B;;OAEG;IACH,SAAS,CAAC,uBAAuB,CAAC,EAAE,oBAAoB,CAAC;IAEzD;;OAEG;IACH,SAAS,CAAC,wBAAwB,CAAC,EAAE,oBAAoB,CAAC;IAE1D;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC;IAEjC;;OAEG;IACH,IAAI,YAAY,YAEf;IAED;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC;IAE5C;;OAEG;IACH,IAAI,QAAQ,2BAEX;IAED;;OAEG;IACH,SAAS,CAAC,gCAAgC,EAAE,OAAO,CAAC;gBAExC,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IAaxE,SAAS,CAAC,KAAK;IAMf,SAAS,CAAC,cAAc;IAMxB;;OAEG;IACH,SAAS,CAAC,UAAU;IAWpB;;OAEG;IACI,MAAM;IAQb;;OAEG;IACH,SAAS,KAAK,YAAY;;;;;MAsBzB;IAED;;OAEG;IACH,SAAS,CAAC,cAAc;IA6CxB;;OAEG;IACH,SAAS,CAAC,iBAAiB;IAQ3B;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,yBAAyB,EAAE;IAuBjE,wBAAwB;IACxB,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,QAAQ;IAoBxD;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,yBAAyB,EAAE;IAWlE;;OAEG;IACH,SAAS,CAAC,YAAY,CACpB,WAAW,EAAE,WAAW,CAAC,QAAQ,EACjC,YAAY,EAAE,OAAO,EACrB,KAAK,SAAI;IAkCX;;OAEG;IACI,UAAU,CAAC,WAAW,EAAE,OAAO,GAAG,UAAU;IAmBnD;;;;OAIG;IACI,aAAa,CAAC,WAAW,EAAE,OAAO;IAUzC;;OAEG;IACI,cAAc;IAKrB;;OAEG;IACH,SAAS,CAAC,QAAQ;CAKnB"}

package/lib/types/components/SectionScrollProgress/index.d.ts

@@ -1,67 +1,122 @@
-import type { SmoothScroll } from '../SmoothScroll';
+import type { CustomScroll } from '../CustomScroll';
 import { NScrollSectionProgress } from './types';
 import { Component as ComponentClass } from '../../base/Component';
 import { IGetScrollValues } from '../../utils/scroll';
 export type { NScrollSectionProgress };
 /**
- * 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.
  */
 export declare class SectionScrollProgress<StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps, ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps, CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes> extends ComponentClass<StaticProps, ChangeableProps, CallbacksTypes> {
     protected _getDefaultProps(): {
-        container: Window & typeof globalThis;
+        scrollContainer: Window & typeof globalThis;
         viewportTarget: string;
         resizeTimeout: number;
     };
-    /** Scroll container */
-    protected _scrollContainer: Element | SmoothScroll | Window;
-    /** Scroll container */
-    get scrollContainer(): Window | Element | SmoothScroll<import("../SmoothScroll").NSmoothScroll.IStaticProps, import("../SmoothScroll").NSmoothScroll.IChangeableProps, import("../SmoothScroll").NSmoothScroll.ICallbacksTypes>;
-    /** Section element */
+    /**
+     * The container element in which the section is being scrolled.
+     */
+    protected _scrollContainer: Element | CustomScroll | Window;
+    /**
+     * Returns the scroll container.
+     *
+     * @returns {Element | CustomScroll | Window} The scroll container.
+     */
+    get scrollContainer(): Window | Element | CustomScroll<import("../CustomScroll").NCustomScroll.IStaticProps, import("../CustomScroll").NCustomScroll.IChangeableProps, import("../CustomScroll").NCustomScroll.ICallbacksTypes>;
+    /**
+     * The section element that is being tracked for scroll progress.
+     */
     protected _section: Element;
-    /** Section element */
+    /**
+     * Returns the section element being tracked.
+     */
     get section(): Element;
-    /** Scrolling scope */
+    /**
+     * Global scope of the scrolling section, from the point it enters to the point it exits the viewport.
+     */
     protected _scopeGlobal: [number, number];
-    /** Scrolling scope */
+    /**
+     * Returns the global scope of the scrolling section.
+     */
     get scopeGlobal(): [number, number];
-    /** Scope of element appearing from bottom to top */
+    /**
+     * Scope representing the section appearing from the bottom to the top of the viewport.
+     */
     protected _scopeIn: [number, number];
-    /** Scope of element appearing from bottom to top */
+    /**
+     * Returns the scope of the section appearing in the viewport.
+     */
     get scopeIn(): [number, number];
-    /** Scope of element moving */
+    /**
+     * Scope representing the movement of the section within the viewport.
+     */
     protected _scopeMove: [number, number];
-    /** Scope of element moving */
+    /**
+     * Returns the scope of the section moving through the viewport.
+     */
     get scopeMove(): [number, number];
-    /** Scope of element disappearing from bottom to top */
+    /**
+     * Scope representing the section disappearing from the viewport, from bottom to top.
+     */
     protected _scopeOut: [number, number];
-    /** Scope of element disappearing from bottom to top */
+    /**
+     * Returns the scope of the section disappearing from the viewport.
+     */
     get scopeOut(): [number, number];
-    /** Previous global progress */
+    /**
+     * Tracks the previous progress of the global scroll.
+     */
     protected _prevProgressGlobal: number;
-    /** Global progress */
+    /**
+     * Tracks the current global progress of the scroll through the section.
+     */
     protected _progressGlobal: number;
-    /** Global progress */
+    /**
+     * Returns the current global progress of the scroll.
+     */
     get progressGlobal(): number;
     protected set progressGlobal(value: number);
+    /**
+     * Throttling index to control how often the section's rendering calculations are performed.
+     */
     protected _frameThrottleIndex: number;
     constructor(initialProps?: StaticProps & ChangeableProps, canInit?: boolean);
+    /**
+     * Initializes the `SectionScrollProgress` component and sets up scroll and resize events.
+     */
     protected _init(): void;
-    /** Set events */
+    /**
+     * Sets the resize and scroll events for monitoring the section's scroll progress.
+     */
     protected _setEvents(): void;
     protected _onPropsMutate(): void;
-    /** 'in' progress */
+    /**
+     * Returns the progress of the section as it appears in the viewport.
+     */
     get progressIn(): number;
-    /** 'out' progress */
+    /**
+     * Returns the progress of the section as it exits the viewport.
+     */
     get progressOut(): number;
-    /** 'move' progress */
+    /**
+     * Returns the progress of the section as it moves through the viewport.
+     */
     get progressMove(): number;
-    /** Resize the scene */
+    /**
+     * Resizes the section and recalculates the scroll progress.
+     */
     resize(): void;
-    /** Calculate scopes */
+    /**
+     * Calculates the scroll scopes for the section.
+     */
     protected _calculateScopes({ scrollTop }: IGetScrollValues): void;
-    /** Check if the section can be rendered */
+    /**
+     * Determines whether the section can be rendered based on scroll progress changes.
+     */
     protected _canRender(isForce?: boolean): boolean;
-    /** Render the scene */
+    /**
+     * Renders the section by updating its scroll progress and triggering callbacks.
+     */
     protected _render(scrollValues: IGetScrollValues, isForce?: boolean): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/components/SectionScrollProgress/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAA6B,MAAM,gBAAgB,CAAC;AAI7E,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEvC;;GAEG;AACH,qBAAa,qBAAqB,CAChC,WAAW,SACT,sBAAsB,CAAC,YAAY,GAAG,sBAAsB,CAAC,YAAY,EAC3E,eAAe,SACb,sBAAsB,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,gBAAgB,EACnF,cAAc,SACZ,sBAAsB,CAAC,eAAe,GAAG,sBAAsB,CAAC,eAAe,CACjF,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;IAS1B,uBAAuB;IACvB,SAAS,CAAC,gBAAgB,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;IAE5D,uBAAuB;IACvB,IAAI,eAAe,6MAElB;IAED,sBAAsB;IACtB,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE5B,sBAAsB;IACtB,IAAI,OAAO,YAEV;IAED,sBAAsB;IACtB,SAAS,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,sBAAsB;IACtB,IAAI,WAAW,qBAEd;IAED,oDAAoD;IACpD,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErC,oDAAoD;IACpD,IAAI,OAAO,qBAEV;IAED,8BAA8B;IAC9B,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC,8BAA8B;IAC9B,IAAI,SAAS,qBAEZ;IAED,uDAAuD;IACvD,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,uDAAuD;IACvD,IAAI,QAAQ,qBAEX;IAED,+BAA+B;IAC/B,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAC;IAEtC,sBAAsB;IACtB,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAElC,sBAAsB;IACtB,IAAI,cAAc,WAEjB;IAED,SAAS,KAAK,cAAc,CAAC,KAAK,QAAA,EAEjC;IAED,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAC;gBAE1B,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IA8BxE,SAAS,CAAC,KAAK;IAMf,iBAAiB;IACjB,SAAS,CAAC,UAAU;IA4BpB,SAAS,CAAC,cAAc;IAMxB,oBAAoB;IACpB,IAAI,UAAU,WAEb;IAED,qBAAqB;IACrB,IAAI,WAAW,WAEd;IAED,sBAAsB;IACtB,IAAI,YAAY,WAEf;IAED,uBAAuB;IAChB,MAAM;IAab,uBAAuB;IACvB,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,EAAE,gBAAgB;IAgB1D,2CAA2C;IAC3C,SAAS,CAAC,UAAU,CAAC,OAAO,UAAQ;IAIpC,uBAAuB;IACvB,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,gBAAgB,EAAE,OAAO,UAAQ;CAgBlE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,SAAS,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAA6B,MAAM,gBAAgB,CAAC;AAI7E,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEvC;;;GAGG;AACH,qBAAa,qBAAqB,CAChC,WAAW,SACT,sBAAsB,CAAC,YAAY,GAAG,sBAAsB,CAAC,YAAY,EAC3E,eAAe,SACb,sBAAsB,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,gBAAgB,EACnF,cAAc,SACZ,sBAAsB,CAAC,eAAe,GAAG,sBAAsB,CAAC,eAAe,CACjF,SAAQ,cAAc,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IACpE,SAAS,CAAC,gBAAgB;;;;;IAS1B;;OAEG;IACH,SAAS,CAAC,gBAAgB,EAAE,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;IAE5D;;;;OAIG;IACH,IAAI,eAAe,6MAElB;IAED;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,WAAW,qBAEd;IAED;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,OAAO,qBAEV;IAED;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,IAAI,SAAS,qBAEZ;IAED;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,QAAQ,qBAEX;IAED;;OAEG;IACH,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,IAAI,cAAc,WAEjB;IAED,SAAS,KAAK,cAAc,CAAC,KAAK,QAAA,EAEjC;IAED;;OAEG;IACH,SAAS,CAAC,mBAAmB,EAAE,MAAM,CAAC;gBAE1B,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IA8BxE;;OAEG;IACH,SAAS,CAAC,KAAK;IAMf;;OAEG;IACH,SAAS,CAAC,UAAU;IA4BpB,SAAS,CAAC,cAAc;IAMxB;;OAEG;IACH,IAAI,UAAU,WAEb;IAED;;OAEG;IACH,IAAI,WAAW,WAEd;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACI,MAAM;IAab;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,EAAE,gBAAgB;IAgB1D;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,OAAO,UAAQ;IAIpC;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,gBAAgB,EAAE,OAAO,UAAQ;CAiBlE"}

package/lib/types/components/SectionScrollProgress/types.d.ts

@@ -1,24 +1,27 @@
 import { NComponent } from '../../base/Component/types';
-import type { SmoothScroll } from '../SmoothScroll';
+import type { CustomScroll } from '../CustomScroll';
 import { TOnResizeTarget } from '../../utils/listeners/onResize';
 export declare namespace NScrollSectionProgress {
     interface IStaticProps extends NComponent.IStaticProps {
         /**
-         * Section element
+         * The section element that is being tracked for scroll progress.
+         * This can be a CSS selector or a direct reference to the element.
          */
         section: string | Element;
         /**
-         * Scrollable container
+         * The scrollable container in which the section is being scrolled.
+         * This can be a CSS selector, a reference to an element, a custom scroll instance, or the window object.
          * @default window
          */
-        container?: string | Element | SmoothScroll | Window;
+        scrollContainer?: string | Element | CustomScroll | Window;
         /**
-         * Viewport target
+         * The target viewport for observing resize events.
          * @default 'any'
          */
         viewportTarget?: TOnResizeTarget;
         /**
-         * Timeout of resize event
+         * The timeout for debouncing resize events (in milliseconds).
+         * This defines the delay before executing the resize handler.
          * @default 0
          */
         resizeDebounce?: number;
@@ -26,7 +29,13 @@ export declare namespace NScrollSectionProgress {
     interface IChangeableProps extends NComponent.IChangeableProps {
     }
     interface ICallbacksTypes extends NComponent.ICallbacksTypes {
+        /**
+         * Callback triggered during the render process when the section's scroll progress is updated.
+         */
         render: undefined;
+        /**
+         * Callback triggered when the section or viewport is resized.
+         */
         resize: undefined;
     }
 }

package/lib/types/components/SectionScrollProgress/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,YAAa,SAAQ,UAAU,CAAC,YAAY;QAC3D;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAC1B;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;QACrD;;;WAGG;QACH,cAAc,CAAC,EAAE,eAAe,CAAC;QACjC;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,gBAAiB,SAAQ,UAAU,CAAC,gBAAgB;KAAG;IAExE,UAAiB,eAAgB,SAAQ,UAAU,CAAC,eAAe;QACjE,MAAM,EAAE,SAAS,CAAC;QAClB,MAAM,EAAE,SAAS,CAAC;KACnB;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/components/SectionScrollProgress/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,YAAa,SAAQ,UAAU,CAAC,YAAY;QAC3D;;;WAGG;QACH,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAE1B;;;;WAIG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;QAE3D;;;WAGG;QACH,cAAc,CAAC,EAAE,eAAe,CAAC;QAEjC;;;;WAIG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED,UAAiB,gBAAiB,SAAQ,UAAU,CAAC,gBAAgB;KAAG;IAExE,UAAiB,eAAgB,SAAQ,UAAU,CAAC,eAAe;QACjE;;WAEG;QACH,MAAM,EAAE,SAAS,CAAC;QAElB;;WAEG;QACH,MAAM,EAAE,SAAS,CAAC;KACnB;CACF"}