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

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

@@ -0,0 +1,39 @@
+import getTransitionProperties from '../../style/getTransitionProperties/getTransitionProperties.js';
+/**
+ * @name                whenTransitionEnd
+ * @namespace           js.dom.when
+ * @type                Function
+ * @platform            js
+ * @status              stable
+ * @async
+ *
+ * Monitor an HTMLElement to be notified when his transition has ended
+ *
+ * @feature       Promise based API
+ *
+ * @param 		{HTMLElement} 				        $elm 		The element to monitor
+ * @return 		(Promise<HTMLElement>) 								The promise that will be resolved when the element transition has ended
+ *
+ * @snippet         whenTransitionEnd($1)
+ * whenTransitionEnd($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example 	js
+ * import { whenTransitionEnd } from '@blackbyte/sugar/dom'
+ * await whenTransitionEnd(myCoolHTMLElement);
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenTransitionEnd($elm) {
+    return new Promise((resolve) => {
+        const transition = getTransitionProperties($elm);
+        setTimeout(() => {
+            resolve($elm);
+        }, transition.totalDuration);
+    });
+}
+//# sourceMappingURL=whenTransitionEnd.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenTransitionEnd.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenTransitionEnd/whenTransitionEnd.ts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,MAAM,gEAAgE,CAAC;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,IAAiB;IAEjB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACjD,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,32 @@
+/**
+ * @name            whenVideoReady
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Wait until the passed video is ready to play.
+ * It checks if the video metadata has been loaded, and if not it waits for the `loadedmetadata` event.
+ *
+ * @feature         Promise based API
+ *
+ * @param 		{HTMLVideoElement} 			$video  		The video to check the ready state
+ * @return 		{Promise} 								    The promise that will be resolved when the video is ready to play
+ *
+ * @snippet         whenVideoReady($1)
+ * whenVideoReady($1).then(\$video => {
+ *   $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenVideoReady } from '@blackbyte/sugar/dom'
+ * whenVideoReady($myCoolHTMLVideoElement).then(($video) => {
+ *   // do something when the video is ready to play
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenVideoReady($video: HTMLVideoElement): Promise<HTMLVideoElement>;

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

@@ -0,0 +1,44 @@
+/**
+ * @name            whenVideoReady
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Wait until the passed video is ready to play.
+ * It checks if the video metadata has been loaded, and if not it waits for the `loadedmetadata` event.
+ *
+ * @feature         Promise based API
+ *
+ * @param 		{HTMLVideoElement} 			$video  		The video to check the ready state
+ * @return 		{Promise} 								    The promise that will be resolved when the video is ready to play
+ *
+ * @snippet         whenVideoReady($1)
+ * whenVideoReady($1).then(\$video => {
+ *   $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { whenVideoReady } from '@blackbyte/sugar/dom'
+ * whenVideoReady($myCoolHTMLVideoElement).then(($video) => {
+ *   // do something when the video is ready to play
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function whenVideoReady($video) {
+    return new Promise((resolve) => {
+        if ($video.duration > 0) {
+            resolve($video);
+        }
+        else {
+            $video.addEventListener('loadedmetadata', () => {
+                resolve($video);
+            });
+        }
+    });
+}
+//# sourceMappingURL=whenVideoReady.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenVideoReady.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenVideoReady/whenVideoReady.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CACpC,MAAwB;IAExB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,MAAM,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,GAAG,EAAE;gBAC7C,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,37 @@
+/**
+ * @name            whenVisible
+ * @namespace       js.dom.when
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Monitor an HTMLElement to be notified when it is visible
+ *
+ * @feature       Promise based API
+ *
+ * @param 		{HTMLElement} 				        $elm 		The element to monitor
+ * @return 		(Promise<HTMLElement>) 								The promise that will be resolved when the element is visible
+ *
+ * @snippet         whenVisible($1)
+ * whenVisible($1).then(\$elm => {
+ *      $2
+ * });
+ *
+ * @todo      tests
+ *
+ * @example 	js
+ * import { whenVisible } from '@blackbyte/sugar/dom'
+ * whenVisible(myCoolHTMLElement).then(($elm) => {
+ *   // do something with your element that is now visible
+ * });
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TWhenVisibleSettings = {
+    whenVisible?: Function;
+    whenInvisible?: Function;
+    once: boolean;
+};
+export default function whenVisible($elm: HTMLElement, settings?: Partial<TWhenVisibleSettings>): Promise<HTMLElement>;

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

@@ -0,0 +1,53 @@
+import { uniqid } from '@blackbyte/sugar/string';
+const _whenVisibleStatuses = new WeakMap();
+export default function whenVisible($elm, settings) {
+    let observer;
+    const pro = new Promise((resolve, reject) => {
+        var _a;
+        const finalSettings = Object.assign({ whenVisible: undefined, whenInvisible: undefined, once: true }, (settings !== null && settings !== void 0 ? settings : {}));
+        const statuses = (_a = _whenVisibleStatuses.get($elm)) !== null && _a !== void 0 ? _a : {};
+        _whenVisibleStatuses.set($elm, statuses);
+        // generate a uniqid for this listener
+        const id = uniqid();
+        observer = new IntersectionObserver(function (entries) {
+            var _a, _b;
+            if (entries[0]['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.whenInvisible) === null || _a === void 0 ? void 0 : _a.call(finalSettings, $elm);
+            }
+            else {
+                // "once" settings 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.whenVisible) === 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.observe($elm);
+    });
+    pro.finally(() => {
+        observer === null || observer === void 0 ? void 0 : observer.disconnect();
+    });
+    return pro;
+}
+//# sourceMappingURL=whenVisible.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"whenVisible.js","sourceRoot":"","sources":["../../../../../src/js/dom/when/whenVisible/whenVisible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAwCjD,MAAM,oBAAoB,GAAG,IAAI,OAAO,EAAE,CAAC;AAE3C,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,IAAiB,EACjB,QAAwC;IAExC,IAAI,QAA8B,CAAC;IAEnC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;QAC1C,MAAM,aAAa,mBACjB,WAAW,EAAE,SAAS,EACtB,aAAa,EAAE,SAAS,EACxB,IAAI,EAAE,IAAI,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAA,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;QACtD,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,sCAAsC;QACtC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,QAAQ,GAAG,IAAI,oBAAoB,CAAC,UAAU,OAAO;;YACnD,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,sDAAsD;gBACtD,yCAAyC;gBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBAClB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;gBAErB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,aAAa,8DAAG,IAAI,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,0BAA0B;gBAC1B,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,CAAC;gBAED,sDAAsD;gBACtD,uCAAuC;gBACvC,IAAI,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;gBAEpB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,WAAW,8DAAG,IAAI,CAAC,CAAC;gBAElC,yCAAyC;gBACzC,kBAAkB;gBAClB,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,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,GAA2B,CAAC;AACrC,CAAC"}

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

@@ -1,4 +1,4 @@
-import uniqid from '../../string/uniqid.js';
+import { uniqid } from '@blackbyte/sugar/string';
 const _whenVisibleStatuses = new WeakMap();
 export default function whenVisible($elm, settings) {
     let observer;

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

@@ -1 +1 @@
-{"version":3,"file":"whenVisible.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenVisible.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,wBAAwB,CAAC;AAwC5C,MAAM,oBAAoB,GAAG,IAAI,OAAO,EAAE,CAAC;AAE3C,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,IAAiB,EACjB,QAAwC;IAExC,IAAI,QAA8B,CAAC;IAEnC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;QAC1C,MAAM,aAAa,mBACjB,WAAW,EAAE,SAAS,EACtB,aAAa,EAAE,SAAS,EACxB,IAAI,EAAE,IAAI,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAA,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;QACtD,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,sCAAsC;QACtC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,QAAQ,GAAG,IAAI,oBAAoB,CAAC,UAAU,OAAO;;YACnD,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,sDAAsD;gBACtD,yCAAyC;gBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBAClB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;gBAErB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,aAAa,8DAAG,IAAI,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,0BAA0B;gBAC1B,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,CAAC;gBAED,sDAAsD;gBACtD,uCAAuC;gBACvC,IAAI,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;gBAEpB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,WAAW,8DAAG,IAAI,CAAC,CAAC;gBAElC,yCAAyC;gBACzC,kBAAkB;gBAClB,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,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,GAA2B,CAAC;AACrC,CAAC"}
+{"version":3,"file":"whenVisible.js","sourceRoot":"","sources":["../../../../src/js/dom/when/whenVisible.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAwCjD,MAAM,oBAAoB,GAAG,IAAI,OAAO,EAAE,CAAC;AAE3C,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,IAAiB,EACjB,QAAwC;IAExC,IAAI,QAA8B,CAAC;IAEnC,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;QAC1C,MAAM,aAAa,mBACjB,WAAW,EAAE,SAAS,EACtB,aAAa,EAAE,SAAS,EACxB,IAAI,EAAE,IAAI,IACP,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAA,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC;QACtD,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEzC,sCAAsC;QACtC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;QAEpB,QAAQ,GAAG,IAAI,oBAAoB,CAAC,UAAU,OAAO;;YACnD,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,sDAAsD;gBACtD,yCAAyC;gBACzC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBAClB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC;gBAErB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,aAAa,8DAAG,IAAI,CAAC,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,0BAA0B;gBAC1B,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,CAAC;gBAED,sDAAsD;gBACtD,uCAAuC;gBACvC,IAAI,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;oBACjB,OAAO;gBACT,CAAC;gBAED,yCAAyC;gBACzC,QAAQ,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;gBAEpB,oBAAoB;gBACpB,MAAA,aAAa,CAAC,WAAW,8DAAG,IAAI,CAAC,CAAC;gBAElC,yCAAyC;gBACzC,kBAAkB;gBAClB,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBACvB,OAAO,CAAC,IAAI,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,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,GAA2B,CAAC;AACrC,CAAC"}

package/dist/js/feature/_exports.d.ts

@@ -1,5 +1,5 @@
-import disableTitleTooltips from './disableTitleTooltips.js';
-import features from './features.js';
-import scrollClasses from './scrollClasses.js';
-import sectionClasses from './sectionClasses.js';
+import disableTitleTooltips from './disableTitleTooltips/disableTitleTooltips.js';
+import features from './features/features.js';
+import scrollClasses from './scrollClasses/scrollClasses.js';
+import sectionClasses from './sectionClasses/sectionClasses.js';
 export { disableTitleTooltips as __disableTitleTooltips, features as __features, scrollClasses as __scrollClasses, sectionClasses as __sectionClasses, disableTitleTooltips, features, scrollClasses, sectionClasses, };

package/dist/js/feature/_exports.js

@@ -1,6 +1,6 @@
-import disableTitleTooltips from './disableTitleTooltips.js';
-import features from './features.js';
-import scrollClasses from './scrollClasses.js';
-import sectionClasses from './sectionClasses.js';
+import disableTitleTooltips from './disableTitleTooltips/disableTitleTooltips.js';
+import features from './features/features.js';
+import scrollClasses from './scrollClasses/scrollClasses.js';
+import sectionClasses from './sectionClasses/sectionClasses.js';
 export { disableTitleTooltips as __disableTitleTooltips, features as __features, scrollClasses as __scrollClasses, sectionClasses as __sectionClasses, disableTitleTooltips, features, scrollClasses, sectionClasses, };
 //# sourceMappingURL=_exports.js.map

package/dist/js/feature/_exports.js.map

@@ -1 +1 @@
-{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/js/feature/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,2BAA2B,CAAC;AAC7D,OAAO,QAAQ,MAAM,eAAe,CAAC;AACrC,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,cAAc,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACL,oBAAoB,IAAI,sBAAsB,EAC9C,QAAQ,IAAI,UAAU,EACtB,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,oBAAoB,EACpB,QAAQ,EACR,aAAa,EACb,cAAc,GACf,CAAC"}
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/js/feature/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,gDAAgD,CAAC;AAClF,OAAO,QAAQ,MAAM,wBAAwB,CAAC;AAC9C,OAAO,aAAa,MAAM,kCAAkC,CAAC;AAC7D,OAAO,cAAc,MAAM,oCAAoC,CAAC;AAEhE,OAAO,EACL,oBAAoB,IAAI,sBAAsB,EAC9C,QAAQ,IAAI,UAAU,EACtB,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,oBAAoB,EACpB,QAAQ,EACR,aAAa,EACb,cAAc,GACf,CAAC"}

package/dist/js/feature/disableTitleTooltips/disableTitleTooltips.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @name            disableTitleTooltips
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This function allows you to disable the ugly tooltips that displays when hover a link/image/etc... with a "title" attribute.
+ * If you want to support accessibility, make use of the "aria-label" attribute instead
+ *
+ * @snippet          disableTitleTooltips();
+ *
+ * @example         js
+ * import { disableTitleTooltips } from '@blackbyte/sugar/features';
+ * disableTitleTooltips();
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function disableTitleTooltips(): void;

package/dist/js/feature/disableTitleTooltips/disableTitleTooltips.js

@@ -0,0 +1,26 @@
+import { querySelectorLive } from '@blackbyte/sugar/dom';
+/**
+ * @name            disableTitleTooltips
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This function allows you to disable the ugly tooltips that displays when hover a link/image/etc... with a "title" attribute.
+ * If you want to support accessibility, make use of the "aria-label" attribute instead
+ *
+ * @snippet          disableTitleTooltips();
+ *
+ * @example         js
+ * import { disableTitleTooltips } from '@blackbyte/sugar/features';
+ * disableTitleTooltips();
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function disableTitleTooltips() {
+    querySelectorLive('[title]:is(a,img)', ($elm) => {
+        $elm.removeAttribute('title');
+    });
+}
+//# sourceMappingURL=disableTitleTooltips.js.map

package/dist/js/feature/disableTitleTooltips/disableTitleTooltips.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"disableTitleTooltips.js","sourceRoot":"","sources":["../../../../src/js/feature/disableTitleTooltips/disableTitleTooltips.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB;IAC1C,iBAAiB,CAAC,mBAAmB,EAAE,CAAC,IAAiB,EAAE,EAAE;QAC3D,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/js/feature/features/features.d.ts

@@ -0,0 +1,32 @@
+import { TScrollClassesSettings } from '../scrollClasses/scrollClasses.js';
+import { TSectionClassesSettings } from '../sectionClasses/sectionClasses.js';
+/**
+ * @name            features
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This function allows you to activate some features like the `disableTitleTooltip`,`sectionClasses`, etc...
+ * Available features are:
+ * - `disableTitleTooltip`
+ * - `scrollClasses`
+ * - `sectionClasses`
+ *
+ * @param           {'all' | TFeaturesSettings}                 [settings={}]               The features you want to activate with some settings associated if needed
+ *
+ * @snippet          features($1);
+ *
+ * @example         js
+ * import { features } from '@blackbyte/sugar/features';
+ * features('all');
+ *
+ * @since           1.0.0
+ * @author          Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TFeaturesSettings = {
+    disableTitleTooltips?: boolean;
+    scrollClasses?: boolean | TScrollClassesSettings;
+    sectionClasses?: boolean | TSectionClassesSettings;
+};
+export default function features(features: 'all' | TFeaturesSettings): void;

package/dist/js/feature/features/features.js

@@ -0,0 +1,19 @@
+import disableTitleTooltips from '../disableTitleTooltips/disableTitleTooltips.js';
+import scrollClasses from '../scrollClasses/scrollClasses.js';
+import sectionClasses from '../sectionClasses/sectionClasses.js';
+export default function features(features) {
+    if (features === 'all' || features.disableTitleTooltips) {
+        disableTitleTooltips();
+    }
+    if (features === 'all' || features.scrollClasses) {
+        scrollClasses(features === 'all'
+            ? undefined
+            : features.scrollClasses);
+    }
+    if (features === 'all' || features.sectionClasses) {
+        sectionClasses(features === 'all'
+            ? undefined
+            : features.sectionClasses);
+    }
+}
+//# sourceMappingURL=features.js.map

package/dist/js/feature/features/features.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.js","sourceRoot":"","sources":["../../../../src/js/feature/features/features.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,MAAM,iDAAiD,CAAC;AACnF,OAAO,aAAyC,MAAM,mCAAmC,CAAC;AAC1F,OAAO,cAA2C,MAAM,qCAAqC,CAAC;AAiC9F,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,QAAmC;IAClE,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,CAAC,oBAAoB,EAAE,CAAC;QACxD,oBAAoB,EAAE,CAAC;IACzB,CAAC;IACD,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACjD,aAAa,CACX,QAAQ,KAAK,KAAK;YAChB,CAAC,CAAC,SAAS;YACX,CAAC,CAAE,QAAQ,CAAC,aAAwC,CACvD,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,KAAK,KAAK,IAAI,QAAQ,CAAC,cAAc,EAAE,CAAC;QAClD,cAAc,CACZ,QAAQ,KAAK,KAAK;YAChB,CAAC,CAAC,SAAS;YACX,CAAC,CAAE,QAAQ,CAAC,cAA0C,CACzD,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/js/feature/scrollClasses/scrollClasses.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @name            scrollClasses
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This feature allows you to have `-scrolled`, `-scrolled-x`, `-scrolled-y`, `-scrolled-up` and `-scrolled-down` classes added and removed from
+ * the body depending on an scroll offset that can be set by:
+ * 1. `-scrolled`: Added when passed the `offset` set in the settings
+ * 2. `-scrolled-x`: Added when passed the `offsetX` set in the settings
+ * 3. `-scrolled-y`: Added when passed the `offsetY` set in the settings
+ * 4. `-scrolled-up`: Added when the user scrolls up (no offset)
+ * 5. `-scrolled-down`: Added when the user scrolls down (no offset)
+ *
+ * Note that you can specify these settings in the CSS with the following variables:
+ * - `--s-scrolled-classes-offset`: The offset you want before adding the classes
+ * - `--s-scrolled-classes-offset-x`: The offset x you want before adding the classes
+ * - `--s-scrolled-classes-offset-y`: The offset y you want before adding the classes
+ * - `--s-scrolled-classes-class`: The class name you want. Will be used also in the %cls-x and %cls-y classes
+ *
+ * @param           {TScrollClassesSettings}          [settings={}]           The settings you want to override
+ *
+ * @setting         {number}        [offset=100]                The offset you want before adding the classes
+ * @setting         {number}        [offsetX=null]              The offset x you want before adding the classes
+ * @setting         {number}        [offsetY=null]              The offset y you want before adding the classes
+ * @setting         {string}        [class=scrolled]            The class name you want. Will be used also in the %cls-x and %cls-y classes
+ *
+ * @snippet          scrollClasses($1);
+ *
+ * @example         js
+ * import { scrollClasses } from '@blackbyte/sugar/features';
+ * scrollClasses({
+ *      class: 'hello',
+ *      offset: 200
+ * });
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TScrollClassesSettings = {
+    offset: number;
+    offsetX: number;
+    offsetY: number;
+    class: string;
+};
+export default function scrollClasses(settings?: TScrollClassesSettings): void;

package/dist/js/feature/scrollClasses/scrollClasses.js

@@ -0,0 +1,104 @@
+/**
+ * @name            scrollClasses
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This feature allows you to have `-scrolled`, `-scrolled-x`, `-scrolled-y`, `-scrolled-up` and `-scrolled-down` classes added and removed from
+ * the body depending on an scroll offset that can be set by:
+ * 1. `-scrolled`: Added when passed the `offset` set in the settings
+ * 2. `-scrolled-x`: Added when passed the `offsetX` set in the settings
+ * 3. `-scrolled-y`: Added when passed the `offsetY` set in the settings
+ * 4. `-scrolled-up`: Added when the user scrolls up (no offset)
+ * 5. `-scrolled-down`: Added when the user scrolls down (no offset)
+ *
+ * Note that you can specify these settings in the CSS with the following variables:
+ * - `--s-scrolled-classes-offset`: The offset you want before adding the classes
+ * - `--s-scrolled-classes-offset-x`: The offset x you want before adding the classes
+ * - `--s-scrolled-classes-offset-y`: The offset y you want before adding the classes
+ * - `--s-scrolled-classes-class`: The class name you want. Will be used also in the %cls-x and %cls-y classes
+ *
+ * @param           {TScrollClassesSettings}          [settings={}]           The settings you want to override
+ *
+ * @setting         {number}        [offset=100]                The offset you want before adding the classes
+ * @setting         {number}        [offsetX=null]              The offset x you want before adding the classes
+ * @setting         {number}        [offsetY=null]              The offset y you want before adding the classes
+ * @setting         {string}        [class=scrolled]            The class name you want. Will be used also in the %cls-x and %cls-y classes
+ *
+ * @snippet          scrollClasses($1);
+ *
+ * @example         js
+ * import { scrollClasses } from '@blackbyte/sugar/features';
+ * scrollClasses({
+ *      class: 'hello',
+ *      offset: 200
+ * });
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function scrollClasses(settings) {
+    const style = window.getComputedStyle(document.body);
+    const finalSettings = Object.assign({ offset: parseInt(style.getPropertyValue('--s-scrolled-classes-offset') || '0') ||
+            100, offsetX: parseInt(style.getPropertyValue('--s-scrolled-classes-offset-x') || '0'), offsetY: parseInt(style.getPropertyValue('--s-scrolled-classes-offset-y') || '0'), class: style.getPropertyValue('--s-scrolled-classes-class') || 'scrolled' }, (settings !== null && settings !== void 0 ? settings : {}));
+    let currentX = window.scrollX, currentY = window.scrollY;
+    const offsetX = finalSettings.offsetX !== 0
+        ? finalSettings.offsetX
+        : finalSettings.offset, offsetY = finalSettings.offsetY !== 0
+        ? finalSettings.offsetY
+        : finalSettings.offset;
+    function handleScroll() {
+        let isScrolled = false;
+        // scrolled up/down class
+        if (window.scrollY > currentY) {
+            document.body.classList.remove(`${finalSettings.class}-up`);
+            if (!document.body.classList.contains(`${finalSettings.class}-down`)) {
+                document.body.classList.add(`${finalSettings.class}-down`);
+            }
+        }
+        else if (window.scrollY < currentY) {
+            document.body.classList.remove(`${finalSettings.class}-down`);
+            if (!document.body.classList.contains(`${finalSettings.class}-up`)) {
+                document.body.classList.add(`${finalSettings.class}-up`);
+            }
+        }
+        if (window.scrollY >= offsetY) {
+            if (!document.body.classList.contains(`${finalSettings.class}-y`)) {
+                document.body.classList.add(`${finalSettings.class}-y`);
+            }
+            isScrolled = true;
+        }
+        else {
+            if (document.body.classList.contains(`${finalSettings.class}-y`)) {
+                document.body.classList.remove(`${finalSettings.class}-y`);
+            }
+        }
+        if (window.scrollX >= offsetX) {
+            if (!document.body.classList.contains(`${finalSettings.class}-x`)) {
+                document.body.classList.add(`${finalSettings.class}-x`);
+            }
+            isScrolled = true;
+        }
+        else {
+            if (document.body.classList.contains(`${finalSettings.class}-x`)) {
+                document.body.classList.remove(`${finalSettings.class}-x`);
+            }
+        }
+        if (isScrolled) {
+            if (!document.body.classList.contains(finalSettings.class)) {
+                document.body.classList.add(finalSettings.class);
+            }
+        }
+        else {
+            if (document.body.classList.contains(finalSettings.class)) {
+                document.body.classList.remove(finalSettings.class);
+            }
+        }
+        currentX = window.scrollX;
+        currentY = window.scrollY;
+        requestAnimationFrame(handleScroll);
+    }
+    requestAnimationFrame(handleScroll);
+}
+//# sourceMappingURL=scrollClasses.js.map

package/dist/js/feature/scrollClasses/scrollClasses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrollClasses.js","sourceRoot":"","sources":["../../../../src/js/feature/scrollClasses/scrollClasses.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AASH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,QAAiC;IACrE,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAErD,MAAM,aAAa,mBACjB,MAAM,EACJ,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,6BAA6B,CAAC,IAAI,GAAG,CAAC;YACtE,GAAG,EACL,OAAO,EAAE,QAAQ,CACf,KAAK,CAAC,gBAAgB,CAAC,+BAA+B,CAAC,IAAI,GAAG,CAC/D,EACD,OAAO,EAAE,QAAQ,CACf,KAAK,CAAC,gBAAgB,CAAC,+BAA+B,CAAC,IAAI,GAAG,CAC/D,EACD,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,4BAA4B,CAAC,IAAI,UAAU,IACtE,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,IAAI,QAAQ,GAAW,MAAM,CAAC,OAAO,EACnC,QAAQ,GAAW,MAAM,CAAC,OAAO,CAAC;IAEpC,MAAM,OAAO,GACT,aAAa,CAAC,OAAO,KAAK,CAAC;QACzB,CAAC,CAAC,aAAa,CAAC,OAAO;QACvB,CAAC,CAAC,aAAa,CAAC,MAAM,EAC1B,OAAO,GACL,aAAa,CAAC,OAAO,KAAK,CAAC;QACzB,CAAC,CAAC,aAAa,CAAC,OAAO;QACvB,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC;IAE7B,SAAS,YAAY;QACnB,IAAI,UAAU,GAAG,KAAK,CAAC;QAEvB,yBAAyB;QACzB,IAAI,MAAM,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;YAC9B,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,KAAK,CAAC,CAAC;YAC5D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,OAAO,CAAC,EAAE,CAAC;gBACrE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,OAAO,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,OAAO,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;gBACnE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,KAAK,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;gBAClE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,CAAC;YAC1D,CAAC;YACD,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;gBACjE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;gBAClE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,CAAC;YAC1D,CAAC;YACD,UAAU,GAAG,IAAI,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;gBACjE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3D,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1D,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAC1B,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC;QAE1B,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;IACD,qBAAqB,CAAC,YAAY,CAAC,CAAC;AACtC,CAAC"}

package/dist/js/feature/sectionClasses/sectionClasses.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @name            sectionClasses
+ * @namespace       js.dom.feature
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ *
+ * This feature allows you to add some classes on your sections when they are in the viewport, near the viewport, above, etc...
+ * 1. `-in-viewport`: Added when the section is in the viewport
+ * 2. `-from-above`: Added when the section enters the viewport from above
+ * 3. `-from-below`: Added when the section enters the viewport from below
+ * 4. `-above-viewport`: Added when the section is above the viewport
+ * 5. `-below-viewport`: Added when the section is below the viewport
+ *
+ * @param           {TSectionClassesSettings}          [settings={}]           The settings you want to override
+ *
+ * @setting        {String}          [inClass='-in-viewport']        The class to add when the section is in the viewport
+ * @setting        {Boolean}         [keepInClassWhenAbove=false]   Whether to keep the inClass when the section is above the viewport
+ * @setting        {String}          [fromAboveClass='-from-above'] The class to add when the section enters the viewport from above
+ * @setting        {String}          [fromBelowClass='-from-below'] The class to add when the section enters the viewport from below
+ * @setting        {String}          [aboveClass='-above-viewport'] The class to add when the section is above the viewport
+ * @setting        {String}          [belowClass='-below-viewport'] The class to add when
+ * @setting        {Number}          [offset=25]                     The offset in px to consider the section is in the viewport
+ *
+ * @snippet          sectionClasses($1);
+ *
+ * @example         js
+ * import { sectionClasses } from '@blackbyte/sugar/features';
+ * sectionClasses();
+ *
+ * @since       1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TSectionClassesSettings = {
+    inClass: string;
+    keepInClassWhenAbove: boolean;
+    fromAboveClass: string;
+    fromBelowClass: string;
+    aboveClass: string;
+    belowClass: string;
+    offset: number;
+    once?: boolean;
+};
+export default function sectionClasses(settings?: Partial<TSectionClassesSettings>): void;