@blackbyte/sugar 1.0.0-beta.3 → 1.0.0-beta.31

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

@@ -0,0 +1,60 @@
+import type { TWhenEntersViewportSettings } from '../whenEntersViewport/whenEntersViewport.js';
+import type { TWhenInteractSettings } from '../whenInteract/whenInteract.js';
+import type { TWhenInViewportSettings } from '../whenInViewport/whenInViewport.js';
+import type { TWhenNearViewportSettings } from '../whenNearViewport/whenNearViewport.js';
+import type { TWhenOutOfViewportSettings } from '../whenOutOfViewport/whenOutOfViewport.js';
+import type { TWhenVisibleSettings } from '../whenVisible/whenVisible.js';
+/**
+ * @name            when
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform          js
+ * @status        stable
+ * @async
+ *
+ * This function listen for passed `trigger(s)` on the passed `HTMLElement` and resolve the promise once one of them has reached his state.
+ *
+ * @param       {HTMLElement}           $elm              The element to listen on
+ * @param       {String|String[]}       trigger           The trigger(s) to listen on
+ * @param       {TwhenSettings}         [settings={}]     Some settings like offset, etc...
+ * @return      {SPromise<HTMLElement>}                   A promise resolved when all the triggers are fulfilled
+ *
+ * @setting         {Partial<TWhenInViewportSettings>}          [whenInViewport={}]            Some settings for the whenInViewport function
+ * @setting         {Partial<TWhenNearViewportSettings>}        [whenNearViewport={}]           Some settings for the whenNearViewport function
+ * @setting         {Partial<IWhenEntersViewportSettubgs>}      [whenEntersViewport={}]         Some settings for the whenEntersViewport function
+ * @setting         {Partial<TWhenOutOfViewportSettings>}      [whenOutOfViewport={}]         Some settings for the whenOutOfViewport function
+ * @setting         {Partial<TWhenInteractSettings>}      [whenInteract={}]         Some settings for the whenInteract function
+ * @setting         {Partial<TWhenVisibleSettings>}      [whenVisible={}]         Some settings for the whenVisible function
+ * @setting         {Partial<IWhenStyleSheetsReadySettings>}      [whenStylesheetsReady={}]         Some settings for the whenStylesheetsReady function
+ *
+ * @snippet         when($1, $2, $3)
+ * when($1, $2).then(() => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example         js
+ * import { when } from '@blackbyte/sugar/dom';
+ * when($elm, 'inViewport', {
+ *    whenInViewport: {
+ *       offset: 50
+ *    }
+ * }).then(() => {
+ *      // do something
+ * });
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TwhenSettings = {
+    whenInViewport?: TWhenInViewportSettings;
+    whenNearViewport?: TWhenNearViewportSettings;
+    whenEntersViewport?: TWhenEntersViewportSettings;
+    whenOutOfViewport?: TWhenOutOfViewportSettings;
+    whenInteract?: TWhenInteractSettings;
+    whenVisible?: TWhenVisibleSettings;
+};
+export type TWhenTrigger<string> = ('direct' | 'directly' | 'inViewport' | 'nearViewport' | 'enterViewport' | 'outOfViewport' | 'interact' | 'visible' | 'domReady' | 'stylesheetsReady' | 'animationEnd')[];
+export declare const WhenTriggers: string[];
+export default function when($elm: HTMLElement, trigger: TWhenTrigger[], settings?: TwhenSettings): Promise<any>;

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

@@ -0,0 +1,95 @@
+// @ts-nocheck
+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 whenAnimationEnd from '../whenAnimationEnd/whenAnimationEnd.js';
+import whenDomReady from '../whenDomReady/whenDomReady.js';
+import whenEntersViewport from '../whenEntersViewport/whenEntersViewport.js';
+import whenInteract from '../whenInteract/whenInteract.js';
+import whenInViewport from '../whenInViewport/whenInViewport.js';
+import whenNearViewport from '../whenNearViewport/whenNearViewport.js';
+import whenOutOfViewport from '../whenOutOfViewport/whenOutOfViewport.js';
+import whenStylesheetsReady from '../whenStylesheetsReady/whenStylesheetsReady.js';
+import whenVisible from '../whenVisible/whenVisible.js';
+export const WhenTriggers = [
+    'direct',
+    'directly',
+    'inViewport',
+    'nearViewport',
+    'enterViewport',
+    'outOfViewport',
+    'interact',
+    'visible',
+    'stylesheetsReady',
+    'domReady',
+    'animationEnd',
+];
+export default function when($elm, trigger, settings) {
+    const finalSettings = Object.assign({ whenInViewport: {}, whenNearViewport: {}, whenOutOfViewport: {}, whenInteract: {}, whenVisible: {}, whenStylesheetsReady: {} }, (settings !== null && settings !== void 0 ? settings : {}));
+    return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        // ensure we work with an array of time(s)
+        if (!Array.isArray(trigger))
+            trigger = trigger.split(',').map((t) => t.trim());
+        const promises = [];
+        // adding watchers
+        trigger.forEach((t) => {
+            var _a;
+            // timeout
+            const timeoutMatches = t.match(/^timeout\:([0-9]+)/);
+            if (timeoutMatches && timeoutMatches[1]) {
+                const timeout = parseInt(timeoutMatches[1]);
+                const promise = new Promise((resolve) => {
+                    setTimeout(resolve, timeout);
+                });
+                promises.push(promise);
+                return;
+            }
+            switch (t) {
+                case 'inViewport':
+                    promises.push(whenInViewport($elm, finalSettings.whenInViewport));
+                    break;
+                case 'nearViewport':
+                    promises.push(whenNearViewport($elm, finalSettings.whenNearViewport));
+                    break;
+                case 'enterViewport':
+                    promises.push(whenEntersViewport($elm, finalSettings.whenEntersViewport));
+                    break;
+                case 'outOfViewport':
+                    promises.push(whenOutOfViewport($elm, finalSettings.whenOutOfViewport));
+                    break;
+                case 'interact':
+                    promises.push(whenInteract($elm, finalSettings.whenInteract));
+                    break;
+                case 'visible':
+                    promises.push(whenVisible($elm, Object.assign(Object.assign({}, ((_a = finalSettings.whenVisible) !== null && _a !== void 0 ? _a : {})), { once: true })));
+                    break;
+                case 'domReady':
+                    promises.push(whenDomReady());
+                    break;
+                case 'stylesheetsReady':
+                    promises.push(whenStylesheetsReady());
+                    break;
+                case 'animationEnd':
+                    promises.push(whenAnimationEnd($elm));
+                    break;
+            }
+        });
+        // if no times setted, execute directly
+        if (!trigger.length ||
+            trigger.includes('direct') ||
+            trigger.includes('directly')) {
+            resolve($elm);
+            return;
+        }
+        // listen for at least 1 promise resolved
+        yield Promise.race(promises);
+        resolve($elm);
+    }));
+}
+//# sourceMappingURL=when.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"when.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/when/when.ts"],"names":[],"mappings":"AAAA,cAAc;;;;;;;;;;AASd,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AACvE,OAAO,YAAY,MAAM,iCAAiC,CAAC;AAC3D,OAAO,kBAAkB,MAAM,6CAA6C,CAAC;AAC7E,OAAO,YAAY,MAAM,iCAAiC,CAAC;AAC3D,OAAO,cAAc,MAAM,qCAAqC,CAAC;AACjE,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AACvE,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAC1E,OAAO,oBAAoB,MAAM,iDAAiD,CAAC;AACnF,OAAO,WAAW,MAAM,+BAA+B,CAAC;AAoExD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,cAAc;IACd,eAAe;IACf,eAAe;IACf,UAAU;IACV,SAAS;IACT,kBAAkB;IAClB,UAAU;IACV,cAAc;CACf,CAAC;AAEF,MAAM,CAAC,OAAO,UAAU,IAAI,CAC1B,IAAiB,EACjB,OAAuB,EACvB,QAAwB;IAExB,MAAM,aAAa,mBACjB,cAAc,EAAE,EAAE,EAClB,gBAAgB,EAAE,EAAE,EACpB,iBAAiB,EAAE,EAAE,EACrB,YAAY,EAAE,EAAE,EAChB,WAAW,EAAE,EAAE,EACf,oBAAoB,EAAE,EAAE,IACrB,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,0CAA0C;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YACzB,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAY,EAAE,CAAC;QAE7B,kBAAkB;QAClB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;;YACpB,UAAU;YACV,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACrD,IAAI,cAAc,IAAI,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxC,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBACtC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC/B,CAAC,CAAC,CAAC;gBACH,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,OAAO;YACT,CAAC;YAED,QAAQ,CAAC,EAAE,CAAC;gBACV,KAAK,YAAY;oBACf,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;oBAClE,MAAM;gBACR,KAAK,cAAc;oBACjB,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC;oBACtE,MAAM;gBACR,KAAK,eAAe;oBAClB,QAAQ,CAAC,IAAI,CACX,kBAAkB,CAAC,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAC,CAC3D,CAAC;oBACF,MAAM;gBACR,KAAK,eAAe;oBAClB,QAAQ,CAAC,IAAI,CACX,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,iBAAiB,CAAC,CACzD,CAAC;oBACF,MAAM;gBACR,KAAK,UAAU;oBACb,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;oBAC9D,MAAM;gBACR,KAAK,SAAS;oBACZ,QAAQ,CAAC,IAAI,CACX,WAAW,CAAC,IAAI,kCACX,CAAC,MAAA,aAAa,CAAC,WAAW,mCAAI,EAAE,CAAC,KACpC,IAAI,EAAE,IAAI,IACV,CACH,CAAC;oBACF,MAAM;gBACR,KAAK,UAAU;oBACb,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;oBAC9B,MAAM;gBACR,KAAK,kBAAkB;oBACrB,QAAQ,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;oBACtC,MAAM;gBACR,KAAK,cAAc;oBACjB,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;oBACtC,MAAM;YACV,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,uCAAuC;QACvC,IACE,CAAC,OAAO,CAAC,MAAM;YACf,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,EAC5B,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;YACd,OAAO;QACT,CAAC;QAED,yCAAyC;QACzC,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE7B,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenAnimationEnd.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenAnimationEnd/whenAnimationEnd.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CACtC,IAAiB;IAEjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,CAAC,gBAAgB,CACnB,cAAc,EACd,CAAC,CAAC,EAAE,EAAE;YACJ,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,EACD;YACE,IAAI,EAAE,IAAI;SACX,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenAttribute/whenAttribute.js

@@ -0,0 +1,49 @@
+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 { parse } from '@blackbyte/sugar/string';
+export default function whenAttribute($elm, attrName, settings) {
+    return new Promise((resolve) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const finalSettings = Object.assign({ check: undefined }, (settings !== null && settings !== void 0 ? settings : {}));
+        if ($elm.hasAttribute(attrName)) {
+            const value = parse((_a = $elm.getAttribute(attrName)) !== null && _a !== void 0 ? _a : 'undefined');
+            if (finalSettings.check && finalSettings.check(value, value)) {
+                resolve(value);
+                return;
+            }
+            else if (!finalSettings.check) {
+                resolve(value);
+                return;
+            }
+        }
+        const observer = new MutationObserver((mutations) => {
+            mutations.forEach((mutation) => {
+                var _a;
+                if (mutation.attributeName !== attrName) {
+                    return;
+                }
+                const value = parse((_a = $elm.getAttribute(mutation.attributeName)) !== null && _a !== void 0 ? _a : 'undefined');
+                if (finalSettings.check &&
+                    finalSettings.check(value, mutation.oldValue)) {
+                    resolve(value);
+                    observer.disconnect();
+                }
+                else if (!finalSettings.check) {
+                    resolve(value);
+                    observer.disconnect();
+                }
+            });
+        });
+        observer.observe($elm, {
+            attributes: true,
+        });
+    }));
+}
+//# sourceMappingURL=whenAttribute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenAttribute.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenAttribute/whenAttribute.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAsDhD,MAAM,CAAC,OAAO,UAAU,aAAa,CACnC,IAAiB,EACjB,QAAgB,EAChB,QAAiC;IAEjC,OAAO,IAAI,OAAO,CAAC,CAAO,OAAO,EAAE,EAAE;;QACnC,MAAM,aAAa,mBACjB,KAAK,EAAE,SAAS,IACb,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;QAEF,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAA,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,mCAAI,WAAW,CAAC,CAAC;YAChE,IAAI,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7D,OAAO,CAAC,KAAK,CAAC,CAAC;gBACf,OAAO;YACT,CAAC;iBAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;gBAChC,OAAO,CAAC,KAAK,CAAC,CAAC;gBACf,OAAO;YACT,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,CAAC,SAAS,EAAE,EAAE;YAClD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;;gBAC7B,IAAI,QAAQ,CAAC,aAAa,KAAK,QAAQ,EAAE,CAAC;oBACxC,OAAO;gBACT,CAAC;gBACD,MAAM,KAAK,GAAG,KAAK,CACjB,MAAA,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,mCAAI,WAAW,CACzD,CAAC;gBACF,IACE,aAAa,CAAC,KAAK;oBACnB,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAC7C,CAAC;oBACD,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,CAAC;qBAAM,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;oBAChC,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE;YACrB,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenBackgroundImageLoaded/whenBackgroundImageLoaded.js

@@ -0,0 +1,61 @@
+import { unquote } from '@blackbyte/sugar/string';
+import { getStyleProperty } from '@blackbyte/sugar/dom';
+import whenImageLoaded from '../whenImageLoaded/whenImageLoaded.js';
+/**
+ * @name            whenBackgroundImageLoaded
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Detect when a background image has been loaded on an HTMLElement
+ *
+ * @feature       Promise based API
+ *
+ * @param    {HTMLElement}    $elm    The HTMLElement on which to detect the background image load
+ * @return   {SPromise}               A promise that will be resolved when the background image has been loaded
+ *
+ * @snippet         whenBackgroundImageLoaded($1)
+ * whenBackgroundImageLoaded($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { whenBackgroundImageLoaded } from '@blackbyte/sugar/dom'
+ *
+ * // using promise
+ * await whenBackgroundImageLoaded($elm);
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenBackgroundImageLoaded($elm) {
+    let isCancelled = false, $img;
+    const promise = new Promise((resolve, reject) => {
+        // get the background-image property from computed style
+        const backgroundImage = getStyleProperty($elm, 'background-image');
+        const matches = backgroundImage.match(/.*url\((.*)\).*/);
+        if (!matches || !matches[1]) {
+            reject('No background image url found...');
+            return;
+        }
+        // process url
+        const url = unquote(matches[1]);
+        // make a new image with the image set
+        $img = new Image();
+        $img.src = url;
+        // return the promise of image loaded
+        whenImageLoaded($img).then(() => {
+            if (!isCancelled) {
+                resolve($elm);
+            }
+        });
+    });
+    promise.finally(() => {
+        isCancelled = true;
+    }).catch(() => { });
+    return promise;
+}
+//# sourceMappingURL=whenBackgroundImageLoaded.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenBackgroundImageLoaded.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenBackgroundImageLoaded/whenBackgroundImageLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,eAAe,MAAM,uCAAuC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,IAAiB;IAEjB,IAAI,WAAW,GAAG,KAAK,EACrB,IAAI,CAAC;IACP,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC9C,wDAAwD;QACxD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,kCAAkC,CAAC,CAAC;YAC3C,OAAO;QACT,CAAC;QACD,cAAc;QACd,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,sCAAsC;QACtC,IAAI,GAAG,IAAI,KAAK,EAAE,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,qCAAqC;QACrC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YAC9B,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;QACnB,WAAW,GAAG,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IAEnB,OAAO,OAA+B,CAAC;AACzC,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenDomReady.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenDomReady/whenDomReady.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY;IAClC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,kBAAkB,GAAG,GAAG,EAAE;gBACjC,IAAI,QAAQ,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;oBACvC,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenEntersViewport/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 '@blackbyte/sugar/is';
+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/whenEntersViewport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenEntersViewport.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenEntersViewport/whenEntersViewport.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA0CnD,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/whenEventListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenEventListener.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenEventListener/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/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($iframe);
+            }
+        }, 10);
+    });
+}
+//# sourceMappingURL=whenIframeReady.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenIframeReady.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenIframeReady/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,OAAO,CAAC,CAAC;YACnB,CAAC;QACH,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/dom/when/whenImageLoaded/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);
+    }).catch(() => { });
+    return pro;
+}
+//# sourceMappingURL=whenImageLoaded.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenImageLoaded.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenImageLoaded/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,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACnB,OAAO,GAAgC,CAAC;AAC1C,CAAC"}

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

@@ -0,0 +1,59 @@
+import whenImageLoaded from '../whenImageLoaded/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
+ * ]).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 = [];
+        if (!$imgs.length) {
+            resolve([]);
+            return;
+        }
+        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/whenImagesLoaded.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"whenImagesLoaded.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenImagesLoaded/whenImagesLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,MAAM,uCAAuC,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;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,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClB,OAAO,CAAC,EAAE,CAAC,CAAC;YACZ,OAAO;QACT,CAAC;QAED,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/whenInViewport.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @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
+ * @setting     {Function}    [whenIn]                A callback function to call when the element enter the viewport
+ * @setting     {Function}    [whenOut]               A callback function to call when the element leave the viewport
+ * @setting     {Boolean}     [once=true]             Specify if the promise should be resolved only once (the first time the element enter 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;