Add doc for click modifiers.

cypress-io · Aug 6, 2020 · 255715f · 255715f
1 parent 80f63e7
commit 255715f
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/lib/tags/usage.js b/lib/tags/usage.js
@@ -45,6 +45,22 @@ module.exports = function usageOptions (hexo, args) {
     withinSubject: () => {
       return 'Element to search for children in. If null, search begins from root-level DOM element'
     },
+
+    ctrlKey: () => {
+      return 'Activates the control key during click. Aliases: <code>controlKey</code>.'
+    },
+
+    altKey: () => {
+      return 'Activates the alt key (option key for Mac) during click. Aliases: <code>optionKey</code>.'
+    },
+
+    shiftKey: () => {
+      return 'Activates the shift key during click.'
+    },
+
+    metaKey: () => {
+      return 'Activates the meta key (Windows key or command key for Mac) during click. Aliases: <code>commandKey</code>, <code>cmdKey</code>.'
+    },
   }
 
   const blurb = blurbs[opt]

diff --git a/source/api/commands/click.md b/source/api/commands/click.md
@@ -58,6 +58,10 @@ Option | Default | Description
 `force` | `false` | {% usage_options force click %}
 `multiple` | `false` | {% usage_options multiple click %}
 `timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .click %}
+`ctrlKey` | `false` | {% usage_options ctrlKey %}
+`altKey` | `false` | {% usage_options altKey %}
+`shiftKey` | `false` | {% usage_options shiftKey %}
+`metaKey` | `false` | {% usage_options metaKey %}
 
 ## Yields {% helper_icon yields %}
 

diff --git a/source/api/commands/dblclick.md b/source/api/commands/dblclick.md
@@ -58,6 +58,10 @@ Option | Default | Description
 `force` | `false` | {% usage_options force dblclick %}
 `multiple` | `true` | {% usage_options multiple dblclick %}
 `timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .dblclick %}
+`ctrlKey` | `false` | {% usage_options ctrlKey %}
+`altKey` | `false` | {% usage_options altKey %}
+`shiftKey` | `false` | {% usage_options shiftKey %}
+`metaKey` | `false` | {% usage_options metaKey %}
 
 ## Yields {% helper_icon yields %}
 

diff --git a/source/api/commands/rightclick.md b/source/api/commands/rightclick.md
@@ -62,6 +62,10 @@ Option | Default | Description
 `force` | `false` | {% usage_options force rightclick %}
 `multiple` | `false` | {% usage_options multiple rightclick %}
 `timeout` | {% url `defaultCommandTimeout` configuration#Timeouts %} | {% usage_options timeout .rightclick %}
+`ctrlKey` | `false` | {% usage_options ctrlKey %}
+`altKey` | `false` | {% usage_options altKey %}
+`shiftKey` | `false` | {% usage_options shiftKey %}
+`metaKey` | `false` | {% usage_options metaKey %}
 
 ## Yields {% helper_icon yields %}