codeceptjs/docs/helpers/Playwright.md

Supercharged End 2 End Testing Framework for NodeJS

---
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` or `playwright-core` package version ^1 to be installed:

    npm i playwright@^1.18 --save

or

    npm i playwright-core@^1.18 --save

Breaking Changes: if you use Playwright v1.38 and later, it will no longer download browsers automatically.

Run `npx playwright install` to download browsers after `npm install`.

Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.



## Configuration

This helper should be configured in codecept.conf.(js|ts)

Type: [object][6]

### Properties

*   `url` **[string][9]?** base url of website to be tested
*   `browser` **(`"chromium"` | `"firefox"` | `"webkit"` | `"electron"`)?** a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
*   `show` **[boolean][27]?** show browser window.
*   `restart` **([string][9] | [boolean][27])?** restart strategy between tests. Possible values:*   'context' or **false** - restarts [browser context][44] but keeps running browser. Recommended by Playwright team to keep tests isolated.
    *   'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
*   `timeout` **[number][18]?** *   [timeout][45] in ms of all Playwright actions .
*   `disableScreenshots` **[boolean][27]?** don't save screenshot on failure.
*   `emulate` **any?** browser in device emulation mode.
*   `video` **[boolean][27]?** enables video recording for failed tests; videos are saved into `output/videos` folder
*   `keepVideoForPassedTests` **[boolean][27]?** save videos for passed tests; videos are saved into `output/videos` folder
*   `trace` **[boolean][27]?** record [tracing information][46] with screenshots and snapshots.
*   `keepTraceForPassedTests` **[boolean][27]?** save trace for passed tests.
*   `fullPageScreenshots` **[boolean][27]?** make full page screenshots on failure.
*   `uniqueScreenshotNames` **[boolean][27]?** option to prevent screenshot override if you have scenarios with the same name in different suites.
*   `keepBrowserState` **[boolean][27]?** keep browser state between tests when `restart` is set to 'session'.
*   `keepCookies` **[boolean][27]?** keep cookies between tests when `restart` is set to 'session'.
*   `waitForAction` **[number][18]?** how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
*   `waitForNavigation` **(`"load"` | `"domcontentloaded"` | `"commit"`)?** When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `commit`. Choose one of those options is possible. See [Playwright API][43].
*   `pressKeyDelay` **[number][18]?** Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
*   `getPageTimeout` **[number][18]?** config option to set maximum navigation time in milliseconds.
*   `waitForTimeout` **[number][18]?** default wait* timeout in ms. Default: 1000.
*   `basicAuth` **[object][6]?** the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
*   `windowSize` **[string][9]?** default window size. Set a dimension like `640x480`.
*   `colorScheme` **(`"dark"` | `"light"` | `"no-preference"`)?** default color scheme. Possible values: `dark` | `light` | `no-preference`.
*   `userAgent` **[string][9]?** user-agent string.
*   `locale` **[string][9]?** locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
*   `manualStart` **[boolean][27]?** do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
*   `chromium` **[object][6]?** pass additional chromium options
*   `firefox` **[object][6]?** pass additional firefox options
*   `electron` **[object][6]?** (pass additional electron options
*   `channel` **any?** (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge][47].
*   `ignoreLog` **[Array][10]<[string][9]>?** An array with console message types that are not logged to debug log. Default value is `['warning', 'log']`. E.g. you can set `[]` to log all messages. See all possible [values][48].
*   `ignoreHTTPSErrors` **[boolean][27]?** Allows access to untrustworthy pages, e.g. to a page with an expired certificate. Default value is `false`
*   `bypassCSP` **[boolean][27]?** bypass Content Security Policy or CSP
*   `highlightElement` **[boolean][27]?** highlight the interacting elements. Default: false. Note: only activate under verbose mode (--verbose).
*   `recordHar` **[object][6]?** record HAR and will be saved to `output/har`. See more of [HAR options][3].
*   `testIdAttribute` **[string][9]?** locate elements based on the testIdAttribute. See more of [locate by test id][49].
*   `storageState` **([string][9] | [object][6])?** Playwright storage state (path to JSON file or object)
    passed directly to `browser.newContext`.
    If a Scenario is declared with a `cookies` option (e.g. `Scenario('name', { cookies: [...] }, fn)`),
    those cookies are used instead and the configured `storageState` is ignored (no merge).
    May include session cookies, auth tokens, localStorage and (if captured with
    `grabStorageState({ indexedDB: true })`) IndexedDB data; treat as sensitive and do not commit.

## handleRoleLocator

Handles role locator objects by converting them to Playwright's getByRole() API
Accepts both raw objects ({role: 'button', text: 'Submit'}) and Locator-wrapped role objects.
Returns elements array if role locator, null otherwise

### Parameters

*   `context` &#x20;
*   `locator` &#x20;



#### Video Recording Customization

By default, video is saved to `output/video` dir. You can customize this path by passing `dir` option to `recordVideo` option.

`video`: enables video recording for failed tests; videos are saved into `output/videos` folder

*   `keepVideoForPassedTests`: - save videos for passed tests
*   `recordVideo`: [additional options for videos customization][2]

#### Trace Recording Customization

Trace recording provides complete information on test execution and includes DOM snapshots, screenshots, and network requests logged during run.
Traces will be saved to `output/trace`

*   `trace`: enables trace recording for failed tests; trace are saved into `output/trace` folder
*   `keepTraceForPassedTests`: - save trace for passed tests

#### HAR Recording Customization

A HAR file is an HTTP Archive file that contains a record of all the network requests that are made when a page is loaded.
It contains information about the request and response headers, cookies, content, timings, and more. You can use HAR files to mock network requests in your tests.
HAR will be saved to `output/har`. More info could be found here [https://playwright.dev/docs/api/class-browser#browser-new-context-option-record-har][3].

    ...
    recordHar: {
        mode: 'minimal', // possible values: 'minimal'|'full'.
        content: 'embed' // possible values:  "omit"|"embed"|"attach".
    }
    ...

#### 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][4]

```js
{
   helpers: {
     Playwright: {
       url: "http://localhost",
       chromium: {
         browserWSEndpoint: 'ws://localhost:9222/devtools/browser/c5aa6160-b5bc-4d53-bb49-6ecb36cd2e0a',
         cdpConnection: false // default is false
       }
     }
   }
}
```

#### Example #5: Testing with Chromium extensions

[official docs][5]

```js
{
 helpers: {
   Playwright: {
     url: "http://localhost",
     show: true // headless mode not supported for extensions
     chromium: {
       // Note: due to this would launch persistent context, so to avoid the error when running tests with run-workers a timestamp would be appended to the defined folder name. For instance: playwright-tmp_1692715649511
       userDataDir: '/tmp/playwright-tmp', // necessary to launch the browser in normal mode instead of incognito,
       args: [
          `--disable-extensions-except=${pathToExtension}`,
          `--load-extension=${pathToExtension}`
       ]
     }
   }
 }
}
```

#### Example #6: Launch tests emulating iPhone 6

```js
const { devices } = require('playwright');

