codeceptjs 2.3.4 → 2.4.1

package/docs/helpers/WebDriver.md

@@ -1,5 +1,7 @@
 ---
-id: WebDriver
+permalink: /helpers/WebDriver
+editLink: false
+sidebar: auto
 title: WebDriver
 ---
 
@@ -7,7 +9,7 @@ title: WebDriver
 
 ## WebDriver
 
-Extends Helper
+**Extends Helper**
 
 WebDriver helper which wraps [webdriverio][1] library to
 manipulate browser using Selenium WebDriver or PhantomJS.
@@ -19,20 +21,21 @@ WebDriver requires [Selenium Server and ChromeDriver/GeckoDriver to be installed
 This helper should be configured in codecept.json or codecept.conf.js
 
 -   `url`: base url of website to be tested.
+-   `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
 -   `browser`: browser in which to perform testing.
 -   `host`:  - WebDriver host to connect.
 -   `port`:  - WebDriver port to connect.
 -   `protocol`:  - protocol for WebDriver server.
 -   `path`:  - path to WebDriver server,
 -   `restart`:  - restart browser between tests.
--   `smartWait`: (optional) enables [SmartWait][3]; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+-   `smartWait`: (optional) **enables [SmartWait][3]**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
 -   `disableScreenshots`:  - don't save screenshots on failure.
 -   `fullPageScreenshots`  - make full page screenshots on failure.
 -   `uniqueScreenshotNames`:  - option to prevent screenshot override if you have scenarios with the same name in different suites.
 -   `keepBrowserState`:  - keep browser state between tests when `restart` is set to false.
 -   `keepCookies`:  - keep cookies between tests when `restart` set to false.
 -   `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
--   `waitForTimeout`:  sets default wait time in _ms_ for all `wait` functions.
+-   `waitForTimeout`:  sets default wait time in _ms_ for all `wait*` functions.
 -   `desiredCapabilities`: Selenium's [desired
     capabilities][4].
 -   `manualStart`:  - do not start browser before a test, start it manually inside a helper
