@koine/dom 2.0.0-beta.82 → 2.0.0-beta.83

package/_listen-delegation.cjs.js

@@ -3,7 +3,35 @@
 var utils = require('@koine/utils');
 var escapeSelector = require('./escapeSelector.cjs.js');
 
-let activeEvents={};let getIndex=(e,t,n)=>{for(let r=0;r<e.length;r++)if(e[r].selector===t&&e[r].callback.toString()===n.toString())return r;return -1};let getRunTarget=(n,r)=>{if(["*","window",window].includes(r))return window;if(["document","document.documentElement",document,document.documentElement].includes(r))return document;if(utils.isString(r))return n.closest(escapeSelector.escapeSelector(r));if("string"!=typeof r&&r.contains){if(r===n)return n;if(r.contains(n))return r}return !1};let eventHandler=e=>{activeEvents[e.type]?.forEach(function(t){let n=getRunTarget(e.target,t.selector);n&&t.callback(e,n);});};
+/**
+ * @internal
+ *//**
+ * @internal
+ *//**
+ * Active events
+ *
+ * @internal
+ */let activeEvents={};/**
+ * Get the index for the listener
+ *
+ * @internal
+ */let getIndex=(e,t,n)=>{for(let r=0;r<e.length;r++)if(e[r].selector===t&&e[r].callback.toString()===n.toString())return r;return -1};/**
+ * Check if the listener callback should run or not
+ *
+ * @internal
+ * @param target The event.target
+ * @param selector The selector/element to check the target against
+ * @return If not false, run listener and pass the targeted element to use in the callback
+ */let getRunTarget=(n,r)=>{// @ts-expect-error FIXME: type
+if(["*","window",window].includes(r))return window;if(["document","document.documentElement",document,document.documentElement].// @ts-expect-error FIXME: type
+includes(r))return document;if(utils.isString(r))return n.closest(escapeSelector.escapeSelector(r));// @ts-expect-error FIXME: type
+if("string"!=typeof r&&r.contains){if(r===n)return n;// @ts-expect-error FIXME: type
+if(r.contains(n))return r}return !1};/**
+ * Handle listeners after event fires
+ *
+ * @internal
+ */let eventHandler=e=>{// if (!activeEvents[event.type]) return;
+activeEvents[e.type]?.forEach(function(t){let n=getRunTarget(e.target,t.selector);n&&t.callback(e,n);});};
 
 exports.activeEvents = activeEvents;
 exports.eventHandler = eventHandler;

package/_listen-delegation.esm.js

@@ -1,6 +1,34 @@
 import { isString } from '@koine/utils';
 import { escapeSelector } from './escapeSelector.esm.js';
 
-let activeEvents={};let getIndex=(e,t,n)=>{for(let r=0;r<e.length;r++)if(e[r].selector===t&&e[r].callback.toString()===n.toString())return r;return -1};let getRunTarget=(n,r)=>{if(["*","window",window].includes(r))return window;if(["document","document.documentElement",document,document.documentElement].includes(r))return document;if(isString(r))return n.closest(escapeSelector(r));if("string"!=typeof r&&r.contains){if(r===n)return n;if(r.contains(n))return r}return !1};let eventHandler=e=>{activeEvents[e.type]?.forEach(function(t){let n=getRunTarget(e.target,t.selector);n&&t.callback(e,n);});};
+/**
+ * @internal
+ *//**
+ * @internal
+ *//**
+ * Active events
+ *
+ * @internal
+ */let activeEvents={};/**
+ * Get the index for the listener
+ *
+ * @internal
+ */let getIndex=(e,t,n)=>{for(let r=0;r<e.length;r++)if(e[r].selector===t&&e[r].callback.toString()===n.toString())return r;return -1};/**
+ * Check if the listener callback should run or not
+ *
+ * @internal
+ * @param target The event.target
+ * @param selector The selector/element to check the target against
+ * @return If not false, run listener and pass the targeted element to use in the callback
+ */let getRunTarget=(n,r)=>{// @ts-expect-error FIXME: type
+if(["*","window",window].includes(r))return window;if(["document","document.documentElement",document,document.documentElement].// @ts-expect-error FIXME: type
+includes(r))return document;if(isString(r))return n.closest(escapeSelector(r));// @ts-expect-error FIXME: type
+if("string"!=typeof r&&r.contains){if(r===n)return n;// @ts-expect-error FIXME: type
+if(r.contains(n))return r}return !1};/**
+ * Handle listeners after event fires
+ *
+ * @internal
+ */let eventHandler=e=>{// if (!activeEvents[event.type]) return;
+activeEvents[e.type]?.forEach(function(t){let n=getRunTarget(e.target,t.selector);n&&t.callback(e,n);});};
 
 export { activeEvents as a, getIndex as b, eventHandler as e, getRunTarget as g };