{
 helpers: {
   Playwright: {
     url: "http://localhost",
     emulate: devices['iPhone 6'],
   }
 }
}
```

#### Example #7: Launch test with a specific user locale

```js
{
 helpers: {
  Playwright : {
    url: "http://localhost",
    locale: "fr-FR",
  }
 }
}
```

*   #### Example #8: Launch test with a specific color scheme

```js
{
 helpers: {
  Playwright : {
    url: "http://localhost",
    colorScheme: "dark",
  }
 }
}
```

*   #### Example #9: Launch electron test

```js
{
 helpers: {
    Playwright: {
      browser: 'electron',
      electron: {
        executablePath: require("electron"),
        args: [path.join('../', "main.js")],
      },
    }
  },
}
```

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
```

### Parameters

*   `config` &#x20;

### _addPopupListener

Add the 'dialog' event listener to a page

#### Parameters

*   `page` &#x20;

### _contextLocator

Grab Locator if called within Context

#### Parameters

*   `locator` **any**&#x20;

### _createContextPage

Create a new browser context with a page. 
Usually it should be run from a custom helper after call of `_startBrowser()`

#### Parameters

*   `contextOptions` **[object][6]?** See [https://playwright.dev/docs/api/class-browser#browser-new-context][7]

### _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` &#x20;

### _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` &#x20;
*   `providedContext`   

### _locateClickable

Find a clickable element by providing human-readable text:

```js
this.helpers['Playwright']._locateClickable('Next page').then // ...
```

#### Parameters

*   `locator` &#x20;

### _locateElement

Get the first element by different locator types, including strict locator
Should be used in custom helpers:

```js
const element = await this.helpers['Playwright']._locateElement({name: 'password'});
```

#### Parameters

*   `locator` &#x20;

### _locateFields

Find field elements by providing human-readable text:

```js
this.helpers['Playwright']._locateFields('Your email').then // ...
```

#### Parameters

*   `locator` &#x20;

### _setPage

Set current page

#### Parameters

*   `page` **[object][6]** 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][8].

