@blackbyte/sugar 1.0.0-beta.29 → 1.0.0-beta.30

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

@@ -1,62 +0,0 @@
-import type { TWhenEntersViewportSettings } from '../when/whenEntersViewport.js';
-import type { TWhenInteractSettings } from '../when/whenInteract.js';
-import type { TWhenInViewportSettings } from '../when/whenInViewport.js';
-import type { TWhenNearViewportSettings } from '../when/whenNearViewport.js';
-import type { TWhenOutOfViewportSettings } from '../when/whenOutOfViewport.js';
-import type { IWhenStyleSheetsReadySettings } from '../when/whenStylesheetsReady.js';
-import type { TWhenVisibleSettings } from '../when/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;
-    whenStylesheetsReady?: IWhenStyleSheetsReadySettings;
-};
-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.js

@@ -1,96 +0,0 @@
-// @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 '../when/whenAnimationEnd.js';
-import whenEntersViewport from '../when/whenEntersViewport.js';
-import whenInteract from '../when/whenInteract.js';
-import whenInViewport from '../when/whenInViewport.js';
-import whenNearViewport from '../when/whenNearViewport.js';
-import whenOutOfViewport from '../when/whenOutOfViewport.js';
-import whenStylesheetsReady from '../when/whenStylesheetsReady.js';
-import whenVisible from '../when/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) => {
-            // 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 'entersViewport':
-                    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, {
-                        whenVisible: finalSettings.whenVisible,
-                        once: true,
-                    }));
-                    break;
-                case 'domReady':
-                    promises.push(whenDomReady());
-                    break;
-                case 'stylesheetsReady':
-                    promises.push(whenStylesheetsReady($elm ? [$elm] : null));
-                    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.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"when.js","sourceRoot":"","sources":["../../../../src/js/dom/when/when.ts"],"names":[],"mappings":"AAAA,cAAc;;;;;;;;;;AAUd,OAAO,gBAAgB,MAAM,6BAA6B,CAAC;AAC3D,OAAO,kBAAkB,MAAM,+BAA+B,CAAC;AAC/D,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,gBAAgB,MAAM,6BAA6B,CAAC;AAC3D,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,oBAAoB,MAAM,iCAAiC,CAAC;AACnE,OAAO,WAAW,MAAM,wBAAwB,CAAC;AAqEjD,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,gBAAgB;oBACnB,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,EAAE;wBAChB,WAAW,EAAE,aAAa,CAAC,WAAW;wBACtC,IAAI,EAAE,IAAI;qBACX,CAAC,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,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC1D,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.d.ts