package/addClass.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let addClass=(e,s="")=>{if("development"===process.env.NODE_ENV&&!e){console.warn("[@koine/dom:addClass] unexisting DOM element");return}e&&e.classList.add(s);};
+/**
+ * Add class shortcut
+ */let addClass=(e,s="")=>{if("development"===process.env.NODE_ENV&&!e){console.warn("[@koine/dom:addClass] unexisting DOM element");return}e&&e.classList.add(s);};
 
 exports.addClass = addClass;
 exports["default"] = addClass;

package/addClass.esm.js

@@ -1,3 +1,5 @@
-let addClass=(e,s="")=>{if("development"===process.env.NODE_ENV&&!e){console.warn("[@koine/dom:addClass] unexisting DOM element");return}e&&e.classList.add(s);};
+/**
+ * Add class shortcut
+ */let addClass=(e,s="")=>{if("development"===process.env.NODE_ENV&&!e){console.warn("[@koine/dom:addClass] unexisting DOM element");return}e&&e.classList.add(s);};
 
 export { addClass, addClass as default };

package/createElement.cjs.js

@@ -4,7 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var addClass = require('./addClass.cjs.js');
 
-let createElement=(t,r)=>{let l=document.createElement(t);return r&&addClass.addClass(l,r),l};
+/**
+ * Shortcut for `document.createElement`, allowing to to create an HTML element
+ * with a given className directly (a very common use case)
+ */let createElement=(t,r)=>{let l=document.createElement(t);return r&&addClass.addClass(l,r),l};
 
 exports.createElement = createElement;
 exports["default"] = createElement;

package/createElement.esm.js

@@ -1,5 +1,8 @@
 import { addClass } from './addClass.esm.js';
 
-let createElement=(t,r)=>{let l=document.createElement(t);return r&&addClass(l,r),l};
+/**
+ * Shortcut for `document.createElement`, allowing to to create an HTML element
+ * with a given className directly (a very common use case)
+ */let createElement=(t,r)=>{let l=document.createElement(t);return r&&addClass(l,r),l};
 
 export { createElement, createElement as default };

package/dom.cjs.js

@@ -2,7 +2,17 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let dom=(e,o,t)=>(o||document).querySelector(t?e:e.replace(/:/g,"\\:"));
+/**
+ * Sizzle/jQuery like DOM nodes shortcut for `document.querySelector`
+ * To avoid an extra function call we inline the above `escape`
+ *
+ * @param selector DOM selector
+ * @param parent It falls back to `window.document`
+ * @param avoidEscape Whether to avoid escaping `:` in the selector string
+ * @example <caption>Basic DOM selection</caption>
+ * const $container = dom(".my-section:");
+ * const $el = dom("[data-some-attr]", $container);
+ */let dom=(e,o,t)=>(o||document).querySelector(t?e:e.replace(/:/g,"\\:"));
 
 exports["default"] = dom;
 exports.dom = dom;

package/dom.esm.js

@@ -1,3 +1,13 @@
-let dom=(e,o,t)=>(o||document).querySelector(t?e:e.replace(/:/g,"\\:"));
+/**
+ * Sizzle/jQuery like DOM nodes shortcut for `document.querySelector`
+ * To avoid an extra function call we inline the above `escape`
+ *
+ * @param selector DOM selector
+ * @param parent It falls back to `window.document`
+ * @param avoidEscape Whether to avoid escaping `:` in the selector string
+ * @example <caption>Basic DOM selection</caption>
+ * const $container = dom(".my-section:");
+ * const $el = dom("[data-some-attr]", $container);
+ */let dom=(e,o,t)=>(o||document).querySelector(t?e:e.replace(/:/g,"\\:"));
 
 export { dom as default, dom };

