@splendidlabz/utils 1.6.0 → 1.8.1

package/dist/esm/dom/actions/prefer-horizontal-scroll.js

@@ -0,0 +1,131 @@
+// src/dom/get-element.js
+function getElement(selector) {
+  if (!selector) return;
+  if (selector instanceof Element) return selector;
+  return document.querySelector(selector);
+}
+
+// src/dom/events.js
+function addListeners(listeners) {
+  listeners.forEach(({ node, event, handler }) => {
+    node.addEventListener(event, handler);
+  });
+}
+function removeListeners(listeners) {
+  listeners.forEach(({ node, event, handler }) => {
+    node.removeEventListener(event, handler);
+  });
+}
+
+// src/dom/css-vars.js
+function getCSSVar(element, prop) {
+  element = getElement(element);
+  return getComputedStyle(element).getPropertyValue(prop);
+}
+function setCSSVar(element, prop, value) {
+  element = getElement(element);
+  element.style.setProperty(prop, value);
+}
+
+// src/lib/objects/omit-empty.js
+function omitEmpty(obj, shallow = false) {
+  if (typeof obj !== "object" || obj === null) return obj;
+  if (obj instanceof Date) return obj;
+  const result = Array.isArray(obj) ? [] : {};
+  for (const [key, value] of Object.entries(obj)) {
+    if (value === null || value === void 0 || value === "" || typeof value === "object" && !(value instanceof Date) && Object.keys(value).length === 0) {
+      continue;
+    }
+    result[key] = shallow ? value : omitEmpty(value);
+  }
+  return result;
+}
+
+// src/dom/actions/prefer-horizontal-scroll.js
+var DEFAULT_OPTIONS = {
+  scrollSnapDelay: 1e3
+};
+function preferHorizontalScroll(node, props = {}) {
+  if (!node.classList.contains("scrollable-prefer-horizontal")) return;
+  const state = {
+    origSnapType: null,
+    currentSnapType: null,
+    snapTimeoutID: null
+  };
+  const options = {
+    ...DEFAULT_OPTIONS,
+    ...omitEmpty({
+      scrollSnapDelay: getCSSVar(node, "--scroll-snap-delay")
+    }),
+    ...omitEmpty(props)
+  };
+  const listeners = [
+    {
+      event: "wheel",
+      node,
+      handler: handleWheel
+    },
+    {
+      event: "pointerenter",
+      node,
+      handler: handlePointerEnter
+    },
+    {
+      event: "pointerleave",
+      node,
+      handler: handlePointerLeave
+    }
+  ];
+  addListeners(listeners);
+  function handleWheel(event) {
+    const direction = event.deltaY > 0 ? "down" : "up";
+    const updatedDelta = event.deltaY;
+    if (isTrackpad(event)) return false;
+    setCSSVar(node, "--snap-type", "none");
+    const scrolledAmount = node.scrollLeft;
+    const scrollWidth = node.scrollWidth;
+    const clientWidth = node.clientWidth;
+    const scrollableAmount = scrollWidth - clientWidth;
+    if (direction === "down" && scrolledAmount < scrollableAmount) {
+      node.scrollLeft += updatedDelta;
+      event.preventDefault();
+    }
+    if (direction === "up" && scrolledAmount > 0) {
+      node.scrollLeft += updatedDelta;
+      event.preventDefault();
+    }
+    const { snapTimeoutID } = state;
+    if (snapTimeoutID) clearTimeout(snapTimeoutID);
+    state.snapTimeoutID = setTimeout((_) => {
+      restoreHijackedState(node, state);
+    }, options.scrollSnapDelay);
+  }
+  function handlePointerEnter(event) {
+    state.origSnapType = getCSSVar(node, "--snap-type") || "proximity";
+  }
+  function handlePointerLeave(event) {
+    restoreHijackedState(node, state);
+  }
+  return {
+    destroy() {
+      removeListeners(listeners);
+    }
+  };
+}
+function restoreHijackedState(node, state) {
+  const scrollLeft = node.scrollLeft;
+  setCSSVar(node, "--snap-type", state.origSnapType);
+  const finalScrollLeft = node.scrollLeft;
+  setCSSVar(node, "--snap-type", "none");
+  node.scrollTo({ left: scrollLeft, behavior: "instant" });
+  node.scrollTo({ left: finalScrollLeft, behavior: "smooth" });
+  setTimeout((_) => {
+    setCSSVar(node, "--snap-type", state.origSnapType);
+  }, 250);
+}
+function isTrackpad(event) {
+  if (event.wheelDeltaY === event.deltaY * -3) return true;
+}
+export {
+  preferHorizontalScroll
+};