@@ -58,6 +61,26 @@ Example:
 }
 ```
 
+Example with basic authentication
+
+```js
+{
+   helpers: {
+     WebDriver : {
+       smartWait: 5000,
+       browser: "chrome",
+       basicAuth: {username: 'username', password: 'password'},
+       restart: false,
+       windowSize: "maximize",
+       timeouts: {
+         "script": 60000,
+         "page load": 10000
+       }
+     }
+   }
+}
+```
+
 Additional configuration params can be used from [webdriverio
 website][6].
 
@@ -71,7 +94,7 @@ website][6].
        browser: "chrome",
        desiredCapabilities: {
          chromeOptions: {
-           args: [ "--headless", "--disable-gpu", "--window-size=800,600" ]
+           args: [ "--headless", "--disable-gpu", "--no-sandbox" ]
          }
        }
      }
@@ -256,7 +279,7 @@ See [complete reference on webdriver.io][12].
 
 #### TestingBot
 
-> Recommended: use official [TestingBot Helper][14].
+> **Recommended**: use official [TestingBot Helper][14].
 
 Alternatively, TestingBot can be configured via wdio service, which should be installed additionally:
 
@@ -329,7 +352,7 @@ const browser = WebDriver.browser
 
 -   `config`  
 
-### \_locate
+### _locate
 
 Get elements by different locator types, including strict locator.
 Should be used in custom helpers:
@@ -340,10 +363,10 @@ this.helpers['WebDriver']._locate({name: 'password'}).then //...
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 -   `smartWait`   
 
-### \_locateCheckable
+### _locateCheckable
 
 Find a checkbox by providing human readable text:
 
@@ -353,9 +376,9 @@ this.helpers['WebDriver']._locateCheckable('I agree with terms and conditions').
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 
-### \_locateClickable
+### _locateClickable
 
 Find a clickable element by providing human readable text:
 
@@ -365,9 +388,9 @@ this.helpers['WebDriver']._locateClickable('Next page').then // ...
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 
-### \_locateFields
+### _locateFields
 
 Find field elements by providing human readable text:
 
@@ -377,13 +400,13 @@ this.helpers['WebDriver']._locateFields('Your email').then // ...
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 
 ### acceptPopup
 
 Accepts the active JavaScript native popup window, as created by window.alert|window.confirm|window.prompt.
 Don't confuse popups with modal windows, as created by [various
-libraries][18].
+libraries][20].
 
 ### amOnPage
 
@@ -398,9 +421,7 @@ I.amOnPage('/login'); // opens a login page
 
 #### Parameters
 
--   `url` [string][19] url path or global url.
-    
-
+-   `url` **[string][18]** url path or global url.
 
 ### appendField
 
@@ -413,10 +434,8 @@ I.appendField('#myTextField', 'appended');
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator
--   `value` [string][19] text value to append.
-    
-
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator
+-   `value` **[string][18]** text value to append.
     
 
 
@@ -436,10 +455,8 @@ I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) field located by label|name|CSS|XPath|strict locator.
--   `pathToFile` [string][19] local file path relative to codecept.json config file.
-    
-
+-   `locator` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
+-   `pathToFile` **[string][18]** local file path relative to codecept.json config file.
     Appium: not tested
 
 ### cancelPopup
@@ -461,10 +478,8 @@ I.checkOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][19] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
-
+-   `field` **([string][18] | [object][19])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
     Appium: not tested 
 
 ### clearCookie
@@ -479,9 +494,7 @@ I.clearCookie('test');
 
 #### Parameters
 
--   `cookie` [string][19] (optional, `null` by default) cookie name
-    
-
+-   `cookie` **[string][18]?** (optional, `null` by default) cookie name 
 
 ### clearField
 
@@ -496,9 +509,7 @@ I.clearField('#email');
 #### Parameters
 
 -   `field`  
--   `editable` ([string][19] \| [object][20]) field located by label|name|CSS|XPath|strict locator.
-    
-
+-   `editable` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
 
 ### click
 
@@ -517,7 +528,7 @@ I.click('Submit');
 // CSS button
 I.click('#form input[type=submit]');
 // XPath
-I.click('//form/[@type=submit]');
+I.click('//form/*[@type=submit]');
 // link in context
 I.click('Logout', '#nav');
 // using strict locator
@@ -526,10 +537,8 @@ I.click({css: 'nav a.login'});
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` ([string][19] \| [object][20]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -564,7 +573,7 @@ I.defineTimeout({ implicit: 10000, pageLoad: 10000, script: 5000 });
 
 #### Parameters
 
--   `timeouts`  WebDriver timeouts object.
+-   `timeouts` **WebdriverIO.Timeouts** WebDriver timeouts object.
 
 ### dontSee
 
@@ -578,9 +587,8 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
 
 #### Parameters
 
--   `text` [string][19] which is not present.
--   `context` ([string][19] \| [object][20]) (optional) element located by CSS|XPath|strict locator in which to perfrom search.
-
+-   `text` **[string][18]** which is not present.
+-   `context` **([string][18] | [object][19])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -598,10 +606,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
-    
-
-    Appium: not tested
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.Appium: not tested
 
 ### dontSeeCookie
 
@@ -613,9 +618,7 @@ I.dontSeeCookie('auth'); // no auth cookie
 
 #### Parameters
 
--   `name` [string][19] cookie name.
-    
-
+-   `name` **[string][18]** cookie name.
 
 ### dontSeeCurrentUrlEquals
 
@@ -629,9 +632,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
 
 #### Parameters
 
--   `url` [string][19] value to check.
-    
-
+-   `url` **[string][18]** value to check.
 
 ### dontSeeElement
 
@@ -643,9 +644,7 @@ I.dontSeeElement('.modal'); // modal is not shown
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|Strict locator.
     
 
 
@@ -662,9 +661,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|Strict locator.
 
 ### dontSeeInCurrentUrl
 
@@ -672,9 +669,7 @@ Checks that current url does not contain a provided fragment.
 
 #### Parameters
 
--   `url` [string][19] value to check.
-    
-
+-   `url` **[string][18]** value to check.
 
 ### dontSeeInField
 
@@ -688,10 +683,8 @@ I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][19] value to check.
-    
-
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][18]** value to check.
 
 ### dontSeeInSource
 