package/domAll.cjs.js

@@ -2,7 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let domAll=(e,l,o)=>(l||document).querySelectorAll(o?e:e.replace(/:/g,"\\:"));
+/**
+ * Sizzle/jQuery like DOM nodes shortcut for `document.querySelectorAll`
+ * To avoid an extra function call we inline the above `escape`
+ *
+ * @param string selector DOM selector
+ * @param parent It falls back to `window.document`
+ * @param avoidEscape Whether to avoid escaping `:` in the selector string
+ */let domAll=(e,l,o)=>(l||document).querySelectorAll(o?e:e.replace(/:/g,"\\:"));
 
 exports["default"] = domAll;
 exports.domAll = domAll;

package/domAll.esm.js

@@ -1,3 +1,10 @@
-let domAll=(e,l,o)=>(l||document).querySelectorAll(o?e:e.replace(/:/g,"\\:"));
+/**
+ * Sizzle/jQuery like DOM nodes shortcut for `document.querySelectorAll`
+ * To avoid an extra function call we inline the above `escape`
+ *
+ * @param string selector DOM selector
+ * @param parent It falls back to `window.document`
+ * @param avoidEscape Whether to avoid escaping `:` in the selector string
+ */let domAll=(e,l,o)=>(l||document).querySelectorAll(o?e:e.replace(/:/g,"\\:"));
 
 export { domAll as default, domAll };

package/domEach.cjs.js

@@ -4,7 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var domAll = require('./domAll.cjs.js');
 
-let domEach=(o,t,e,m)=>{let r=domAll.domAll(o,e);for(let l=0;l<r.length;l++)t.call(m,r[l],l);};
+/**
+ * Each shortcut, iterate through a NodeList of HTMLElements retrieved with the
+ * given selector (and optionally a parent container passed as thrid arguement)
+ *
+ * @param selector DOM selector
+ * @param callback
+ * @param parent It falls back to `window.document`
+ * @param scope
+ */let domEach=(o,t,e,m)=>{let r=domAll.domAll(o,e);for(let l=0;l<r.length;l++)t.call(m,r[l],l);};
 
 exports["default"] = domEach;
 exports.domEach = domEach;

package/domEach.esm.js

@@ -1,5 +1,13 @@
 import { domAll } from './domAll.esm.js';
 
-let domEach=(o,t,e,m)=>{let r=domAll(o,e);for(let l=0;l<r.length;l++)t.call(m,r[l],l);};
+/**
+ * Each shortcut, iterate through a NodeList of HTMLElements retrieved with the
+ * given selector (and optionally a parent container passed as thrid arguement)
+ *
+ * @param selector DOM selector
+ * @param callback
+ * @param parent It falls back to `window.document`
+ * @param scope
+ */let domEach=(o,t,e,m)=>{let r=domAll(o,e);for(let l=0;l<r.length;l++)t.call(m,r[l],l);};
 
 export { domEach as default, domEach };

package/emitEvent.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let emitEvent=(t="customEvent",e={})=>{"function"==typeof window.CustomEvent&&document.dispatchEvent(new CustomEvent(t,{bubbles:!0,detail:e}));};
+/**
+ * Emit event (use only if the targeted browser supports `CustomEvent`s)
+ */let emitEvent=(t="customEvent",e={})=>{"function"==typeof window.CustomEvent&&document.dispatchEvent(new CustomEvent(t,{bubbles:!0,detail:e}));};
 
 exports["default"] = emitEvent;
 exports.emitEvent = emitEvent;

package/emitEvent.esm.js

@@ -1,3 +1,5 @@
-let emitEvent=(t="customEvent",e={})=>{"function"==typeof window.CustomEvent&&document.dispatchEvent(new CustomEvent(t,{bubbles:!0,detail:e}));};
+/**
+ * Emit event (use only if the targeted browser supports `CustomEvent`s)
+ */let emitEvent=(t="customEvent",e={})=>{"function"==typeof window.CustomEvent&&document.dispatchEvent(new CustomEvent(t,{bubbles:!0,detail:e}));};
 
 export { emitEvent as default, emitEvent };

