@tb-dev/prototype-dom 6.1.14 → 6.2.0

package/dist/index.d.ts

@@ -36,6 +36,15 @@ 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?: {
+            timeout?: number;
+        } & ScrollIntoViewOptions) => Promise<void>;
         /**
          * Wait for the first descendant element that matches the given selector to exist.
          * @param selector CSS selector to match.
@@ -125,6 +134,15 @@ 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?: {
+            timeout?: number;
+        } & ScrollIntoViewOptions) => 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,18 @@
       return promise;
     };
   }
+  function scrollAsync() {
+    return async function(selector, options = {}) {
+      const { timeout, ...scrollOptions } = options;
+      const element2 = await this.waitChild(selector, timeout);
+      element2.scrollIntoView({
+        behavior: "smooth",
+        block: "center",
+        inline: "nearest",
+        ...scrollOptions
+      });
+    };
+  }
   const element = {
     getAttributeStrict,
     getAttributeAsFloatStrict,
@@ -124,6 +136,7 @@
     queryAsArray,
     queryAsSet,
     queryAsMap,
+    scrollAsync,
     waitChild
   };
 
@@ -164,6 +177,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 +189,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.2.0",
   "description": "Adds prototype methods to DOM objects",
   "license": "MIT",
   "type": "module",