@tb-dev/prototype-dom 6.1.14 → 6.3.0

package/dist/index.d.ts

@@ -1,5 +1,12 @@
+export declare interface ScrollAsyncOptions extends ScrollIntoViewOptions {
+    timeout?: number;
+    /** @default true */
+    throwOnTimeout?: boolean;
+}
+
 export { }
 
+
 declare global {
     interface Document {
         /**
@@ -36,6 +43,13 @@ declare global {
          * @param valueFn Function that returns the value for each element.
          */
         queryAsMap: <T extends Element, K, V = T>(selector: string, keyFn: (element: T) => K, valueFn?: (element: T) => V) => Map<K, V>;
+        /**
+         * Wait for the first descendant element that matches the given selector to exist.
+         * Once found, scroll the element into view.
+         * @param selector CSS selector to match.
+         * @param options Options to customize the scrolling behavior.
+         */
+        scrollAsync: (selector: string, options?: ScrollAsyncOptions) => Promise<void>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
          * @param selector CSS selector to match.
@@ -125,6 +139,13 @@ declare global {
          * @param valueFn Function that returns the value for each element.
          */
         queryAsMap: <T extends Element, K, V = T>(selector: string, keyFn: (element: T) => K, valueFn?: (element: T) => V) => Map<K, V>;
+        /**
+         * Wait for the first descendant element that matches the given selector to exist.
+         * Once found, scroll the element into view.
+         * @param selector CSS selector to match.
+         * @param options Options to customize the scrolling behavior.
+         */
+        scrollAsync: (selector: string, options?: ScrollAsyncOptions) => Promise<void>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
          * @param selector CSS selector to match.

package/dist/index.iife.js

@@ -113,6 +113,22 @@
       return promise;
     };
   }
+  function scrollAsync() {
+    return async function(selector, options = {}) {
+      const { timeout, throwOnTimeout = true, ...scrollOptions } = options;
+      try {
+        const element2 = await this.waitChild(selector, timeout);
+        element2.scrollIntoView({
+          behavior: "smooth",
+          block: "center",
+          inline: "nearest",
+          ...scrollOptions
+        });
+      } catch (err) {
+        if (throwOnTimeout) throw err;
+      }
+    };
+  }
   const element = {
     getAttributeStrict,
     getAttributeAsFloatStrict,
@@ -124,6 +140,7 @@
     queryAsArray,
     queryAsSet,
     queryAsMap,
+    scrollAsync,
     waitChild
   };
 
@@ -164,6 +181,7 @@
   Document.prototype.queryAsArray = element.queryAsArray();
   Document.prototype.queryAsSet = element.queryAsSet();
   Document.prototype.queryAsMap = element.queryAsMap();
+  Document.prototype.scrollAsync = element.scrollAsync();
   Document.prototype.waitChild = element.waitChild();
   Element.prototype.getAttributeStrict = element.getAttributeStrict();
   Element.prototype.getAttributeAsFloatStrict = element.getAttributeAsFloatStrict();
@@ -175,6 +193,7 @@
   Element.prototype.queryAsArray = element.queryAsArray();
   Element.prototype.queryAsSet = element.queryAsSet();
   Element.prototype.queryAsMap = element.queryAsMap();
+  Element.prototype.scrollAsync = element.scrollAsync();
   Element.prototype.waitChild = element.waitChild();
   URLSearchParams.prototype.getStrict = urlSearchParams.getStrict();
   URLSearchParams.prototype.getAsInteger = urlSearchParams.getAsInteger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tb-dev/prototype-dom",
-  "version": "6.1.14",
+  "version": "6.3.0",
   "description": "Adds prototype methods to DOM objects",
   "license": "MIT",
   "type": "module",
@@ -22,17 +22,17 @@
     "*.{?(c|m)@(j|t)s,css,vue,md,json}": "prettier --write"
   },
   "devDependencies": {
-    "@tb-dev/eslint-config": "^5.2.1",
-    "eslint": "^9.9.0",
-    "husky": "^9.1.5",
-    "lint-staged": "^15.2.9",
+    "@tb-dev/eslint-config": "^5.3.2",
+    "eslint": "^9.10.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
     "prettier": "^3.3.3",
-    "tslib": "^2.6.3",
-    "typedoc": "^0.26.6",
-    "typedoc-plugin-mdn-links": "^3.2.9",
-    "typescript": "^5.5.4",
-    "vite": "^5.4.2",
-    "vite-plugin-dts": "^4.0.3"
+    "tslib": "^2.7.0",
+    "typedoc": "^0.26.7",
+    "typedoc-plugin-mdn-links": "^3.2.12",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.5",
+    "vite-plugin-dts": "^4.2.1"
   },
   "files": [
     "dist/**/*"