check isIntersectingViewport

Author: bvandercar-vt

README.md

@@ -115,11 +115,10 @@ Toggles random mouse movements on or off.
 Simulates a mouse click at the specified selector or element.
 
 - **selector (optional):** CSS selector or ElementHandle to identify the target element.
-- **options (optional):** Additional options for clicking.
+- **options (optional):** Additional options for clicking. **Extends the `options` of the `move` function (below)**
   - `hesitate (number):` Delay before initiating the click action in milliseconds. Default is `0`.
   - `waitForClick (number):` Delay between mousedown and mouseup in milliseconds. Default is `0`.
   - `moveDelay (number):` Delay after moving the mouse in milliseconds. Default is `2000`. If `randomizeMoveDelay=true`, delay is randomized from 0 to `moveDelay`.
-  - `randomizeMoveDelay (boolean):` Randomize delay between actions from `0` to `moveDelay`. Default is `true`.
 
 #### `move(selector: string | ElementHandle, options?: MoveOptions): Promise<void>`
 
@@ -134,6 +133,8 @@ Moves the mouse to the specified selector or element.
   - `maxTries (number):` Maximum number of attempts to mouse-over the element. Default is `10`.
   - `moveSpeed (number):` Speed of mouse movement. Default is random.
   - `overshootThreshold (number):` Distance from current location to destination that triggers overshoot to occur. (Below this distance, no overshoot will occur). Default is `500`.
+  - `scrollBehavior (ScrollBehavior):` Scroll behavior when target element is outside the visible window. Default is `undefined` (browser default).
+  - `scrollWait (number):` Time to wait after scrolling (when scrolling occurs due to target element being outside the visible window). Default is `200`.
 
 #### `moveTo(destination: Vector, options?: MoveToOptions): Promise<void>`
 

src/__test__/spoof.spec.ts

@@ -12,7 +12,8 @@ const cursorDefaultOptions = {
   moveDelay: 0,
   moveSpeed: 99,
   hesitate: 0,
-  waitForClick: 0
+  waitForClick: 0,
+  scrollWait: 0
 } as const satisfies ClickOptions
 
 describe('Mouse movements', () => {

src/spoof.ts

@@ -59,7 +59,7 @@ export interface MoveOptions extends BoxOptions, Pick<PathOptions, 'moveSpeed'>
   readonly scrollBehavior?: ScrollBehavior
   /**
    * Time to wait after scrolling (when scrolling occurs due to target element being outside the visible window)
-   * @default 2000
+   * @default 200
    */
   readonly scrollWait?: number
 }
@@ -76,7 +76,7 @@ export interface ClickOptions extends MoveOptions {
    */
   readonly waitForClick?: number
   /**
-   * @default 200
+   * @default 2000
    */
   readonly moveDelay?: number
 }
@@ -525,17 +525,20 @@ export const createCursor = (
         }
 
         // Make sure the object is in view
-        const objectId = elem.remoteObject().objectId
-        if (objectId !== undefined) {
-          const scrollElemIntoView = async (): Promise<void> => await elem.evaluate((e, scrollBehavior) => e.scrollIntoView({
-            block: 'center',
-            behavior: scrollBehavior
-          }), optionsResolved.scrollBehavior)
+        if (!(await elem.isIntersectingViewport())) {
+          const scrollElemIntoView = async (): Promise<void> =>
+            await elem.evaluate((e, scrollBehavior) => e.scrollIntoView({
+              block: 'center',
+              behavior: scrollBehavior
+            }), optionsResolved.scrollBehavior)
 
           if (optionsResolved.scrollBehavior !== undefined) {
+            // DOM.scrollIntoViewIfNeeded is instant scroll, so do the JS scroll if scrollBehavior passed
             await scrollElemIntoView()
           } else {
             try {
+              const { objectId } = elem.remoteObject()
+              if (objectId === undefined) throw new Error()
               await getCDPClient(page).send('DOM.scrollIntoViewIfNeeded', {
                 objectId
               })
@@ -545,7 +548,6 @@ export const createCursor = (
               await scrollElemIntoView()
             }
           }
-
           await delay(optionsResolved.scrollWait)
         }