@@ -1,30 +0,0 @@
-/**
- * @name            whenAnimationEnd
- * @namespace       js.dom.when
- * @type            Function
- * @platform        js
- * @status          stable
- * @async
- *
- * Detect when animation ends
- *
- * @param    {HTMLElement}            $elm           The element to listen on
- * @return   {Promise<HTMLElement>}                  A promise that will be resolved once the animation has ended
- *
- * @snippet         whenAnimationEnd($1)
- * whenAnimationEnd($1).then(\$elm => {
- *   $2
- * });
- *
- * @todo      tests
- *
- * @example    js
- * import { whenAnimationEnd } from '@blackbyte/sugar/dom'
- * whenAnimationEnd(myCoolElm).then(($elm) => {
- *   // do something...
- * });
- *
- * @since           1.0.0
- * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function whenAnimationEnd($elm: HTMLElement): Promise<HTMLElement>;

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

@@ -1,39 +0,0 @@
-/**
- * @name            whenAnimationEnd
- * @namespace       js.dom.when
- * @type            Function
- * @platform        js
- * @status          stable
- * @async
- *
- * Detect when animation ends
- *
- * @param    {HTMLElement}            $elm           The element to listen on
- * @return   {Promise<HTMLElement>}                  A promise that will be resolved once the animation has ended
- *
- * @snippet         whenAnimationEnd($1)
- * whenAnimationEnd($1).then(\$elm => {
- *   $2
- * });
- *
- * @todo      tests
- *
- * @example    js
- * import { whenAnimationEnd } from '@blackbyte/sugar/dom'
- * whenAnimationEnd(myCoolElm).then(($elm) => {
- *   // do something...
- * });
- *
- * @since           1.0.0
- * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function whenAnimationEnd($elm) {
-    return new Promise((resolve) => {
-        $elm.addEventListener('animationend', (e) => {
-            resolve($elm);
-        }, {
-            once: true,
-        });
-    });
-}
-//# sourceMappingURL=whenAnimationEnd.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"whenAnimationEnd.js","sourceRoot":"","sources":["../../../../src/js/dom/when/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.d.ts

@@ -1,51 +0,0 @@
-/**
- * @name            whenAttribute
- * @namespace       js.dom.when
- * @type            Function
- * @platform        js
- * @status          stable
- * @async
- *
- * Resolve a promise when the wanted attribute on the passed HTMLElement exist or pass the check function provided
- *
- * @feature       Detect attribute changes
- * @feature       Possibility to pass a check function to check if the attribute suits your needs
- * @feature       Promise based API
- *
- * @param 		{HTMLElement} 			$elm 				        The HTMLElement on which to monitor the property
- * @param 		{String} 					  attribute 			    The attribute to monitor
- * @param 		{Function} 					[checkFn=null] 	    Optional function to check the attribute. The promise is resolved when this function return true
- * @return 		(Promise) 										          The promise that will be resolved when the attribute exist on the element (and that it passes the checkFn)
- *
- * @snippet         whenAttribute($1, $2)
- * whenAttribute($1, $2).then(value => {
- *   $3
- * });
- *
- * @todo      tests
- *
- * @example 	js
- * import { whenAttribute } from '@blackbyte/sugar/dom'
- *
- * // using promise
- * whenAttribute($myCoolHTMLElement, 'value').then(value => {
- *   // do something...
- * });
- *
- * // with a check function
- * whenAttribute($myCoolHTMLElement, 'value', {
- *   check(newVal, oldVal) {
- *    // make sure the value is a number
- *    return typeof(newVal) === 'number';
- *   }
- * }).then(value => {
- *   // do something...
- * });
- *
- * @since           1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export type TWhenAttributeSettings = {
-    check?: Function;
-};
-export default function whenAttribute($elm: HTMLElement, attrName: string, settings?: TWhenAttributeSettings): Promise<any>;

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

@@ -1,49 +0,0 @@
-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 '../../../shared/string/parse.js';
-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.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"whenAttribute.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenAttribute.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,OAAO,MAAM,iCAAiC,CAAC;AAsDtD,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,OAAO,CAAC,MAAA,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,mCAAI,WAAW,CAAC,CAAC;YAClE,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,OAAO,CACnB,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.d.ts

@@ -1,31 +0,0 @@
-/**
- * @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: HTMLElement): Promise<HTMLElement>;

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

@@ -1,61 +0,0 @@
-import { unquote } from '@blackbyte/sugar/string';
-import getStyleProperty from '../style/getStyleProperty.js';
-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;
-    });
-    return promise;
-}
-//# sourceMappingURL=whenBackgroundImageLoaded.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"whenBackgroundImageLoaded.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenBackgroundImageLoaded.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,eAAe,MAAM,sCAAsC,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAEH,OAAO,OAA+B,CAAC;AACzC,CAAC"}

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

@@ -1,31 +0,0 @@
-/**
- * @name            whenDomReady
- * @namespace       js.dom.when
- * @type            Function
- * @platform        js
- * @status          stable
- * @async
- *
- * Wait that the dom is ready before resolving the promise
- *
- * @param     {Function}          [callback=null]     A callback to call when ready
- * @return 		{Promise<void>} 					              A promise that will be resolved when the dom is ready
- *
- * @snippet         whenDomReady()
- * whenDomReady().then(() => {
- *   $1
- * });
- *
- * @todo      tests
- *
- * @example  	js
- * import { whenDomReady } from '@blackbyte/sugar/dom'
- * whenDomReady().then(() => {
- *   // do something...
- * });
- *
- * @see             https://www.jstips.co/en/javascript/detect-document-ready-in-pure-js/
- * @since           1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function whenDomReady(): Promise<void>;

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

@@ -1,45 +0,0 @@
-/**
- * @name            whenDomReady
- * @namespace       js.dom.when
- * @type            Function
- * @platform        js
- * @status          stable
- * @async
- *
- * Wait that the dom is ready before resolving the promise
- *
- * @param     {Function}          [callback=null]     A callback to call when ready
- * @return 		{Promise<void>} 					              A promise that will be resolved when the dom is ready
- *
- * @snippet         whenDomReady()
- * whenDomReady().then(() => {
- *   $1
- * });
- *
- * @todo      tests
- *
- * @example  	js
- * import { whenDomReady } from '@blackbyte/sugar/dom'
- * whenDomReady().then(() => {
- *   // do something...
- * });
- *
- * @see             https://www.jstips.co/en/javascript/detect-document-ready-in-pure-js/
- * @since           1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export default function whenDomReady() {
-    return new Promise((resolve) => {
-        if (document.readyState === 'complete') {
-            resolve();
-        }
-        else {
-            document.onreadystatechange = () => {
-                if (document.readyState === 'complete') {
-                    resolve();
-                }
-            };
-        }
-    });
-}
-//# sourceMappingURL=whenDomReady.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"whenDomReady.js","sourceRoot":"","sources":["../../../../src/js/dom/when/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.d.ts

@@ -1,39 +0,0 @@
-/**
- * @name                whenEntersViewport
- * @namespace           js.dom.when
- * @type                Function
- * @platform            js
- * @status              stable
- * @async
- *
- * Monitor an HTMLElement to be notified when it is enters in the viewport (1/3vh in the viewport), or in the viewport
- *
- * @feature       Promise based API
- * @feature       Some settings available to tweak the behavior
- *
- * @param 		{HTMLElement} 				                      $elm 					      The element to monitor
- * @param 		{Partial<TWhenEntersViewportSettings>} 			[settings={}] 		  Some settings to tweak the detection behavior
- * @return 		(Promise<HTMLElement>) 											                    The promise that will be resolved when the element is in the viewport
- *
- * @setting         {String}        [offset='0px 0px -25% 0px']         An offset to detect the element entering in viewport earlier or later
- *
- * @snippet         whenEntersViewport($1)
- * whenEntersViewport($1).then(\$elm => {
- *   $2
- * });
- *
- * @todo      tests
- *
- * @example 	js
- * import { whenEntersViewport } from '@blackbyte/sugar/dom'
- * whenEntersViewport($myElement).then(($elm) => {
- *   // do something with your element that has entered the viewport...
- * });
- *
- * @since           1.0.0
- * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
- */
-export type TWhenEntersViewportSettings = {
-    offset: string | number | undefined;
-};
-export default function whenEntersViewport(elm: HTMLElement, settings?: TWhenEntersViewportSettings): Promise<HTMLElement>;

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

@@ -1,58 +0,0 @@
-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.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"whenEntersViewport.js","sourceRoot":"","sources":["../../../../src/js/dom/when/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"}