Add a scroll option to multiple clicking methods

Author: mdmintz

examples/cdp_mode/ReadMe.md

@@ -403,12 +403,12 @@ sb.cdp.select(selector, timeout=None)
 sb.cdp.select_all(selector, timeout=None)
 sb.cdp.find_elements(selector, timeout=None)
 sb.cdp.find_visible_elements(selector, timeout=None)
-sb.cdp.click(selector, timeout=None)
-sb.cdp.click_if_visible(selector, timeout=0)
-sb.cdp.click_visible_elements(selector, limit=0)
-sb.cdp.click_nth_element(selector, number)
-sb.cdp.click_nth_visible_element(selector, number)
-sb.cdp.click_with_offset(selector, x, y, center=False)
+sb.cdp.click(selector, timeout=None, scroll=True)
+sb.cdp.click_if_visible(selector, timeout=0, scroll=True)
+sb.cdp.click_visible_elements(selector, limit=0, scroll=True)
+sb.cdp.click_nth_element(selector, number, scroll=True)
+sb.cdp.click_nth_visible_element(selector, number, scroll=True)
+sb.cdp.click_with_offset(selector, x, y, center=False, scroll=True)
 sb.cdp.click_link(link_text)
 sb.cdp.go_back()
 sb.cdp.go_forward()
@@ -428,7 +428,7 @@ sb.cdp.bring_to_front()
 sb.cdp.get_active_element()
 sb.cdp.get_active_element_css()
 sb.cdp.click_active_element()
-sb.cdp.mouse_click(selector, timeout=None)
+sb.cdp.mouse_click(selector, timeout=None, scroll=True)
 sb.cdp.nested_click(parent_selector, selector)
 sb.cdp.get_nested_element(parent_selector, selector)
 sb.cdp.select_option_by_text(dropdown_selector, option)

help_docs/cdp_mode_methods.md

@@ -29,12 +29,12 @@ sb.cdp.select(selector, timeout=None)
 sb.cdp.select_all(selector, timeout=None)
 sb.cdp.find_elements(selector, timeout=None)
 sb.cdp.find_visible_elements(selector, timeout=None)
-sb.cdp.click(selector, timeout=None)
-sb.cdp.click_if_visible(selector)
-sb.cdp.click_visible_elements(selector, limit=0)
-sb.cdp.click_nth_element(selector, number)
-sb.cdp.click_nth_visible_element(selector, number)
-sb.cdp.click_with_offset(selector, x, y, center=False)
+sb.cdp.click(selector, timeout=None, scroll=True)
+sb.cdp.click_if_visible(selector, timeout=0, scroll=True)
+sb.cdp.click_visible_elements(selector, limit=0, scroll=True)
+sb.cdp.click_nth_element(selector, number, scroll=True)
+sb.cdp.click_nth_visible_element(selector, number, scroll=True)
+sb.cdp.click_with_offset(selector, x, y, center=False, scroll=True)
 sb.cdp.click_link(link_text)
 sb.cdp.go_back()
 sb.cdp.go_forward()
@@ -54,7 +54,7 @@ sb.cdp.bring_to_front()
 sb.cdp.get_active_element()
 sb.cdp.get_active_element_css()
 sb.cdp.click_active_element()
-sb.cdp.mouse_click(selector, timeout=None)
+sb.cdp.mouse_click(selector, timeout=None, scroll=True)
 sb.cdp.nested_click(parent_selector, selector)
 sb.cdp.get_nested_element(parent_selector, selector)
 sb.cdp.select_option_by_text(dropdown_selector, option)

help_docs/method_summary.md

@@ -90,14 +90,16 @@ self.find_elements(selector, by="css selector", limit=0)
 # Duplicates:
 # self.select_all(selector, by="css selector", limit=0)
 self.find_visible_elements(selector, by="css selector", limit=0)