package/escapeSelector.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let escapeSelector=e=>e.replace(/:/g,"\\:");
+/**
+ * Escape colons to allow use class names as `.module:block__element`
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector#Escaping_special_characters
+ *
+ * @param selector
+ */let escapeSelector=e=>e.replace(/:/g,"\\:");
 
 exports["default"] = escapeSelector;
 exports.escapeSelector = escapeSelector;

package/escapeSelector.esm.js

@@ -1,3 +1,8 @@
-let escapeSelector=e=>e.replace(/:/g,"\\:");
+/**
+ * Escape colons to allow use class names as `.module:block__element`
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector#Escaping_special_characters
+ *
+ * @param selector
+ */let escapeSelector=e=>e.replace(/:/g,"\\:");
 
 export { escapeSelector as default, escapeSelector };

package/exists.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let exists=e=>e&&e instanceof window.HTMLElement;
+/**
+ * Checks if passed node exist and is a valid element.
+ *
+ * @borrows @glidejs/glide/src/utils/dom (source)
+ */let exists=e=>e&&e instanceof window.HTMLElement;
 
 exports["default"] = exists;
 exports.exists = exists;

package/exists.esm.js

@@ -1,3 +1,7 @@
-let exists=e=>e&&e instanceof window.HTMLElement;
+/**
+ * Checks if passed node exist and is a valid element.
+ *
+ * @borrows @glidejs/glide/src/utils/dom (source)
+ */let exists=e=>e&&e instanceof window.HTMLElement;
 
 export { exists as default, exists };

package/forEach.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let forEach=(e,l,t)=>{for(let o=0;o<e.length;o++)l.call(t,e[o],o);};
+/**
+ * For each, iterate through a `NodeList` or an `array` of `HTMLElement`s
+ *
+ * @param scope The optional `this` of the callback function
+ */let forEach=(e,l,t)=>{for(let o=0;o<e.length;o++)l.call(t,e[o],o);};// /**
 
 exports["default"] = forEach;
 exports.forEach = forEach;

package/forEach.esm.js

@@ -1,3 +1,7 @@
-let forEach=(e,l,t)=>{for(let o=0;o<e.length;o++)l.call(t,e[o],o);};
+/**
+ * For each, iterate through a `NodeList` or an `array` of `HTMLElement`s
+ *
+ * @param scope The optional `this` of the callback function
+ */let forEach=(e,l,t)=>{for(let o=0;o<e.length;o++)l.call(t,e[o],o);};// /**
 
 export { forEach as default, forEach };

package/getDataAttr.cjs.js

@@ -2,7 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getDataAttr=(t,e)=>t.getAttribute("data-"+e);
+// TODO: maybe move to `dataset` API but consider the comment about Safari here
+// https://stackoverflow.com/a/9201264/1938970
+/**
+ * Get data attribute
+ *
+ * @param element
+ * @param attribute The name of the `data-{attr}`
+ */let getDataAttr=(t,e)=>// element.dataset[attribute];
+    t.getAttribute("data-"+e);
 
 exports["default"] = getDataAttr;
 exports.getDataAttr = getDataAttr;

package/getDataAttr.esm.js

@@ -1,3 +1,11 @@
-let getDataAttr=(t,e)=>t.getAttribute("data-"+e);
+// TODO: maybe move to `dataset` API but consider the comment about Safari here
+// https://stackoverflow.com/a/9201264/1938970
+/**
+ * Get data attribute
+ *
+ * @param element
+ * @param attribute The name of the `data-{attr}`
+ */let getDataAttr=(t,e)=>// element.dataset[attribute];
+    t.getAttribute("data-"+e);
 
 export { getDataAttr as default, getDataAttr };

package/getDocumentHeight.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getDocumentHeight=()=>{let{body:t,documentElement:e}=document;return Math.max(t.scrollHeight,e.scrollHeight,t.offsetHeight,e.offsetHeight,t.clientHeight,e.clientHeight)};
+/**
+ * Determine the document's height
+ *
+ * @see https://github.com/cferdinandi/smooth-scroll (credits)
+ */let getDocumentHeight=()=>{let{body:t,documentElement:e}=document;return Math.max(t.scrollHeight,e.scrollHeight,t.offsetHeight,e.offsetHeight,t.clientHeight,e.clientHeight)};
 
 exports["default"] = getDocumentHeight;
 exports.getDocumentHeight = getDocumentHeight;

