vevet 3.0.0-beta.5 → 3.0.0-beta.7

package/lib/types/utils/image/load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/load.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,cAAc,CAAC;AAOvC,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,GAAG,gBAAgB,EACjC,KAAK,CAAC,EAAE,eAAe,iCAkExB"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/load.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,cAAc,CAAC;AAOvC,KAAK,eAAe,GAAG;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,MAAM,GAAG,gBAAgB,EACjC,KAAK,CAAC,EAAE,eAAe,iCAgExB"}

package/lib/types/utils/image/pathsToProps.d.ts

@@ -9,6 +9,38 @@ export interface IImageAdaptivePaths<S extends Record<string | number, string> =
 }
 /**
  * Transform image paths to properties
+ *
+ * @example
+ *
+ * imagePathsToProps({
+ *   original: '/original.jpg',
+ *   thumb: '/thumb.jpg',
+ *   thumbWebp: '/thumb.webp',
+ * });
+ * // => {"src":"/thumb.webp","srcSet":""}
+ *
+ * imagePathsToProps({
+ *   original: '/original.jpg',
+ *   thumb: '/thumb.jpg',
+ *   thumbWebp: '/thumb.webp',
+ *   sizes: {
+ *     640: '/640.jpg',
+ *     750: '/750.jpg',
+ *     1024: '/1024.jpg',
+ *     1440: '/1440.jpg',
+ *     1920: '/1920.jpg',
+ *     2560: '/2560.jpg',
+ *   },
+ *   sizesWebp: {
+ *     640: '/640.webp',
+ *     750: '/750.webp',
+ *     1024: '/1024.webp',
+ *     1440: '/1440.webp',
+ *     1920: '/1920.webp',
+ *     2560: '/2560.webp',
+ *   },
+ * });
+ * // => {"src":"/thumb.webp","srcSet":"/640.webp 640w, /750.webp 750w, /1024.webp 1024w, /1440.webp 1440w, /1920.webp 1920w, /2560.webp 2560w"}
  */
 export declare function imagePathsToProps(data: IImagePaths | IImageAdaptivePaths): {
     src: string;

package/lib/types/utils/image/pathsToProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pathsToProps.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/pathsToProps.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAC9C,SAAQ,WAAW;IACnB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,SAAS,CAAC,EAAE,CAAC,CAAC;CACf;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,mBAAmB;;;EAyBxE"}
+{"version":3,"file":"pathsToProps.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/pathsToProps.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB,CAClC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,CAC9C,SAAQ,WAAW;IACnB,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,SAAS,CAAC,EAAE,CAAC,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG,mBAAmB;;;EAyBxE"}

package/lib/types/utils/image/sizesToSrcSet.d.ts

@@ -1,5 +1,16 @@
 /**
  * Transform image sizes to src set
+ *
+ * @example
+ *
+ * imageSizesToSrcSet({
+ *   640: '/640.jpg',
+ *   750: '/750.jpg',
+ *   1024: '/1024.jpg',
+ *   1440: '/1440.jpg',
+ * });
+ *
+ * // => "/640.jpg 640w, /750.jpg 750w, /1024.jpg 1024w, /1440.jpg 1440w"
  */
 export declare function imageSizesToSrcSet(sizes: Record<string | number, string>): string;
 //# sourceMappingURL=sizesToSrcSet.d.ts.map

package/lib/types/utils/image/sizesToSrcSet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sizesToSrcSet.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/sizesToSrcSet.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,UAYxE"}
+{"version":3,"file":"sizesToSrcSet.d.ts","sourceRoot":"","sources":["../../../../src/utils/image/sizesToSrcSet.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,UAYxE"}

package/lib/types/utils/listeners/isIntersectionObserverSupported.d.ts

@@ -1,3 +1,5 @@
-/** Check if intersection observer is supported */
+/**
+ * Check if intersection observer is supported
+ */
 export declare function isIntersectionObserverSupported(): boolean;
 //# sourceMappingURL=isIntersectionObserverSupported.d.ts.map

package/lib/types/utils/listeners/isIntersectionObserverSupported.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isIntersectionObserverSupported.d.ts","sourceRoot":"","sources":["../../../../src/utils/listeners/isIntersectionObserverSupported.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,wBAAgB,+BAA+B,YAU9C"}
+{"version":3,"file":"isIntersectionObserverSupported.d.ts","sourceRoot":"","sources":["../../../../src/utils/listeners/isIntersectionObserverSupported.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,+BAA+B,YAU9C"}

package/lib/types/utils/listeners/onResize.d.ts

@@ -1,4 +1,4 @@
-import { NViewport } from 'src/Application/events/Viewport';
+import { NViewport } from '../../Application/events/Viewport';
 export type TOnResizeTarget = keyof NViewport.ICallbacksTypes;
 export interface IOnResizeProps {
     /** Callback on resize */
@@ -37,6 +37,26 @@ export interface IOnResize {
  * Add events on resize.
  * If `element` is provided, `ResizeObserver` will be used (first callback will not be fired).
  * Otherwise, viewport callbacks will be used.
+ *
+ * @example
+ *
+ * const handler = onResize({
+ *   onResize: () => console.log('resize'),
+ *   element: document.getElementById('app')!,
+ *   viewportTarget: 'any',
+ *   hasBothEvents: true,   // trace both element and viewport sizes
+ *   resizeDebounce: 100,
+ * });
+ *
+ * // resize with timeout called twice, but `onResize` will be called only once
+ * handler.debounceResize();
+ * handler.debounceResize();
+ *
+ * // resize without timeout
+ * handler.resize();
+ *
+ * // remove listeners
+ * handler.remove();
  */
 export declare function onResize({ onResize: handleResize, element, viewportTarget, hasBothEvents, resizeDebounce, }: IOnResizeProps): IOnResize;
 //# sourceMappingURL=onResize.d.ts.map

package/lib/types/utils/listeners/onResize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onResize.d.ts","sourceRoot":"","sources":["../../../../src/utils/listeners/onResize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAG5D,MAAM,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,yBAAyB;IACzB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;IACtC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,gCAAgC;IAChC,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,EACvB,QAAQ,EAAE,YAAY,EACtB,OAAO,EACP,cAAsB,EACtB,aAAqB,EACrB,cAAkB,GACnB,EAAE,cAAc,GAAG,SAAS,CAwD5B"}
+{"version":3,"file":"onResize.d.ts","sourceRoot":"","sources":["../../../../src/utils/listeners/onResize.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAG9D,MAAM,MAAM,eAAe,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,yBAAyB;IACzB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;IACtC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,2BAA2B;IAC3B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,6BAA6B;IAC7B,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,gCAAgC;IAChC,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,QAAQ,CAAC,EACvB,QAAQ,EAAE,YAAY,EACtB,OAAO,EACP,cAAsB,EACtB,aAAqB,EACrB,cAAkB,GACnB,EAAE,cAAc,GAAG,SAAS,CAwD5B"}

package/lib/types/utils/scroll/getScrollValues.d.ts

@@ -5,6 +5,10 @@ export interface IGetScrollValues {
 }
 /**
  * Get scroll values of a certain element
+ *
+ * @example
+ *
+ * getScrollValues(window); // => { scrollTop: 0, scrollLeft: 0 }
  */
 export declare function getScrollValues(selector?: Window | Element | IScrollLike | undefined): IGetScrollValues | undefined;
 //# sourceMappingURL=getScrollValues.d.ts.map

package/lib/types/utils/scroll/getScrollValues.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getScrollValues.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/getScrollValues.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,GAAE,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,SAAkB,GAC5D,gBAAgB,GAAG,SAAS,CAe9B"}
+{"version":3,"file":"getScrollValues.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/getScrollValues.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,GAAE,MAAM,GAAG,OAAO,GAAG,WAAW,GAAG,SAAkB,GAC5D,gBAAgB,GAAG,SAAS,CAe9B"}

package/lib/types/utils/scroll/normalizeWheel.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Normalize wheel delta
+ *
+ * @example
+ *
+ * normalizeWheel(event); // => { spinX: -0, spinY: 1.25, pixelX: -0, pixelY: 125 }
+ */
 export declare function normalizeWheel(event: WheelEvent): {
     spinX: number;
     spinY: number;

package/lib/types/utils/scroll/normalizeWheel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeWheel.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/normalizeWheel.ts"],"names":[],"mappings":"AAEA,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU;;;;;EAE/C"}
+{"version":3,"file":"normalizeWheel.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/normalizeWheel.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU;;;;;EAE/C"}

package/lib/types/utils/scroll/onScroll.d.ts

@@ -12,6 +12,14 @@ export interface IOnScrollProps {
 }
 /**
  * Add `onScroll` event
+ *
+ * @example
+ *
+ * onScroll({
+ *   container: window,
+ *   callback: ({ scrollLeft, scrollTop }) => console.log(scrollLeft, scrollTop),
+ *   isPassive: true,
+ * });
  */
 export declare function onScroll({ container, callback, isPassive, }: IOnScrollProps): IRemovable;
 export {};

package/lib/types/utils/scroll/onScroll.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"onScroll.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/onScroll.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D,KAAK,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;AAE3D,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAaD,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAID;;GAEG;AACH,wBAAgB,QAAQ,CAAC,EACvB,SAAS,EACT,QAAQ,EACR,SAAiB,GAClB,EAAE,cAAc,GAAG,UAAU,CAyE7B"}
+{"version":3,"file":"onScroll.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/onScroll.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D,KAAK,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC;AAE3D,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAaD,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,QAAQ,EAAE,CAAC,IAAI,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACrD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAID;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,EACvB,SAAS,EACT,QAAQ,EACR,SAAiB,GAClB,EAAE,cAAc,GAAG,UAAU,CAyE7B"}

package/lib/types/utils/scroll/scrollTo.d.ts

@@ -22,6 +22,26 @@ export interface IScrollToProps {
 }
 /**
  * Scroll to coordinates
+ *
+ * @example
+ *
+ * // static duration
+ * scrollTo({
+ *   container: window,
+ *   top: 500,
+ *   duration: 500,
+ * });
+ *
+ * // dynamic duration
+ * scrollTo({
+ *   top: 1000,
+ *   duration: (px) => px,
+ * });
+ *
+ * // use promise
+ * scrollTo({ top: 500 })
+ *   .then(() => console.log('done'))
+ *   .catch(() => {});
  */
 export declare function scrollTo({ container, top, left, duration: durationProp, }: IScrollToProps): Promise<void>;
 //# sourceMappingURL=scrollTo.d.ts.map

package/lib/types/utils/scroll/scrollTo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scrollTo.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/scrollTo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAI9C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;IAC3C;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,EACvB,SAAkB,EAClB,GAAO,EACP,IAAQ,EACR,QAAQ,EAAE,YAAkB,GAC7B,EAAE,cAAc,iBAuChB"}
+{"version":3,"file":"scrollTo.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/scrollTo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAI9C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;IAC3C;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;CACpD;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,QAAQ,CAAC,EACvB,SAAkB,EAClB,GAAO,EACP,IAAQ,EACR,QAAQ,EAAE,YAAkB,GAC7B,EAAE,cAAc,iBAuChB"}

package/lib/types/utils/scroll/scrollToElement.d.ts

@@ -7,6 +7,31 @@ export interface IScrollToElementProps extends IScrollToProps {
 }
 /**
  * Scroll to element
+ *
+ * @example
+ *
+ * // static duration
+ * scrollToElement({
+ *   container: window,
+ *   element: document.getElementById('element_20')!,
+ *   top: 60,
+ *   duration: 500,
+ * });
+ *
+ * // dynamic duration
+ * scrollToElement({
+ *   element: document.getElementById('element_20')!,
+ *   top: 60,
+ *   duration: (px) => px,
+ * });
+ *
+ * // use promise
+ * scrollToElement({
+ *   element: document.getElementById('element_20')!,
+ *   top: 60,
+ * })
+ *   .then(() => console.log('done'))
+ *   .catch(() => {});
  */
 export declare function scrollToElement({ container, element: elementProp, top, left, ...props }: IScrollToElementProps): Promise<void>;
 //# sourceMappingURL=scrollToElement.d.ts.map

package/lib/types/utils/scroll/scrollToElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scrollToElement.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/scrollToElement.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAY,MAAM,YAAY,CAAC;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,SAAkB,EAClB,OAAO,EAAE,WAAW,EACpB,GAAO,EACP,IAAQ,EACR,GAAG,KAAK,EACT,EAAE,qBAAqB,iBAgCvB"}
+{"version":3,"file":"scrollToElement.d.ts","sourceRoot":"","sources":["../../../../src/utils/scroll/scrollToElement.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAY,MAAM,YAAY,CAAC;AAEtD,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,eAAe,CAAC,EAC9B,SAAkB,EAClB,OAAO,EAAE,WAAW,EACpB,GAAO,EACP,IAAQ,EACR,GAAG,KAAK,EACT,EAAE,qBAAqB,iBAgCvB"}

package/lib/types/version.d.ts

@@ -1,3 +1,3 @@
-declare const version = "3.0.0-beta.5";
+declare const version = "3.0.0-beta.7";
 export default version;
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vevet",
-  "version": "3.0.0-beta.5",
+  "version": "3.0.0-beta.7",
   "description": "Vevet - a JavaScript library of ready-made solutions and helpers",
   "scripts": {
     "storybook": "storybook dev -p 6006",

package/src/Application/index.ts

@@ -7,7 +7,8 @@ import { getDeviceInfo } from '@/utils/internal/getDeviceInfo';
 import { fetchWebpSupport } from '@/utils/internal/fetchWebpSupport';
 
 /**
- * Vevet Application
+ * Vevet Application. This is the base Vevet class
+ * that should be initialized first.
  */
 export class Application {
   /** Vevet version */

package/src/Application/types.ts

@@ -1,9 +1,6 @@
 import { EasingType } from 'easing-progress';
 
 export namespace NApplication {
-  /**
-   * Properties
-   */
   export interface IProps {
     isVersionPrinted: boolean;
     /**

package/src/components/CustomCursor/index.ts

@@ -20,8 +20,8 @@ export class CustomCursor<
       container: window,
       isEnabled: true,
       isNativeCursorHidden: false,
-      width: 50,
-      height: 50,
+      width: 36,
+      height: 36,
       lerp: 0.2,
       isFpsNormalized: true,
       isAutoStop: true,
@@ -84,9 +84,6 @@ export class CustomCursor<
   /** Animation frame */
   private _animationFrame!: AnimationFrame;
 
-  /** If can play animation */
-  private _canPlay: boolean;
-
   /** Current cursor coordinates */
   private _coords: NCustomCursor.ICoords;
 
@@ -150,7 +147,6 @@ export class CustomCursor<
     // set default vars
     this._coords = { x: 0, y: 0, width: 0, height: 0 };
     this._targetCoords = { x: 0, y: 0, width: 0, height: 0 };
-    this._canPlay = this.props.isEnabled;
 
     if (canInit) {
       this.init();
@@ -167,7 +163,18 @@ export class CustomCursor<
 
     // enable by default
     if (this.props.isEnabled) {
-      this.enable();
+      this._enable();
+    }
+  }
+
+  /** Handle properties mutation */
+  protected _onPropsMutate() {
+    super._onPropsMutate();
+
+    if (this.props.isEnabled) {
+      this._enable();
+    } else {
+      this._disable();
     }
   }
 
@@ -279,7 +286,7 @@ export class CustomCursor<
 
     this.outerElement.classList.add(this.className('-in-action'));
 
-    if (this._canPlay) {
+    if (this.props.isEnabled) {
       this._animationFrame.play();
     }
   }
@@ -414,9 +421,7 @@ export class CustomCursor<
   }
 
   /** Enable cursor animation */
-  public enable() {
-    this._canPlay = true;
-
+  protected _enable() {
     this.outerElement.classList.remove(this.className('-disabled'));
     this.innerElement.classList.remove(this.className('-disabled'));
 
@@ -424,9 +429,7 @@ export class CustomCursor<
   }
 
   /** Disable cursor animation */
-  public disable() {
-    this._canPlay = false;
-
+  protected _disable() {
     this.outerElement.classList.add(this.className('-disabled'));
     this.innerElement.classList.add(this.className('-disabled'));
 

package/src/components/CustomCursor/types.ts

@@ -7,11 +7,6 @@ export namespace NCustomCursor {
      * @default window
      */
     container: Window | Element | string;
-    /**
-     * If need to launch cursor animation after anitialization
-     * @default true
-     */
-    isEnabled?: boolean;
     /**
      * If need to hide the native cursor
      * @default false
@@ -20,6 +15,11 @@ export namespace NCustomCursor {
   }
 
   export interface IChangeableProps extends NComponent.IChangeableProps {
+    /**
+     * Custom cursor is enabled
+     * @default true
+     */
+    isEnabled?: boolean;
     /**
      * @default 50
      */

package/src/utils/image/index.ts

@@ -1,5 +1,3 @@
 export * from './sizesToSrcSet';
 export * from './pathsToProps';
 export * from './load';
-
-// TODO: examples

package/src/utils/image/load.ts

@@ -18,6 +18,17 @@ type TLoadImageProps = {
 
 /**
  * Load an image
+ *
+ * @example
+ *
+ * const loaderWithoutCache = loadImage('/image.jpg');
+ *
+ * loaderWithoutCache.then((img) => console.log(img)).catch(() => {});
+ *
+ * const loaderWithCache = loadImage('/image.jpg', {
+ *   crossOrigin: 'anonymous',
+ *   useCache: true,
+ * });
  */
 export function loadImage(
   source: string | HTMLImageElement,
@@ -38,6 +49,7 @@ export function loadImage(
     (resolve: (img: HTMLImageElement) => void, reject: () => void) => {
       const cachedImage =
         loadProps.useCache && cachedImages.find((img) => img.src === imageSrc);
+
       // get image from cache
       if (cachedImage) {
         resolve(cachedImage.image);
@@ -48,19 +60,19 @@ export function loadImage(
       // load the image by src
       if (typeof source === 'string') {
         const img = new Image();
+
         img.crossOrigin = loadProps.crossOrigin;
+
         img.onload = () => {
           if (loadProps.useCache) {
-            cachedImages.push({
-              src: imageSrc,
-              image: img,
-            });
+            cachedImages.push({ src: imageSrc, image: img });
           }
+
           resolve(img);
         };
-        img.onerror = () => {
-          reject();
-        };
+
+        img.onerror = () => reject();
+
         img.src = source;
 
         return;
@@ -73,16 +85,13 @@ export function loadImage(
         } else {
           source.addEventListener('load', () => {
             if (loadProps.useCache) {
-              cachedImages.push({
-                src: imageSrc,
-                image: source,
-              });
+              cachedImages.push({ src: imageSrc, image: source });
             }
+
             resolve(source);
           });
-          source.addEventListener('error', () => {
-            reject();
-          });
+
+          source.addEventListener('error', () => reject());
         }
       }
     }

package/src/utils/image/pathsToProps.ts

@@ -15,6 +15,38 @@ export interface IImageAdaptivePaths<
 
 /**
  * Transform image paths to properties
+ *
+ * @example
+ *
+ * imagePathsToProps({
+ *   original: '/original.jpg',
+ *   thumb: '/thumb.jpg',
+ *   thumbWebp: '/thumb.webp',
+ * });
+ * // => {"src":"/thumb.webp","srcSet":""}
+ *
+ * imagePathsToProps({
+ *   original: '/original.jpg',
+ *   thumb: '/thumb.jpg',
+ *   thumbWebp: '/thumb.webp',
+ *   sizes: {
+ *     640: '/640.jpg',
+ *     750: '/750.jpg',
+ *     1024: '/1024.jpg',
+ *     1440: '/1440.jpg',
+ *     1920: '/1920.jpg',
+ *     2560: '/2560.jpg',
+ *   },
+ *   sizesWebp: {
+ *     640: '/640.webp',
+ *     750: '/750.webp',
+ *     1024: '/1024.webp',
+ *     1440: '/1440.webp',
+ *     1920: '/1920.webp',
+ *     2560: '/2560.webp',
+ *   },
+ * });
+ * // => {"src":"/thumb.webp","srcSet":"/640.webp 640w, /750.webp 750w, /1024.webp 1024w, /1440.webp 1440w, /1920.webp 1920w, /2560.webp 2560w"}
  */
 export function imagePathsToProps(data: IImagePaths | IImageAdaptivePaths) {
   const app = window.vevetApp;

package/src/utils/image/sizesToSrcSet.ts

@@ -1,5 +1,16 @@
 /**
  * Transform image sizes to src set
+ *
+ * @example
+ *
+ * imageSizesToSrcSet({
+ *   640: '/640.jpg',
+ *   750: '/750.jpg',
+ *   1024: '/1024.jpg',
+ *   1440: '/1440.jpg',
+ * });
+ *
+ * // => "/640.jpg 640w, /750.jpg 750w, /1024.jpg 1024w, /1440.jpg 1440w"
  */
 export function imageSizesToSrcSet(sizes: Record<string | number, string>) {
   const keys = Object.keys(sizes);

package/src/utils/listeners/index.ts

@@ -1,4 +1,2 @@
 export * from './isIntersectionObserverSupported';
 export * from './onResize';
-
-// TODO: examples

package/src/utils/listeners/isIntersectionObserverSupported.ts

@@ -1,4 +1,6 @@
-/** Check if intersection observer is supported */
+/**
+ * Check if intersection observer is supported
+ */
 export function isIntersectionObserverSupported() {
   if (
     !('IntersectionObserver' in window) ||

package/src/utils/listeners/onResize.ts

@@ -1,4 +1,4 @@
-import { NViewport } from 'src/Application/events/Viewport';
+import { NViewport } from '@/src/Application/events/Viewport';
 import { NCallbacks } from '@/base/Callbacks';
 
 export type TOnResizeTarget = keyof NViewport.ICallbacksTypes;
@@ -42,6 +42,26 @@ export interface IOnResize {
  * Add events on resize.
  * If `element` is provided, `ResizeObserver` will be used (first callback will not be fired).
  * Otherwise, viewport callbacks will be used.
+ *
+ * @example
+ *
+ * const handler = onResize({
+ *   onResize: () => console.log('resize'),
+ *   element: document.getElementById('app')!,
+ *   viewportTarget: 'any',
+ *   hasBothEvents: true,   // trace both element and viewport sizes
+ *   resizeDebounce: 100,
+ * });
+ *
+ * // resize with timeout called twice, but `onResize` will be called only once
+ * handler.debounceResize();
+ * handler.debounceResize();
+ *
+ * // resize without timeout
+ * handler.resize();
+ *
+ * // remove listeners
+ * handler.remove();
  */
 export function onResize({
   onResize: handleResize,

package/src/utils/scroll/getScrollValues.ts

@@ -7,6 +7,10 @@ export interface IGetScrollValues {
 
 /**
  * Get scroll values of a certain element
+ *
+ * @example
+ *
+ * getScrollValues(window); // => { scrollTop: 0, scrollLeft: 0 }
  */
 export function getScrollValues(
   selector: Window | Element | IScrollLike | undefined = window

package/src/utils/scroll/index.ts

@@ -3,5 +3,3 @@ export * from './normalizeWheel';
 export * from './onScroll';
 export * from './scrollTo';
 export * from './scrollToElement';
-
-// TODO: examples

package/src/utils/scroll/normalizeWheel.ts

@@ -1,5 +1,12 @@
 import normalizeWheelFunc from 'normalize-wheel';
 
+/**
+ * Normalize wheel delta
+ *
+ * @example
+ *
+ * normalizeWheel(event); // => { spinX: -0, spinY: 1.25, pixelX: -0, pixelY: 125 }
+ */
 export function normalizeWheel(event: WheelEvent) {
   return normalizeWheelFunc(event);
 }

package/src/utils/scroll/onScroll.ts

@@ -32,6 +32,14 @@ let instances: IInstance[] = [];
 
 /**
  * Add `onScroll` event
+ *
+ * @example
+ *
+ * onScroll({
+ *   container: window,
+ *   callback: ({ scrollLeft, scrollTop }) => console.log(scrollLeft, scrollTop),
+ *   isPassive: true,
+ * });
  */
 export function onScroll({
   container,

package/src/utils/scroll/scrollTo.ts

@@ -26,6 +26,26 @@ export interface IScrollToProps {
 
 /**
  * Scroll to coordinates
+ *
+ * @example
+ *
+ * // static duration
+ * scrollTo({
+ *   container: window,
+ *   top: 500,
+ *   duration: 500,
+ * });
+ *
+ * // dynamic duration
+ * scrollTo({
+ *   top: 1000,
+ *   duration: (px) => px,
+ * });
+ *
+ * // use promise
+ * scrollTo({ top: 500 })
+ *   .then(() => console.log('done'))
+ *   .catch(() => {});
  */
 export function scrollTo({
   container = window,