package/dist/esm/dom/actions/sticky.js

@@ -0,0 +1,185 @@
+// src/dom/bounding-box.js
+function boundingBox(element, { containsPadding = true } = {}) {
+  const box = element.getBoundingClientRect();
+  const ret = {};
+  for (const prop in box) ret[prop] = box[prop];
+  if (!containsPadding) {
+    const style = getComputedStyle(element);
+    const paddingTop = parseFloat(style.paddingTop);
+    const paddingRight = parseFloat(style.paddingRight);
+    const paddingBottom = parseFloat(style.paddingBottom);
+    const paddingLeft = parseFloat(style.paddingLeft);
+    ret.x = ret.x + paddingLeft;
+    ret.y = ret.y + paddingTop;
+    ret.width = ret.width - paddingLeft - paddingRight;
+    ret.height = ret.height - paddingTop - paddingBottom;
+    ret.top = ret.top + paddingTop;
+    ret.bottom = ret.bottom - paddingBottom;
+    ret.right = ret.right - paddingRight;
+    ret.left = ret.left + paddingLeft;
+  }
+  ret.xCenter = (ret.left + ret.right) / 2;
+  ret.yCenter = (ret.top + ret.bottom) / 2;
+  return ret;
+}
+function boundingBoxRelativeToAncestor({ element, ancestorElement }) {
+  ancestorElement = ancestorElement || element.parentElement;
+  const box = boundingBox(element);
+  const ancestorBox = boundingBox(ancestorElement, {
+    containsPadding: false
+  });
+  return {
+    top: box.top - ancestorBox.top,
+    right: box.right - ancestorBox.right,
+    bottom: box.bottom - ancestorBox.bottom,
+    left: box.left - ancestorBox.left,
+    width: box.width,
+    height: box.height,
+    xCenter: (box.left + box.right) / 2 - ancestorBox.left,
+    yCenter: (box.top + box.bottom) / 2 - ancestorBox.top
+  };
+}
+
+// src/dom/events.js
+function dispatchEvent(node, eventName, detail, options = {}) {
+  node.dispatchEvent(
+    new CustomEvent(eventName, {
+      ...options,
+      detail
+    })
+  );
+}
+
+// src/dom/get-element.js
+function getNodeType(node) {
+  if (node instanceof Element) return "element";
+  if (node instanceof NodeList) return "nodelist";
+  if (Array.isArray(node)) return "array";
+}
+
+// src/dom/observers/observer.js
+function useObserverMethodOnTarget(target, observer, method = "observe", options = void 0) {
+  const targetType = getNodeType(target);
+  if (targetType === "element") observer[method](target, options);
+  if (targetType === "nodelist") {
+    const elements = Array.from(target);
+    elements.forEach((element) => observer[method](element, options));
+  }
+  if (targetType === "array") {
+    target.forEach((element) => observer[method](element, options));
+  }
+}
+
+// src/dom/observers/resize-observer.js
+function resizeObserver(target, options) {
+  const { callback, ...opts } = options;
+  const observer = new ResizeObserver(observerFn);
+  if (target === window) target = document.body;
+  useObserverMethodOnTarget(target, observer, "observe", opts);
+  function observerFn(entries) {
+    for (const entry of entries) {
+      if (callback) callback({ entry, entries, observer });
+      else dispatchEvent(target, "resize-obs", { entry, entries, observer });
+    }
+  }
+  return {
+    observe(target2) {
+      useObserverMethodOnTarget(target2, observer, "observe", options);
+    },
+    unobserve(target2) {
+      useObserverMethodOnTarget(target2, observer, "unobserve");
+    },
+    disconnect: (_) => observer.disconnect(),
+    destroy: (_) => observer.disconnect()
+  };
+}
+
+// src/dom/ui/scroll-container.js
+function findScrollContainer(element, direction = "both") {
+  if (!element) return;
+  let parent = element.parentElement;
+  while (parent) {
+    const { overflow, overflowX, overflowY } = getComputedStyle(parent);
+    if (direction === "both") {
+      if (overflow.includes("auto") || overflow.includes("scroll"))
+        return parent;
+    }
+    if (direction === "horizontal") {
+      if (overflowX === "auto" || overflowX === "scroll") return parent;
+    }
+    if (direction === "vertical") {
+      if (overflowY === "auto" || overflowY === "scroll") return parent;
+    }
+    parent = parent.parentElement;
+  }
+  return document.documentElement;
+}
+
+// src/dom/actions/sticky.js
+function sticky(node, props = {}) {
+  const scrollContainer = findScrollContainer(node);
+  let stickyTBLR = getComputedTBLR(node);
+  const obs = resizeObserver(node, {
+    callback: ({ entry }) => {
+      stickyTBLR = getComputedTBLR(node);
+      isSticking();
+      scrollContainer === document.documentElement ? window.addEventListener("scroll", scrollEventListener) : scrollContainer.addEventListener("scroll", scrollEventListener);
+    }
+  });
+  function scrollEventListener(event) {
+    isSticking();
+  }
+  function isSticking() {
+    const { top, bottom, left, right } = stickyTBLR;
+    const relativeRect = boundingBoxRelativeToAncestor({
+      element: node,
+      ancestorElement: scrollContainer
+    });
+    if (!isNaN(top)) {
+      if (relativeRect.top - top <= 1) {
+        node.classList.add("sticking");
+      } else {
+        node.classList.remove("sticking");
+      }
+    }
+    if (!isNaN(bottom)) {
+      if (relativeRect.bottom + bottom >= -1) {
+        node.classList.add("sticking");
+      } else {
+        node.classList.remove("sticking");
+      }
+    }
+    if (!isNaN(left)) {
+      if (relativeRect.left - left <= 1) {
+        node.classList.add("sticking");
+      } else {
+        node.classList.remove("sticking");
+      }
+    }
+    if (!isNaN(right)) {
+      if (relativeRect.right + right >= -1) {
+        node.classList.add("sticking");
+      } else {
+        node.classList.remove("sticking");
+      }
+    }
+  }
+  return {
+    destroy() {
+      obs.disconnect();
+      scrollContainer.removeEventListener("scroll", scrollEventListener);
+    }
+  };
+}
+function getComputedTBLR(element) {
+  const style = getComputedStyle(element);
+  return {
+    top: parseFloat(style.top),
+    bottom: parseFloat(style.bottom),
+    left: parseFloat(style.left),
+    right: parseFloat(style.right)
+  };
+}
+export {
+  sticky
+};