@@ -704,9 +697,7 @@ I.dontSeeInSource('<!--'); // no comments in source
 #### Parameters
 
 -   `text`  
--   `value` [string][19] to check.
-    
-
+-   `value` **[string][18]** to check.
 
 ### dontSeeInTitle
 
@@ -718,9 +709,7 @@ I.dontSeeInTitle('Error');
 
 #### Parameters
 
--   `text` [string][19] value to check.
-    
-
+-   `text` **[string][18]** value to check.
 
 ### doubleClick
 
@@ -736,10 +725,8 @@ I.doubleClick('.btn.edit');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
--   `context` ([string][19] \| [object][20]) (optional, `null` by default) element to search in CSS|XPath|Strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -755,10 +742,8 @@ I.dragAndDrop('#dragHandle', '#container');
 
 #### Parameters
 
--   `srcElement` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
--   `destElement` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
-    
-
+-   `srcElement` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `destElement` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
     Appium: not tested
 
 ### dragSlider
@@ -773,10 +758,8 @@ I.dragSlider('#slider', -70);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
--   `offsetX` [number][22] position to drag.
-    
- 
+-   `locator` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
+-   `offsetX` **[number][22]** position to drag. 
 
 ### executeAsyncScript
 
@@ -803,7 +786,10 @@ let val = await I.executeAsyncScript(function(url, done) {
 
 #### Parameters
 
--   `fn` ([string][19] \| [function][24]) function to be executed in browser context.
+-   `fn` **([string][18] | [function][24])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][25]&lt;any>** 
 
 ### executeScript
 
@@ -833,7 +819,10 @@ let date = await I.executeScript(function(el) {
 
 #### Parameters
 
--   `fn` ([string][19] \| [function][24]) function to be executed in browser context.
+-   `fn` **([string][18] | [function][24])** function to be executed in browser context.
+-   `args` **...any** to be passed to function.
+
+Returns **[Promise][25]&lt;any>** Wraps [execute][26] command.
 
 ### fillField
 
@@ -853,11 +842,8 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][19] text value to fill.
-    
-
-    
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][18]** text value to fill.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -876,7 +862,7 @@ const windows = await I.grabAllWindowHandles();
 
 Retrieves an attribute from an element located by CSS or XPath and returns it to test.
 An array as a result will be returned if there are more than one matched element.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let hint = await I.grabAttributeFrom('#tooltip', 'title');
@@ -884,12 +870,10 @@ let hint = await I.grabAttributeFrom('#tooltip', 'title');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `attr` [string][19] attribute name.
-
-Returns [Promise][25]&lt;[string][19]> attribute value
-
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][18]** attribute name.
 
+Returns **[Promise][25]&lt;[string][18]>** attribute value
 Appium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
 
 ### grabBrowserLogs
@@ -901,12 +885,13 @@ let logs = await I.grabBrowserLogs();
 console.log(JSON.stringify(logs))
 ```
 
+Returns **[Promise][25]&lt;([string][18] | [undefined][27])>** 
+
 ### grabCookie
 
 Gets a cookie object by name.
 If none provided gets all cookies.
-
--   Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let cookie = await I.grabCookie('auth');
@@ -915,16 +900,14 @@ assert(cookie.value, '123456');
 
 #### Parameters
 
--   `name`  cookie name. 
-
-Returns [Promise][25]&lt;[string][19]> attribute value
-
+-   `name` **[string][18]?** cookie name. 
 
+Returns **[Promise][25]&lt;[string][18]>** attribute value
 
 ### grabCssPropertyFrom
 
 Grab CSS property for given locator
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 ```js
 const value = await I.grabCssPropertyFrom('h3', 'font-weight');
@@ -932,12 +915,10 @@ const value = await I.grabCssPropertyFrom('h3', 'font-weight');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `cssProperty` [string][19] CSS property name.
-
-Returns [Promise][25]&lt;[string][19]> CSS value
-
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `cssProperty` **[string][18]** CSS property name.
 
+Returns **[Promise][25]&lt;[string][18]>** CSS value
 
 ### grabCurrentUrl
 
