Merge pull request #778 from seleniumbase/drag-and-drop-with-offset

Improve drag-and-drop functionality

Author: mdmintz

help_docs/method_summary.md

@@ -131,6 +131,8 @@ self.drag_and_drop(drag_selector, drop_selector,
                    drag_by=By.CSS_SELECTOR, drop_by=By.CSS_SELECTOR,
                    timeout=None)
 
+self.drag_and_drop_with_offset(selector, x, y, by=By.CSS_SELECTOR, timeout=None)
+
 self.select_option_by_text(dropdown_selector, option,
                            dropdown_by=By.CSS_SELECTOR,
                            timeout=None)

requirements.txt

@@ -2,7 +2,7 @@ pip>=20.3.3
 packaging>=20.8
 setuptools>=44.1.1;python_version<"3.5"
 setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"
-setuptools>=51.1.1;python_version>="3.6"
+setuptools>=51.1.2;python_version>="3.6"
 setuptools-scm>=5.0.1
 wheel>=0.36.2
 attrs>=20.3.0

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.51.12"
+__version__ = "1.51.13"

seleniumbase/fixtures/base_case.py

@@ -1474,6 +1474,28 @@ def drag_and_drop(self, drag_selector, drop_selector,
             self.__slow_mode_pause_if_active()
         return drag_element
 
+    def drag_and_drop_with_offset(
+            self, selector, x, y, by=By.CSS_SELECTOR, timeout=None):
+        """ Drag and drop an element to an {X,Y}-offset location. """
+        if not timeout:
+            timeout = settings.SMALL_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        selector, by = self.__recalculate_selector(selector, by)
+        css_selector = self.convert_to_css_selector(selector, by=by)
+        element = self.wait_for_element_visible(css_selector, timeout=timeout)
+        self.__demo_mode_highlight_if_active(css_selector, By.CSS_SELECTOR)
+        css_selector = re.escape(css_selector)  # Add "\\" to special chars
+        css_selector = self.__escape_quotes_if_needed(css_selector)
+        script = js_utils.get_drag_and_drop_with_offset_script(
+            css_selector, x, y)
+        self.safe_execute_script(script)
+        if self.demo_mode:
+            self.__demo_mode_pause_if_active()
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
+        return element
+
     def __select_option(self, dropdown_selector, option,
                         dropdown_by=By.CSS_SELECTOR, option_by="text",
                         timeout=None):

seleniumbase/fixtures/js_utils.py

@@ -792,6 +792,50 @@ def get_drag_and_drop_script():
     return script
 
 
+def get_drag_and_drop_with_offset_script(selector, x, y):
+    script_a = (
+        """
+        var source = document.querySelector("%s");
+        var offsetX = %f;
+        var offsetY = %f;
+        """ % (selector, x, y))
+    script_b = (
+        r"""
+        var rect = source.getBoundingClientRect();
+        var dragPt = {x: rect.left + (rect.width >> 1),
+                      y: rect.top + (rect.height >> 1)};
+        var dropPt = {x: dragPt.x + offsetX, y: dragPt.y + offsetY};
+        var target = document.elementFromPoint(dropPt.x, dropPt.y);
+        var dataTransfer = {
+          dropEffect: '',
+          effectAllowed: 'all',
+          files: [],
+          items: {},
+          types: [],
+          setData: function (format, data) {
+            this.items[format] = data;
+            this.types.push(format);
+          },
+          getData: function (format) {
+            return this.items[format];
+          },
+          clearData: function (format) { }
+        };
+        var emit = function (event, target, pt) {
+          var evt = document.createEvent('MouseEvent');
+          evt.initMouseEvent(event, true, true, window, 0, 0, 0, pt.x, pt.y,
+                             false, false, false, false, 0, null);
+          evt.dataTransfer = dataTransfer;
+          target.dispatchEvent(evt);
+        };
+        emit('mousedown', source, dragPt);
+        emit('mousemove', source, dragPt);
+        emit('mousemove', source, dropPt);
+        emit('mouseup',   source, dropPt);""")
+    script = script_a + script_b
+    return script
+
+
 def clear_out_console_logs(driver):
     try:
         # Clear out the current page log before navigating to a new page

setup.py

@@ -106,7 +106,7 @@
         'packaging>=20.8',
         'setuptools>=44.1.1;python_version<"3.5"',
         'setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"',
-        'setuptools>=51.1.1;python_version>="3.6"',
+        'setuptools>=51.1.2;python_version>="3.6"',
         'setuptools-scm>=5.0.1',
         'wheel>=0.36.2',
         'attrs>=20.3.0',