Source: browser-command/generic-browser-commands.js

  1. 'use strict';
  3. /**
  4.  * @module browser-command/generic-browser-commands
  5.  * @desc Defines custom browser commands that are made available through the global WebdriverIO browser object.
  6.  */
  7. const genericBrowserCommands = {
  9.   /**
  10.    * @function waitForAllVisible
  11.    * @desc Similar to waitForVisible from webdriverio but on multiple elements
  12.    * @since 1.0.0
  13.    * @param {string[]} elements - Array of elements that are CSS selectors
  14.    * @returns {Promise}
  15.    */
  16.   waitForAllVisible(elements) {
  17.     const promises = [];
  19.     for (const i in elements) {
  20.       if (elements.hasOwnProperty(i)) {
  21.         promises.push(browser.waitForVisible(elements[i]));
  22.       }
  23.     }
  25.     return Promise.all(promises);
  26.   },
  28.   /**
  29.    * @function getNumberOfElements
  30.    * @desc Get the number of elements matching a specific CSS selector
  31.    * @since 1.0.0
  32.    * @param {string} selector - CSS selector to identify the elements
  33.    * @returns {Promise}
  34.    */
  35.   async getNumberOfElements(selector) {
  36.     const elements = await browser.elements(selector);
  37.     return elements.value.length;
  38.   },
  40.   /**
  41.    * @function clickNthElement
  42.    * @desc Click on the nth element of the list of elements matching the CSS selector
  43.    * @since 1.0.0
  44.    * @param {string} selector - CSS selector to identify the elements
  45.    * @param {number} nth - Element to click on. First element is at rank 1.
  46.    * @returns {Promise}
  47.    */
  48.   async clickNthElement(selector, nth) {
  49.     const elements = await browser.elements(selector);
  50.     return browser.elementIdClick(elements.value[nth - 1].ELEMENT);
  51.   },
  53.   /**
  54.    * @function clickFirstElement
  55.    * @desc Click on the first element of the list of elements matching the CSS selector
  56.    * @since 1.0.0
  57.    * @param {string} selector - CSS selector to identify the elements
  58.    * @returns {Promise}
  59.    */
  60.   async clickFirstElement(selector) {
  61.     const elements = await browser.elements(selector);
  62.     return browser.elementIdClick(elements.value[0].ELEMENT);
  63.   },
  65.   /**
  66.    * @function clickLastElement
  67.    * @desc Click on the last element of the list of elements matching the CSS selector
  68.    * @since 1.0.0
  69.    * @param {string} selector - CSS selector to identify the elements
  70.    * @returns {Promise}
  71.    */
  72.   async clickLastElement(selector) {
  73.     const elements = await browser.elements(selector);
  74.     return browser.elementIdClick(elements.value[elements.value.length - 1].ELEMENT);
  75.   },
  77.   /**
  78.    * @desc Scroll vertically and horizontally from the element position before clicking.
  79.    * It can be used for instance when there is a floating object that hides a button to click on. A scroll would allow to make the button
  80.    * move out of the floating object and thus be clickable.
  81.    * @since 1.1.0
  82.    * @param {string} selector CSS selector to match
  83.    * @param {int} hOffset Offset for the horizontal scroll
  84.    * @param {int} vOffset Offset for the vertical scroll
  85.    * @param {int} [pause = 200] Pause in ms after scrolling (for the floating element to disappear for instance)
  86.    */
  87.   async scrollAndClick(selector, hOffset, vOffset, pause = 200) {
  88.     const elementId = await browser
  89.       .scroll(selector, hOffset, vOffset)
  90.       .pause(pause)
  91.       .element(selector);
  93.     return browser.elementIdClick(elementId.value.ELEMENT);
  94.   },
  96. };
  98. /**
  99.  * @alias genericBrowserCommand.waitForAllVisible
  100.  * @memberOf browser
  101.  * @method waitForAllVisible
  102.  */
  103. browser.addCommand(
  104.   'waitForAllVisible',
  105.   function (elements) {
  106.     return genericBrowserCommands.waitForAllVisible(elements);
  107.   }
  108. );
  110. /**
  111.  * @alias genericBrowserCommand.getNumberOfElements
  112.  * @memberOf browser
  113.  * @method getNumberOfElements
  114.  */
  115. browser.addCommand(
  116.   'getNumberOfElements',
  117.   function (selector) {
  118.     return genericBrowserCommands.getNumberOfElements(selector);
  119.   }
  120. );
  122. /**
  123.  * @alias genericBrowserCommand.clickNthElement
  124.  * @memberOf browser
  125.  * @method clickNthElement
  126.  */
  127. browser.addCommand(
  128.   'clickNthElement',
  129.   function (selector, nth) {
  130.     return genericBrowserCommands.clickNthElement(selector, nth);
  131.   }
  132. );
  134. /**
  135.  * @alias genericBrowserCommand.clickFirstElement
  136.  * @memberOf browser
  137.  * @method clickFirstElement
  138.  */
  139. browser.addCommand(
  140.   'clickFirstElement',
  141.   function (selector) {
  142.     return genericBrowserCommands.clickFirstElement(selector);
  143.   }
  144. );
  146. /**
  147.  * @alias genericBrowserCommand.clickLastElement
  148.  * @memberOf browser
  149.  * @method clickLastElement
  150.  */
  151. browser.addCommand(
  152.   'clickLastElement',
  153.   function (selector) {
  154.     return genericBrowserCommands.clickLastElement(selector);
  155.   }
  156. );
  158. /**
  159.  * @alias genericBrowserCommand.scrollAndClick
  160.  * @memberOf browser
  161.  * @method scrollAndClick
  162.  */
  163. browser.addCommand(
  164.   'scrollAndClick',
  165.   function (selector, hOffset, vOffset, pause) {
  166.     return genericBrowserCommands.scrollAndClick(selector, hOffset, vOffset, pause);
  167.   }
  168. );
  170. module.exports = genericBrowserCommands;