### 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][9]** url path or global url.

Returns **void** automatically synchronized promise through #recorder

### appendField

Appends text to a input field or textarea.
Field is located by name, label, CSS or XPath

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

```js
I.appendField('#myTextField', 'appended');
// typing secret
I.appendField('password', secret('123456'));
// within a context
I.appendField('name', 'John', '.form-container');
```

#### Parameters

*   `field` **([string][9] | [object][6])** located by label|name|CSS|XPath|strict locator
*   `value` **[string][9]** text value to append.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 

Returns **void** automatically synchronized promise through #recorder

### attachFile

Attaches a file to element located by label, name, CSS or XPath
Path to file is relative current codecept directory (where codecept.conf.ts or codecept.conf.js is located).
File will be uploaded to remote system (if tests are running remotely).

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

```js
I.attachFile('Avatar', 'data/avatar.jpg');
I.attachFile('form input[name=avatar]', 'data/avatar.jpg');
// within a context
I.attachFile('Avatar', 'data/avatar.jpg', '.form-container');
```

If the locator points to a non-file-input element (e.g., a dropzone area),
the file will be dropped onto that element using drag-and-drop events.

```js
I.attachFile('#dropzone', 'data/avatar.jpg');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.
*   `pathToFile` **[string][9]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 

Returns **void** automatically synchronized promise through #recorder

### blockTraffic

Blocks traffic of a given URL or a list of URLs.

Examples:

```js
I.blockTraffic('http://example.com/css/style.css');
I.blockTraffic('http://example.com/css/*.css');
I.blockTraffic('http://example.com/**');
I.blockTraffic(/.css$/);
```

```js
I.blockTraffic(['http://example.com/css/style.css', 'http://example.com/css/*.css']);
```

#### Parameters

*   `urls` **([string][9] | [Array][10] | [RegExp][11])** URL or a list of URLs to block . URL can contain * for wildcards. Example: [https://www.example.com][12]** to block all traffic for that domain. Regexp are also supported.

### blur

Remove focus from a text input, button, etc.
Calls [blur][13] on the element.

Examples:

```js
I.blur('.text-area')
```

```js
//element `#product-tile` is focused
I.see('#add-to-cart-btn');
I.blur('#product-tile')
I.dontSee('#add-to-cart-btn');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.
*   `options` **any?** Playwright only: [Additional options][14] for available options object as 2nd argument. 

Returns **void** automatically synchronized promise through #recorder

### cancelPopup

Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.

### checkOption

[Additional options][15] for check available as 3rd argument.

Examples:

```js
// click on element at position
I.checkOption('Agree', '.signup', { position: { x: 5, y: 5 } })
```

> ⚠️ To avoid flakiness, option `force: true` is set by default

Selects a checkbox or radio button.
Element is located by label or name or CSS or XPath.

The second parameter is an optional 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][9] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
*   `options`   

Returns **void** automatically synchronized promise through #recorder

### clearCookie

Clears a cookie by name,
if none provided clears all cookies.

```js
I.clearCookie();
I.clearCookie('test');
```

#### Parameters

*   `cookieName` &#x20;
*   `cookie` **[string][9]?** (optional, `null` by default) cookie name 

### clearField

Clears a `<textarea>` or text `<input>` element's value.

The second parameter is an optional context (CSS or XPath locator) to narrow the search.

```js
I.clearField('Email');
I.clearField('user[email]');
I.clearField('#email');
// within a context
I.clearField('Email', '.form-container');
```

#### Parameters

*   `locator` &#x20;
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 
*   `editable` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.

Returns **void** automatically synchronized promise through #recorder.

### 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.

If no locator is provided, defaults to clicking the body element (`'//body'`).