package/getDocumentHeight.esm.js

@@ -1,3 +1,7 @@
-let getDocumentHeight=()=>{let{body:t,documentElement:e}=document;return Math.max(t.scrollHeight,e.scrollHeight,t.offsetHeight,e.offsetHeight,t.clientHeight,e.clientHeight)};
+/**
+ * Determine the document's height
+ *
+ * @see https://github.com/cferdinandi/smooth-scroll (credits)
+ */let getDocumentHeight=()=>{let{body:t,documentElement:e}=document;return Math.max(t.scrollHeight,e.scrollHeight,t.offsetHeight,e.offsetHeight,t.clientHeight,e.clientHeight)};
 
 export { getDocumentHeight as default, getDocumentHeight };

package/getHeight.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getHeight=e=>parseInt(window.getComputedStyle(e).height,10);
+/**
+ * Get element height
+ */let getHeight=e=>parseInt(window.getComputedStyle(e).height,10);
 
 exports["default"] = getHeight;
 exports.getHeight = getHeight;

package/getHeight.esm.js

@@ -1,3 +1,5 @@
-let getHeight=e=>parseInt(window.getComputedStyle(e).height,10);
+/**
+ * Get element height
+ */let getHeight=e=>parseInt(window.getComputedStyle(e).height,10);
 
 export { getHeight as default, getHeight };

package/getListeners.cjs.js

@@ -6,7 +6,15 @@ var _listenDelegation = require('./_listen-delegation.cjs.js');
 require('@koine/utils');
 require('./escapeSelector.cjs.js');
 
-let getListeners=()=>{let t={};for(let r in _listenDelegation.activeEvents)t[r]=_listenDelegation.activeEvents[r];return t};
+/**
+ * Get an immutable copy of all active event listeners
+ *
+ * @category listen-delegation
+ *
+ * @return Active event listeners
+ */let getListeners=()=>{let t={};for(let r in _listenDelegation.activeEvents)// if (activeEvents.hasOwnProperty(type)) {
+t[r]=_listenDelegation.activeEvents[r];// }
+return t};
 
 exports["default"] = getListeners;
 exports.getListeners = getListeners;

package/getListeners.esm.js

@@ -2,6 +2,14 @@ import { a as activeEvents } from './_listen-delegation.esm.js';
 import '@koine/utils';
 import './escapeSelector.esm.js';
 
-let getListeners=()=>{let t={};for(let r in activeEvents)t[r]=activeEvents[r];return t};
+/**
+ * Get an immutable copy of all active event listeners
+ *
+ * @category listen-delegation
+ *
+ * @return Active event listeners
+ */let getListeners=()=>{let t={};for(let r in activeEvents)// if (activeEvents.hasOwnProperty(type)) {
+t[r]=activeEvents[r];// }
+return t};
 
 export { getListeners as default, getListeners };

package/getOffset.cjs.js

@@ -2,7 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getOffset=e=>{let f=0,t=0;for(;e&&!isNaN(e.offsetLeft)&&!isNaN(e.offsetTop);)f+=e.offsetLeft-e.scrollLeft,t+=e.offsetTop-e.scrollTop,e=e.offsetParent;return {top:t,left:f}};
+/**
+ * Get an element's distance from the top and left of the Document.
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top and left in pixels
+ */let getOffset=e=>{let f=0,t=0;for(;e&&!isNaN(e.offsetLeft)&&!isNaN(e.offsetTop);)f+=e.offsetLeft-e.scrollLeft,t+=e.offsetTop-e.scrollTop,// @ts-expect-error nevermind?
+e=e.offsetParent;return {top:t,left:f}};
 
 exports["default"] = getOffset;
 exports.getOffset = getOffset;

package/getOffset.esm.js

@@ -1,3 +1,9 @@
-let getOffset=e=>{let f=0,t=0;for(;e&&!isNaN(e.offsetLeft)&&!isNaN(e.offsetTop);)f+=e.offsetLeft-e.scrollLeft,t+=e.offsetTop-e.scrollTop,e=e.offsetParent;return {top:t,left:f}};
+/**
+ * Get an element's distance from the top and left of the Document.
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top and left in pixels
+ */let getOffset=e=>{let f=0,t=0;for(;e&&!isNaN(e.offsetLeft)&&!isNaN(e.offsetTop);)f+=e.offsetLeft-e.scrollLeft,t+=e.offsetTop-e.scrollTop,// @ts-expect-error nevermind?
+e=e.offsetParent;return {top:t,left:f}};
 
 export { getOffset as default, getOffset };

