add support for double click

resolve go-rod#727
bsnyl5 · Sep 23, 2022 · 3965e2f · 3965e2f
1 parent da8f102
commit 3965e2f
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 13 deletions.
diff --git a/element.go b/element.go
@@ -100,7 +100,7 @@ func (el *Element) MoveMouseOut() error {
 // Click will press then release the button just like a human.
 // Before the action, it will try to scroll to the element, hover the mouse over it,
 // wait until the it's interactable and enabled.
-func (el *Element) Click(button proto.InputMouseButton) error {
+func (el *Element) Click(button proto.InputMouseButton, clickCount int) error {
 	err := el.Hover()
 	if err != nil {
 		return err
@@ -113,7 +113,7 @@ func (el *Element) Click(button proto.InputMouseButton) error {
 
 	defer el.tryTrace(TraceTypeInput, string(button)+" click")()
 
-	return el.page.Mouse.Click(button)
+	return el.page.Mouse.Click(button, clickCount)
 }
 
 // Tap will scroll to the button and tap it just like a human.

diff --git a/element_test.go b/element_test.go
@@ -689,11 +689,11 @@ func TestUseReleasedElement(t *testing.T) {
 	p := g.page.MustNavigate(g.srcFile("fixtures/click.html"))
 	btn := p.MustElement("button")
 	btn.MustRelease()
-	g.Err(btn.Click("left"))
+	g.Err(btn.Click("left", 1))
 
 	btn = p.MustElement("button")
 	g.E(proto.RuntimeReleaseObject{ObjectID: btn.Object.ObjectID}.Call(p))
-	g.Is(btn.Click("left"), cdp.ErrObjNotFound)
+	g.Is(btn.Click("left", 1), cdp.ErrObjNotFound)
 }
 
 func TestElementRemove(t *testing.T) {

diff --git a/fixtures/double-click.html b/fixtures/double-click.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <button ondblclick='this.textContent = "ok"'>click me</button>
+  </body>
+</html>
diff --git a/input.go b/input.go
@@ -294,7 +294,7 @@ func (m *Mouse) Scroll(offsetX, offsetY float64, steps int) error {
 }
 
 // Down holds the button down
-func (m *Mouse) Down(button proto.InputMouseButton, clicks int) error {
+func (m *Mouse) Down(button proto.InputMouseButton, clickCount int) error {
 	m.Lock()
 	defer m.Unlock()
 
@@ -306,7 +306,7 @@ func (m *Mouse) Down(button proto.InputMouseButton, clicks int) error {
 		Type:       proto.InputDispatchMouseEventTypeMousePressed,
 		Button:     button,
 		Buttons:    gson.Int(buttons),
-		ClickCount: clicks,
+		ClickCount: clickCount,
 		Modifiers:  m.page.Keyboard.getModifiers(),
 		X:          m.x,
 		Y:          m.y,
@@ -319,7 +319,7 @@ func (m *Mouse) Down(button proto.InputMouseButton, clicks int) error {
 }
 
 // Up releases the button
-func (m *Mouse) Up(button proto.InputMouseButton, clicks int) error {
+func (m *Mouse) Up(button proto.InputMouseButton, clickCount int) error {
 	m.Lock()
 	defer m.Unlock()
 
@@ -337,7 +337,7 @@ func (m *Mouse) Up(button proto.InputMouseButton, clicks int) error {
 		Type:       proto.InputDispatchMouseEventTypeMouseReleased,
 		Button:     button,
 		Buttons:    gson.Int(buttons),
-		ClickCount: clicks,
+		ClickCount: clickCount,
 		Modifiers:  m.page.Keyboard.getModifiers(),
 		X:          m.x,
 		Y:          m.y,
@@ -350,15 +350,15 @@ func (m *Mouse) Up(button proto.InputMouseButton, clicks int) error {
 }
 
 // Click the button. It's the combination of Mouse.Down and Mouse.Up
-func (m *Mouse) Click(button proto.InputMouseButton) error {
+func (m *Mouse) Click(button proto.InputMouseButton, clickCount int) error {
 	m.page.browser.trySlowmotion()
 
-	err := m.Down(button, 1)
+	err := m.Down(button, clickCount)
 	if err != nil {
 		return err
 	}
 
-	return m.Up(button, 1)
+	return m.Up(button, clickCount)
 }
 
 // Touch presents a touch device, such as a hand with fingers, each finger is a proto.InputTouchPoint.

diff --git a/input_test.go b/input_test.go
@@ -169,6 +169,18 @@ func TestMouseClick(t *testing.T) {
 	g.True(page.MustHas("[a=ok]"))
 }
 
+func TestMouseDoubleClick(t *testing.T) {
+	g := setup(t)
+
+	g.browser.SlowMotion(1)
+	defer func() { g.browser.SlowMotion(0) }()
+
+	page := g.page.MustNavigate(g.srcFile("fixtures/double-click.html"))
+	el := page.MustElement("button")
+	el.MustDoubleClick()
+	g.Eq(el.MustText(), "ok")
+}
+
 func TestMouseDrag(t *testing.T) {
 	g := setup(t)
 

diff --git a/must.go b/must.go
@@ -626,7 +626,7 @@ func (m *Mouse) MustUp(button proto.InputMouseButton) *Mouse {
 
 // MustClick is similar to Mouse.Click
 func (m *Mouse) MustClick(button proto.InputMouseButton) *Mouse {
-	m.page.e(m.Click(button))
+	m.page.e(m.Click(button, 1))
 	return m
 }
 
@@ -726,7 +726,13 @@ func (el *Element) MustHover() *Element {
 
 // MustClick is similar to Element.Click
 func (el *Element) MustClick() *Element {
-	el.e(el.Click(proto.InputMouseButtonLeft))
+	el.e(el.Click(proto.InputMouseButtonLeft, 1))
+	return el
+}
+
+// MustDoubleClick is similar to Element.Click
+func (el *Element) MustDoubleClick() *Element {
+	el.e(el.Click(proto.InputMouseButtonLeft, 2))
 	return el
 }