@@ -949,9 +930,7 @@ let url = await I.grabCurrentUrl();
 console.log(`Current URL is [${url}]`);
 ```
 
-Returns [Promise][25]&lt;[string][19]> current URL
-
-
+Returns **[Promise][25]&lt;[string][18]>** current URL
 
 ### grabCurrentWindowHandle
 
@@ -966,7 +945,7 @@ const window = await I.grabCurrentWindowHandle();
 
 Grab the width, height, location of given locator.
 Provide `width` or `height`as second param to get your desired prop.
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 Returns an object with `x`, `y`, `width`, `height` keys.
 
@@ -984,13 +963,11 @@ const width = await I.grabElementBoundingRect('h3', 'width');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 -   `prop`  
--   `elementSize` [string][19] x, y, width or height of the given element.
-
-Returns [object][20] Element bounding rectangle
-
+-   `elementSize` **[string][18]** x, y, width or height of the given element.
 
+Returns **[object][19]** Element bounding rectangle
 
 ### grabGeoLocation
 
@@ -1000,13 +977,10 @@ Return the current geo location
 let geoLocation = await I.grabGeoLocation();
 ```
 
-
-
-
 ### grabHTMLFrom
 
 Retrieves the innerHTML from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async function with `await` operator.
+Resumes test execution, so **should be used inside async function with `await`** operator.
 If more than one element is found - an array of HTMLs returned.
 
 ```js
@@ -1015,11 +989,10 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][25]&lt;[string][19]> HTML code for an element
-
+-   `locator`  
+-   `element` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][25]&lt;[string][18]>** HTML code for an element
 
 ### grabNumberOfOpenTabs
 
@@ -1029,9 +1002,7 @@ Grab number of open tabs.
 let tabs = await I.grabNumberOfOpenTabs();
 ```
 
-Returns [Promise][25]&lt;[number][22]> number of open tabs
-
-
+Returns **[Promise][25]&lt;[number][22]>** number of open tabs
 
 ### grabNumberOfVisibleElements
 
@@ -1043,24 +1014,20 @@ let numOfElements = await I.grabNumberOfVisibleElements('p');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
-
-Returns [Promise][25]&lt;[number][22]> number of visible elements
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
 
+Returns **[Promise][25]&lt;[number][22]>** number of visible elements
 
 ### grabPageScrollPosition
 
 Retrieves a page scroll position and returns it to test.
-Resumes test execution, so should be used inside an async function with `await` operator.
+Resumes test execution, so **should be used inside an async function with `await`** operator.
 
 ```js
 let { x, y } = await I.grabPageScrollPosition();
 ```
 
-Returns [Promise][25]&lt;[object][20]> scroll position
-
-
+Returns **[Promise][25]&lt;[Object][19]&lt;[string][18], any>>** scroll position
 
 ### grabPopupText
 
@@ -1079,14 +1046,12 @@ Resumes test execution, so should be used inside an async function.
 let pageSource = await I.grabSource();
 ```
 
-Returns [Promise][25]&lt;[string][19]> source code
-
-
+Returns **[Promise][25]&lt;[string][18]>** source code
 
 ### grabTextFrom
 
 Retrieves a text from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let pin = await I.grabTextFrom('#pin');
@@ -1096,29 +1061,25 @@ If multiple elements found returns an array of texts.
 
 #### Parameters
 
--   `locator`  element located by CSS|XPath|strict locator.
-
-Returns [Promise][25]&lt;[string][19]> attribute value
-
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 
+Returns **[Promise][25]&lt;([string][18] | [Array][28]&lt;[string][18]>)>** attribute value
 
 ### grabTitle
 
 Retrieves a page title and returns it to test.
-Resumes test execution, so should be used inside async with `await` operator.
+Resumes test execution, so **should be used inside async with `await`** operator.
 
 ```js
 let title = await I.grabTitle();
 ```
 
-Returns [Promise][25]&lt;[string][19]> title
-
-
+Returns **[Promise][25]&lt;[string][18]>** title
 
 ### grabValueFrom
 
 Retrieves a value from a form element located by CSS or XPath and returns it to test.
-Resumes test execution, so should be used inside async function with `await` operator.
+Resumes test execution, so **should be used inside async function with `await`** operator.
 
 ```js
 let email = await I.grabValueFrom('input[name=email]');
