dblclick.md

title
dblclick

Double-click a DOM element.

Syntax

.dblclick()
.dblclick(options)

Usage

{% fa fa-check-circle green %} Correct Usage

cy.get('button').dblclick()          // Double click on button
cy.focused().dblclick()              // Double click on el with focus
cy.contains('Welcome').dblclick()    // Double click on first el containing 'Welcome'

{% fa fa-exclamation-triangle red %} Incorrect Usage

cy.dblclick('button')          // Errors, cannot be chained off 'cy'
cy.window().dblclick()         // Errors, 'window' does not yield DOM element

Arguments

{% fa fa-angle-right %} options (Object)

Pass in an options object to change the default behavior of .dblclick().

Option	Default	Description
log	true	{% usage_options log %}
timeout	{% url defaultCommandTimeout configuration#Timeouts %}	{% usage_options timeout .dblclick %}

Yields {% helper_icon yields %}

{% yields same_subject .dblclick %}

Examples

No Args

Double click an anchor link

cy.get('a#nav1').dblclick() // yields the <a>

Notes

Actionability

The element must first reach actionability

.dblclick() is an "action command" that follows all the rules {% url 'defined here' interacting-with-elements %}.

Rules

Requirements {% helper_icon requirements %}

{% requirements dom .dblclick %}

Assertions {% helper_icon assertions %}

{% assertions actions .dblclick %}

Timeouts {% helper_icon timeout %}

{% timeouts actions .dblclick %}

Command Log

Double click on a calendar schedule

cy.get('[data-schedule-id="4529114"]:first').dblclick()

The commands above will display in the Command Log as:

{% imgTag /img/api/dblclick/double-click-in-testing.png "Command Log dblclick" %}

When clicking on dblclick within the command log, the console outputs the following:

{% imgTag /img/api/dblclick/element-double-clicked-on.png "console.log dblclick" %}

See also

• {% url .click() click %}