@blackbyte/sugar 1.0.0-beta.1

package/dist/js/dom/when/whenEntersViewport.js

@@ -0,0 +1,58 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import isInViewport from '../../is/isInViewport.js';
+export default function whenEntersViewport(elm, settings) {
+    function getRootMargin() {
+        return [
+            `${Math.round(window.innerHeight * 0.15 * -1)}px`,
+            `${Math.round(window.innerWidth * 0.15 * -1)}px`,
+            `${Math.round(window.innerHeight * 0.15 * -1)}px`,
+            `${Math.round(window.innerWidth * 0.15 * -1)}px`,
+        ].join(' ');
+    }
+    const finalSettings = Object.assign({ offset: undefined }, settings);
+    let resizeTimeout;
+    const rootMargin = finalSettings.offset
+        ? `${finalSettings.offset}`
+        : getRootMargin();
+    return new Promise((resolve) => __awaiter(this, void 0, void 0, function* () {
+        const options = {
+            root: null, // relative to document viewport
+            rootMargin, // margin around root. Values are similar to css property. Unitless values not allowed
+            threshold: 0, // visible amount of item shown in relation to root
+        };
+        if (isInViewport(elm)) {
+            return resolve(elm);
+        }
+        function onChange(changes, observer) {
+            changes.forEach((change) => {
+                var _a;
+                if (change.intersectionRatio > 0) {
+                    (_a = observer.disconnect) === null || _a === void 0 ? void 0 : _a.call(observer);
+                    resolve(elm);
+                }
+            });
+        }
+        let observer = new IntersectionObserver(onChange, options);
+        observer.observe(elm);
+        window.addEventListener('resize', (e) => {
+            clearTimeout(resizeTimeout);
+            // @ts-ignore
+            resizeTimeout = setTimeout(() => {
+                var _a;
+                (_a = observer.disconnect) === null || _a === void 0 ? void 0 : _a.call(observer);
+                options.rootMargin = rootMargin;
+                observer = new IntersectionObserver(onChange, options);
+                observer.observe(elm);
+            }, 500);
+        });
+    }));
+}
+//# sourceMappingURL=whenEntersViewport.js.map

package/dist/js/dom/when/whenEntersViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenEntersViewport.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenEntersViewport.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AA0CpD,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACxC,GAAgB,EAChB,QAAsC;IAEtC,SAAS,aAAa;QACpB,OAAO;YACL,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YACjD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YAChD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YACjD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;SACjD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAED,MAAM,aAAa,mBACjB,MAAM,EAAE,SAAS,IACd,QAAQ,CACZ,CAAC;IAEF,IAAI,aAAqB,CAAC;IAE1B,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM;QACrC,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE;QAC3B,CAAC,CAAC,aAAa,EAAE,CAAC;IAEpB,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,EAAE;QACnC,MAAM,OAAO,GAA6B;YACxC,IAAI,EAAE,IAAI,EAAE,gCAAgC;YAC5C,UAAU,EAAE,sFAAsF;YAClG,SAAS,EAAE,CAAC,EAAE,mDAAmD;SAClE,CAAC;QAEF,IAAI,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;QAED,SAAS,QAAQ,CAAC,OAAO,EAAE,QAAQ;YACjC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;;gBACzB,IAAI,MAAM,CAAC,iBAAiB,GAAG,CAAC,EAAE,CAAC;oBACjC,MAAA,QAAQ,CAAC,UAAU,wDAAI,CAAC;oBACxB,OAAO,CAAC,GAAG,CAAC,CAAC;gBACf,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEtB,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;YACtC,YAAY,CAAC,aAAa,CAAC,CAAC;YAC5B,aAAa;YACb,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;;gBAC9B,MAAA,QAAQ,CAAC,UAAU,wDAAI,CAAC;gBACxB,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;gBAChC,QAAQ,GAAG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACvD,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC,EAAE,GAAG,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenEventListener.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @name            whenEventListener
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Promisify the `addEventListener` method of an element to resolve a promise
+ * once the event has been triggered.
+ *
+ * @param    {string}             event     The event to listen for (e.g. 'click', 'animationend', etc.)
+ * @param    {HTMLElement}        $elm      The element to listen on
+ * @return   {Promise<Event>}               A promise that will be resolved once the event has been triggered
+ *
+ * @snippet         whenEventListener($1, $2)
+ * whenEventListener($1, $2).then(e: Event => {
+ *      $3
+ * });
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { whenEventListener } from '@blackbyte/sugar/dom'
+ * whenEventListener('click', myCoolElm).then((e: Event) => {
+ *      // do something...
+ * });
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenEventListener(event: string, $elm: HTMLElement): Promise<Event>;