@@ -1126,11 +1087,9 @@ let email = await I.grabValueFrom('input[name=email]');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) field located by label|name|CSS|XPath|strict locator.
-
-Returns [Promise][25]&lt;[string][19]> attribute value
-
+-   `locator` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
 
+Returns **[Promise][25]&lt;[string][18]>** attribute value
 
 ### moveCursorTo
 
@@ -1144,11 +1103,9 @@ I.moveCursorTo('#submit', 5,5);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
--   `offsetX` [number][22] (optional, `0` by default) X-axis offset. 
--   `offsetY` [number][22] (optional, `0` by default) Y-axis offset.
-    
- 
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][22]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][22]** (optional, `0` by default) Y-axis offset. 
 
 ### openNewTab
 
@@ -1167,7 +1124,7 @@ I.openNewTab();
 
 Presses a key in the browser (on a focused element).
 
-_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][26].
+_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][29].
 
 ```js
 I.pressKey('Backspace');
@@ -1226,15 +1183,13 @@ Some of the supported key names are:
 
 #### Parameters
 
--   `key` ([string][19] \| [array][27]) key or array of keys to press.
-    
-_Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
+-   `key` **([string][18] | [Array][28]&lt;[string][18]>)** key or array of keys to press._Note:_ In case a text field or textarea is focused be aware that some browsers do not respect active modifier when combining modifier keys with other keys.
 
 ### pressKeyDown
 
 Presses a key in the browser and leaves it in a down state.
 
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][28]).
+To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][30]).
 
 ```js
 I.pressKeyDown('Control');
@@ -1244,15 +1199,13 @@ I.pressKeyUp('Control');
 
 #### Parameters
 
--   `key` [string][19] name of key to press down.
-    
-
+-   `key` **[string][18]** name of key to press down.
 
 ### pressKeyUp
 
 Releases a key in the browser which was previously set to a down state.
 
-To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][28]).
+To make combinations with modifier key and user operation (e.g. `'Control'` + [`click`][30]).
 
 ```js
 I.pressKeyDown('Control');
@@ -1262,9 +1215,7 @@ I.pressKeyUp('Control');
 
 #### Parameters
 
--   `key` [string][19] name of key to release.
-    
-
+-   `key` **[string][18]** name of key to release.
 
 ### refreshPage
 
@@ -1274,9 +1225,6 @@ Reload the current page.
 I.refreshPage();
 ```
 
-
-
-
 ### resizeWindow
 
 Resize the current window to provided width and height.
@@ -1284,10 +1232,8 @@ First parameter can be set to `maximize`.
 
 #### Parameters
 
--   `width` [number][22] width in pixels or `maximize`.
--   `height` [number][22] height in pixels.
-    
-
+-   `width` **[number][22]** width in pixels or `maximize`.
+-   `height` **[number][22]** height in pixels.
     Appium: not tested in web, in apps doesn't work
 
 ### rightClick
@@ -1305,14 +1251,12 @@ I.rightClick('Click me', '.context');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) clickable element located by CSS|XPath|strict locator.
--   `context` ([string][19] \| [object][20]) (optional, `null` by default) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** clickable element located by CSS|XPath|strict locator.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|XPath|strict locator.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
-
+ 
 
 ### runInWeb
 
@@ -1353,21 +1297,32 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
 
 #### Parameters
 
--   `fileName` [string][19] file name to save.
--   `fullPage` [boolean][29] (optional, `false` by default) flag to enable fullscreen screenshot mode.
-    
- 
+-   `fileName` **[string][18]** file name to save.
+-   `fullPage` **[boolean][31]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
 
-### scrollPageToBottom
+### scrollIntoView
 
-Scroll page to the bottom.
+Scroll element into viewport.
 
 ```js
-I.scrollPageToBottom();
+I.scrollIntoView('#submit');
+I.scrollIntoView('#submit', true);
+I.scrollIntoView('#submit', { behavior: "smooth", block: "center", inline: "center" });
 ```
 