package/dist/esm/dom/bounding-box.js

@@ -0,0 +1,45 @@
+// src/dom/bounding-box.js
+function boundingBox(element, { containsPadding = true } = {}) {
+  const box = element.getBoundingClientRect();
+  const ret = {};
+  for (const prop in box) ret[prop] = box[prop];
+  if (!containsPadding) {
+    const style = getComputedStyle(element);
+    const paddingTop = parseFloat(style.paddingTop);
+    const paddingRight = parseFloat(style.paddingRight);
+    const paddingBottom = parseFloat(style.paddingBottom);
+    const paddingLeft = parseFloat(style.paddingLeft);
+    ret.x = ret.x + paddingLeft;
+    ret.y = ret.y + paddingTop;
+    ret.width = ret.width - paddingLeft - paddingRight;
+    ret.height = ret.height - paddingTop - paddingBottom;
+    ret.top = ret.top + paddingTop;
+    ret.bottom = ret.bottom - paddingBottom;
+    ret.right = ret.right - paddingRight;
+    ret.left = ret.left + paddingLeft;
+  }
+  ret.xCenter = (ret.left + ret.right) / 2;
+  ret.yCenter = (ret.top + ret.bottom) / 2;
+  return ret;
+}
+function boundingBoxRelativeToAncestor({ element, ancestorElement }) {
+  ancestorElement = ancestorElement || element.parentElement;
+  const box = boundingBox(element);
+  const ancestorBox = boundingBox(ancestorElement, {
+    containsPadding: false
+  });
+  return {
+    top: box.top - ancestorBox.top,
+    right: box.right - ancestorBox.right,
+    bottom: box.bottom - ancestorBox.bottom,
+    left: box.left - ancestorBox.left,
+    width: box.width,
+    height: box.height,
+    xCenter: (box.left + box.right) / 2 - ancestorBox.left,
+    yCenter: (box.top + box.bottom) / 2 - ancestorBox.top
+  };
+}
+export {
+  boundingBox,
+  boundingBoxRelativeToAncestor
+};

package/dist/esm/dom/clipboard.js

@@ -0,0 +1,13 @@
+// src/dom/clipboard.js
+function copyRichText(element) {
+  const range = document.createRange();
+  range.selectNode(element);
+  const selection = window.getSelection();
+  selection.removeAllRanges();
+  selection.addRange(range);
+  document.execCommand("copy");
+  selection.removeAllRanges();
+}
+export {
+  copyRichText
+};