package/dist/js/dom/when/whenEventListener.js

@@ -0,0 +1,41 @@
+/**
+ * @name            whenEventListener
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Promisify the `addEventListener` method of an element to resolve a promise
+ * once the event has been triggered.
+ *
+ * @param    {string}             event     The event to listen for (e.g. 'click', 'animationend', etc.)
+ * @param    {HTMLElement}        $elm      The element to listen on
+ * @return   {Promise<Event>}               A promise that will be resolved once the event has been triggered
+ *
+ * @snippet         whenEventListener($1, $2)
+ * whenEventListener($1, $2).then(e: Event => {
+ *      $3
+ * });
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { whenEventListener } from '@blackbyte/sugar/dom'
+ * whenEventListener('click', myCoolElm).then((e: Event) => {
+ *      // do something...
+ * });
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenEventListener(event, $elm) {
+    return new Promise((resolve) => {
+        $elm.addEventListener(event, (e) => {
+            resolve(e);
+        }, {
+            once: true,
+        });
+    });
+}
+//# sourceMappingURL=whenEventListener.js.map

package/dist/js/dom/when/whenEventListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenEventListener.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenEventListener.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,KAAa,EACb,IAAiB;IAEjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,CAAC,gBAAgB,CACnB,KAAK,EACL,CAAC,CAAC,EAAE,EAAE;YACJ,OAAO,CAAC,CAAC,CAAC,CAAC;QACb,CAAC,EACD;YACE,IAAI,EAAE,IAAI;SACX,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenIframeReady.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name            whenIframeReady
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Wait until the passed iframe is ready to be used
+ *
+ * @param     {HTMLIframeElement}               $iframe          The iframe to wait on
+ * @return 		{Promise<HTMLIframeElement>} 					            A promise that will be resolved when an interaction has been made
+ *
+ * @snippet         whenIframeReady($1)
+ * whenIframeReady($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenIframeReady } from '@blackbyte/sugar/dom'
+ * whenIframeReady($myCoolIframe).then($iframe => {
+ *      // do something...
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenIframeReady($iframe: HTMLIFrameElement): Promise<any>;

package/dist/js/dom/when/whenIframeReady.js

@@ -0,0 +1,45 @@
+/**
+ * @name            whenIframeReady
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Wait until the passed iframe is ready to be used
+ *
+ * @param     {HTMLIframeElement}               $iframe          The iframe to wait on
+ * @return 		{Promise<HTMLIframeElement>} 					            A promise that will be resolved when an interaction has been made
+ *
+ * @snippet         whenIframeReady($1)
+ * whenIframeReady($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenIframeReady } from '@blackbyte/sugar/dom'
+ * whenIframeReady($myCoolIframe).then($iframe => {
+ *      // do something...
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenIframeReady($iframe) {
+    return new Promise((resolve) => {
+        var _a, _b;
+        if ((_b = (_a = $iframe.contentWindow) === null || _a === void 0 ? void 0 : _a.document) === null || _b === void 0 ? void 0 : _b.body) {
+            return resolve($iframe);
+        }
+        let int = setInterval(() => {
+            var _a, _b;
+            if ((_b = (_a = $iframe.contentWindow) === null || _a === void 0 ? void 0 : _a.document) === null || _b === void 0 ? void 0 : _b.body) {
+                clearInterval(int);
+                resolve(null);
+            }
+        }, 10);
+    });
+}
+//# sourceMappingURL=whenIframeReady.js.map

package/dist/js/dom/when/whenIframeReady.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenIframeReady.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenIframeReady.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,OAA0B;IAE1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;;QAC7B,IAAI,MAAA,MAAA,OAAO,CAAC,aAAa,0CAAE,QAAQ,0CAAE,IAAI,EAAE,CAAC;YAC1C,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC;QACD,IAAI,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE;;YACzB,IAAI,MAAA,MAAA,OAAO,CAAC,aAAa,0CAAE,QAAQ,0CAAE,IAAI,EAAE,CAAC;gBAC1C,aAAa,CAAC,GAAG,CAAC,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenImageLoaded.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @name            whenImageLoaded
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Wait until the passed image is fully loaded
+ *
+ * @feature         Promise based API
+ *
+ * @param 		{HTMLImageElement} 			$img  		The image to check the loading state
+ * @return 		{SPromise} 								        The promise that will be resolved when all the images are correctly loaded
+ *
+ * @snippet         whenImageLoaded($1)
+ * whenImageLoaded($1).then(\$img => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenImageLoaded } from '@blackbyte/sugar/dom'
+ *  whenImageLoaded(myCoolHTMLImageElement).then(($img) => {
+ * 		// do something when the image is loaded
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenImageLoaded($img: HTMLImageElement): Promise<HTMLImageElement>;

package/dist/js/dom/when/whenImageLoaded.js

@@ -0,0 +1,60 @@
+/**
+ * @name            whenImageLoaded
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Wait until the passed image is fully loaded
+ *
+ * @feature         Promise based API
+ *
+ * @param 		{HTMLImageElement} 			$img  		The image to check the loading state
+ * @return 		{SPromise} 								        The promise that will be resolved when all the images are correctly loaded
+ *
+ * @snippet         whenImageLoaded($1)
+ * whenImageLoaded($1).then(\$img => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenImageLoaded } from '@blackbyte/sugar/dom'
+ *  whenImageLoaded(myCoolHTMLImageElement).then(($img) => {
+ * 		// do something when the image is loaded
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenImageLoaded($img) {
+    let imgLoadedHandler, imgErrorHandler;
+    const pro = new Promise((resolve, reject) => {
+        // check if image is already loaded
+        if ($img.hasAttribute('src') && $img.complete) {
+            // resolve promise
+            resolve($img);
+        }
+        else {
+            // wait until loaded
+            imgLoadedHandler = (e) => {
+                // resolve the promise
+                resolve($img);
+            };
+            $img.addEventListener('load', imgLoadedHandler);
+            // listen for error
+            imgErrorHandler = (e) => {
+                // reject
+                reject(e);
+            };
+            $img.addEventListener('error', imgErrorHandler);
+        }
+    });
+    pro.finally(() => {
+        imgLoadedHandler && $img.removeEventListener('load', imgLoadedHandler);
+        imgErrorHandler && $img.removeEventListener('error', imgErrorHandler);
+    });
+    return pro;
+}
+//# sourceMappingURL=whenImageLoaded.js.map

package/dist/js/dom/when/whenImageLoaded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenImageLoaded.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenImageLoaded.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CACrC,IAAsB;IAEtB,IAAI,gBAAgB,EAAE,eAAe,CAAC;IAEtC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC1C,mCAAmC;QACnC,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC9C,kBAAkB;YAClB,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;aAAM,CAAC;YACN,oBAAoB;YACpB,gBAAgB,GAAG,CAAC,CAAC,EAAE,EAAE;gBACvB,sBAAsB;gBACtB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC;YACF,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YAChD,mBAAmB;YACnB,eAAe,GAAG,CAAC,CAAC,EAAE,EAAE;gBACtB,SAAS;gBACT,MAAM,CAAC,CAAC,CAAC,CAAC;YACZ,CAAC,CAAC;YACF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;QACf,gBAAgB,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QACvE,eAAe,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IACH,OAAO,GAAgC,CAAC;AAC1C,CAAC"}

package/dist/js/dom/when/whenImagesLoaded.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @name            whenImagesLoaded
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Detect when some images are loaded. This function take advantage of the SPromise class
+ * and trigger an event called "img.loaded" that will be triggered on each loaded images and another called "loaded" once all the images are loaded.
+ * See in the example bellow.
+ *
+ * @feature       Promise based API
+ *
+ * @param    {Array<HTMLImageElement>}    $imgs     An array (or nodeList) of HTMLImageElement to detect the load
+ * @return   {Promise}                              A promise resolved when all images are loaded properly
+ *
+ * @snippet         whenImagesLoaded($1)
+ * whenImagesLoaded($1).then(imgs => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { whenImagesLoaded } from '@blackbyte/sugar/dom'
+ * whenImagesLoaded([
+ * 	$img1, $img2, $img3
+ * ]).on('loaded', $img => {
+ *    // do something with the loaded image
+ * }).then(imgs => {
+ *   // do something here
+ * })
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenImagesLoaded($imgs: HTMLImageElement[]): Promise<HTMLImageElement[]>;

package/dist/js/dom/when/whenImagesLoaded.js

@@ -0,0 +1,57 @@
+import whenImageLoaded from './whenImageLoaded.js';
+/**
+ * @name            whenImagesLoaded
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Detect when some images are loaded. This function take advantage of the SPromise class
+ * and trigger an event called "img.loaded" that will be triggered on each loaded images and another called "loaded" once all the images are loaded.
+ * See in the example bellow.
+ *
+ * @feature       Promise based API
+ *
+ * @param    {Array<HTMLImageElement>}    $imgs     An array (or nodeList) of HTMLImageElement to detect the load
+ * @return   {Promise}                              A promise resolved when all images are loaded properly
+ *
+ * @snippet         whenImagesLoaded($1)
+ * whenImagesLoaded($1).then(imgs => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { whenImagesLoaded } from '@blackbyte/sugar/dom'
+ * whenImagesLoaded([
+ * 	$img1, $img2, $img3
+ * ]).on('loaded', $img => {
+ *    // do something with the loaded image
+ * }).then(imgs => {
+ *   // do something here
+ * })
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenImagesLoaded($imgs) {
+    return new Promise((resolve, reject) => {
+        const promises = [], loadedImages = [];
+        Array.from($imgs).forEach(($img) => {
+            const pro = whenImageLoaded($img);
+            pro
+                .then((_$img) => {
+                loadedImages.push(_$img);
+                if (loadedImages.length === $imgs.length) {
+                    resolve(loadedImages);
+                }
+            })
+                .catch((error) => {
+                reject(error);
+            }),
+                promises.push(pro);
+        });
+    });
+}
+//# sourceMappingURL=whenImagesLoaded.js.map

package/dist/js/dom/when/whenImagesLoaded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenImagesLoaded.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenImagesLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,sBAAsB,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,KAAyB;IAEzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAgC,EAAE,EAC9C,YAAY,GAAuB,EAAE,CAAC;QAExC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAClC,GAAG;iBACA,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACd,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,YAAY,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;oBACzC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenInViewport.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @name                whenInViewport
+ * @namespace           js.dom.when
+ * @type                Function
+ * @platform            js
+ * @status              stable
+ * @async
+ *
+ * Monitor an HTMLElement to be notified when it is in the viewport
+ *
+ * @feature       Promise based API
+ * @feature       Some settings available to tweak the behavior
+ *
+ * @setting     {String}      [offset='10px']         An offset to detect sooner or later the element entering in the viewport
+ *
+ * @param 		{HTMLElement} 				                      $elm 					      The element to monitor
+ * @param 		{Partial<TWhenInViewportSettings>} 					[settings={}] 		  Some settings to tweak the detection behavior
+ * @return 		(SPromise<HTMLElement>) 											                  The promise that will be resolved when the element is in the viewport
+ *
+ * @snippet         whenInViewport($1)
+ * whenInViewport($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example 	js
+ * import { whenInViewport } from '@blackbyte/sugar/dom'
+ * const promise = whenInViewport(myCoolHTMLElement).then((elm) => {
+ * 		// do something with your element that has entered the viewport...
+ * });
+ * // when you want to stop listening
+ * promise.cancel();
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TWhenInViewportSettings = {
+    offset: string;
+    whenIn: Function | undefined;
+    whenOut: Function | undefined;
+    once: boolean;
+};
+export type TWhenInViewportResult = Promise<HTMLElement> & {
+    cancel: Function;
+};
+export default function whenInViewport($elm: HTMLElement, settings?: Partial<TWhenInViewportSettings>): TWhenInViewportResult;

package/dist/js/dom/when/whenInViewport.js

@@ -0,0 +1,82 @@
+import uniqid from '../../string/uniqid.js';
+const whenInViewportStatuses = new WeakMap();
+class CancelablePromise extends Promise {
+    cancel() { }
+}
+export default function whenInViewport($elm, settings) {
+    const finalSettings = Object.assign({ offset: '10px', once: true, whenIn: undefined, whenOut: undefined }, (settings !== null && settings !== void 0 ? settings : {}));
+    let observer;
+    function getRootMargin() {
+        return [
+            `${Math.round(window.innerHeight * 0.15 * -1)}px`,
+            `${Math.round(window.innerWidth * 0.15 * -1)}px`,
+            `${Math.round(window.innerHeight * 0.15 * -1)}px`,
+            `${Math.round(window.innerWidth * 0.15 * -1)}px`,
+        ].join(' ');
+    }
+    // generate a uniqid for this listener
+    const id = uniqid();
+    const rootMargin = finalSettings.offset
+        ? `${finalSettings.offset}`
+        : getRootMargin();
+    const pro = new CancelablePromise((resolve) => {
+        var _a;
+        const options = {
+            root: null, // relative to document viewport
+            rootMargin,
+            threshold: 0, // visible amount of item shown in relation to root
+        };
+        // store status for all listeners
+        let statuses = (_a = whenInViewportStatuses.get($elm)) !== null && _a !== void 0 ? _a : {};
+        whenInViewportStatuses.set($elm, statuses);
+        function onChange(changes) {
+            changes.forEach((change) => {
+                var _a, _b;
+                if (change.intersectionRatio === 0) {
+                    // prevent from triggering multiple times the callback
+                    // for this listener if already invisible
+                    if (!statuses[id]) {
+                        return;
+                    }
+                    // set the listener status on the element
+                    statuses[id] = false;
+                    // process callbacks
+                    (_a = finalSettings.whenOut) === null || _a === void 0 ? void 0 : _a.call(finalSettings, $elm);
+                }
+                else {
+                    // "once" finalSettings support
+                    if (finalSettings.once) {
+                        observer.disconnect();
+                    }
+                    // prevent from triggering multiple times the callback
+                    // for this listener if already visible
+                    if (statuses[id]) {
+                        return;
+                    }
+                    // set the listener status on the element
+                    statuses[id] = true;
+                    // process callbacks
+                    (_b = finalSettings.whenIn) === null || _b === void 0 ? void 0 : _b.call(finalSettings, $elm);
+                    // resolve the promise only if the "once"
+                    // setting is true
+                    if (finalSettings.once) {
+                        resolve($elm);
+                    }
+                }
+            });
+        }
+        observer = new IntersectionObserver(onChange, options);
+        observer.observe($elm);
+        setTimeout(() => {
+            pro.cancel = () => {
+                observer.disconnect();
+                Promise.resolve($elm);
+            };
+        });
+    });
+    pro.finally(() => {
+        observer === null || observer === void 0 ? void 0 : observer.disconnect();
+    });
+    return pro;
+}
+//# sourceMappingURL=whenInViewport.js.map

package/dist/js/dom/when/whenInViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenInViewport.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenInViewport.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAC;AA+C5C,MAAM,sBAAsB,GAAG,IAAI,OAAO,EAAE,CAAC;AAM7C,MAAM,iBAAkB,SAAQ,OAAoB;IAClD,MAAM,KAAI,CAAC;CACZ;AAED,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,IAAiB,EACjB,QAA2C;IAE3C,MAAM,aAAa,mBACjB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,SAAS,EACjB,OAAO,EAAE,SAAS,IACf,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,QAAQ,CAAC;IAEb,SAAS,aAAa;QACpB,OAAO;YACL,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YACjD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YAChD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;YACjD,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI;SACjD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACd,CAAC;IAED,sCAAsC;IACtC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;IAEpB,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM;QACrC,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE;QAC3B,CAAC,CAAC,aAAa,EAAE,CAAC;IAEpB,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAC,CAAC,OAAO,EAAE,EAAE;;QAC5C,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,IAAI,EAAE,gCAAgC;YAC5C,UAAU;YACV,SAAS,EAAE,CAAC,EAAE,mDAAmD;SAClE,CAAC;QAEF,iCAAiC;QACjC,IAAI,QAAQ,GAAG,MAAA,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;QACtD,sBAAsB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE3C,SAAS,QAAQ,CAAC,OAAO;YACvB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;;gBACzB,IAAI,MAAM,CAAC,iBAAiB,KAAK,CAAC,EAAE,CAAC;oBACnC,sDAAsD;oBACtD,yCAAyC;oBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;wBAClB,OAAO;oBACT,CAAC;oBAED,yCAAyC;oBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;oBAErB,oBAAoB;oBACpB,MAAA,aAAa,CAAC,OAAO,8DAAG,IAAI,CAAC,CAAC;gBAChC,CAAC;qBAAM,CAAC;oBACN,+BAA+B;oBAC/B,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;wBACvB,QAAQ,CAAC,UAAU,EAAE,CAAC;oBACxB,CAAC;oBAED,sDAAsD;oBACtD,uCAAuC;oBACvC,IAAI,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;wBACjB,OAAO;oBACT,CAAC;oBAED,yCAAyC;oBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;oBAEpB,oBAAoB;oBACpB,MAAA,aAAa,CAAC,MAAM,8DAAG,IAAI,CAAC,CAAC;oBAE7B,yCAAyC;oBACzC,kBAAkB;oBAClB,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;wBACvB,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,QAAQ,GAAG,IAAI,oBAAoB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACvD,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEvB,UAAU,CAAC,GAAG,EAAE;YACd,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE;gBAChB,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACtB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACxB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;QACf,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/js/dom/when/whenInteract.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @name            whenInteract
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Wait that an interaction is made with the passed element like "focus", "focusIn", "pointerover", etc...
+ *
+ * @param 		{HTMLElement} 		                  $elm 	                  The html element you want to monitor
+ * @param     {Partial<IInteractionSettings>}     [settings={}]           Some settings to configure your interaction detection
+ * @return 		{Promise<HTMLElement>} 					                            A promise that will be resolved when an interaction has been made
+ *
+ * @setting         {boolean}           [pointerover=true]         Specify if you want to detect the pointerover or not
+ * @setting         {boolean}           [pointerout=true]          Specify if you want to detect the pointerout or not
+ * @setting         {boolean}           [pointerdown=true]         Specify if you want to detect the pointerdown or not
+ * @setting         {boolean}           [touchstart=true]          Specify if you want to detect the touchstart or not
+ * @setting         {boolean}           [touchend=true]            Specify if you want to detect the touchend or not
+ * @setting         {boolean}           [focus=true]               Specify if you want to detect the focus or not
+ *
+ * @snippet         whenInteract($1)
+ * whenInteract($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenInteract } from '@blackbyte/sugar/dom'
+ * whenInteract(myCoolElement).then($elm => {
+ *      // do something...
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TWhenInteractSettings = {
+    pointerover: boolean;
+    pointerout: boolean;
+    pointerdown: boolean;
+    touchstart: boolean;
+    touchend: boolean;
+    focus: boolean;
+};
+export default function whenInteract(elm: HTMLElement, settings?: Partial<TWhenInteractSettings>): Promise<any>;