Support for the aliases.

cypress-io · Jul 30, 2020 · 7393711 · 7393711
1 parent e722ebf
commit 7393711
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 deletions.
diff --git a/cli/types/cypress.d.ts b/cli/types/cypress.d.ts
@@ -2324,12 +2324,24 @@ declare namespace Cypress {
      * @default false
      */
     ctrlKey: boolean
+    /**
+     * Alias for the ctrl key
+     *
+     * @default false
+     */
+    controlKey: boolean
     /**
      * Press alt key. It's option key in Mac.
      *
      * @default false
      */
     altKey: boolean
+    /**
+     * Alias for the alt key.
+     *
+     * @default false
+     */
+    optionKey: boolean
     /**
      * Press shift key
      *
@@ -2342,6 +2354,18 @@ declare namespace Cypress {
      * @default false
      */
     metaKey: boolean
+    /**
+     * Alias for the meta key.
+     *
+     * @default false
+     */
+    commandKey: boolean
+    /**
+     * Alias for the meta key.
+     *
+     * @default false
+     */
+    cmdKey: boolean
   }
 
   interface ResolvedConfigOptions {

diff --git a/packages/driver/cypress/integration/commands/actions/click_spec.js b/packages/driver/cypress/integration/commands/actions/click_spec.js
@@ -897,6 +897,12 @@ describe('src/cy/commands/actions/click', () => {
         // ctrl should be released
         cy.get('#button').click()
         cy.get('#result').should('not.contain', '{Ctrl}')
+
+        cy.get('#button').click({
+          controlKey: true,
+        })
+
+        cy.get('#result').should('contain', '{Ctrl}')
       })
 
       it('alt', () => {
@@ -909,6 +915,12 @@ describe('src/cy/commands/actions/click', () => {
         // alt should be released
         cy.get('#button').click()
         cy.get('#result').should('not.contain', '{Alt}')
+
+        cy.get('#button').click({
+          optionKey: true,
+        })
+
+        cy.get('#result').should('contain', '{Alt}')
       })
 
       it('shift', () => {
@@ -933,6 +945,18 @@ describe('src/cy/commands/actions/click', () => {
         // shift should be released
         cy.get('#button').click()
         cy.get('#result').should('not.contain', '{Meta}')
+
+        cy.get('#button').click({
+          commandKey: true,
+        })
+
+        cy.get('#result').should('contain', '{Meta}')
+
+        cy.get('#button').click({
+          cmdKey: true,
+        })
+
+        cy.get('#result').should('contain', '{Meta}')
       })
 
       it('multiple', () => {

diff --git a/packages/driver/src/cy/commands/actions/click.js b/packages/driver/src/cy/commands/actions/click.js
@@ -57,6 +57,7 @@ module.exports = (Commands, Cypress, cy, state, config) => {
       ctrlKey: false,
       altKey: false,
       shiftKey: false,
+      cmdKey: false,
       ...defaultOptions,
     })
 
@@ -69,19 +70,19 @@ module.exports = (Commands, Cypress, cy, state, config) => {
     }
 
     const flagModifiers = (press) => {
-      if (options.ctrlKey) {
+      if (options.ctrlKey || options.controlKey) {
         keyboard.flagModifier({ key: 'Control' }, press)
       }
 
-      if (options.altKey) {
+      if (options.altKey || options.optionKey) {
         keyboard.flagModifier({ key: 'Alt' }, press)
       }
 
       if (options.shiftKey) {
         keyboard.flagModifier({ key: 'Shift' }, press)
       }
 
-      if (options.metaKey) {
+      if (options.metaKey || options.commandKey || options.cmdKey) {
         keyboard.flagModifier({ key: 'Meta' }, press)
       }
     }