package/dist/esm/dom/cookie.js

@@ -0,0 +1,32 @@
+// src/dom/cookie.js
+var cookies = {
+  get(name) {
+    return getCookie(name);
+  },
+  set(name, value, days) {
+    setCookie(name, value, days);
+  }
+};
+function getCookie(name) {
+  const match = document.cookie.match(new RegExp("(^| )" + name + "=([^;]+)"));
+  if (!match) return null;
+  const decoded = decodeURIComponent(match[2]);
+  try {
+    return JSON.parse(decoded);
+  } catch (e) {
+    return decoded;
+  }
+}
+function setCookie(name, value, days) {
+  let expires = "";
+  if (days) {
+    const date = /* @__PURE__ */ new Date();
+    date.setTime(date.getTime() + days * 24 * 60 * 60 * 1e3);
+    expires = "; expires=" + date.toUTCString();
+  }
+  document.cookie = name + "=" + (value || "") + expires + "; path=/";
+}
+export {
+  cookies,
+  getCookie
+};

package/dist/esm/dom/css-vars.js

@@ -0,0 +1,28 @@
+// src/dom/get-element.js
+function getElement(selector) {
+  if (!selector) return;
+  if (selector instanceof Element) return selector;
+  return document.querySelector(selector);
+}
+
+// src/dom/css-vars.js
+function getCSSValue(element, prop) {
+  return getCSSVar(element, prop);
+}
+function setCSSValue(element, prop, value) {
+  setCSSVar(element, prop, value);
+}
+function getCSSVar(element, prop) {
+  element = getElement(element);
+  return getComputedStyle(element).getPropertyValue(prop);
+}
+function setCSSVar(element, prop, value) {
+  element = getElement(element);
+  element.style.setProperty(prop, value);
+}
+export {
+  getCSSValue,
+  getCSSVar,
+  setCSSValue,
+  setCSSVar
+};

package/dist/esm/dom/events.js

@@ -0,0 +1,67 @@
+// src/dom/events.js
+function addListeners(listeners) {
+  listeners.forEach(({ node, event, handler }) => {
+    node.addEventListener(event, handler);
+  });
+}
+function removeListeners(listeners) {
+  listeners.forEach(({ node, event, handler }) => {
+    node.removeEventListener(event, handler);
+  });
+}
+function dispatchEvent(node, eventName, detail, options = {}) {
+  node.dispatchEvent(
+    new CustomEvent(eventName, {
+      ...options,
+      detail
+    })
+  );
+}
+function updateEvent(event, updates) {
+  const { type, ...rest } = event;
+  return new CustomEvent(event.type, {
+    ...rest,
+    ...updates
+  });
+}
+function createListeners(listeners) {
+  listeners = listeners || [];
+  listeners.forEach((listener) => {
+    const { node, event, handler } = listener;
+    node.addEventListener(event, handler);
+  });
+  return {
+    get list() {
+      return listeners;
+    },
+    add({ node, event, handler }) {
+      listeners.push({ node, event, handler });
+      node.addEventListener(event, handler);
+    },
+    remove({ node, event, handler }) {
+      const index = listeners.findIndex((listener) => {
+        if (listener.node === node && listener.event === event && listener.handler === handler) {
+          return true;
+        }
+        return false;
+      });
+      if (index !== -1) {
+        listeners.splice(index, 1);
+        node.removeEventListener(event, handler);
+      }
+    },
+    clear() {
+      listeners.forEach(({ node, event, handler }) => {
+        listeners = [];
+        node.removeEventListener(event, handler);
+      });
+    }
+  };
+}
+export {
+  addListeners,
+  createListeners,
+  dispatchEvent,
+  removeListeners,
+  updateEvent
+};

package/dist/esm/dom/focusable.js

