{
  "doc": {
    "id": "api/commands/dblclick",
    "title": "dblclick | Cypress Documentation",
    "description": "Double-click a DOM element in Cypress.",
    "section": "api",
    "source_path": "/llm/markdown/api/commands/dblclick.md",
    "version": "e6988a974973e9090ce70406c38cb2b9e0eac9fa",
    "updated_at": "2026-05-15T15:50:22.536Z",
    "headings": [
      {
        "id": "api/commands/dblclick#dblclick",
        "text": "dblclick",
        "level": 1
      },
      {
        "id": "api/commands/dblclick#syntax",
        "text": "Syntax",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#usage",
        "text": "Usage",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#arguments",
        "text": "Arguments",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#yields-learn-about-subject-management",
        "text": "Yields Learn about subject management",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#examples",
        "text": "Examples",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#no-args",
        "text": "No Args",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#double-click-an-anchor-link",
        "text": "Double click an anchor link",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#position",
        "text": "Position",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#specify-a-position-of-the-element-to-double-click",
        "text": "Specify a position of the element to double click",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#coordinates",
        "text": "Coordinates",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#specify-coordinates-relative-to-the-top-left-corner",
        "text": "Specify coordinates relative to the top left corner",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#options",
        "text": "Options",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#force-a-double-click-regardless-of-its-actionable-state",
        "text": "Force a double click regardless of its actionable state",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#force-a-double-click-with-position-argument",
        "text": "Force a double click with position argument",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#force-a-double-click-with-relative-coordinates",
        "text": "Force a double click with relative coordinates",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#double-click-all-buttons-found-on-the-page",
        "text": "Double click all buttons found on the page",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#double-click-with-key-combinations",
        "text": "Double click with key combinations",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#alt-click",
        "text": "Alt click",
        "level": 5
      },
      {
        "id": "api/commands/dblclick#notes",
        "text": "Notes",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#actionability",
        "text": "Actionability",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#the-element-must-first-reach-actionability",
        "text": "The element must first reach actionability",
        "level": 4
      },
      {
        "id": "api/commands/dblclick#rules",
        "text": "Rules",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#requirements-learn-about-chaining-commands",
        "text": "Requirements Learn about chaining commands",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#assertions-learn-about-assertions",
        "text": "Assertions Learn about assertions",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#timeouts-learn-about-timeouts",
        "text": "Timeouts Learn about timeouts",
        "level": 3
      },
      {
        "id": "api/commands/dblclick#command-log",
        "text": "Command Log",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#history",
        "text": "History",
        "level": 2
      },
      {
        "id": "api/commands/dblclick#see-also",
        "text": "See also",
        "level": 2
      }
    ]
  },
  "chunks": [
    {
      "id": "api/commands/dblclick#syntax",
      "doc_id": "api/commands/dblclick",
      "heading": "Syntax",
      "heading_level": 2,
      "content_markdown": "## Syntax\n\n```\n.dblclick().dblclick(options).dblclick(position).dblclick(position, options).dblclick(x, y).dblclick(x, y, options)\n```\n\n### Usage\n\n**Correct Usage**\n\n```\ncy.get('button').dblclick() // Double click on buttoncy.focused().dblclick() // Double click on el with focuscy.contains('Welcome').dblclick() // Double click on first el containing 'Welcome'\n```\n\n**Incorrect Usage**\n\n```\ncy.dblclick('button') // Errors, cannot be chained off 'cy'cy.window().dblclick() // Errors, 'window' does not yield DOM element\n```\n\n### Arguments\n\n**position _(String)_**\n\nThe position where the double click should be issued. The `center` position is the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`, `center`, `right`, `bottomLeft`, `bottom`, and `bottomRight`.\n\n**x _(Number)_**\n\nThe distance in pixels from the element's left to issue the double click.\n\n**y _(Number)_**\n\nThe distance in pixels from the element's top to issue the double click.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `.dblclick()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |\n| `animationDistanceThreshold` | [`animationDistanceThreshold`](/llm/markdown/app/references/configuration.md#Actionability) | The distance in pixels an element must exceed over time to be [considered animating](/llm/markdown/app/core-concepts/interacting-with-elements.md#Animations). |\n| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |\n| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |\n| `multiple` | `true` | Serially click multiple elements |\n| `scrollBehavior` | [`scrollBehavior`](/llm/markdown/app/references/configuration.md#Actionability) | Viewport position to where an element [should be scrolled](/llm/markdown/app/core-concepts/interacting-with-elements.md#Scrolling) before executing the command |\n| `shiftKey` | `false` | Activates the shift key. |\n| `timeout` | [`defaultCommandTimeout`](/llm/markdown/app/references/configuration.md#Timeouts) | Time to wait for `.dblclick()` to resolve before [timing out](#Timeouts) |\n| `waitForAnimations` | [`waitForAnimations`](/llm/markdown/app/references/configuration.md#Actionability) | Whether to wait for elements to [finish animating](/llm/markdown/app/core-concepts/interacting-with-elements.md#Animations) before executing the command. |\n\n### Yields [Learn about subject management](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Subject-Management)\n\n*   `.dblclick()` yields the same subject it was given.\n*   It is [unsafe](/llm/markdown/app/core-concepts/retry-ability.md#Only-queries-are-retried) to chain further commands that rely on the subject after `.dblclick()`.\n",
      "section": "api",
      "anchors": [
        "syntax"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 459
    },
    {
      "id": "api/commands/dblclick#usage",
      "doc_id": "api/commands/dblclick",
      "heading": "Usage",
      "heading_level": 3,
      "content_markdown": "### Usage\n\n**Correct Usage**\n\n```\ncy.get('button').dblclick() // Double click on buttoncy.focused().dblclick() // Double click on el with focuscy.contains('Welcome').dblclick() // Double click on first el containing 'Welcome'\n```\n\n**Incorrect Usage**\n\n```\ncy.dblclick('button') // Errors, cannot be chained off 'cy'cy.window().dblclick() // Errors, 'window' does not yield DOM element\n```\n",
      "section": "api",
      "anchors": [
        "usage"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 63
    },
    {
      "id": "api/commands/dblclick#arguments",
      "doc_id": "api/commands/dblclick",
      "heading": "Arguments",
      "heading_level": 3,
      "content_markdown": "### Arguments\n\n**position _(String)_**\n\nThe position where the double click should be issued. The `center` position is the default position. Valid positions are `topLeft`, `top`, `topRight`, `left`, `center`, `right`, `bottomLeft`, `bottom`, and `bottomRight`.\n\n**x _(Number)_**\n\nThe distance in pixels from the element's left to issue the double click.\n\n**y _(Number)_**\n\nThe distance in pixels from the element's top to issue the double click.\n\n**options _(Object)_**\n\nPass in an options object to change the default behavior of `.dblclick()`.\n\n| Option | Default | Description |\n| --- | --- | --- |\n| `altKey` | `false` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |\n| `animationDistanceThreshold` | [`animationDistanceThreshold`](/llm/markdown/app/references/configuration.md#Actionability) | The distance in pixels an element must exceed over time to be [considered animating](/llm/markdown/app/core-concepts/interacting-with-elements.md#Animations). |\n| `ctrlKey` | `false` | Activates the control key. Aliases: `controlKey`. |\n| `log` | `true` | Displays the command in the [Command log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) |\n| `force` | `false` | Forces the action, disables [waiting for actionability](#Assertions) |\n| `metaKey` | `false` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |\n| `multiple` | `true` | Serially click multiple elements |\n| `scrollBehavior` | [`scrollBehavior`](/llm/markdown/app/references/configuration.md#Actionability) | Viewport position to where an element [should be scrolled](/llm/markdown/app/core-concepts/interacting-with-elements.md#Scrolling) before executing the command |\n| `shiftKey` | `false` | Activates the shift key. |\n| `timeout` | [`defaultCommandTimeout`](/llm/markdown/app/references/configuration.md#Timeouts) | Time to wait for `.dblclick()` to resolve before [timing out](#Timeouts) |\n| `waitForAnimations` | [`waitForAnimations`](/llm/markdown/app/references/configuration.md#Actionability) | Whether to wait for elements to [finish animating](/llm/markdown/app/core-concepts/interacting-with-elements.md#Animations) before executing the command. |\n",
      "section": "api",
      "anchors": [
        "arguments"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 344
    },
    {
      "id": "api/commands/dblclick#yields-learn-about-subject-management",
      "doc_id": "api/commands/dblclick",
      "heading": "Yields Learn about subject management",
      "heading_level": 3,
      "content_markdown": "### Yields [Learn about subject management](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Subject-Management)\n\n*   `.dblclick()` yields the same subject it was given.\n*   It is [unsafe](/llm/markdown/app/core-concepts/retry-ability.md#Only-queries-are-retried) to chain further commands that rely on the subject after `.dblclick()`.\n",
      "section": "api",
      "anchors": [
        "yields-learn-about-subject-management"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 40
    },
    {
      "id": "api/commands/dblclick#examples",
      "doc_id": "api/commands/dblclick",
      "heading": "Examples",
      "heading_level": 2,
      "content_markdown": "## Examples\n\n### No Args\n\n#### Double click an anchor link\n\n```\ncy.get('a#nav1').dblclick() // yields the <a>\n```\n\n### Position\n\n#### Specify a position of the element to double click\n\nClick the bottom center of the button.\n\n```\ncy.get('button').dblclick('bottom')\n```\n\n### Coordinates\n\n#### Specify coordinates relative to the top left corner\n\nThe double click below will be issued inside of the element (30px from the left and 10px from the top).\n\n```\ncy.get('button').dblclick(30, 10)\n```\n\n### Options\n\n#### Force a double click regardless of its actionable state\n\nForcing a double click overrides the [actionable checks](/llm/markdown/app/core-concepts/interacting-with-elements.md#Forcing) Cypress applies and will automatically fire the events.\n\n```\ncy.get('button').dblclick({ force: true })\n```\n\n#### Force a double click with position argument\n\n```\ncy.get('button').dblclick('topRight', { force: true })\n```\n\n#### Force a double click with relative coordinates\n\n```\ncy.get('button').dblclick(60, 60, { force: true })\n```\n\n#### Double click all buttons found on the page\n\nBy default, Cypress will iteratively apply the double click to each element and will also log to the [Command Log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) multiple times.\n\nYou can turn this off by passing `multiple: false` to `.dblclick()`.\n\n```\ncy.get('button').dblclick({ multiple: false })\n```\n\n#### Double click with key combinations\n\nThe `.dblclick()` command may also be fired with key modifiers in order to simulate holding key combinations while double clicking, such as `SHIFT + double click`.\n\nYou can also use key combinations during [.type()](/llm/markdown/api/commands/type.md). This offers options to hold down keys across multiple commands. See [Key Combinations](/llm/markdown/api/commands/type.md#Key-Combinations) for more information.\n\nThe following modifiers can be combined with `.dblclick()`.\n\n| Option | Notes |\n| --- | --- |\n| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |\n| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |\n| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |\n| `shiftKey` | Activates the shift key. |\n\n##### Alt click\n\n```\n// execute ALT + dblclick on the first <li>cy.get('li:first').dblclick({  altKey: true,})\n```\n",
      "section": "api",
      "anchors": [
        "examples"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 437
    },
    {
      "id": "api/commands/dblclick#coordinates",
      "doc_id": "api/commands/dblclick",
      "heading": "Coordinates",
      "heading_level": 3,
      "content_markdown": "### Coordinates\n\n#### Specify coordinates relative to the top left corner\n\nThe double click below will be issued inside of the element (30px from the left and 10px from the top).\n\n```\ncy.get('button').dblclick(30, 10)\n```\n",
      "section": "api",
      "anchors": [
        "coordinates"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 47
    },
    {
      "id": "api/commands/dblclick#specify-coordinates-relative-to-the-top-left-corner",
      "doc_id": "api/commands/dblclick",
      "heading": "Specify coordinates relative to the top left corner",
      "heading_level": 4,
      "content_markdown": "#### Specify coordinates relative to the top left corner\n\nThe double click below will be issued inside of the element (30px from the left and 10px from the top).\n\n```\ncy.get('button').dblclick(30, 10)\n```\n",
      "section": "api",
      "anchors": [
        "specify-coordinates-relative-to-the-top-left-corner"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 44
    },
    {
      "id": "api/commands/dblclick#options",
      "doc_id": "api/commands/dblclick",
      "heading": "Options",
      "heading_level": 3,
      "content_markdown": "### Options\n\n#### Force a double click regardless of its actionable state\n\nForcing a double click overrides the [actionable checks](/llm/markdown/app/core-concepts/interacting-with-elements.md#Forcing) Cypress applies and will automatically fire the events.\n\n```\ncy.get('button').dblclick({ force: true })\n```\n\n#### Force a double click with position argument\n\n```\ncy.get('button').dblclick('topRight', { force: true })\n```\n\n#### Force a double click with relative coordinates\n\n```\ncy.get('button').dblclick(60, 60, { force: true })\n```\n\n#### Double click all buttons found on the page\n\nBy default, Cypress will iteratively apply the double click to each element and will also log to the [Command Log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) multiple times.\n\nYou can turn this off by passing `multiple: false` to `.dblclick()`.\n\n```\ncy.get('button').dblclick({ multiple: false })\n```\n\n#### Double click with key combinations\n\nThe `.dblclick()` command may also be fired with key modifiers in order to simulate holding key combinations while double clicking, such as `SHIFT + double click`.\n\nYou can also use key combinations during [.type()](/llm/markdown/api/commands/type.md). This offers options to hold down keys across multiple commands. See [Key Combinations](/llm/markdown/api/commands/type.md#Key-Combinations) for more information.\n\nThe following modifiers can be combined with `.dblclick()`.\n\n| Option | Notes |\n| --- | --- |\n| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |\n| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |\n| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |\n| `shiftKey` | Activates the shift key. |\n\n##### Alt click\n\n```\n// execute ALT + dblclick on the first <li>cy.get('li:first').dblclick({  altKey: true,})\n```\n",
      "section": "api",
      "anchors": [
        "options"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 337
    },
    {
      "id": "api/commands/dblclick#force-a-double-click-regardless-of-its-actionable-state",
      "doc_id": "api/commands/dblclick",
      "heading": "Force a double click regardless of its actionable state",
      "heading_level": 4,
      "content_markdown": "#### Force a double click regardless of its actionable state\n\nForcing a double click overrides the [actionable checks](/llm/markdown/app/core-concepts/interacting-with-elements.md#Forcing) Cypress applies and will automatically fire the events.\n\n```\ncy.get('button').dblclick({ force: true })\n```\n",
      "section": "api",
      "anchors": [
        "force-a-double-click-regardless-of-its-actionable-state"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 43
    },
    {
      "id": "api/commands/dblclick#double-click-all-buttons-found-on-the-page",
      "doc_id": "api/commands/dblclick",
      "heading": "Double click all buttons found on the page",
      "heading_level": 4,
      "content_markdown": "#### Double click all buttons found on the page\n\nBy default, Cypress will iteratively apply the double click to each element and will also log to the [Command Log](/llm/markdown/app/core-concepts/open-mode.md#Command-Log) multiple times.\n\nYou can turn this off by passing `multiple: false` to `.dblclick()`.\n\n```\ncy.get('button').dblclick({ multiple: false })\n```\n",
      "section": "api",
      "anchors": [
        "double-click-all-buttons-found-on-the-page"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 64
    },
    {
      "id": "api/commands/dblclick#double-click-with-key-combinations",
      "doc_id": "api/commands/dblclick",
      "heading": "Double click with key combinations",
      "heading_level": 4,
      "content_markdown": "#### Double click with key combinations\n\nThe `.dblclick()` command may also be fired with key modifiers in order to simulate holding key combinations while double clicking, such as `SHIFT + double click`.\n\nYou can also use key combinations during [.type()](/llm/markdown/api/commands/type.md). This offers options to hold down keys across multiple commands. See [Key Combinations](/llm/markdown/api/commands/type.md#Key-Combinations) for more information.\n\nThe following modifiers can be combined with `.dblclick()`.\n\n| Option | Notes |\n| --- | --- |\n| `altKey` | Activates the alt key (option key for Mac). Aliases: `optionKey`. |\n| `ctrlKey` | Activates the control key. Aliases: `controlKey`. |\n| `metaKey` | Activates the meta key (Windows key or command key for Mac). Aliases: `commandKey`, `cmdKey`. |\n| `shiftKey` | Activates the shift key. |\n\n##### Alt click\n\n```\n// execute ALT + dblclick on the first <li>cy.get('li:first').dblclick({  altKey: true,})\n```\n",
      "section": "api",
      "anchors": [
        "double-click-with-key-combinations"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 187
    },
    {
      "id": "api/commands/dblclick#rules",
      "doc_id": "api/commands/dblclick",
      "heading": "Rules",
      "heading_level": 2,
      "content_markdown": "## Rules\n\n### Requirements [Learn about chaining commands](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Chains-of-Commands)\n\n*   `.dblclick()` requires being chained off a command that yields DOM element(s).\n\n### Assertions [Learn about assertions](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Assertions)\n\n*   `.dblclick()` will automatically wait for the element to reach an [actionable state](/llm/markdown/app/core-concepts/interacting-with-elements.md).\n*   `.dblclick()` will automatically [retry](/llm/markdown/app/core-concepts/retry-ability.md) until all chained assertions have passed.\n\n### Timeouts [Learn about timeouts](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Timeouts)\n\n*   `.dblclick()` can time out waiting for the element to reach an [actionable state](/llm/markdown/app/core-concepts/interacting-with-elements.md).\n*   `.dblclick()` can time out waiting for assertions you've added to pass.\n",
      "section": "api",
      "anchors": [
        "rules"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 107
    },
    {
      "id": "api/commands/dblclick#timeouts-learn-about-timeouts",
      "doc_id": "api/commands/dblclick",
      "heading": "Timeouts Learn about timeouts",
      "heading_level": 3,
      "content_markdown": "### Timeouts [Learn about timeouts](/llm/markdown/app/core-concepts/introduction-to-cypress.md#Timeouts)\n\n*   `.dblclick()` can time out waiting for the element to reach an [actionable state](/llm/markdown/app/core-concepts/interacting-with-elements.md).\n*   `.dblclick()` can time out waiting for assertions you've added to pass.\n",
      "section": "api",
      "anchors": [
        "timeouts-learn-about-timeouts"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 41
    },
    {
      "id": "api/commands/dblclick#command-log",
      "doc_id": "api/commands/dblclick",
      "heading": "Command Log",
      "heading_level": 2,
      "content_markdown": "## Command Log\n\n**_Double click on a div_**\n\n```\ncy.get('.action-div').dblclick()\n```\n\nThe commands above will display in the Command Log as:\n\nWhen clicking on `dblclick` within the command log, the console outputs the following:\n",
      "section": "api",
      "anchors": [
        "command-log"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 45
    },
    {
      "id": "api/commands/dblclick#history",
      "doc_id": "api/commands/dblclick",
      "heading": "History",
      "heading_level": 2,
      "content_markdown": "## History\n\n| Version | Changes |\n| --- | --- |\n| [6.1.0](/llm/markdown/app/references/changelog.md#6-1-0) | Added option `scrollBehavior` |\n| [3.5.0](/llm/markdown/app/references/changelog.md#3-5-0) | Added support for options `force` and `multiple`. |\n| [3.5.0](/llm/markdown/app/references/changelog.md#3-5-0) | Added support for `position`, `x`, and `y` arguments. |\n| [3.5.0](/llm/markdown/app/references/changelog.md#3-5-0) | Added sending `mouseover`, `mousemove`, `mouseout`, `pointerdown`, `pointerup`, and `pointermove` during `.dblclick()`. |\n",
      "section": "api",
      "anchors": [
        "history"
      ],
      "path": "/llm/json/chunked/api/commands/dblclick.json",
      "token_estimate": 76
    }
  ]
}