+#### Parameters
+
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `scrollIntoViewOptions`  
+-   `alignToTop` **([boolean][31] | [object][19])** (optional) or scrollIntoViewOptions (optional), see [https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView][32].
+
+### scrollPageToBottom
 
+Scroll page to the bottom.
 
+```js
+I.scrollPageToBottom();
+```
 
 ### scrollPageToTop
 
@@ -1377,9 +1332,6 @@ Scroll page to the top.
 I.scrollPageToTop();
 ```
 
-
-
-
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -1392,11 +1344,9 @@ I.scrollTo('#submit', 5, 5);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
--   `offsetX` [number][22] (optional, `0` by default) X-axis offset. 
--   `offsetY` [number][22] (optional, `0` by default) Y-axis offset.
-    
- 
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][22]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][22]** (optional, `0` by default) Y-axis offset. 
 
 ### see
 
@@ -1411,10 +1361,8 @@ I.see('Register', {css: 'form.register'}); // use strict locator
 
 #### Parameters
 
--   `text` [string][19] expected on page.
--   `context` ([string][19] \| [object][20]) (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
-    
-
+-   `text` **[string][18]** expected on page.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1430,10 +1378,8 @@ I.seeAttributesOnElements('//form', { method: "post"});
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
--   `attributes` [object][20] attributes and their values to check.
-    
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `attributes` **[object][19]** attributes and their values to check.
 
 ### seeCheckboxIsChecked
 
@@ -1447,10 +1393,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
-    
-
-    Appium: not tested
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.Appium: not tested
 
 ### seeCookie
 
@@ -1462,9 +1405,7 @@ I.seeCookie('Auth');
 
 #### Parameters
 
--   `name` [string][19] cookie name.
-    
-
+-   `name` **[string][18]** cookie name.
 
 ### seeCssPropertiesOnElements
 
@@ -1476,10 +1417,8 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
--   `cssProperties` [object][20] object with CSS properties and their values to check.
-    
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
+-   `cssProperties` **[object][19]** object with CSS properties and their values to check.
 
 ### seeCurrentUrlEquals
 
@@ -1494,9 +1433,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
 
 #### Parameters
 
--   `url` [string][19] value to check.
-    
-
+-   `url` **[string][18]** value to check.
 
 ### seeElement
 
@@ -1509,9 +1446,7 @@ I.seeElement('#modal');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** located by CSS|XPath|strict locator.
     
 
 
@@ -1529,9 +1464,7 @@ I.seeElementInDOM('#modal');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
 
 ### seeInCurrentUrl
 
@@ -1543,9 +1476,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
 
 #### Parameters
 
--   `url` [string][19] a fragment to check
-    
-
+-   `url` **[string][18]** a fragment to check
 
 ### seeInField
 
@@ -1561,10 +1492,8 @@ I.seeInField('#searchform input','Search');
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) located by label|name|CSS|XPath|strict locator.
--   `value` [string][19] value to check.
-    
-
+-   `field` **([string][18] | [object][19])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][18]** value to check.
 
 ### seeInPopup
 
@@ -1573,7 +1502,7 @@ given string.
 
 #### Parameters
 
--   `text`  value to check.
+-   `text` **[string][18]** value to check.
 
 ### seeInSource
 
@@ -1585,9 +1514,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
 
 #### Parameters
 
--   `text` [string][19] value to check.
-    
-
+-   `text` **[string][18]** value to check.
 
 ### seeInTitle
 
@@ -1599,9 +1526,7 @@ I.seeInTitle('Home Page');
 
 #### Parameters
 
--   `text` [string][19] text value to check.
-    
-
+-   `text` **[string][18]** text value to check.
 
 ### seeNumberOfElements
 
@@ -1614,11 +1539,8 @@ I.seeNumberOfElements('#submitBtn', 1);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `num` [number][22] number of elements.
-    
-
-    
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `num` **[number][22]** number of elements.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1635,11 +1557,8 @@ I.seeNumberOfVisibleElements('.buttons', 3);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `num` [number][22] number of elements.
-    
-
-    
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `num` **[number][22]** number of elements.
 
 
 This action supports [React locators](https://codecept.io/react#locators)
@@ -1655,8 +1574,8 @@ I.seeTextEquals('text', 'h1');
 
 #### Parameters
 
--   `text`  element value to check.
--   `context`  (optional) element located by CSS|XPath|strict locator.
+-   `text` **[string][18]** element value to check.
+-   `context` **([string][18] | [object][19]?)** element located by CSS|XPath|strict locator. 
 
 ### seeTitleEquals
 
@@ -1668,7 +1587,7 @@ I.seeTitleEquals('Test title.');
 
 #### Parameters
 
--   `text`  value to check.
+-   `text` **[string][18]** value to check.
 
 ### selectOption
 
@@ -1693,10 +1612,8 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
 
 #### Parameters
 
--   `select` ([string][19] \| [object][20]) field located by label|name|CSS|XPath|strict locator.
--   `option` ([string][19] \| [array][27]) visible text or value of option.
-    
-
+-   `select` **([string][18] | [object][19])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][18] | [Array][28]&lt;any>)** visible text or value of option.
 
 ### setCookie
 
@@ -1708,10 +1625,8 @@ I.setCookie({name: 'auth', value: true});
 
 #### Parameters
 
--   `cookie` [object][20] a cookie object.
-    
-Uses Selenium's JSON [cookie
-    format][30].
+-   `cookie` **[object][19]** a cookie object.Uses Selenium's JSON [cookie
+    format][33].
 
 ### setGeoLocation
 
@@ -1724,11 +1639,9 @@ I.setGeoLocation(121.21, 11.56, 10);
 
 #### Parameters
 
--   `latitude` [number][22] to set.
--   `longitude` [number][22] to set
--   `altitude` [number][22] (optional, null by default) to set
-    
- 
+-   `latitude` **[number][22]** to set.
+-   `longitude` **[number][22]** to set
+-   `altitude` **[number][22]** (optional, null by default) to set 
 
 ### switchTo
 
@@ -1741,9 +1654,7 @@ I.switchTo(); // switch back to main page
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) (optional, `null` by default) element located by CSS|XPath|strict locator.
-    
-
+-   `locator` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
 
 ### switchToNextTab
 
@@ -1756,8 +1667,8 @@ I.switchToNextTab(2);
 
 #### Parameters
 
--   `num`  (optional) number of tabs to switch forward, default: 1.
--   `sec`  (optional) time in seconds to wait.
+-   `num` **[number][22]?** (optional) number of tabs to switch forward, default: 1. 
+-   `sec` **([number][22] | null)?** (optional) time in seconds to wait. 
 
 ### switchToPreviousTab
 
@@ -1770,8 +1681,8 @@ I.switchToPreviousTab(2);
 
 #### Parameters
 
--   `num`  (optional) number of tabs to switch backward, default: 1.
--   `sec`  (optional) time in seconds to wait.
+-   `num` **[number][22]?** (optional) number of tabs to switch backward, default: 1. 
+-   `sec` **[number][22]??** (optional) time in seconds to wait. 
 
 ### switchToWindow
 
@@ -1806,10 +1717,8 @@ I.uncheckOption('agree', '//form');
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) checkbox located by label | name | CSS | XPath | strict locator.
--   `context` [string][19] (optional, `null` by default) element located by CSS | XPath | strict locator.
-    
-
+-   `field` **([string][18] | [object][19])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][18]? | [object][19])** (optional, `null` by default) element located by CSS | XPath | strict locator.
     Appium: not tested 
 
 ### wait
@@ -1822,9 +1731,23 @@ I.wait(2); // wait 2 secs
 
 #### Parameters
 
--   `sec` [number][22] number of second to wait.
-    
+-   `sec` **[number][22]** number of second to wait.
+
+### waitForClickable
 
+Waits for element to be clickable (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForClickable('.btn.continue');
+I.waitForClickable('.btn.continue', 5); // wait for 5 secs
+```
+
+#### Parameters
+
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `waitTimeout`  
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait
 
 ### waitForDetached
 