The second parameter is a context (CSS or XPath locator) to narrow the search.

```js
// click body element (default)
I.click();
// 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'});
// using ARIA role locator
I.click({role: 'button', name: 'Submit'});
```

> ℹ️ ARIA role locators (`{role, name}`) match elements the way assistive technology does and survive markup refactors. See [Locators][16].

#### Parameters

*   `locator` **([string][9] | [object][6])** (optional, `'//body'` by default) clickable link or button located by text, or any element located by CSS|XPath|strict locator. 
*   `context` **([string][9]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 
*   `options` **any?** [Additional options][17] for click available as 3rd argument. 

#### Examples

````javascript
```js
// click on element at position
I.click('canvas', '.model', { position: { x: 20, y: 40 } })

// make ctrl-click
I.click('.edit', null, { modifiers: ['Ctrl'] } )
```
````

Returns **void** automatically synchronized promise through #recorder

### clickXY

Performs click at specific coordinates.
If locator is provided, the coordinates are relative to the element.
If locator is not provided, the coordinates are global page coordinates.

```js
// Click at global coordinates (100, 200)
I.clickXY(100, 200);

// Click at coordinates (50, 30) relative to element
I.clickXY('#someElement', 50, 30);
```

#### Parameters

*   `locator` **([string][9] | [object][6] | [number][18])** Element to click on or X coordinate if no element.
*   `x` **[number][18]?** X coordinate relative to element, or Y coordinate if locator is a number.
*   `y` **[number][18]?** Y coordinate relative to element.

Returns **[Promise][19]<void>**&#x20;

### 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][9]** which is not present.
*   `context` **([string][9] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search. 

Returns **void** automatically synchronized promise through #recorder

### 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][9] | [object][6])** located by label|name|CSS|XPath|strict locator.

Returns **void** automatically synchronized promise through #recorder

### dontSeeCookie

Checks that cookie with given name does not exist.

```js
I.dontSeeCookie('auth'); // no auth cookie
```

#### Parameters

*   `name` **[string][9]** cookie name.

Returns **void** automatically synchronized promise through #recorder

### dontSeeCurrentPathEquals

Checks that current URL path does NOT match the expected path.
Query strings and URL fragments are ignored.

```js
I.dontSeeCurrentPathEquals('/form'); // fails for '/form', '/form?user=1', '/form#section'
I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
```

#### Parameters

*   `path` **[string][9]** value to check.

Returns **void** automatically synchronized promise through #recorder

### 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][9]** value to check.

Returns **void** automatically synchronized promise through #recorder

### dontSeeElement

Opposite to `seeElement`. Checks that element is not visible (or in DOM)

The second parameter is a context (CSS or XPath locator) to narrow the search.

```js
I.dontSeeElement('.modal'); // modal is not shown
I.dontSeeElement('.modal', '#container');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** located by CSS|XPath|Strict locator.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 

Returns **void** automatically synchronized promise through #recorder

### 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][9] | [object][6])** located by CSS|XPath|Strict locator.

Returns **void** automatically synchronized promise through #recorder

### dontSeeInCurrentUrl

Checks that current url does not contain a provided fragment.

#### Parameters

*   `url` **[string][9]** value to check.

Returns **void** automatically synchronized promise through #recorder

### dontSeeInField

Checks that value of input field or textarea doesn't equal to given value
Opposite to `seeInField`.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

```js
I.dontSeeInField('email', 'user@user.com'); // field by name
I.dontSeeInField({ css: 'form input.email' }, 'user@user.com'); // field by CSS
// within a context
I.dontSeeInField('Name', 'old_value', '.form-container');
```

#### Parameters

*   `field` **([string][9] | [object][6])** located by label|name|CSS|XPath|strict locator.
*   `value` **([string][9] | [object][6])** value to check.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 

Returns **void** automatically synchronized promise through #recorder

### 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` &#x20;
*   `value` **[string][9]** to check.

Returns **void** automatically synchronized promise through #recorder

### dontSeeInTitle

Checks that title does not contain text.

```js
I.dontSeeInTitle('Error');
```

#### Parameters

*   `text` **[string][9]** value to check.

Returns **void** automatically synchronized promise through #recorder

### dontSeeTraffic

Verifies that a certain request is not part of network traffic.

Examples:

```js
I.dontSeeTraffic({ name: 'Unexpected API Call', url: 'https://api.example.com' });
I.dontSeeTraffic({ name: 'Unexpected API Call of "user" endpoint', url: /api.example.com.*user/ });
```

#### Parameters

*   `opts` **[Object][6]** options when checking the traffic network.

    *   `opts.name` **[string][9]** A name of that request. Can be any value. Only relevant to have a more meaningful error message in case of fail.
    *   `opts.url` **([string][9] | [RegExp][11])** Expected URL of request in network traffic. Can be a string or a regular expression.

Returns **void** automatically synchronized promise through #recorder

### 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][9] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 

Returns **void** automatically synchronized promise through #recorder

### dragAndDrop

```js
// specify coordinates for source position
I.dragAndDrop('img.src', 'img.dst', { sourcePosition: {x: 10, y: 10} })
```

> When no option is set, custom drag and drop would be used, to use the dragAndDrop API from Playwright, please set options, for example `force: true`

Drag an item to a destination element.

```js
I.dragAndDrop('#dragHandle', '#container');
```

#### Parameters

*   `srcElement` **([string][9] | [object][6])** located by CSS|XPath|strict locator.
*   `destElement` **([string][9] | [object][6])** located by CSS|XPath|strict locator.
*   `options` **any?** [Additional options][20] can be passed as 3rd argument.

Returns **void** automatically synchronized promise through #recorder

### 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][9] | [object][6])** located by label|name|CSS|XPath|strict locator.
*   `offsetX` **[number][18]** position to drag. 

Returns **void** automatically synchronized promise through #recorder

### 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,
or 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` **([string][9] | [function][21])** function to be executed in browser context.
*   `arg` **any?** optional argument to pass to the function

Returns **[Promise][19]<any>**&#x20;

### fillField

Fills a text field or textarea, after clearing its value, with the given string.
Field is located by name, label, CSS, or XPath.

The third parameter is an optional context (CSS or XPath locator) to narrow the search.

```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');
// by ARIA role locator
I.fillField({role: 'textbox', name: 'Email'}, 'hello@world.com');
// within a context
I.fillField('Name', 'John', '#section2');
```

> ℹ️ ARIA role locators (`{role, name}`) match fields by their accessible name and survive markup refactors. See [Locators][16].

#### Parameters

*   `field` **([string][9] | [object][6])** located by label|name|CSS|XPath|strict locator.
*   `value` **([string][9] | [object][6])** text value to fill.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator. 

Returns **void** automatically synchronized promise through #recorder

### flushNetworkTraffics

Resets all recorded network requests.

```js
I.flushNetworkTraffics();
```

### flushWebSocketMessages

Resets all recorded WS messages.

### focus

Calls [focus][13] on the matching element.

Examples:

```js
I.dontSee('#add-to-cart-btn');
I.focus('#product-tile')
I.see('#add-to-cart-bnt');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.
*   `options` **any?** Playwright only: [Additional options][22] for available options object as 2nd argument. 

Returns **void** automatically synchronized promise through #recorder

### forceClick

Perform an emulated click on a link or a button, given by a locator.
Unlike normal click instead of sending native event, emulates a click with JavaScript.
This works on hidden, animated or inactive elements as well.

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.forceClick('Logout');
// button of form
I.forceClick('Submit');
// CSS button
I.forceClick('#form input[type=submit]');
// XPath
I.forceClick('//form/*[@type=submit]');
// link in context
I.forceClick('Logout', '#nav');
// using strict locator
I.forceClick({css: 'nav a.login'});
```

#### Parameters

*   `locator` **([string][9] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
*   `context` **([string][9]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator. 

Returns **void** automatically synchronized promise through #recorder

### grabAriaSnapshot

Retrieves the ARIA snapshot for an element using Playwright's [`locator.ariaSnapshot`][23].
This method returns a YAML representation of the accessibility tree that can be used for assertions.
If no locator is provided, it captures the snapshot of the entire page body.

```js
const snapshot = await I.grabAriaSnapshot();
expect(snapshot).toContain('heading "Sign up"');

const formSnapshot = await I.grabAriaSnapshot('#login-form');
expect(formSnapshot).toContain('textbox "Email"');
```

[Learn more about ARIA snapshots][24]

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator. Defaults to body element. 

Returns **[Promise][19]<[string][9]>** YAML representation of the accessibility tree

### grabAttributeFrom

Retrieves an attribute 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.
If more than one element is found - attribute of first element is returned.

```js
let hint = await I.grabAttributeFrom('#tooltip', 'title');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `attr` **[string][9]** attribute name.

Returns **[Promise][19]<[string][9]>** attribute value

### grabAttributeFromAll

Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
Resumes test execution, so **should be used inside async with `await`** operator.

```js
let hints = await I.grabAttributeFromAll('.tooltip', 'title');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `attr` **[string][9]** attribute name.

Returns **[Promise][19]<[Array][10]<[string][9]>>** attribute value

### grabBrowserLogs

Get JS log from browser.

```js
const logs = await I.grabBrowserLogs();
const errors = logs.map(l => ({ type: l.type(), text: l.text() })).filter(l => l.type === 'error');
console.log(JSON.stringify(errors));
```

[Learn more about console messages][25]

Returns **[Promise][19]<[Array][10]<any>>**&#x20;

### grabCheckedElementStatus

Return the checked status of given element.

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `options` **[object][6]?** See [https://playwright.dev/docs/api/class-locator#locator-is-checked][26] 

Returns **[Promise][19]<[boolean][27]>**&#x20;

### grabCookie

Returns cookie in JSON format. If name not passed returns all cookies for this domain.

Gets a cookie object by name.
If none provided gets all cookies.
Resumes test execution, so **should be used inside async function with `await`** operator.

```js
let cookie = await I.grabCookie('auth');
assert(cookie.value, '123456');
```

#### Parameters

*   `name` **[string][9]?** cookie name. 

Returns **any** attribute value

### grabCssPropertyFrom

Grab CSS property for given locator
Resumes test execution, so **should be used inside an async function with `await`** operator.
If more than one element is found - value of first element is returned.

```js
const value = await I.grabCssPropertyFrom('h3', 'font-weight');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `cssProperty` **[string][9]** CSS property name.

Returns **[Promise][19]<[string][9]>** CSS value

### grabCssPropertyFromAll

Grab array of CSS properties for given locator
Resumes test execution, so **should be used inside an async function with `await`** operator.

```js
const values = await I.grabCssPropertyFromAll('h3', 'font-weight');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `cssProperty` **[string][9]** CSS property name.

Returns **[Promise][19]<[Array][10]<[string][9]>>** 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][19]<[string][9]>** 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
}
```

Returns **void** automatically synchronized promise through #recorder

### grabDisabledElementStatus

Return the disabled status of given element.

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `options` **[object][6]?** See [https://playwright.dev/docs/api/class-locator#locator-is-disabled][28] 

Returns **[Promise][19]<[boolean][27]>**&#x20;

### 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][9] | [object][6])** element located by CSS|XPath|strict locator.
*   `prop` &#x20;
*   `elementSize` **[string][9]?** x, y, width or height of the given element.

Returns **([Promise][19]<DOMRect> | [Promise][19]<[number][18]>)** 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 - HTML of first element is returned.

```js
let postHTML = await I.grabHTMLFrom('#post');
```

#### Parameters

*   `locator` &#x20;
*   `element` **([string][9] | [object][6])** located by CSS|XPath|strict locator.

Returns **[Promise][19]<[string][9]>** HTML code for an element

### grabHTMLFromAll

Retrieves all the innerHTML from elements 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 postHTMLs = await I.grabHTMLFromAll('.post');
```

#### Parameters

*   `locator` &#x20;
*   `element` **([string][9] | [object][6])** located by CSS|XPath|strict locator.

Returns **[Promise][19]<[Array][10]<[string][9]>>** HTML code for an element

### grabMetrics

Return a performance metric from the chrome cdp session.
Note: Chrome-only

Examples:

```js
const metrics = await I.grabMetrics();

// returned metrics

[
  { name: 'Timestamp', value: 1584904.203473 },
  { name: 'AudioHandlers', value: 0 },
  { name: 'AudioWorkletProcessors', value: 0 },
  { name: 'Documents', value: 22 },
  { name: 'Frames', value: 10 },
  { name: 'JSEventListeners', value: 366 },
  { name: 'LayoutObjects', value: 1240 },
  { name: 'MediaKeySessions', value: 0 },
  { name: 'MediaKeys', value: 0 },
  { name: 'Nodes', value: 4505 },
  { name: 'Resources', value: 141 },
  { name: 'ContextLifecycleStateObservers', value: 34 },
  { name: 'V8PerContextDatas', value: 4 },
  { name: 'WorkerGlobalScopes', value: 0 },
  { name: 'UACSSResources', value: 0 },
  { name: 'RTCPeerConnections', value: 0 },
  { name: 'ResourceFetchers', value: 22 },
  { name: 'AdSubframes', value: 0 },
  { name: 'DetachedScriptStates', value: 2 },
  { name: 'ArrayBufferContents', value: 1 },
  { name: 'LayoutCount', value: 0 },
  { name: 'RecalcStyleCount', value: 0 },
  { name: 'LayoutDuration', value: 0 },
  { name: 'RecalcStyleDuration', value: 0 },
  { name: 'DevToolsCommandDuration', value: 0.000013 },
  { name: 'ScriptDuration', value: 0 },
  { name: 'V8CompileDuration', value: 0 },
  { name: 'TaskDuration', value: 0.000014 },
  { name: 'TaskOtherDuration', value: 0.000001 },
  { name: 'ThreadTime', value: 0.000046 },
  { name: 'ProcessTime', value: 0.616852 },
  { name: 'JSHeapUsedSize', value: 19004908 },
  { name: 'JSHeapTotalSize', value: 26820608 },
  { name: 'FirstMeaningfulPaint', value: 0 },
  { name: 'DomContentLoaded', value: 1584903.690491 },
  { name: 'NavigationStart', value: 1584902.841845 }
]

```

Returns **[Promise][19]<[Array][10]<[Object][6]>>**&#x20;

### grabNumberOfOpenTabs

Grab number of open tabs.
Resumes test execution, so **should be used inside async function with `await`** operator.

```js
let tabs = await I.grabNumberOfOpenTabs();
```

Returns **[Promise][19]<[number][18]>** number of open tabs

### grabNumberOfVisibleElements

Grab number of visible elements by locator.
Resumes test execution, so **should be used inside async function with `await`** operator.

```js
let numOfElements = await I.grabNumberOfVisibleElements('p');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** located by CSS|XPath|strict locator.

Returns **[Promise][19]<[number][18]>** 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][19]<PageScrollPosition>** 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][19]<([string][9] | null)>**&#x20;

### grabRecordedNetworkTraffics

Grab the recording network traffics

```js
const traffics = await I.grabRecordedNetworkTraffics();
expect(traffics[0].url).to.equal('https://reqres.in/api/comments/1');
expect(traffics[0].response.status).to.equal(200);
expect(traffics[0].response.body).to.contain({ name: 'this was mocked' });
```

Returns **[Array][10]** recorded network traffics

### grabSource

Retrieves page source and returns it to test.
Resumes test execution, so **should be used inside async function with `await`** operator.

```js
let pageSource = await I.grabSource();
```

Returns **[Promise][19]<[string][9]>** source code

### grabStorageState

Grab the current storage state (cookies, localStorage, etc.) via Playwright's `browserContext.storageState()`.
Returns the raw object that Playwright provides.

Security: The returned object can contain authentication tokens, session cookies
and (when `indexedDB: true` is used) data that may include user PII. Treat it as a secret.
Avoid committing it to source control and prefer storing it in a protected secrets store / CI artifact vault.

#### Parameters

*   `options` **[object][6]?**  

    *   `options.indexedDB` **[boolean][27]?** set to true to include IndexedDB in snapshot (Playwright >=1.51)```js
        // basic usage
        const state = await I.grabStorageState();
        require('fs').writeFileSync('authState.json', JSON.stringify(state));

        // include IndexedDB when using Firebase Auth, etc.
        const stateWithIDB = await I.grabStorageState({ indexedDB: true });
        ```

### 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 first element.

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.

Returns **[Promise][19]<[string][9]>** attribute value

### grabTextFromAll

Retrieves all texts 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 pins = await I.grabTextFromAll('#pin li');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.

Returns **[Promise][19]<[Array][10]<[string][9]>>** 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][19]<[string][9]>** title