package/getOffsetTop.cjs.js

@@ -2,7 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getOffsetTop=e=>{let t=0;if(e.offsetParent)for(;e;)t+=e.offsetTop,e=e.offsetParent;return t>=0?t:0};
+/**
+ * Get an element's distance from the top of the Document.
+ *
+ * @see https://vanillajstoolkit.com/helpers/getoffsettop/
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top in pixels
+ */let getOffsetTop=e=>{let t=0;if(e.offsetParent)for(;e;)t+=e.offsetTop,// @ts-expect-error nevermind?
+e=e.offsetParent;return t>=0?t:0};
 
 exports["default"] = getOffsetTop;
 exports.getOffsetTop = getOffsetTop;

package/getOffsetTop.esm.js

@@ -1,3 +1,11 @@
-let getOffsetTop=e=>{let t=0;if(e.offsetParent)for(;e;)t+=e.offsetTop,e=e.offsetParent;return t>=0?t:0};
+/**
+ * Get an element's distance from the top of the Document.
+ *
+ * @see https://vanillajstoolkit.com/helpers/getoffsettop/
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top in pixels
+ */let getOffsetTop=e=>{let t=0;if(e.offsetParent)for(;e;)t+=e.offsetTop,// @ts-expect-error nevermind?
+e=e.offsetParent;return t>=0?t:0};
 
 export { getOffsetTop as default, getOffsetTop };

package/getOffsetTopSlim.cjs.js

@@ -2,7 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getOffsetTopSlim=t=>t.getBoundingClientRect().top+window.scrollY;
+/**
+ * Get an element's distance from the top of the Document (using more modern/performant
+ * technique compared to {@link ./getOffsetTop})
+ *
+ * @see https://stackoverflow.com/q/5598743/1938970
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top in pixels
+ */let getOffsetTopSlim=t=>t.getBoundingClientRect().top+window.scrollY;
 
 exports["default"] = getOffsetTopSlim;
 exports.getOffsetTopSlim = getOffsetTopSlim;

package/getOffsetTopSlim.esm.js

@@ -1,3 +1,11 @@
-let getOffsetTopSlim=t=>t.getBoundingClientRect().top+window.scrollY;
+/**
+ * Get an element's distance from the top of the Document (using more modern/performant
+ * technique compared to {@link ./getOffsetTop})
+ *
+ * @see https://stackoverflow.com/q/5598743/1938970
+ *
+ * @param elem The HTML node element
+ * @return Distance from the top in pixels
+ */let getOffsetTopSlim=t=>t.getBoundingClientRect().top+window.scrollY;
 
 export { getOffsetTopSlim as default, getOffsetTopSlim };

package/getScrollbarWidth.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getScrollbarWidth=t=>window.innerWidth-(t||document.documentElement).clientWidth;
+/**
+ * Get scrollbar's current width
+ */let getScrollbarWidth=t=>window.innerWidth-(t||document.documentElement).clientWidth;
 
 exports["default"] = getScrollbarWidth;
 exports.getScrollbarWidth = getScrollbarWidth;

package/getScrollbarWidth.esm.js

@@ -1,3 +1,5 @@
-let getScrollbarWidth=t=>window.innerWidth-(t||document.documentElement).clientWidth;
+/**
+ * Get scrollbar's current width
+ */let getScrollbarWidth=t=>window.innerWidth-(t||document.documentElement).clientWidth;
 
 export { getScrollbarWidth as default, getScrollbarWidth };

package/getStyleValue.cjs.js

@@ -2,7 +2,12 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getStyleValue=(e,t)=>getComputedStyle(e,null).getPropertyValue(t);
+/**
+ * Return the current style value for an element CSS property
+ *
+ * @param el The element to compute
+ * @param prop The style property
+ */let getStyleValue=(e,t)=>getComputedStyle(e,null).getPropertyValue(t);
 
 exports["default"] = getStyleValue;
 exports.getStyleValue = getStyleValue;

