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

package/dist/js/is/isScrollable/isScrollable.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @name            isScrollable
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Check if the passed element is scrollable or not
+ *
+ * @param     {HTMLElement}       $elm        The element to check
+ * @return    {Boolean}                       true if is scrollable, false if not
+ *
+ * @snippet         isScrollable($1)
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { isScrollable } from '@blackbyte/sugar/is'
+ * if (isScrollable($myElement)) {
+ *   // do something
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TIsScrollableSettings = {
+    x: boolean;
+    y: boolean;
+};
+export default function isScrollable($elm: HTMLElement, settings?: Partial<TIsScrollableSettings>): boolean;

package/dist/js/is/isScrollable/isScrollable.js

@@ -0,0 +1,48 @@
+/**
+ * @name            isScrollable
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Check if the passed element is scrollable or not
+ *
+ * @param     {HTMLElement}       $elm        The element to check
+ * @return    {Boolean}                       true if is scrollable, false if not
+ *
+ * @snippet         isScrollable($1)
+ *
+ * @todo      tests
+ *
+ * @example    js
+ * import { isScrollable } from '@blackbyte/sugar/is'
+ * if (isScrollable($myElement)) {
+ *   // do something
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isScrollable($elm, settings) {
+    var _a;
+    settings = Object.assign({ x: true, y: true }, (settings !== null && settings !== void 0 ? settings : {}));
+    // check only Element nodes
+    if (!($elm instanceof Element)) {
+        return false;
+    }
+    const style = ((_a = window.parent) !== null && _a !== void 0 ? _a : window).getComputedStyle($elm);
+    var overflowY = style.overflowY.trim();
+    var overflowX = style.overflowX.trim();
+    const dir = {
+        vertical: (overflowY === 'scroll' || overflowY === 'auto') &&
+            $elm.scrollHeight > $elm.clientHeight,
+        horizontal: (overflowX === 'scroll' || overflowX === 'auto') &&
+            $elm.scrollWidth > $elm.clientWidth,
+    };
+    if (settings.x && dir.horizontal)
+        return true;
+    if (settings.y && dir.vertical)
+        return true;
+    return false;
+}
+//# sourceMappingURL=isScrollable.js.map

package/dist/js/is/isScrollable/isScrollable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isScrollable.js","sourceRoot":"","sources":["../../../../src/js/is/isScrollable/isScrollable.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAOH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,IAAiB,EACjB,QAAyC;;IAEzC,QAAQ,GAAG,gBACT,CAAC,EAAE,IAAI,EACP,CAAC,EAAE,IAAI,IACJ,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,2BAA2B;IAC3B,IAAI,CAAC,CAAC,IAAI,YAAY,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,GAAG,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,MAAM,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC/D,IAAI,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IACvC,IAAI,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAEvC,MAAM,GAAG,GAAG;QACV,QAAQ,EACN,CAAC,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC;YAChD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY;QACvC,UAAU,EACR,CAAC,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC;YAChD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW;KACtC,CAAC;IAEF,IAAI,QAAQ,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAC9C,IAAI,QAAQ,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC5C,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/js/is/isTablet/isTablet.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @name              isTablet
+ * @namespace         js.is
+ * @type              Function
+ * @platform          js
+ * @status            stable
+ *
+ * Detect if is a tablet device
+ *
+ * @return    {Boolean}    true if is a tablet, false if not
+ *
+ * @todo      integrate some kind of media query check
+ * @todo      tests
+ *
+ * @snippet         isTablet()
+ *
+ * @example 	js
+ * import { isTablet } from '@blackbyte/sugar/is'
+ * if (isTablet()) {
+ *   // do something cool...
+ * }
+ *
+ * @see       https://blog.devgenius.io/4-ways-to-detect-mobile-browsers-in-javascript-943b66657524
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isTablet(): boolean;

package/dist/js/is/isTablet/isTablet.js

@@ -0,0 +1,45 @@
+/**
+ * @name              isTablet
+ * @namespace         js.is
+ * @type              Function
+ * @platform          js
+ * @status            stable
+ *
+ * Detect if is a tablet device
+ *
+ * @return    {Boolean}    true if is a tablet, false if not
+ *
+ * @todo      integrate some kind of media query check
+ * @todo      tests
+ *
+ * @snippet         isTablet()
+ *
+ * @example 	js
+ * import { isTablet } from '@blackbyte/sugar/is'
+ * if (isTablet()) {
+ *   // do something cool...
+ * }
+ *
+ * @see       https://blog.devgenius.io/4-ways-to-detect-mobile-browsers-in-javascript-943b66657524
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isTablet() {
+    // touch event
+    if (!('ontouchstart' in document.documentElement))
+        return false;
+    // orientation
+    if (window.orientation === undefined)
+        return false;
+    // match media
+    const minWidth = 640, maxWidth = 1279;
+    if (!window.matchMedia(`only screen and (min-width: ${minWidth}px) and (max-width: ${maxWidth}px)`).matches) {
+        return false;
+    }
+    // limited accuracy
+    if (!window.matchMedia('(pointer: coarse)').matches)
+        return false;
+    // it seems that it's a tablet
+    return true;
+}
+//# sourceMappingURL=isTablet.js.map

package/dist/js/is/isTablet/isTablet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isTablet.js","sourceRoot":"","sources":["../../../../src/js/is/isTablet/isTablet.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ;IAC9B,cAAc;IACd,IAAI,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,eAAe,CAAC;QAAE,OAAO,KAAK,CAAC;IAChE,cAAc;IACd,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACnD,cAAc;IACd,MAAM,QAAQ,GAAG,GAAG,EAClB,QAAQ,GAAG,IAAI,CAAC;IAClB,IACE,CAAC,MAAM,CAAC,UAAU,CAChB,+BAA+B,QAAQ,uBAAuB,QAAQ,KAAK,CAC5E,CAAC,OAAO,EACT,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,mBAAmB;IACnB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAClE,8BAA8B;IAC9B,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/js/is/isUcBrowser/isUcBrowser.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name            isUcBrowser
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Detect if is the UC stock browser that is running the page
+ *
+ * @param       {String}        [ua=navigator.userAgent]        The user agent on which to make the test
+ * @return      {Boolean}                                       true if is UC browser, false if not
+ *
+ * @todo      tests
+ *
+ * @snippet         isUcBrowser()
+ *
+ * @example    js
+ * import { isUcBrowser } from '@blackbyte/sugar/is'
+ * if (isUcBrowser()) {
+ *   // do something
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isUcBrowser(ua?: string): boolean;

package/dist/js/is/isUcBrowser/isUcBrowser.js

@@ -0,0 +1,29 @@
+/**
+ * @name            isUcBrowser
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Detect if is the UC stock browser that is running the page
+ *
+ * @param       {String}        [ua=navigator.userAgent]        The user agent on which to make the test
+ * @return      {Boolean}                                       true if is UC browser, false if not
+ *
+ * @todo      tests
+ *
+ * @snippet         isUcBrowser()
+ *
+ * @example    js
+ * import { isUcBrowser } from '@blackbyte/sugar/is'
+ * if (isUcBrowser()) {
+ *   // do something
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isUcBrowser(ua = navigator.userAgent) {
+    return ua.match(/UCBrowser/i) !== null;
+}
+//# sourceMappingURL=isUcBrowser.js.map

package/dist/js/is/isUcBrowser/isUcBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUcBrowser.js","sourceRoot":"","sources":["../../../../src/js/is/isUcBrowser/isUcBrowser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,KAAa,SAAS,CAAC,SAAS;IAClE,OAAO,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;AACzC,CAAC"}

package/dist/js/is/isUserScrolling/isUserScrolling.d.ts

@@ -0,0 +1 @@
+export default function isUserScrolling($elm: any): boolean;

package/dist/js/is/isUserScrolling/isUserScrolling.js

@@ -0,0 +1,64 @@
+var _a, _b;
+/**
+ * @name            isUserScrolling
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ * @async
+ *
+ * Check the user is scrolling a particular element
+ *
+ * @param 		{HTMLElement} 				[$elm=document]  			The element to monitor
+ * @return 		{Boolean}									                  If the element is in the viewport or not
+ *
+ * @snippet         isUserScrolling()
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { isUserScrolling } from '@blackbyte/sugar/is'
+ * if (isUserScrolling(myCoolHTMLElement) {
+ *   // i'm in the viewport
+ * }
+ *
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+let _isUserScrolling = false, _isUserScrollingTimeout;
+try {
+    (_a = document === null || document === void 0 ? void 0 : document.addEventListener) === null || _a === void 0 ? void 0 : _a.call(document, 'wheel', (e) => {
+        _isUserScrolling = true;
+        clearTimeout(_isUserScrollingTimeout);
+        _isUserScrollingTimeout = setTimeout(() => {
+            _isUserScrolling = false;
+        }, 200);
+    });
+    (_b = document === null || document === void 0 ? void 0 : document.addEventListener) === null || _b === void 0 ? void 0 : _b.call(document, 'touchmove', (e) => {
+        _isUserScrolling = true;
+        clearTimeout(_isUserScrollingTimeout);
+        _isUserScrollingTimeout = setTimeout(() => {
+            _isUserScrolling = false;
+        }, 200);
+    });
+}
+catch (e) { }
+export default function isUserScrolling($elm) {
+    if ($elm._isUserInteractive !== undefined) {
+        return !!($elm._isUserInteractive && _isUserScrolling);
+    }
+    $elm.addEventListener('mouseover', (e) => {
+        $elm._isUserInteractive = true;
+    });
+    $elm.addEventListener('mouseout', (e) => {
+        $elm._isUserInteractive = false;
+    });
+    $elm.addEventListener('touchstart', (e) => {
+        $elm._isUserInteractive = true;
+    });
+    $elm.addEventListener('touchend', (e) => {
+        $elm._isUserInteractive = false;
+    });
+    return false;
+}
+//# sourceMappingURL=isUserScrolling.js.map

package/dist/js/is/isUserScrolling/isUserScrolling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isUserScrolling.js","sourceRoot":"","sources":["../../../../src/js/is/isUserScrolling/isUserScrolling.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,IAAI,gBAAgB,GAAG,KAAK,EAC1B,uBAAuB,CAAC;AAC1B,IAAI,CAAC;IACH,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,yDAAG,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1C,gBAAgB,GAAG,IAAI,CAAC;QACxB,YAAY,CAAC,uBAAuB,CAAC,CAAC;QACtC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;YACxC,gBAAgB,GAAG,KAAK,CAAC;QAC3B,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;IAEH,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,yDAAG,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;QAC9C,gBAAgB,GAAG,IAAI,CAAC;QACxB,YAAY,CAAC,uBAAuB,CAAC,CAAC;QACtC,uBAAuB,GAAG,UAAU,CAAC,GAAG,EAAE;YACxC,gBAAgB,GAAG,KAAK,CAAC;QAC3B,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC,CAAC,CAAC;AACL,CAAC;AAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;AAEd,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,IAAI;IAC1C,IAAI,IAAI,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,IAAI,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;QACvC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;QACtC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClC,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,EAAE;QACxC,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE;QACtC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/js/is/isVideoPlaying/isVideoPlaying.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @name            isVideoPlaying
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This function allows you to know if a video is currently playing or not
+ *
+ * @param     {HTMLVideoElement}      $video       The video element to check
+ * @return    {Boolean}                           true if the video is playing, false if not
+ *
+ * @todo      tests
+ *
+ * @snippet         isVideoPlaying($1)
+ *
+ * @example 	js
+ * import { isVideoPlaying } from '@blackbyte/sugar/is'
+ * if (isVideoPlaying($myVideo)) {
+ *   // do something cool...
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isVideoPlaying($video: HTMLVideoElement): boolean;

package/dist/js/is/isVideoPlaying/isVideoPlaying.js

@@ -0,0 +1,32 @@
+/**
+ * @name            isVideoPlaying
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * This function allows you to know if a video is currently playing or not
+ *
+ * @param     {HTMLVideoElement}      $video       The video element to check
+ * @return    {Boolean}                           true if the video is playing, false if not
+ *
+ * @todo      tests
+ *
+ * @snippet         isVideoPlaying($1)
+ *
+ * @example 	js
+ * import { isVideoPlaying } from '@blackbyte/sugar/is'
+ * if (isVideoPlaying($myVideo)) {
+ *   // do something cool...
+ * }
+ *
+ * @since           1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isVideoPlaying($video) {
+    return !!($video.currentTime > 0 &&
+        !$video.paused &&
+        !$video.ended &&
+        $video.readyState > 2);
+}
+//# sourceMappingURL=isVideoPlaying.js.map

package/dist/js/is/isVideoPlaying/isVideoPlaying.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isVideoPlaying.js","sourceRoot":"","sources":["../../../../src/js/is/isVideoPlaying/isVideoPlaying.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,MAAwB;IAC7D,OAAO,CAAC,CAAC,CACP,MAAM,CAAC,WAAW,GAAG,CAAC;QACtB,CAAC,MAAM,CAAC,MAAM;QACd,CAAC,MAAM,CAAC,KAAK;QACb,MAAM,CAAC,UAAU,GAAG,CAAC,CACtB,CAAC;AACJ,CAAC"}

package/dist/js/is/isVisible/isVisible.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @name            isVisible
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Check if the passed HTMLElement is visible or not.
+ * Visible mean that it has not an opacity of 0, not a visibility of hidden and not a display of none and `return !!(e.offsetWidth || e.offsetHeight || e.getClientRects().length);`
+ *
+ * @param 		{HTMLElement} 				$elm  		The element to check
+ * @return 		{Boolean}								        If the element is visible or not
+ *
+ * @snippet         isVisible($1)
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { isVisible } from '@blackbyte/sugar/is'
+ * if (isVisible(myCoolHTMLElement) {
+ *   // i'm visible
+ * }
+ *
+ * @see             https://stackoverflow.com/questions/19669786/check-if-element-is-visible-in-dom
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export default function isVisible(elm: HTMLElement): boolean;

package/dist/js/is/isVisible/isVisible.js

@@ -0,0 +1,43 @@
+/**
+ * @name            isVisible
+ * @namespace       js.is
+ * @type            Function
+ * @platform        js
+ * @status          stable
+ *
+ * Check if the passed HTMLElement is visible or not.
+ * Visible mean that it has not an opacity of 0, not a visibility of hidden and not a display of none and `return !!(e.offsetWidth || e.offsetHeight || e.getClientRects().length);`
+ *
+ * @param 		{HTMLElement} 				$elm  		The element to check
+ * @return 		{Boolean}								        If the element is visible or not
+ *
+ * @snippet         isVisible($1)
+ *
+ * @todo      tests
+ *
+ * @example  	js
+ * import { isVisible } from '@blackbyte/sugar/is'
+ * if (isVisible(myCoolHTMLElement) {
+ *   // i'm visible
+ * }
+ *
+ * @see             https://stackoverflow.com/questions/19669786/check-if-element-is-visible-in-dom
+ * @since           1.0.0
+ * @author         Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+function _isVisible(e) {
+    return !!(e.offsetWidth || e.offsetHeight || e.getClientRects().length);
+}
+export default function isVisible(elm) {
+    // assume that the script tag is always visible
+    if (elm.nodeName.toLowerCase() === 'script')
+        return true;
+    // check if visible through offsets and clientRects
+    if (!_isVisible(elm)) {
+        return false;
+    }
+    // get style
+    const style = window.getComputedStyle(elm, null), opacity = style.opacity, visibility = style.visibility, display = style.display;
+    return '0' !== opacity && 'none' !== display && 'hidden' !== visibility;
+}
+//# sourceMappingURL=isVisible.js.map

package/dist/js/is/isVisible/isVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isVisible.js","sourceRoot":"","sources":["../../../../src/js/is/isVisible/isVisible.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,SAAS,UAAU,CAAC,CAAC;IACnB,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,GAAgB;IAChD,+CAA+C;IAC/C,IAAI,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAEzD,mDAAmD;IACnD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,YAAY;IACZ,MAAM,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,GAAG,EAAE,IAAI,CAAC,EAC9C,OAAO,GAAG,KAAK,CAAC,OAAO,EACvB,UAAU,GAAG,KAAK,CAAC,UAAU,EAC7B,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAC1B,OAAO,GAAG,KAAK,OAAO,IAAI,MAAM,KAAK,OAAO,IAAI,QAAQ,KAAK,UAAU,CAAC;AAC1E,CAAC"}

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

@@ -1,5 +1,5 @@
-import escapeQueue, { escapeQueueLength } from './escapeQueue.js';
-import hotkey from './hotkey.js';
-export * from './escapeQueue.js';
-export * from './hotkey.js';
+import escapeQueue, { escapeQueueLength } from './escapeQueue/escapeQueue.js';
+import hotkey from './hotkey/hotkey.js';
+export * from './escapeQueue/escapeQueue.js';
+export * from './hotkey/hotkey.js';
 export { escapeQueue as __escapeQueue, escapeQueueLength as __escapeQueueLength, hotkey as __hotkey, escapeQueue, escapeQueueLength, hotkey, };

package/dist/js/keyboard/_exports.js

@@ -1,6 +1,6 @@
-import escapeQueue, { escapeQueueLength } from './escapeQueue.js';
-import hotkey from './hotkey.js';
-export * from './escapeQueue.js';
-export * from './hotkey.js';
+import escapeQueue, { escapeQueueLength } from './escapeQueue/escapeQueue.js';
+import hotkey from './hotkey/hotkey.js';
+export * from './escapeQueue/escapeQueue.js';
+export * from './hotkey/hotkey.js';
 export { escapeQueue as __escapeQueue, escapeQueueLength as __escapeQueueLength, hotkey as __hotkey, escapeQueue, escapeQueueLength, hotkey, };
 //# sourceMappingURL=_exports.js.map

package/dist/js/keyboard/_exports.js.map

@@ -1 +1 @@
-{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/js/keyboard/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,EAAE,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAE5B,OAAO,EACL,WAAW,IAAI,aAAa,EAC5B,iBAAiB,IAAI,mBAAmB,EACxC,MAAM,IAAI,QAAQ,EAClB,WAAW,EACX,iBAAiB,EACjB,MAAM,GACP,CAAC"}
+{"version":3,"file":"_exports.js","sourceRoot":"","sources":["../../../src/js/keyboard/_exports.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,EAAE,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAC9E,OAAO,MAAM,MAAM,oBAAoB,CAAC;AAExC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AAEnC,OAAO,EACL,WAAW,IAAI,aAAa,EAC5B,iBAAiB,IAAI,mBAAmB,EACxC,MAAM,IAAI,QAAQ,EAClB,WAAW,EACX,iBAAiB,EACjB,MAAM,GACP,CAAC"}

package/dist/js/keyboard/escapeQueue/escapeQueue.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @name 		            escapeQueue
+ * @namespace           js.keyboard
+ * @type                Function
+ * @platform            js
+ * @status              stable
+ *
+ * This funciton allows you to register actions to execute when user press the escape key.
+ * It will take care of executing the last registered action first, then the others...
+ * This function returns a SPromise instance on which you can call the `cancel` method to unregister your
+ * action in the queue.
+ * Note that you can get the current queue length by calling `escapeQueueLength()`.
+ *
+ * @param         {Function}          [callback=null]           The callback to call on pressing escape
+ * @param         {Object}            [settings={}]             An option object to configure your hotkey. Here's the list of available settings:
+ * @return        {SPromise}                                    An SPromise instance that will be resolved when the user has pressed the escape key and that it's yout turn in the queue
+ *
+ * @setting         {HTMLElement}       [ctx=document]          Specify where to add the listener
+ * @setting         {String}            [id=null]               Specify an id. If specified, will before unqueue the previous item with the same id and add it again
+ *
+ * @todo      tests
+ *
+ * @snippet         escapeQueue($1).then(() => {
+ *      $2
+ * });
+ *
+ * @example    js
+ * import { escapeQueue } from '@blackbyte/sugar/keyboard'
+ * const promise = escapeQueue();
+ * promise.then(() => {
+ *      // do something...
+ * });
+ *
+ * // if you want to cancel your subscription
+ * promise.cancel();
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type TEscapeQueueSettings = {
+    id?: string;
+    ctx?: HTMLElement | Document | HTMLElement[] | Document[];
+};
+export type TEscapeQueueApi = {
+    cancel: Function;
+};
+export type TEscapeQueueItem = {
+    id: string;
+    callback?: Function;
+    resolve: Function;
+};
+export type TEscapeQueueResult = Promise<void> & {
+    cancel: Function;
+};
+export declare function escapeQueueLength(): number;
+export default function escapeQueue(callback?: Function, settings?: TEscapeQueueSettings): TEscapeQueueResult;

package/dist/js/keyboard/escapeQueue/escapeQueue.js

@@ -0,0 +1,69 @@
+import { uniqid } from '@blackbyte/sugar/string';
+let _escapeQueue = [];
+const _escapeQueueMap = new WeakMap();
+let _isEscaping = false;
+class CancelablePromise extends Promise {
+    cancel() { }
+}
+export function escapeQueueLength() {
+    return _escapeQueue.length;
+}
+export default function escapeQueue(callback, settings) {
+    // create the queue item before the Promise constructor so cancel() can
+    // reference it synchronously
+    const finalSettings = Object.assign({ ctx: document }, (settings !== null && settings !== void 0 ? settings : {}));
+    // @ts-ignore
+    const roots = Array.isArray(finalSettings.ctx)
+        ? finalSettings.ctx
+        : [finalSettings.ctx];
+    roots.forEach(($root) => {
+        // make sure we only register 1 listener per ctx
+        if (_escapeQueueMap.has($root))
+            return;
+        _escapeQueueMap.set($root, true);
+        $root.addEventListener('keydown', (e) => {
+            var _a;
+            if (e.key !== 'Escape' || !_escapeQueue.length || _isEscaping) {
+                return;
+            }
+            // make sure to not escape multiple times at once
+            _isEscaping = true;
+            setTimeout(() => {
+                _isEscaping = false;
+            });
+            const queueItem = _escapeQueue.pop();
+            (_a = queueItem.callback) === null || _a === void 0 ? void 0 : _a.call(queueItem);
+            queueItem.resolve();
+        });
+    });
+    let queueItem;
+    const pro = new CancelablePromise((resolve) => {
+        var _a;
+        // create the queue item to register
+        queueItem = {
+            id: (_a = finalSettings.id) !== null && _a !== void 0 ? _a : uniqid(),
+            callback,
+            resolve,
+        };
+        if (finalSettings.id) {
+            const existing = (_escapeQueue.find((i) => i.id === finalSettings.id));
+            if (existing) {
+                existing.callback = callback;
+                existing.resolve = resolve;
+            }
+            else {
+                _escapeQueue.push(queueItem);
+            }
+        }
+        else {
+            // add to the queue
+            _escapeQueue.push(queueItem);
+        }
+    });
+    // assign cancel() synchronously — no setTimeout needed
+    pro.cancel = () => {
+        _escapeQueue = _escapeQueue.filter((i) => i.id !== queueItem.id);
+    };
+    return pro;
+}
+//# sourceMappingURL=escapeQueue.js.map

package/dist/js/keyboard/escapeQueue/escapeQueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escapeQueue.js","sourceRoot":"","sources":["../../../../src/js/keyboard/escapeQueue/escapeQueue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AA6DjD,IAAI,YAAY,GAAuB,EAAE,CAAC;AAC1C,MAAM,eAAe,GAAG,IAAI,OAAO,EAAE,CAAC;AACtC,IAAI,WAAW,GAAG,KAAK,CAAC;AAExB,MAAM,iBAAkB,SAAQ,OAAa;IAC3C,MAAM,KAAI,CAAC;CACZ;AAED,MAAM,UAAU,iBAAiB;IAC/B,OAAO,YAAY,CAAC,MAAM,CAAC;AAC7B,CAAC;AAED,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,QAAmB,EACnB,QAA+B;IAE/B,uEAAuE;IACvE,6BAA6B;IAC7B,MAAM,aAAa,mBACjB,GAAG,EAAE,QAAQ,IACV,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC,CACpB,CAAC;IAEF,aAAa;IACb,MAAM,KAAK,GAA+B,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC;QACxE,CAAC,CAAC,aAAa,CAAC,GAAG;QACnB,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAExB,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACtB,gDAAgD;QAChD,IAAI,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC;YAAE,OAAO;QACvC,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAEjC,KAAK,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE;;YACtC,IAAI,CAAC,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,WAAW,EAAE,CAAC;gBAC9D,OAAO;YACT,CAAC;YAED,iDAAiD;YACjD,WAAW,GAAG,IAAI,CAAC;YACnB,UAAU,CAAC,GAAG,EAAE;gBACd,WAAW,GAAG,KAAK,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,MAAM,SAAS,GAAqB,YAAY,CAAC,GAAG,EAAE,CAAC;YACvD,MAAA,SAAS,CAAC,QAAQ,yDAAI,CAAC;YACvB,SAAS,CAAC,OAAO,EAAE,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,SAA2B,CAAC;IAEhC,MAAM,GAAG,GAAG,IAAI,iBAAiB,CAAC,CAAC,OAAO,EAAE,EAAE;;QAC5C,oCAAoC;QACpC,SAAS,GAAG;YACV,EAAE,EAAE,MAAA,aAAa,CAAC,EAAE,mCAAI,MAAM,EAAE;YAChC,QAAQ;YACR,OAAO;SACR,CAAC;QAEF,IAAI,aAAa,CAAC,EAAE,EAAE,CAAC;YACrB,MAAM,QAAQ,GAAqB,CACjC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,aAAa,CAAC,EAAE,CAAC,CACpD,CAAC;YACF,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC7B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,mBAAmB;YACnB,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,uDAAuD;IACvD,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE;QAChB,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/js/keyboard/hotkey/hotkey.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @name 		            hotkey
+ * @namespace           js.keyboard
+ * @type                Function
+ * @platform            js
+ * @status              stable
+ *
+ * This function allows you to register a hotkey on the passed element.
+ * You can specify the hotkey using the following syntax:
+ * - `ctrl+a`
+ * - `shift+ctrl+a`
+ * - `a`
+ * This function take care of avoiding to call your callback when the active element
+ * is an input, a textarea or an editable content with the "contenteditable" attribute,
+ * unless:
+ * - the "meta" or "ctrl" key is used in the hotkey.
+ * - the pressed key is the "escape" key.
+ *
+ *
+ * @param       {String|String[]}         key             The key(s) to listen for
+ * @param       {Function}                callback        The callback to call when the hotkey is pressed
+ * @param       {THotkeySettings}         [settings={}]   Some settings to configure your hotkey
+ * @return      {THotkeyApi}                              An object with a cancel method that you can call to cancel the hotkey
+ *
+ * @setting    {HTMLElement}       [ctx=document.body]       The context in which to listen for the hotkey
+ * @setting    {Boolean}           [preventDefault=true]    Specify if you want to prevent the default behavior of the hotkey
+ *
+ * @todo      tests
+ *
+ * @snippet         hotkey($1, () => {
+ *      $2
+ * });
+ *
+ * @example    js
+ * import { hotkey } from '@blackbyte/sugar/keyboard'
+ * const hotkeyApi = hotkey('ctrl+a', (e) => {
+ *   console.log('Hotkey pressed');
+ * });
+ *
+ * // if you want to cancel the hotkey
+ * hotkeyApi.cancel();
+ *
+ * @since       1.0.0
+ * @author    Olivier Bossel <olivier.bossel@gmail.com> (https://blackbyte.space)
+ */
+export type THotkeySettings = {
+    ctx: HTMLElement | Document;
+    preventDefault: boolean;
+};
+export type THotkeyApi = {
+    cancel: Function;
+};
+export default function hotkey(key: string | string[], callback: Function, settings?: Partial<THotkeySettings>): THotkeyApi;