### grabTrafficUrl

Returns full URL of request matching parameter "urlMatch".

Examples:

```js
I.grabTrafficUrl('https://api.example.com/session');
I.grabTrafficUrl(/session.*start/);
```

#### Parameters

*   `urlMatch` **([string][9] | [RegExp][11])** Expected URL of request in network traffic. Can be a string or a regular expression.

Returns **[Promise][19]<any>**&#x20;

### 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.
If more than one element is found - value of first element is returned.

```js
let email = await I.grabValueFrom('input[name=email]');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.

Returns **[Promise][19]<[string][9]>** attribute value

### grabValueFromAll

Retrieves an array of value from a form 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 inputs = await I.grabValueFromAll('//form/input');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** field located by label|name|CSS|XPath|strict locator.

Returns **[Promise][19]<[Array][10]<[string][9]>>** attribute value

### grabWebElement

Grab WebElement for given locator
Resumes test execution, so **should be used inside an async function with `await`** operator.

```js
const webElement = await I.grabWebElement('#button');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.

Returns **[Promise][19]<any>** WebElement of being used Web helper

### grabWebElements

Grab WebElements for given locator
Resumes test execution, so **should be used inside an async function with `await`** operator.

```js
const webElements = await I.grabWebElements('#button');
```

#### Parameters