package/getStyleValue.esm.js

@@ -1,3 +1,8 @@
-let getStyleValue=(e,t)=>getComputedStyle(e,null).getPropertyValue(t);
+/**
+ * Return the current style value for an element CSS property
+ *
+ * @param el The element to compute
+ * @param prop The style property
+ */let getStyleValue=(e,t)=>getComputedStyle(e,null).getPropertyValue(t);
 
 export { getStyleValue as default, getStyleValue };

package/getVisualBackgroundColor.cjs.js

@@ -2,7 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let getVisualBackgroundColor=r=>{if(!r)return "#fff";let e=window.getComputedStyle(r).backgroundColor;if("rgba(0, 0, 0, 0)"===e||"transparent"===e){let e=r.parentElement;return e?getVisualBackgroundColor(e):"#fff"}return e};
+/**
+ * Get the background color of an element eventually looking recursively into
+ * its parents, if nothing is found it returns a `#fff` background
+ */let getVisualBackgroundColor=r=>{if(!r)return "#fff";// if (!elem) return transparent;
+let e=window.getComputedStyle(r).backgroundColor;if("rgba(0, 0, 0, 0)"===e||"transparent"===e){let e=r.parentElement;return e?getVisualBackgroundColor(e):"#fff"}return e};
 
 exports["default"] = getVisualBackgroundColor;
 exports.getVisualBackgroundColor = getVisualBackgroundColor;

package/getVisualBackgroundColor.esm.js

@@ -1,3 +1,7 @@
-let getVisualBackgroundColor=r=>{if(!r)return "#fff";let e=window.getComputedStyle(r).backgroundColor;if("rgba(0, 0, 0, 0)"===e||"transparent"===e){let e=r.parentElement;return e?getVisualBackgroundColor(e):"#fff"}return e};
+/**
+ * Get the background color of an element eventually looking recursively into
+ * its parents, if nothing is found it returns a `#fff` background
+ */let getVisualBackgroundColor=r=>{if(!r)return "#fff";// if (!elem) return transparent;
+let e=window.getComputedStyle(r).backgroundColor;if("rgba(0, 0, 0, 0)"===e||"transparent"===e){let e=r.parentElement;return e?getVisualBackgroundColor(e):"#fff"}return e};
 
 export { getVisualBackgroundColor as default, getVisualBackgroundColor };

package/injectCss.cjs.js

@@ -4,7 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var dom = require('./dom.cjs.js');
 
-let injectCss=(t,d="",n=document)=>{let o=dom.dom("#"+t);o||((o=n.createElement("style")).id=t,n.body.appendChild(o)),o.innerHTML=d;};
+/**
+ * Inject css
+ *
+ * @param id The `<style>` HTMLElement's `id`
+ */let injectCss=(t,d="",n=document)=>{let o=dom.dom("#"+t);o||((o=n.createElement("style")).id=t,n.body.appendChild(o)),o.innerHTML=d;};
 
 exports["default"] = injectCss;
 exports.injectCss = injectCss;

package/injectCss.esm.js

@@ -1,5 +1,9 @@
 import { dom } from './dom.esm.js';
 
-let injectCss=(t,d="",n=document)=>{let o=dom("#"+t);o||((o=n.createElement("style")).id=t,n.body.appendChild(o)),o.innerHTML=d;};
+/**
+ * Inject css
+ *
+ * @param id The `<style>` HTMLElement's `id`
+ */let injectCss=(t,d="",n=document)=>{let o=dom("#"+t);o||((o=n.createElement("style")).id=t,n.body.appendChild(o)),o.innerHTML=d;};
 
 export { injectCss as default, injectCss };

package/isHidden.cjs.js

@@ -2,7 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-let isHidden=e=>!e||null===e.offsetParent;
+/**
+ * Is element hidden?
+ */let isHidden=e=>!e||null===e.offsetParent;
 
 exports["default"] = isHidden;
 exports.isHidden = isHidden;

package/isHidden.esm.js

@@ -1,3 +1,5 @@
-let isHidden=e=>!e||null===e.offsetParent;
+/**
+ * Is element hidden?
+ */let isHidden=e=>!e||null===e.offsetParent;
 
 export { isHidden as default, isHidden };