-self.click_visible_elements(selector, by="css selector", limit=0, timeout=None)
-self.click_nth_visible_element(selector, number, by="css selector", timeout=None)
-self.click_if_visible(selector, by="css selector", timeout=0)
+self.click_visible_elements(
+    selector, by="css selector", limit=0, timeout=None, scroll=True)
+self.click_nth_visible_element(
+    selector, number, by="css selector", timeout=None, scroll=True)
+self.click_if_visible(selector, by="css selector", timeout=0, scroll=True)
 self.click_active_element()
 self.click_with_offset(
-    selector, x, y, by="css selector", mark=None, timeout=None, center=None)
+    selector, x, y, by="css selector", mark=None, timeout=None, center=None, scroll=True)
 self.double_click_with_offset(
-    selector, x, y, by="css selector", mark=None, timeout=None, center=None)
+    selector, x, y, by="css selector", mark=None, timeout=None, center=None, scroll=True)
 self.is_checked(selector, by="css selector", timeout=None)
 # Duplicates:
 # self.is_selected(selector, by="css selector", timeout=None)

seleniumbase/core/sb_cdp.py

@@ -429,7 +429,7 @@ def find_visible_elements(self, selector, timeout=None):
                     visible_elements.append(element)
         return visible_elements
 
-    def click_nth_element(self, selector, number):
+    def click_nth_element(self, selector, number, scroll=True):
         elements = self.select_all(selector)
         if len(elements) < number:
             raise Exception(
@@ -440,10 +440,11 @@ def click_nth_element(self, selector, number):
         if number < 0:
             number = 0
         element = elements[number]
-        element.scroll_into_view()
+        if scroll:
+            element.scroll_into_view()
         element.click()
 
-    def click_nth_visible_element(self, selector, number):
+    def click_nth_visible_element(self, selector, number, scroll=True):
         """Finds all matching page elements and clicks the nth visible one.
         Example: self.click_nth_visible_element('[type="checkbox"]', 5)
                 (Clicks the 5th visible checkbox on the page.)"""
@@ -457,7 +458,8 @@ def click_nth_visible_element(self, selector, number):
         if number < 0:
             number = 0
         element = elements[number]
-        element.scroll_into_view()
+        if scroll:
+            element.scroll_into_view()
         element.click()
 
     def click_link(self, link_text):
@@ -793,12 +795,13 @@ def get_active_element_css(self):
         js_code = js_code.replace("return getBestSelector", "getBestSelector")
         return self.loop.run_until_complete(self.page.evaluate(js_code))
 
-    def click(self, selector, timeout=None):
+    def click(self, selector, timeout=None, scroll=True):
         if not timeout:
             timeout = settings.SMALL_TIMEOUT
         self.__slow_mode_pause_if_set()
         element = self.find_element(selector, timeout=timeout)
-        element.scroll_into_view()
+        if scroll:
+            element.scroll_into_view()
         tag_name = element.tag_name
         if tag_name:
             tag_name = tag_name.lower().strip()
@@ -824,10 +827,10 @@ def click_active_element(self):
         self.__slow_mode_pause_if_set()
         self.loop.run_until_complete(self.page.wait(0.2))
 
-    def click_if_visible(self, selector, timeout=0):
+    def click_if_visible(self, selector, timeout=0, scroll=True):
         if self.is_element_visible(selector):
             with suppress(Exception):
-                self.click(selector, timeout=1)
+                self.click(selector, timeout=1, scroll=scroll)
         elif timeout == 0:
             return
         else:
@@ -836,7 +839,7 @@ def click_if_visible(self, selector, timeout=0):
                 if self.is_element_visible(selector):
                     self.click(selector, timeout=1)
 
-    def click_visible_elements(self, selector, limit=0):
+    def click_visible_elements(self, selector, limit=0, scroll=True):
         """Finds all matching page elements and clicks visible ones in order.
         If a click reloads or opens a new page, the clicking will stop.
         If no matching elements appear, an Exception will be raised.
@@ -859,7 +862,8 @@ def click_visible_elements(self, selector, limit=0):
                 except Exception:
                     continue
                 if (width != 0 or height != 0):
-                    element.scroll_into_view()
+                    if scroll:
+                        element.scroll_into_view()
                     element.click()
                     click_count += 1
                     time.sleep(0.044)
@@ -868,13 +872,14 @@ def click_visible_elements(self, selector, limit=0):
             except Exception:
                 break
 
-    def mouse_click(self, selector, timeout=None):
+    def mouse_click(self, selector, timeout=None, scroll=True):
         """(Attempt simulating a mouse click)"""
         if not timeout:
             timeout = settings.SMALL_TIMEOUT
         self.__slow_mode_pause_if_set()
         element = self.find_element(selector, timeout=timeout)
-        element.scroll_into_view()
+        if scroll:
+            element.scroll_into_view()
         element.mouse_click()
         self.__slow_mode_pause_if_set()
         self.loop.run_until_complete(self.page.wait(0.2))
@@ -1970,9 +1975,10 @@ def gui_click_with_offset(
             py = element_rect["y"]
             self.gui_click_x_y(px + x, py + y, timeframe=timeframe)
 
-    def click_with_offset(self, selector, x, y, center=False):
+    def click_with_offset(self, selector, x, y, center=False, scroll=True):
         element = self.find_element(selector)
-        element.scroll_into_view()
+        if scroll:
+            element.scroll_into_view()
         if "--debug" in sys.argv:
             displayed_selector = "`%s`" % selector
             if '"' not in selector:

seleniumbase/fixtures/base_case.py

@@ -411,7 +411,7 @@ def click(
         original_by = by
         selector, by = self.__recalculate_selector(selector, by)
         if self.__is_cdp_swap_needed():
-            self.cdp.click(selector, timeout=timeout)
+            self.cdp.click(selector, timeout=timeout, scroll=scroll)
             return
         if delay and (type(delay) in [int, float]) and delay > 0:
             time.sleep(delay)
@@ -2254,7 +2254,7 @@ def find_visible_elements(self, selector, by="css selector", limit=0):
         )
 
     def click_visible_elements(
-        self, selector, by="css selector", limit=0, timeout=None
+        self, selector, by="css selector", limit=0, timeout=None, scroll=True
     ):
         """Finds all matching page elements and clicks visible ones in order.
         If a click reloads or opens a new page, the clicking will stop.
@@ -2270,7 +2270,7 @@ def click_visible_elements(
             timeout = self.__get_new_timeout(timeout)
         selector, by = self.__recalculate_selector(selector, by)
         if self.__is_cdp_swap_needed():
-            self.cdp.click_visible_elements(selector, limit)
+            self.cdp.click_visible_elements(selector, limit, scroll=scroll)
             return
         self.wait_for_ready_state_complete()
         if self.__needs_minimum_wait():
@@ -2297,7 +2297,8 @@ def click_visible_elements(
                 return
             try:
                 if element.is_displayed():
-                    self.__scroll_to_element(element)
+                    if scroll:
+                        self.__scroll_to_element(element)
                     if self.browser == "safari":
                         self.execute_script("arguments[0].click();", element)
                     else:
@@ -2311,7 +2312,8 @@ def click_visible_elements(
                 time.sleep(0.12)
                 try:
                     if element.is_displayed():
-                        self.__scroll_to_element(element)
+                        if scroll:
+                            self.__scroll_to_element(element)
                         if self.browser == "safari":
                             self.execute_script(
                                 "arguments[0].click();", element
@@ -2348,7 +2350,7 @@ def click_visible_elements(
             self.__switch_to_newest_window_if_not_blank()
 
     def click_nth_visible_element(
-        self, selector, number, by="css selector", timeout=None
+        self, selector, number, by="css selector", timeout=None, scroll=True
     ):
         """Finds all matching page elements and clicks the nth visible one.
         Example: self.click_nth_visible_element('[type="checkbox"]', 5)
@@ -2360,7 +2362,7 @@ def click_nth_visible_element(
             timeout = self.__get_new_timeout(timeout)
         selector, by = self.__recalculate_selector(selector, by)
         if self.__is_cdp_swap_needed():
-            self.cdp.click_nth_visible_element(selector, number)
+            self.cdp.click_nth_visible_element(selector, number, scroll=scroll)
             return
         self.wait_for_ready_state_complete()
         self.wait_for_element_present(selector, by=by, timeout=timeout)
@@ -2379,7 +2381,8 @@ def click_nth_visible_element(
             pre_action_url = self.driver.current_url
         pre_window_count = len(self.driver.window_handles)
         try:
-            self.__scroll_to_element(element)
+            if scroll:
+                self.__scroll_to_element(element)
             self.__element_click(element)
         except (Stale_Exception, ENI_Exception, ECI_Exception):
             time.sleep(0.12)
@@ -2409,26 +2412,28 @@ def click_nth_visible_element(
         ):
             self.__switch_to_newest_window_if_not_blank()
 
-    def click_if_visible(self, selector, by="css selector", timeout=0):
+    def click_if_visible(
+        self, selector, by="css selector", timeout=0, scroll=True
+    ):
         """If the page selector exists and is visible, clicks on the element.
         This method only clicks on the first matching element found.
         Use click_visible_elements() to click all matching elements.
         If a "timeout" is provided, waits that long for the element
         to appear before giving up and returning without a click()."""
         if self.__is_cdp_swap_needed():
-            self.cdp.click_if_visible(selector, timeout=timeout)
+            self.cdp.click_if_visible(selector, timeout=timeout, scroll=scroll)
             return
         self.wait_for_ready_state_complete()
         if self.is_element_visible(selector, by=by):
-            self.click(selector, by=by)
+            self.click(selector, by=by, scroll=scroll)
         elif timeout > 0:
             with suppress(Exception):
                 self.wait_for_element_visible(
                     selector, by=by, timeout=timeout
                 )
                 self.sleep(0.2)
             if self.is_element_visible(selector, by=by):
-                self.click(selector, by=by)
+                self.click(selector, by=by, scroll=scroll)
 
     def click_active_element(self):
         if self.__is_cdp_swap_needed():
@@ -2484,6 +2489,7 @@ def click_with_offset(
         mark=None,
         timeout=None,
         center=None,
+        scroll=True,
     ):
         """Click an element at an {X,Y}-offset location.
         {0,0} is the top-left corner of the element.
@@ -2500,6 +2506,7 @@ def click_with_offset(
             mark=mark,
             timeout=timeout,
             center=center,
+            scroll=scroll,
         )
 
     def double_click_with_offset(
@@ -2511,6 +2518,7 @@ def double_click_with_offset(
         mark=None,
         timeout=None,
         center=None,
+        scroll=True,
     ):
         """Double click an element at an {X,Y}-offset location.
         {0,0} is the top-left corner of the element.
@@ -2527,6 +2535,7 @@ def double_click_with_offset(
             mark=mark,
             timeout=timeout,
             center=center,
+            scroll=scroll,
         )
 
     def is_checked(self, selector, by="css selector", timeout=None):
@@ -14043,9 +14052,12 @@ def __click_with_offset(
         mark=None,
         timeout=None,
         center=None,
+        scroll=True,
     ):
         if self.__is_cdp_swap_needed():
-            self.cdp.click_with_offset(selector, x, y, center=center)
+            self.cdp.click_with_offset(
+                selector, x, y, center=center, scroll=scroll
+            )
             return
         self.wait_for_ready_state_complete()
         if self.__needs_minimum_wait():
@@ -14061,9 +14073,13 @@ def __click_with_offset(
         if self.demo_mode:
             self.__highlight(selector, by=by, loops=1)
         elif self.slow_mode:
-            self.__slow_scroll_to_element(element)
+            if scroll:
+                self.__slow_scroll_to_element(element)
+            else:
+                self.sleep(0.2)
         else:
-            self.__scroll_to_element(element, selector, by)
+            if scroll:
+                self.__scroll_to_element(element, selector, by)
         self.wait_for_ready_state_complete()
         if self.__needs_minimum_wait():
             time.sleep(0.03)