@@ -0,0 +1,118 @@
+// src/dom/focusable.js
+function getFocusableElements(container = document.body) {
+  return {
+    /**
+     * Gets the number of keyboard focusable elements.
+     * This is useful for checking if there are any focusable elements
+     * before attempting to focus them.
+     * 
+     * @returns {number} The number of keyboard focusable elements
+     */
+    get length() {
+      return this.keyboard.length;
+    },
+    /**
+     * Gets all focusable elements within the container that are visible and enabled.
+     * This includes elements that can be focused via mouse or programmatically,
+     * but may not be keyboard focusable.
+     * 
+     * Elements are considered focusable if they:
+     * - Are not disabled
+     * - Are not hidden
+     * - Are not display:none
+     * 
+     * @returns {HTMLElement[]} Array of focusable elements that are visible and enabled
+     */
+    get all() {
+      const elements = Array.from(
+        container.querySelectorAll(
+          `a, 
+            button, 
+            input, 
+            textarea, 
+            select, 
+            details, 
+            iframe, 
+            embed, 
+            object, 
+            summary, 
+            dialog, 
+            audio[controls], 
+            video[controls], 
+            [contenteditable], 
+            [tabindex]
+          `
+        )
+      );
+      return elements.filter((el) => {
+        if (el.hasAttribute("disabled")) return false;
+        if (el.hasAttribute("hidden")) return false;
+        if (window.getComputedStyle(el).display === "none") return false;
+        return true;
+      });
+    },
+    /**
+     * Gets elements that can be focused via keyboard (tabIndex > -1).
+     * These are the elements that will be focused when using the Tab key.
+     * 
+     * @returns {HTMLElement[]} Array of keyboard focusable elements
+     */
+    get keyboard() {
+      return this.all.filter((el) => el instanceof HTMLElement && el.tabIndex > -1);
+    },
+    /**
+     * Alias for keyboard focusable elements.
+     * This is provided for semantic clarity in certain contexts.
+     * 
+     * @returns {HTMLElement[]} Array of keyboard focusable elements
+     */
+    get keyboardOnly() {
+      return this.keyboard;
+    },
+    /**
+     * Gets the first keyboard focusable element.
+     * This is useful for setting initial focus when opening a modal or dialog.
+     * 
+     * @returns {HTMLElement|null} The first focusable element or null if none exist
+     */
+    get first() {
+      return this.keyboard[0] || null;
+    },
+    /**
+     * Gets the last keyboard focusable element.
+     * This is useful for focus trapping when using Shift+Tab.
+     * 
+     * @returns {HTMLElement|null} The last focusable element or null if none exist
+     */
+    get last() {
+      return this.keyboard[this.length - 1] || null;
+    },
+    /**
+     * Gets the next focusable element after the given index.
+     * This is useful for implementing custom tab order or focus management.
+     * 
+     * @param {number} index - The current element's index in the keyboard focusable array
+     * @returns {HTMLElement|null} The next focusable element or null if none exists
+     */
+    next(index) {
+      return this.keyboard[index + 1] || null;
+    },
+    /**
+     * Gets the previous focusable element before the given index.
+     * This is useful for implementing custom tab order or focus management.
+     * 
+     * @param {number} index - The current element's index in the keyboard focusable array
+     * @returns {HTMLElement|null} The previous focusable element or null if none exists
+     */
+    prev(index) {
+      return this.keyboard[index - 1] || null;
+    }
+  };
+}
+function Focusable(container = document.body) {
+  return getFocusableElements(container);
+}
+export {
+  Focusable,
+  getFocusableElements
+};

package/dist/esm/dom/font-size.js

@@ -0,0 +1,44 @@
+// src/lib/numbers/index.js
+function splitUnit(string) {
+  if (typeof string === "number") return [string, null];
+  const regex = /(-?\d*\.?\d+)\s*([a-z]+)/i;
+  const match = string.match(regex);
+  if (match) return [parseFloat(match[1]), match[2]];
+  return [parseFloat(string), null];
+}
+
+// src/dom/font-size.js
+function getUnit(value) {
+  const [, unit] = splitUnit(value);
+  return unit;
+}
+function em(element = document.body, multiple = 1) {
+  const value = parseFloat(getComputedStyle(element)["font-size"]);
+  return Math.round(value * multiple);
+}
+function rem(multiple = 1) {
+  const value = parseFloat(getComputedStyle(document.body)["font-size"]);
+  return Math.round(value * multiple);
+}
+function lh(element = document.body, multiple = 1) {
+  const lineHeight = getComputedStyle(element)["line-height"];
+  const value = parseFloat(lineHeight);
+  return Math.round(value * multiple);
+}
+function toPx(value, element = null) {
+  const [numeric, unit] = splitUnit(value);
+  let finalValue = 0;
+  if (unit === "rem") finalValue = rem(numeric);
+  if (unit === "em") finalValue = em(element, numeric);
+  if (unit === "lh") finalValue = lh(element, numeric);
+  if (unit === "px") finalValue = numeric;
+  if (!unit) finalValue = numeric;
+  return finalValue;
+}
+export {
+  em,
+  getUnit,
+  lh,
+  rem,
+  toPx
+};