@@ -1837,10 +1760,8 @@ I.waitForDetached('#popup');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForElement
 
@@ -1854,10 +1775,8 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait 
 
 ### waitForEnabled
 
@@ -1866,10 +1785,8 @@ Element can be located by CSS or XPath.
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec`  (optional) time in seconds to wait, 1 by default.
-    
-
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]** (optional) time in seconds to wait, 1 by default. 
 
 ### waitForFunction
 
@@ -1888,11 +1805,9 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
 
 #### Parameters
 
--   `fn` ([string][19] \| [function][24]) to be executed in browser context.
--   `argsOrSec` ([array][27] \| [number][22]) (optional, `1` by default) arguments for function or seconds. 
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `fn` **([string][18] | [function][24])** to be executed in browser context.
+-   `argsOrSec` **([Array][28]&lt;any> | [number][22])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][22]?** (optional, `1` by default) time in seconds to wait 
 
 ### waitForInvisible
 
@@ -1905,10 +1820,8 @@ I.waitForInvisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForText
 
@@ -1923,11 +1836,9 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
 
 #### Parameters
 
--   `text` [string][19] to wait for.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait 
--   `context` ([string][19] \| [object][20]) (optional) element located by CSS|XPath|strict locator.
-    
- 
+-   `text` **[string][18]** to wait for.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][18] | [object][19])?** (optional) element located by CSS|XPath|strict locator. 
 
 ### waitForValue
 
@@ -1939,11 +1850,9 @@ I.waitForValue('//input', "GoodValue");
 
 #### Parameters
 
--   `field` ([string][19] \| [object][20]) input field.
--   `value` [string][19] expected value.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `field` **([string][18] | [object][19])** input field.
+-   `value` **[string][18]** expected value.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitForVisible
 
@@ -1956,10 +1865,8 @@ I.waitForVisible('#popup');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitInUrl
 
@@ -1971,10 +1878,8 @@ I.waitInUrl('/info', 2);
 
 #### Parameters
 
--   `urlPart` [string][19] value to check.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `urlPart` **[string][18]** value to check.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitNumberOfVisibleElements
 
@@ -1986,11 +1891,9 @@ I.waitNumberOfVisibleElements('a', 3);
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `num` [number][22] number of elements.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `num` **[number][22]** number of elements.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitToHide
 
@@ -2003,10 +1906,8 @@ I.waitToHide('#popup');
 
 #### Parameters
 
--   `locator` ([string][19] \| [object][20]) element located by CSS|XPath|strict locator.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `locator` **([string][18] | [object][19])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 ### waitUntil
 
@@ -2019,12 +1920,10 @@ I.waitUntil(() => window.requests == 0, 5);
 
 #### Parameters
 
--   `fn` ([function][24] \| [string][19]) function which is executed in browser context.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait 
--   `timeoutMsg` [string][19] message to show in case of timeout fail.
-    
- 
--   `interval`   
+-   `fn` **([function][24] | [string][18])** function which is executed in browser context.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
+-   `timeoutMsg` **[string][18]** message to show in case of timeout fail. 
+-   `interval` **[number][22]?**  
 
 ### waitUrlEquals
 
@@ -2037,10 +1936,8 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 #### Parameters
 
--   `urlPart` [string][19] value to check.
--   `sec` [number][22] (optional, `1` by default) time in seconds to wait
-    
- 
+-   `urlPart` **[string][18]** value to check.
+-   `sec` **[number][22]** (optional, `1` by default) time in seconds to wait 
 
 [1]: http://webdriver.io/
 
@@ -2076,11 +1973,11 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [17]: http://webdriver.io/guide/usage/multiremote.html
 
-[18]: http://jster.net/category/windows-modals-popups
+[18]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+[20]: http://jster.net/category/windows-modals-popups
 
 [21]: https://webdriver.io/docs/timeouts.html
 
@@ -2092,12 +1989,18 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
 
 [25]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
 
-[26]: #fillfield
+[26]: http://webdriver.io/api/protocol/execute.html
+
+[27]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
+
+[28]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[29]: #fillfield
 
-[27]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+[30]: #click
 
-[28]: #click
+[31]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
 
-[29]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+[32]: https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
 
-[30]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object
+[33]: https://code.google.com/p/selenium/wiki/JsonWireProtocol#Cookie_JSON_Object