*   `locator` **([string][9] | [object][6])** element located by CSS|XPath|strict locator.

Returns **[Promise][19]<any>** WebElement of being used Web helper

### grabWebSocketMessages

Grab the recording WS messages

Returns **[Array][10]<any>**&#x20;

### handleDownloads

Handles a file download. A file name is required to save the file on disk.
Files are saved to "output" directory.

Should be used with [FileSystem helper][29] to check that file were downloaded correctly.

```js
I.handleDownloads('downloads/avatar.jpg');
I.click('Download Avatar');
I.amInPath('output/downloads');
I.waitForFile('avatar.jpg', 5);

```

#### Parameters

*   `fileName` **[string][9]** set filename for downloaded file

Returns **[Promise][19]<void>**&#x20;

### makeApiRequest

Performs [api request][30] using
the cookies from the current browser session.

```js
const users = await I.makeApiRequest('GET', '/api/users', { params: { page: 1 }});
users[0]
I.makeApiRequest('PATCH', )
```

> This is Playwright's built-in alternative to using REST helper's sendGet, sendPost, etc methods.

#### Parameters

*   `method` **[string][9]** HTTP method
*   `url` **[string][9]** endpoint
*   `options` **[object][6]** request options depending on method used

Returns **[Promise][19]<[object][6]>** response

