codeceptjs 2.4.3 → 2.6.2

package/docs/helpers/Playwright.md

@@ -0,0 +1,1770 @@
+---
+permalink: /helpers/Playwright
+editLink: false
+sidebar: auto
+title: Playwright
+---
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## Playwright
+
+**Extends Helper**
+
+Uses [Playwright][1] library to run tests inside:
+
+-   Chromium
+-   Firefox
+-   Webkit (Safari)
+
+This helper works with a browser out of the box with no additional tools required to install.
+
+Requires `playwright` package version ^0.12.1 to be installed:
+
+    npm i playwright@^0.12.1 --save
+
+## Configuration
+
+This helper should be configured in codecept.json or codecept.conf.js
+
+-   `url`: base url of website to be tested
+-   `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`. Default: chromium.
+-   `show`:  - show browser window.
+-   `restart`:  - restart browser between tests.
+-   `disableScreenshots`:   - don't save screenshot on failure.
+-   `emulate`:  launch browser in device emulation mode.
+-   `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` is set to false.
+-   `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+-   `waitForNavigation`: . When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. Choose one of those options is possible. See [Playwright API][2].
+-   `pressKeyDelay`: . Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+-   `getPageTimeout`  config option to set maximum navigation time in milliseconds.
+-   `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
+-   `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+-   `windowSize`: (optional) default window size. Set a dimension like `640x480`.
+-   `userAgent`: (optional) user-agent string.
+-   `manualStart`:  - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
+-   `chromium`: (optional) pass additional chromium options
+
+#### Example #1: Wait for 0 network connections.
+
+```js
+{
+   helpers: {
+     Playwright : {
+       url: "http://localhost",
+       restart: false,
+       waitForNavigation: "networkidle0",
+       waitForAction: 500
+     }
+   }
+}
+```
+
+#### Example #2: Wait for DOMContentLoaded event
+
+```js
+{
+   helpers: {
+     Playwright : {
+       url: "http://localhost",
+       restart: false,
+       waitForNavigation: "domcontentloaded",
+       waitForAction: 500
+     }
+   }
+}
+```
+
+#### Example #3: Debug in window mode
+
+```js
+{
+   helpers: {
+     Playwright : {
+       url: "http://localhost",
+       show: true
+     }
+   }
+}
+```
+
+#### Example #4: Connect to remote browser by specifying [websocket endpoint][3]
+
+```js
+{
+   helpers: {
+     Playwright: {
+       url: "http://localhost",
+       chromium: {
+         browserWSEndpoint: "ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a"
+       }
+     }
+   }
+}
+```
+
+#### Example #5: Testing with Chromium extensions
+
+[official docs][4]
+
+```js
+{
+ helpers: {
+   Playwright: {
+     url: "http://localhost",
+     show: true // headless mode not supported for extensions
+     chromium: {
+       args: [
+          `--disable-extensions-except=${pathToExtension}`,
+          `--load-extension=${pathToExtension}`
+       ]
+     }
+   }
+ }
+}
+```
+
+#### Example #6: Lunach tests emulating iPhone 6
+
+```js
+const { devices } = require('playwright');
+
+{
+ helpers: {
+   Playwright: {
+     url: "http://localhost",
+     emulate: devices['iPhone 6'],
+   }
+ }
+}
+```
+
+Note: When connecting to remote browser `show` and specific `chrome` options (e.g. `headless` or `devtools`) are ignored.
+
+## Access From Helpers
+
+Receive Playwright client from a custom helper by accessing `browser` for the Browser object or `page` for the current Page object:
+
+```js
+const { browser } = this.helpers.Playwright;
+await browser.pages(); // List of pages in the browser
+
+// get current page
+const { page } = this.helpers.Playwright;
+await page.url(); // Get the url of the current page
+
+const { browserContext } = this.helpers.Playwright;
+await browserContext.cookies(); // get current browser context
+```
+
+## Methods
+
+### Parameters
+
+-   `config`  
+
+### _addPopupListener
+
+Add the 'dialog' event listener to a page
+
+#### Parameters
+
+-   `page`  
+
+### _getPageUrl
+
+Gets page URL including hash.
+
+### _locate
+
+Get elements by different locator types, including strict locator
+Should be used in custom helpers:
+
+```js
+const elements = await this.helpers['Playwright']._locate({name: 'password'});
+```
+
+#### Parameters
+
+-   `locator`  
+
+### _locateCheckable
+
+Find a checkbox by providing human readable text:
+NOTE: Assumes the checkable element exists
+
+```js
+this.helpers['Playwright']._locateCheckable('I agree with terms and conditions').then // ...
+```
+
+#### Parameters
+
+-   `locator`  
+-   `providedContext`   
+
+### _locateClickable
+
+Find a clickable element by providing human readable text:
+
+```js
+this.helpers['Playwright']._locateClickable('Next page').then // ...
+```
+
+#### Parameters
+
+-   `locator`  
+
+### _locateFields
+
+Find field elements by providing human readable text:
+
+```js
+this.helpers['Playwright']._locateFields('Your email').then // ...
+```
+
+#### Parameters
+
+-   `locator`  
+
+### _setPage
+
+Set current page
+
+#### Parameters
+
+-   `page` **[object][5]** page to set
+
+### 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][6].
+
+### amAcceptingPopups
+
+Set the automatic popup response to Accept.
+This must be set before a popup is triggered.
+
+```js
+I.amAcceptingPopups();
+I.click('#triggerPopup');
+I.acceptPopup();
+```
+
+### amCancellingPopups
+
+Set the automatic popup response to Cancel/Dismiss.
+This must be set before a popup is triggered.
+
+```js
+I.amCancellingPopups();
+I.click('#triggerPopup');
+I.cancelPopup();
+```
+
+### amOnPage
+
+Opens a web page in a browser. Requires relative or absolute url.
+If url starts with `/`, opens a web page of a site defined in `url` config parameter.
+
+```js
+I.amOnPage('/'); // opens main page of website
+I.amOnPage('https://github.com'); // opens github
+I.amOnPage('/login'); // opens a login page
+```
+
+#### Parameters
+
+-   `url` **[string][7]** url path or global url.
+
+### appendField
+
+Appends text to a input field or textarea.
+Field is located by name, label, CSS or XPath
+
+```js
+I.appendField('#myTextField', 'appended');
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator
+-   `value` **[string][7]** text value to append.
+
+### attachFile
+
+Attaches a file to element located by label, name, CSS or XPath
+Path to file is relative current codecept directory (where codecept.json or codecept.conf.js is located).
+File will be uploaded to remote system (if tests are running remotely).
+
+```js
+I.attachFile('Avatar', 'data/avatar.jpg');
+I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `pathToFile` **[string][7]** local file path relative to codecept.json config file.
+
+### cancelPopup
+
+Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.
+
+### checkOption
+
+Selects a checkbox or radio button.
+Element is located by label or name or CSS or XPath.
+
+The second parameter is a context (CSS or XPath locator) to narrow the search.
+
+```js
+I.checkOption('#agree');
+I.checkOption('I Agree to Terms and Conditions');
+I.checkOption('agree', '//form');
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
+
+### clearCookie
+
+Clears a cookie by name,
+if none provided clears all cookies.
+
+```js
+I.clearCookie();
+I.clearCookie('test');
+```
+
+#### Parameters
+
+-   `cookie` **[string][7]?** (optional, `null` by default) cookie name 
+
+### clearField
+
+Clears a `<textarea>` or text `<input>` element's value.
+
+```js
+I.clearField('Email');
+I.clearField('user[email]');
+I.clearField('#email');
+```
+
+#### Parameters
+
+-   `field`  
+-   `editable` **([string][7] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+
+### click
+
+Perform a click on a link or a button, given by a locator.
+If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string.
+For buttons, the "value" attribute, "name" attribute, and inner text are searched. For links, the link text is searched.
+For images, the "alt" attribute and inner text of any parent links are searched.
+
+The second parameter is a context (CSS or XPath locator) to narrow the search.
+
+```js
+// simple link
+I.click('Logout');
+// button of form
+I.click('Submit');
+// CSS button
+I.click('#form input[type=submit]');
+// XPath
+I.click('//form/*[@type=submit]');
+// link in context
+I.click('Logout', '#nav');
+// using strict locator
+I.click({css: 'nav a.login'});
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+### clickLink
+
+Clicks link and waits for navigation (deprecated)
+
+#### Parameters
+
+-   `locator`  
+-   `context`   
+
+### closeCurrentTab
+
+Close current tab and switches to previous.
+
+```js
+I.closeCurrentTab();
+```
+
+### closeOtherTabs
+
+Close all tabs except for the current one.
+
+```js
+I.closeOtherTabs();
+```
+
+### dontSee
+
+Opposite to `see`. Checks that a text is not present on a page.
+Use context parameter to narrow down the search.
+
+```js
+I.dontSee('Login'); // assume we are already logged in.
+I.dontSee('Login', '.nav'); // no login inside .nav element
+```
+
+#### Parameters
+
+-   `text` **[string][7]** which is not present.
+-   `context` **([string][7] | [object][5])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 
+
+### dontSeeCheckboxIsChecked
+
+Verifies that the specified checkbox is not checked.
+
+```js
+I.dontSeeCheckboxIsChecked('#agree'); // located by ID
+I.dontSeeCheckboxIsChecked('I agree to terms'); // located by label
+I.dontSeeCheckboxIsChecked('agree'); // located by name
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+
+### dontSeeCookie
+
+Checks that cookie with given name does not exist.
+
+```js
+I.dontSeeCookie('auth'); // no auth cookie
+```
+
+#### Parameters
+
+-   `name` **[string][7]** cookie name.
+
+### dontSeeCurrentUrlEquals
+
+Checks that current url is not equal to provided one.
+If a relative url provided, a configured url will be prepended to it.
+
+```js
+I.dontSeeCurrentUrlEquals('/login'); // relative url are ok
+I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also ok
+```
+
+#### Parameters
+
+-   `url` **[string][7]** value to check.
+
+### dontSeeElement
+
+Opposite to `seeElement`. Checks that element is not visible (or in DOM)
+
+```js
+I.dontSeeElement('.modal'); // modal is not shown
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|Strict locator.
+
+### dontSeeElementInDOM
+
+Opposite to `seeElementInDOM`. Checks that element is not on page.
+
+```js
+I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or not
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|Strict locator.
+
+### dontSeeInCurrentUrl
+
+Checks that current url does not contain a provided fragment.
+
+#### Parameters
+
+-   `url` **[string][7]** value to check.
+
+### dontSeeInField
+
+Checks that value of input field or textarea doesn't equal to given value
+Opposite to `seeInField`.
+
+```js
+I.dontSeeInField('email', 'user@user.com'); // field by name
+I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][7]** value to check.
+
+### dontSeeInSource
+
+Checks that the current page does not contains the given string in its raw source code.
+
+```js
+I.dontSeeInSource('<!--'); // no comments in source
+```
+
+#### Parameters
+
+-   `text`  
+-   `value` **[string][7]** to check.
+
+### dontSeeInTitle
+
+Checks that title does not contain text.
+
+```js
+I.dontSeeInTitle('Error');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** value to check.
+
+### doubleClick
+
+Performs a double-click on an element matched by link|button|label|CSS or XPath.
+Context can be specified as second parameter to narrow search.
+
+```js
+I.doubleClick('Edit');
+I.doubleClick('Edit', '.actions');
+I.doubleClick({css: 'button.accept'});
+I.doubleClick('.btn.edit');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
+
+### dragAndDrop
+
+Drag an item to a destination element.
+
+```js
+I.dragAndDrop('#dragHandle', '#container');
+```
+
+#### Parameters
+
+-   `srcElement` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+-   `destElement` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+
+### dragSlider
+
+Drag the scrubber of a slider to a given position
+For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
+
+```js
+I.dragSlider('#slider', 30);
+I.dragSlider('#slider', -70);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+-   `offsetX` **[number][8]** position to drag. 
+
+### executeScript
+
+Executes a script on the page:
+
+```js
+I.executeScript(() => window.alert('Hello world'));
+```
+
+Additional parameters of the function can be passed as an object argument:
+
+```js
+I.executeScript(({x, y}) => x + y, {x, y});
+```
+
+You can pass only one parameter into a function
+but you can pass in array or object.
+
+```js
+I.executeScript(([x, y]) => x + y, [x, y]);
+```
+
+If a function returns a Promise it will wait for its resolution.
+
+#### Parameters
+
+-   `fn`  
+-   `arg`  
+
+### fillField
+
+Fills a text field or textarea, after clearing its value, with the given string.
+Field is located by name, label, CSS, or XPath.
+
+```js
+// by label
+I.fillField('Email', 'hello@world.com');
+// by name
+I.fillField('password', secret('123456'));
+// by CSS
+I.fillField('form#login input[name=username]', 'John');
+// or by strict locator
+I.fillField({css: 'form#login input[name=username]'}, 'John');
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][7]** text value to fill.
+
+### forceClick
+
+Force clicks an element without waiting for it to become visible and not animating.
+
+```js
+I.forceClick('#hiddenButton');
+I.forceClick('Click me', '#hidden');
+```
+
+#### Parameters
+
+-   `locator`  
+-   `context`   
+
+### grabAttributeFrom
+
+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.
+
+```js
+let hint = await I.grabAttributeFrom('#tooltip', 'title');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][7]** attribute name.
+
+Returns **[Promise][9]&lt;[string][7]>** attribute value
+
+### grabBrowserLogs
+
+Get JS log from browser.
+
+```js
+let logs = await I.grabBrowserLogs();
+console.log(JSON.stringify(logs))
+```
+
+Returns **[Promise][9]&lt;[Array][10]&lt;any>>** 
+
+### 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.
+
+```js
+let cookie = await I.grabCookie('auth');
+assert(cookie.value, '123456');
+```
+
+#### Parameters
+
+-   `name` **[string][7]?** cookie name. 
+
+Returns **[Promise][9]&lt;[string][7]>** attribute valueReturns cookie in JSON format. If name not passed returns all cookies for this domain.
+
+### grabCssPropertyFrom
+
+Grab CSS property for given locator
+Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+const value = await I.grabCssPropertyFrom('h3', 'font-weight');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `cssProperty` **[string][7]** CSS property name.
+
+Returns **[Promise][9]&lt;[string][7]>** CSS value
+
+### grabCurrentUrl
+
+Get current URL from browser.
+Resumes test execution, so should be used inside an async function.
+
+```js
+let url = await I.grabCurrentUrl();
+console.log(`Current URL is [${url}]`);
+```
+
+Returns **[Promise][9]&lt;[string][7]>** current URL
+
+### grabDataFromPerformanceTiming
+
+Grab the data from performance timing using Navigation Timing API.
+The returned data will contain following things in ms:
+
+-   responseEnd,
+-   domInteractive,
+-   domContentLoadedEventEnd,
+-   loadEventEnd
+    Resumes test execution, so **should be used inside an async function with `await`** operator.
+
+```js
+await I.amOnPage('https://example.com');
+let data = await I.grabDataFromPerformanceTiming();
+//Returned data
+{ // all results are in [ms]
+  responseEnd: 23,
+  domInteractive: 44,
+  domContentLoadedEventEnd: 196,
+  loadEventEnd: 241
+}
+```
+
+### grabElementBoundingRect
+
+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.
+
+Returns an object with `x`, `y`, `width`, `height` keys.
+
+```js
+const value = await I.grabElementBoundingRect('h3');
+// value is like { x: 226.5, y: 89, width: 527, height: 220 }
+```
+
+To get only one metric use second parameter:
+
+```js
+const width = await I.grabElementBoundingRect('h3', 'width');
+// width == 527
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `prop`  
+-   `elementSize` **[string][7]** x, y, width or height of the given element.
+
+Returns **[object][5]** Element bounding rectangle
+
+### 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.
+If more than one element is found - an array of HTMLs returned.
+
+```js
+let postHTML = await I.grabHTMLFrom('#post');
+```
+
+#### Parameters
+
+-   `locator`  
+-   `element` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+
+Returns **[Promise][9]&lt;[string][7]>** HTML code for an element
+
+### grabNumberOfOpenTabs
+
+Grab number of open tabs.
+
+```js
+let tabs = await I.grabNumberOfOpenTabs();
+```
+
+Returns **[Promise][9]&lt;[number][8]>** number of open tabs
+
+### grabNumberOfVisibleElements
+
+Grab number of visible elements by locator.
+
+```js
+let numOfElements = await I.grabNumberOfVisibleElements('p');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+
+Returns **[Promise][9]&lt;[number][8]>** 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.
+
+```js
+let { x, y } = await I.grabPageScrollPosition();
+```
+
+Returns **[Promise][9]&lt;[Object][5]&lt;[string][7], any>>** scroll position
+
+### grabPopupText
+
+Grab the text within the popup. If no popup is visible then it will return null
+
+```js
+await I.grabPopupText();
+```
+
+Returns **[Promise][9]&lt;([string][7] | null)>** 
+
+### grabSource
+
+Retrieves page source and returns it to test.
+Resumes test execution, so should be used inside an async function.
+
+```js
+let pageSource = await I.grabSource();
+```
+
+Returns **[Promise][9]&lt;[string][7]>** 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.
+
+```js
+let pin = await I.grabTextFrom('#pin');
+```
+
+If multiple elements found returns an array of texts.
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+
+Returns **[Promise][9]&lt;([string][7] | [Array][10]&lt;[string][7]>)>** attribute value
+
+### grabTitle
+
+Retrieves a page title and returns it to test.
+Resumes test execution, so **should be used inside async with `await`** operator.
+
+```js
+let title = await I.grabTitle();
+```
+
+Returns **[Promise][9]&lt;[string][7]>** 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.
+
+```js
+let email = await I.grabValueFrom('input[name=email]');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+
+Returns **[Promise][9]&lt;[string][7]>** attribute value
+
+### handleDownloads
+
+Handles a file download.Aa file name is required to save the file on disk.
+Files are saved to "output" directory.
+
+Should be used with [FileSystem helper][11] to check that file were downloaded correctly.
+
+```js
+I.handleDownloads('downloads/avatar.jpg');
+I.click('Download Avatar');
+I.amInPath('output/downloads');
+I.waitForFile('downloads/avatar.jpg', 5);
+```
+
+#### Parameters
+
+-   `fileName` **[string][7]?** set filename for downloaded file 
+
+### haveRequestHeaders
+
+Set headers for all next requests
+
+```js
+I.haveRequestHeaders({
+   'X-Sent-By': 'CodeceptJS',
+});
+```
+
+#### Parameters
+
+-   `customHeaders` **[object][5]** headers to set
+
+### moveCursorTo
+
+Moves cursor to element matched by locator.
+Extra shift can be set with offsetX and offsetY options.
+
+```js
+I.moveCursorTo('.tooltip');
+I.moveCursorTo('#submit', 5,5);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][8]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][8]** (optional, `0` by default) Y-axis offset. 
+
+### openNewTab
+
+Open new tab and switch to it
+
+```js
+I.openNewTab();
+```
+
+You can pass in [page options][12] to emulate device on this page
+
+```js
+// enable mobile
+I.openNewTab({ isMobile: true });
+```
+
+#### Parameters
+
+-   `options`  
+
+### pressKey
+
+Presses a key in the browser (on a focused element).
+
+_Hint:_ For populating text field or textarea, it is recommended to use [`fillField`][13].
+
+```js
+I.pressKey('Backspace');
+```
+
+To press a key in combination with modifier keys, pass the sequence as an array. All modifier keys (`'Alt'`, `'Control'`, `'Meta'`, `'Shift'`) will be released afterwards.
+
+```js
+I.pressKey(['Control', 'Z']);
+```
+
+For specifying operation modifier key based on operating system it is suggested to use `'CommandOrControl'`.
+This will press `'Command'` (also known as `'Meta'`) on macOS machines and `'Control'` on non-macOS machines.
+
+```js
+I.pressKey(['CommandOrControl', 'Z']);
+```
+
+Some of the supported key names are:
+
+-   `'AltLeft'` or `'Alt'`
+-   `'AltRight'`
+-   `'ArrowDown'`
+-   `'ArrowLeft'`
+-   `'ArrowRight'`
+-   `'ArrowUp'`
+-   `'Backspace'`
+-   `'Clear'`
+-   `'ControlLeft'` or `'Control'`
+-   `'ControlRight'`
+-   `'Command'`
+-   `'CommandOrControl'`
+-   `'Delete'`
+-   `'End'`
+-   `'Enter'`
+-   `'Escape'`
+-   `'F1'` to `'F12'`
+-   `'Home'`
+-   `'Insert'`
+-   `'MetaLeft'` or `'Meta'`
+-   `'MetaRight'`
+-   `'Numpad0'` to `'Numpad9'`
+-   `'NumpadAdd'`
+-   `'NumpadDecimal'`
+-   `'NumpadDivide'`
+-   `'NumpadMultiply'`
+-   `'NumpadSubtract'`
+-   `'PageDown'`
+-   `'PageUp'`
+-   `'Pause'`
+-   `'Return'`
+-   `'ShiftLeft'` or `'Shift'`
+-   `'ShiftRight'`
+-   `'Space'`
+-   `'Tab'`
+
+#### Parameters
+
+-   `key` **([string][7] | [Array][10]&lt;[string][7]>)** key or array of keys to press._Note:_ Shortcuts like `'Meta'` + `'A'` do not work on macOS ([GoogleChrome/Playwright#1313][14]).
+
+### 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`][15]).
+
+```js
+I.pressKeyDown('Control');
+I.click('#element');
+I.pressKeyUp('Control');
+```
+
+#### Parameters
+
+-   `key` **[string][7]** 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`][15]).
+
+```js
+I.pressKeyDown('Control');
+I.click('#element');
+I.pressKeyUp('Control');
+```
+
+#### Parameters
+
+-   `key` **[string][7]** name of key to release.
+
+### refreshPage
+
+Reload the current page.
+
+```js
+I.refreshPage();
+```
+
+### resizeWindow
+
+Resize the current window to provided width and height.
+First parameter can be set to `maximize`.
+
+#### Parameters
+
+-   `width` **[number][8]** width in pixels or `maximize`.
+-   `height` **[number][8]** height in pixels.Unlike other drivers Playwright changes the size of a viewport, not the window!
+    Playwright does not control the window of a browser so it can't adjust its real size.
+    It also can't maximize a window.Update configuration to change real window size on start:```js
+    // inside codecept.conf.js
+    // @codeceptjs/configure package must be installed
+    { setWindowSize } = require('@codeceptjs/configure');
+    ```
+
+### rightClick
+
+Performs right click on a clickable element matched by semantic locator, CSS or XPath.
+
+```js
+// right click element with id el
+I.rightClick('#el');
+// right click link or button with text "Click me"
+I.rightClick('Click me');
+// right click button with text "Click me" inside .context
+I.rightClick('Click me', '.context');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** clickable element located by CSS|XPath|strict locator.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+### saveScreenshot
+
+Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+Filename is relative to output folder.
+Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
+
+```js
+I.saveScreenshot('debug.png');
+I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
+```
+
+#### Parameters
+
+-   `fileName` **[string][7]** file name to save.
+-   `fullPage` **[boolean][16]** (optional, `false` by default) flag to enable fullscreen screenshot mode. 
+
+### scrollPageToBottom
+
+Scroll page to the bottom.
+
+```js
+I.scrollPageToBottom();
+```
+
+### scrollPageToTop
+
+Scroll page to the top.
+
+```js
+I.scrollPageToTop();
+```
+
+### scrollTo
+
+Scrolls to element matched by locator.
+Extra shift can be set with offsetX and offsetY options.
+
+```js
+I.scrollTo('footer');
+I.scrollTo('#submit', 5, 5);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+-   `offsetX` **[number][8]** (optional, `0` by default) X-axis offset. 
+-   `offsetY` **[number][8]** (optional, `0` by default) Y-axis offset. 
+
+### see
+
+Checks that a page contains a visible text.
+Use context parameter to narrow down the search.
+
+```js
+I.see('Welcome'); // text welcome on a page
+I.see('Welcome', '.content'); // text inside .content div
+I.see('Register', {css: 'form.register'}); // use strict locator
+```
+
+#### Parameters
+
+-   `text` **[string][7]** expected on page.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text. 
+
+### seeAttributesOnElements
+
+Checks that all elements with given locator have given attributes.
+
+```js
+I.seeAttributesOnElements('//form', { method: "post"});
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+-   `attributes` **[object][5]** attributes and their values to check.
+
+### seeCheckboxIsChecked
+
+Verifies that the specified checkbox is checked.
+
+```js
+I.seeCheckboxIsChecked('Agree');
+I.seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
+I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+
+### seeCookie
+
+Checks that cookie with given name exists.
+
+```js
+I.seeCookie('Auth');
+```
+
+#### Parameters
+
+-   `name` **[string][7]** cookie name.
+
+### seeCssPropertiesOnElements
+
+Checks that all elements with given locator have given CSS properties.
+
+```js
+I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+-   `cssProperties` **[object][5]** object with CSS properties and their values to check.
+
+### seeCurrentUrlEquals
+
+Checks that current url is equal to provided one.
+If a relative url provided, a configured url will be prepended to it.
+So both examples will work:
+
+```js
+I.seeCurrentUrlEquals('/register');
+I.seeCurrentUrlEquals('http://my.site.com/register');
+```
+
+#### Parameters
+
+-   `url` **[string][7]** value to check.
+
+### seeElement
+
+Checks that a given Element is visible
+Element is located by CSS or XPath.
+
+```js
+I.seeElement('#modal');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** located by CSS|XPath|strict locator.
+
+### seeElementInDOM
+
+Checks that a given Element is present in the DOM
+Element is located by CSS or XPath.
+
+```js
+I.seeElementInDOM('#modal');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+
+### seeInCurrentUrl
+
+Checks that current url contains a provided fragment.
+
+```js
+I.seeInCurrentUrl('/register'); // we are on registration page
+```
+
+#### Parameters
+
+-   `url` **[string][7]** a fragment to check
+
+### seeInField
+
+Checks that the given input field or textarea equals to given value.
+For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and XPath.
+
+```js
+I.seeInField('Username', 'davert');
+I.seeInField({css: 'form textarea'},'Type your comment here');
+I.seeInField('form input[type=hidden]','hidden_value');
+I.seeInField('#searchform input','Search');
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** located by label|name|CSS|XPath|strict locator.
+-   `value` **[string][7]** value to check.
+
+### seeInPopup
+
+Checks that the active JavaScript popup, as created by `window.alert|window.confirm|window.prompt`, contains the
+given string.
+
+```js
+I.seeInPopup('Popup text');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** value to check.
+
+### seeInSource
+
+Checks that the current page contains the given string in its raw source code.
+
+```js
+I.seeInSource('<h1>Green eggs &amp; ham</h1>');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** value to check.
+
+### seeInTitle
+
+Checks that title contains text.
+
+```js
+I.seeInTitle('Home Page');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** text value to check.
+
+### seeNumberOfElements
+
+Asserts that an element appears a given number of times in the DOM.
+Element is located by label or name or CSS or XPath.
+
+```js
+I.seeNumberOfElements('#submitBtn', 1);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `num` **[number][8]** number of elements.
+
+### seeNumberOfVisibleElements
+
+Asserts that an element is visible a given number of times.
+Element is located by CSS or XPath.
+
+```js
+I.seeNumberOfVisibleElements('.buttons', 3);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `num` **[number][8]** number of elements.
+
+### seeTextEquals
+
+Checks that text is equal to provided one.
+
+```js
+I.seeTextEquals('text', 'h1');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** element value to check.
+-   `context` **([string][7] | [object][5]?)** element located by CSS|XPath|strict locator. 
+
+### seeTitleEquals
+
+Checks that title is equal to provided one.
+
+```js
+I.seeTitleEquals('Test title.');
+```
+
+#### Parameters
+
+-   `text`  
+
+### selectOption
+
+Selects an option in a drop-down select.
+Field is searched by label | name | CSS | XPath.
+Option is selected by visible text or by value.
+
+```js
+I.selectOption('Choose Plan', 'Monthly'); // select by label
+I.selectOption('subscription', 'Monthly'); // match option by text
+I.selectOption('subscription', '0'); // or by value
+I.selectOption('//form/select[@name=account]','Premium');
+I.selectOption('form select[name=account]', 'Premium');
+I.selectOption({css: 'form select[name=account]'}, 'Premium');
+```
+
+Provide an array for the second argument to select multiple options.
+
+```js
+I.selectOption('Which OS do you use?', ['Android', 'iOS']);
+```
+
+#### Parameters
+
+-   `select` **([string][7] | [object][5])** field located by label|name|CSS|XPath|strict locator.
+-   `option` **([string][7] | [Array][10]&lt;any>)** visible text or value of option.
+
+### setCookie
+
+Sets cookie(s).
+
+Can be a single cookie object or an array of cookies:
+
+```js
+I.setCookie({name: 'auth', value: true});
+
+// as array
+I.setCookie([
+  {name: 'auth', value: true},
+  {name: 'agree', value: true}
+]);
+```
+
+#### Parameters
+
+-   `cookie` **([object][5] | [array][10])** a cookie object or array of cookie objects.
+
+### switchTo
+
+Switches frame or in case of null locator reverts to parent.
+
+```js
+I.switchTo('iframe'); // switch to first iframe
+I.switchTo(); // switch back to main page
+```
+
+#### Parameters
+
+-   `locator` **([string][7]? | [object][5])** (optional, `null` by default) element located by CSS|XPath|strict locator. 
+
+### switchToNextTab
+
+Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
+
+```js
+I.switchToNextTab();
+I.switchToNextTab(2);
+```
+
+#### Parameters
+
+-   `num` **[number][8]**  
+
+### switchToPreviousTab
+
+Switch focus to a particular tab by its number. It waits tabs loading and then switch tab
+
+```js
+I.switchToPreviousTab();
+I.switchToPreviousTab(2);
+```
+
+#### Parameters
+
+-   `num` **[number][8]**  
+
+### uncheckOption
+
+Unselects a checkbox or radio button.
+Element is located by label or name or CSS or XPath.
+
+The second parameter is a context (CSS or XPath locator) to narrow the search.
+
+```js
+I.uncheckOption('#agree');
+I.uncheckOption('I Agree to Terms and Conditions');
+I.uncheckOption('agree', '//form');
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** checkbox located by label | name | CSS | XPath | strict locator.
+-   `context` **([string][7]? | [object][5])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
+
+### wait
+
+Pauses execution for a number of seconds.
+
+```js
+I.wait(2); // wait 2 secs
+```
+
+#### Parameters
+
+-   `sec` **[number][8]** 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][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `waitTimeout`  
+-   `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
+
+### waitForDetached
+
+Waits for an element to become not attached to the DOM on a page (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForDetached('#popup');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitForElement
+
+Waits for element to be present on page (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForElement('.btn.continue');
+I.waitForElement('.btn.continue', 5); // wait for 5 secs
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait
+
+### waitForEnabled
+
+Waits for element to become enabled (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]** (optional) time in seconds to wait, 1 by default. 
+
+### waitForFunction
+
+Waits for a function to return true (waits for 1 sec by default).
+Running in browser context.
+
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
+```js
+I.waitForFunction(() => window.requests == 0);
+I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
+```
+
+#### Parameters
+
+-   `fn` **([string][7] | [function][17])** to be executed in browser context.
+-   `argsOrSec` **([Array][10]&lt;any> | [number][8])?** (optional, `1` by default) arguments for function or seconds. 
+-   `sec` **[number][8]?** (optional, `1` by default) time in seconds to wait 
+
+### waitForInvisible
+
+Waits for an element to be removed or become invisible on a page (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForInvisible('#popup');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitForNavigation
+
+Waits for navigation to finish. By default takes configured `waitForNavigation` option.
+
+See [Pupeteer's reference][18]
+
+#### Parameters
+
+-   `opts` **any**  
+
+### waitForRequest
+
+Waits for a network request.
+
+```js
+I.waitForRequest('http://example.com/resource');
+I.waitForRequest(request => request.url() === 'http://example.com' && request.method() === 'GET');
+```
+
+#### Parameters
+
+-   `urlOrPredicate` **([string][7] | [function][17])** 
+-   `sec` **[number][8]?** seconds to wait 
+
+### waitForResponse
+
+Waits for a network request.
+
+```js
+I.waitForResponse('http://example.com/resource');
+I.waitForResponse(request => request.url() === 'http://example.com' && request.method() === 'GET');
+```
+
+#### Parameters
+
+-   `urlOrPredicate` **([string][7] | [function][17])** 
+-   `sec` **[number][8]?** number of seconds to wait 
+
+### waitForText
+
+Waits for a text to appear (by default waits for 1sec).
+Element can be located by CSS or XPath.
+Narrow down search results by providing context.
+
+```js
+I.waitForText('Thank you, form has been submitted');
+I.waitForText('Thank you, form has been submitted', 5, '#modal');
+```
+
+#### Parameters
+
+-   `text` **[string][7]** to wait for.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+-   `context` **([string][7] | [object][5])?** (optional) element located by CSS|XPath|strict locator. 
+
+### waitForValue
+
+Waits for the specified value to be in value attribute.
+
+```js
+I.waitForValue('//input', "GoodValue");
+```
+
+#### Parameters
+
+-   `field` **([string][7] | [object][5])** input field.
+-   `value` **[string][7]** expected value.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitForVisible
+
+Waits for an element to become visible on a page (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitForVisible('#popup');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to waitThis method accepts [React selectors][19]. 
+
+### waitInUrl
+
+Waiting for the part of the URL to match the expected. Useful for SPA to understand that page was changed.
+
+```js
+I.waitInUrl('/info', 2);
+```
+
+#### Parameters
+
+-   `urlPart` **[string][7]** value to check.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitNumberOfVisibleElements
+
+Waits for a specified number of elements on the page.
+
+```js
+I.waitNumberOfVisibleElements('a', 3);
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `num` **[number][8]** number of elements.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitToHide
+
+Waits for an element to hide (by default waits for 1sec).
+Element can be located by CSS or XPath.
+
+```js
+I.waitToHide('#popup');
+```
+
+#### Parameters
+
+-   `locator` **([string][7] | [object][5])** element located by CSS|XPath|strict locator.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+### waitUntil
+
+Waits for a function to return true (waits for 1sec by default).
+
+```js
+I.waitUntil(() => window.requests == 0);
+I.waitUntil(() => window.requests == 0, 5);
+```
+
+#### Parameters
+
+-   `fn` **([function][17] | [string][7])** function which is executed in browser context.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+-   `timeoutMsg` **[string][7]** message to show in case of timeout fail. 
+-   `interval` **[number][8]?**  
+
+### waitUrlEquals
+
+Waits for the entire URL to match the expected
+
+```js
+I.waitUrlEquals('/info', 2);
+I.waitUrlEquals('http://127.0.0.1:8000/info');
+```
+
+#### Parameters
+
+-   `urlPart` **[string][7]** value to check.
+-   `sec` **[number][8]** (optional, `1` by default) time in seconds to wait 
+
+[1]: https://github.com/microsoft/playwright
+
+[2]: https://github.com/microsoft/playwright/blob/master/docs/api.md#pagewaitfornavigationoptions
+
+[3]: https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target
+
+[4]: https://github.com/microsoft/playwright/blob/v0.11.0/docs/api.md#working-with-chrome-extensions
+
+[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[6]: http://jster.net/category/windows-modals-popups
+
+[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[11]: https://codecept.io/helpers/FileSystem
+
+[12]: https://github.com/microsoft/playwright/blob/v0.12.1/docs/api.md#browsernewpageoptions
+
+[13]: #fillfield
+
+[14]: https://github.com/GoogleChrome/Playwright/issues/1313
+
+[15]: #click
+
+[16]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[17]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
+
+[18]: https://github.com/GoogleChrome/Playwright/blob/master/docs/api.md#pagewaitfornavigationoptions
+
+[19]: https://codecept.io/react