### mockRoute

Mocks network request using [`browserContext.route`][31] of Playwright

```js
I.mockRoute(/(.png$)|(.jpg$)/, route => route.abort());
```

This method allows intercepting and mocking requests & responses. [Learn more about it][32]

#### Parameters

*   `url` **([string][9] | [RegExp][11])?** URL, regex or pattern for to match URL
*   `handler` **[function][21]?** a function to process request

### mockTraffic

Mocks traffic for URL(s).
This is a powerful feature to manipulate network traffic. Can be used e.g. to stabilize your tests, speed up your tests or as a last resort to make some test scenarios even possible.

Examples:

```js
I.mockTraffic('/api/users/1', '{ id: 1, name: 'John Doe' }');
I.mockTraffic('/api/users/*', JSON.stringify({ id: 1, name: 'John Doe' }));
I.mockTraffic([/^https://api.example.com/v1/, 'https://api.example.com/v2/**'], 'Internal Server Error', 'text/html');
```

#### Parameters

*   `urls`  string|Array These are the URL(s) to mock, e.g. "/fooapi/*" or "['/fooapi_1/*', '/barapi_2/*']". Regular expressions are also supported.
*   `responseString`  string The string to return in fake response's body.
*   `contentType`  Content type of fake response. If not specified default value 'application/json' is used. 

### moveCursorTo

Moves cursor to element matched by locator.
Extra shift can be set with offsetX and offsetY options.

An optional `context` (as a second parameter) can be specified to narrow the search to an element within a parent.
When the second argument is a non-number (string or locator object), it is treated as context.

```js
I.moveCursorTo('.tooltip');
I.moveCursorTo('#submit', 5,5);
I.